SmartPlant Materials Open Supplier/Company Interface (OSCI)spmat.hec.co.kr/marian_webentry/Pdfs/INT-OSCI.pdf · 2014. 11. 6. · The Open Supplier/Company Interface (OSCI) is the

SmartPlant Materials Open Supplier/Company Interface (OSCI)

Version 2011 SP5 (7.0.5)

December 2011

DMAR1-PE-200050E

Copyright Copyright © 2004-2011 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.

Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

U.S. Government Restricted Rights Legend Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS 252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.

Unpublished - rights reserved under the copyright laws of the United States.

Intergraph Corporation 300 Intergraph Way Huntsville, AL 35813

Documentation Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides, Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a particular software product.

Other Documentation Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support, SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph as guidance for using a software product.

Terms of Use a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the

software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product and Documentation. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal, non-commercial use. The Documentation may not be printed for resale or redistribution.

b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid licenseagreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its publication date.

The information and the software discussed in this document are subject to change without notice and are subject to applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.

The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should verify for themselves that the data is accurate and suitable for their project work.

2 SmartPlant Materials Open Supplier/Company Interface (OSCI)

Limitation of Damages IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2) YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.

IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:

a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries. b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce

Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S. Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S. Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.

c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive nuclear uses.

d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place. e. Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export

Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN, SmartSketch, SPOOLGEN, SupportManager, SupportModeler, Sapphire, and FreeView are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.

SmartPlant Materials Open Supplier/Company Interface (OSCI) 3


Contents Preface .......................................................................................................................................................... 7

Documentation Comments ..................................................................................................................... 7

Introduction .................................................................................................................................................. 9

Oracle Prerequisites and Data Setup ...................................................................................................... 11

ORACLE XML Parser ........................................................................................................................... 11 ORACLE Web Agent and ORACLE PLSXML ...................................................................................... 11 Database Configuration ........................................................................................................................ 11

DBA Settings .................................................................................................................................. 12 Project Defaults .............................................................................................................................. 12

Importing Data using XML Files ............................................................................................................... 13

General File Format .............................................................................................................................. 13 Tags for Company Data ........................................................................................................................ 13

Tags for Company Types ............................................................................................................... 14 Tags for Company Type Descriptions ............................................................................................ 14 Tags for Companies ....................................................................................................................... 15 Tags for Company Descriptions ..................................................................................................... 16 Tags for Company Contact People ................................................................................................ 16 Tags for Communication Links (Contacts) ..................................................................................... 18 Tags for Assign Company Types ................................................................................................... 18 Tags for Company Addresses ........................................................................................................ 19 Tags for Communication Links (Address) ...................................................................................... 20

Tags for Supplier Data .......................................................................................................................... 21 Tags for Qualifications .................................................................................................................... 21 Tags for Qualification Descriptions ................................................................................................. 21 Tags for Supplier ............................................................................................................................ 22 Tags for Supplier Qualifications ..................................................................................................... 25 Tags for Supplier Material Groups ................................................................................................. 26 Tags for Supplier Manufacturers .................................................................................................... 29 Tags for Supplier Attributes ............................................................................................................ 29

Processing Logic ................................................................................................................................... 30 Document Type Definition (DTD) .......................................................................................................... 31 File Format Example ............................................................................................................................. 36

Imported Data using CIP Logic ................................................................................................................ 41

Imported Data by CIP XML using .xml files .......................................................................................... 41

Data Import ................................................................................................................................................. 43

Defining an Import Job .......................................................................................................................... 43 OSCI Job Options ................................................................................................................................. 44 File Upload ............................................................................................................................................ 44 Starting the OSCI Job ........................................................................................................................... 45

Analyze Mode ................................................................................................................................. 46


Contents

Reviewing the Import Protocol .............................................................................................................. 47

Appendix: Messages ................................................................................................................................. 49

SmartPlant Materials Messages ........................................................................................................... 49 ORACLE Messages .............................................................................................................................. 50

Appendix: Supported XML Date Formats ............................................................................................... 51

Index ........................................................................................................................................................... 53


This document describes the Open Supplier/Company Interface (OSCI).

Documentation Comments Send documentation comments or suggestions to [email protected] (mailto:[email protected]?subject=documentation comments).

Preface


mailto:[email protected]?subject=documentation%20comments

Preface


S E C T I O N 1

The Open Supplier/Company Interface (OSCI) is the SmartPlant Materials interface for creating and updating company and supplier data based on XML documents.

OSCI features include:

Creating and updating company types (only creating), companies, company contact people, communication links (contact), assign company types (only creating), company addresses, communication links (address), qualifications, supplier, supplier qualifications, supplier material groups and supplier manufacturers (only creating)

Creating and modifying translated descriptions for company types, companies, and qualifications

Introduction


Introduction


S E C T I O N 2

This section explains the required software components and how to set up data for the OSCI interface.

ORACLE XML Parser To use the OSCI interface, the XML parser must be installed in the database.

The XML parser has been installed properly if the following SQL statement:

SELECT SUBSTR(dbms_java.longname(object_name),1,30) AS class, status FROM all_objects WHERE object_type = 'JAVA CLASS' AND object_name = dbms_java.shortname('oracle/xml/parser/v2/DOMParser');

returns the following result:

CLASS STATUS --------------------------------- --------- oracle/xml/parser/v2/DOMParser VALID

ORACLE Web Agent and ORACLE PLSXML Install the Oracle web agent and PLSXML.

Database Configuration The document type definition (dtd file) for OSCI is in the following directory:

%SPMAT_HOME%\SQL\OSCI

All directories required for SmartPlant Materials log files must be configured correctly in the instance initialization parameter file, named init.ora.

Before you can use the OSCI interface, several DBA settings and project defaults need to be configured.

Oracle Prerequisites and Data Setup


Oracle Prerequisites and Data Setup

DBA Settings Use the A.60.04 DBA Setting screen to define the following DBA settings:

LOG_FILE_DEST - Specifies the server and global default directory for log files. To override this option, supply a value for the ZX_MAR_LOG project default on the A.20.12/13 screen.

LOG_ONLINE_JOBS - Specifies whether log files for online jobs are created. Activating this option is highly recommended.

OSCI_IMPORT_PATH - Specifies the global default directory for OSCI. It must point to a path on the database server.

OSCI_UPLOAD_DEST - Specifies the destination path on the application server where the file is stored. An example is: D:\spmat\osci_uploads.

OSCI_UPLOAD_URL - Enables the web server to find the OSCI file on the application server. An example is: 'your_servername/osci_upload'. The name of your web server is followed by a virtual directory name, without an ending slash. You must define an alias in the web server configuration.

RBS_OSCI - Globally specifies the rollback segment dedicated to OSCI jobs. If this option is not configured, the Oracle server will randomly assign a rollback segment to OSCI transactions.

SQLLDR_EXECUTABLE - Specifies the name of the Oracle SQL*Loader program.

SERVLET_PATH - Specifies the path in the file system of the application server for servlets, including the name of the application server. Here you must specify your application server and the directory of the servlets, as 'your_servername/mar_jserv'.

For more information about DBA settings, see the SmartPlant Materials DBA Settings guide, available from the Printable Guides page in the software.

Project Defaults Apart from the integrator specific project defaults that are also relevant when using the OSCI interface, the setting of project default ZI_OSCI_CO is very important.

This project default determines the level at which commits are performed during the OSCI import.

If you set this project default to RECORD, a commit is done after each record that is processed successfully.

If the project default is set to COMPANY, a commit is done after each company/supplier after all its details have been processed successfully.

You can open the A.60.63 Valid Settings screen via the toolbar on the OSCI 10.01 screen to see the full and actual list of settings needed for OSCI.

For more information about project defaults, see the SmartPlant Materials Project Defaults guide, available from the Printable Guides page in the software.


S E C T I O N 3

This section outlines the general file format that OSCI requires for XML files and describes the individual tags.

General File Format The import file must be an XML file.

Tags can be provided for creating or updating company and supplier data, language dependent.

Special feature for units (currency) Unlike many code fields in SmartPlant Materials, units are not required to be uppercase because this is not necessarily supported by external systems outside SmartPlant Materials. Units are processed as explained here.

First, the system tries to find the unit as provided in the XML file. If this unit cannot be found, the system tries to find the unit using uppercase in the comparison.

Examples

Unit in the database Unit in the XML file Comment

USD USD Unit is found directly.

USD usd Unit is found because of compare using uppercase.

usd USD Unit is found because of compare using uppercase.

Tags for Company Data You can include an unlimited number of company types, companies, and company contact people, and assign company types and company addresses in the XML file.

Importing Data using XML Files



Tags for Company Types < TYPE_PROC_TYPE>

Mandatory.

Processing type.

Allowable values: I and N.

'I' means that the object is to be inserted. 'N' stands for 'not to be processed;' that is, the company type is not inserted. Nevertheless, the company type information is needed to show the path for underlying objects. For example, if you have already created a company type and now you want to add another description, SmartPlant Materials needs to know which company type the description belongs to.

< CT_CT_CODE>

Mandatory.

Name (code) of the company type.

Tags for Company Type Descriptions You can insert as many descriptions for a company type as you want.

< TYPENLS_PROC_TYPE>

Mandatory.

Processing type.

Allowable values: I, U, and N.

'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the description is not processed, that is, neither inserted nor modified. ‘N’ is not required for the language dependent descriptions, only for company types.

<CTNLS_NLS_ID>

Mandatory

Allowable values: All languages defined on A.10.01 Languages.

<CTNLS_SHORT_DESC>

Mandatory

Language dependent short description for a company type.

<CTNLS_DESCRIPTION>

Mandatory


Importing Data using XML Files Language dependent description for a company type.

Tags for Companies <COMP_PROC_TYPE>

Mandatory

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. 'N' stands for 'not to be processed;' that is, the company is not inserted or modified. Nevertheless, the company information is needed to show the path for underlying objects. For example, if you have already created a company and now you want to add another description, SmartPlant Materials needs to know which company the description belongs to.

<COMP_COMPANY_CODE>

Mandatory

Name (code) of the company.

<COMP_COMPANY_NAME>

Mandatory

Name of the company.

<COMP_PROJECT_CONTEXT>

Optional.

You can use the project context as a filter for the display of records on the P.20.01 Suppliers screen. You will find additional information in the description of A.60.61 in the online Help.

<COMP_KEY_WORD>

Optional.

Key word for a company.

This optional field can be used to enter any additional information that may be helpful when searching for companies or suppliers as a special type of company.

For example, you can use this key word for storing information that a company has been renamed, has merged with another company, or has been bought by another company. Screens with advanced search functionality are able to include this key word information when performing queries.



Tags for Company Descriptions You can insert as many descriptions for a company as you want.

<COMPNLS_PROC_TYPE>

Mandatory

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the description is not processed; that is, neither inserted nor modified. ‘N’ is not required for the language dependent descriptions, only for companies.

<COMPNLS_NLS_ID>

Mandatory.


<COMPNLS_SHORT_DESC>

Mandatory.

Language dependent short description for a company.

<COMPNLS_DESCRIPTION>

Mandatory.

Language dependent description for a company.

Tags for Company Contact People <COMPCT_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. 'N' stands for 'not to be processed;' that is, the company contact is not inserted or modified. Nevertheless, the company contact information is needed to show the path for underlying objects. For example, if you have already created a company contact person and now you want to add another communication link, SmartPlant Materials needs to know which company contact the communication link belongs to.

<COMPCT_COMPANY_CODE>

Mandatory.


Importing Data using XML Files Name (code) of the company

<COMPCT_CCP_CODE>

Mandatory.

Code or abbreviation for the contact person.

<COMPCT_FIRST_NAME>

Optional.

The employee's first name.

<COMPCT_LAST_NAME>

Optional.

The employee's last name.

<COMPCT_COMMENTS>

Optional.

Any optional comment, for example, the employee's function.

<COMPCT_DEPARTMENT>

Optional.

The employee's department.

<COMPCT_TELEPHONE>

Optional.

Phone number of the contact person.

<COMPCT_POSITION>

Optional.

The employee's position.

<COMPCT_DEFAULT_SUP_IND>

Optional (default ‘N’).

Indicates whether this company employee is the default contact person with respect to a supplier.

This default is used on the P.20.01 Suppliers screen.



Tags for Communication Links (Contacts) You can insert as many communication links for a company contact person as you want.

<COMMLINKS_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the communication link is not processed, that is, neither inserted nor modified. ‘N’ is not required for the communication link, only for the company contact person.

<COMMLINKS_CMT_CODE>

Mandatory.

Means of communication to be used when contacting the company's employee.

Possible entries can be 'FAX', 'E-MAIL,' or 'PHONE'. The value of these addresses such as the fax or telephone number can be entered in the Address Value field.

<COMMLINKS_ADDRESS_VALUE>

Mandatory.

Value for the means of communication defined by 'Communication Type'.

Values can be a fax number, a phone number, or an email address.

<COMMLINKS_DEFAULT_IND>


Indicator whether the communication type is the default one for the employee.

Tags for Assign Company Types <ASSIGNCT_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘N’ means that the assign company type is not processed, that is, neither inserted nor modified. ‘N’ is not required for the assign company type.

<ASSIGNCT_CT_CODE>


Importing Data using XML Files Mandatory.

Use any company type defined on A.10.22 and new company types of the XML section company types.

<ASSIGNCT_COMPANY_CODE>

Mandatory.

Use any companies defined on A.10.23 and new companies of the XML section company.

Tags for Company Addresses <COMPADDRS_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. 'N' stands for 'not to be processed;' that is, the company address is not inserted or modified. Nevertheless, the company address information is needed to show the path for underlying objects. For example, if you have already created a company address and now you want to add another communication link, SmartPlant Materials needs to know which company address the communication link belongs to.

<COMPADDRS_ADDRESS_TYPE_CODE>

Mandatory.

Type of the address.

Possible types could be 'BILL TO', 'MAIL TO,' or 'SHIP TO'.

<COMPADDRS_COMPANY_CODE>

Mandatory.


<COMPADDRS_CY_CODE>

Mandatory.

Name (code) of the country.

<COMPADDRS_CITY>

Mandatory.

The city where the company is located.


Importing Data using XML Files <COMPADDRS_STPR_CODE>

Optional.

Name (code) of the state or province.

<COMPADDRS_ADDR1>

Optional.

First line of the mailing address.

<COMPADDRS_ADDR2>

Optional.

Second line of the mailing address.

<COMPADDRS_POSTAL_CODE>

Optional.

The zip or postal code for the address.

Tags for Communication Links (Address) You can insert as many communication links for a company address as you want.

<COMMLINKS2_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the communication link is not processed, that is, neither inserted nor modified. ‘N’ is not required for the communication link, only for the company address.

<COMMLINKS2_CMT_CODE>

Mandatory.

Means of communication to be used when contacting the company.

Possible entries can be 'FAX', 'E-MAIL,' or 'PHONE'. The value of these addresses such as the fax or telephone number can be entered in the Address Value field.

<COMMLINKS2_ADDRESS_VALUE>

Mandatory.

Value for the means of communication defined by 'Communication Type'.


Importing Data using XML Files Values can be a fax number, a phone number, or an email address.

Tags for Supplier Data You can include an unlimited number of qualifications and suppliers in the XML file.

Tags for Qualifications <QUALI_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. 'N' stands for 'not to be processed;' that is, the qualification is not inserted or modified. Nevertheless, the qualification information is needed to show the path for underlying objects. For example, if you have already created a qualification and now you want to add another description, SmartPlant Materials needs to know which qualification the description belongs to.

<QUALI_ORDER_SEQ>

Mandatory.

A unique sequence number to define each qualification.

<QUALI_REVISION>

Optional (default 0).

Revision.

<QUALI_QUAL_ITEM_TYPE>

Mandatory.

Indicates whether the qualification requires a Y/N or DATE answer.

Tags for Qualification Descriptions You can insert as many descriptions for a qualification as you want.

<QUALINLS_PROC_TYPE>

Mandatory.

Processing type.



Importing Data using XML Files 'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the description is not processed, that is, neither inserted nor modified. ‘N’ is not required for the language dependent descriptions, only for qualifications.

<QUALINLS_NLS_ID>

Mandatory.


<QUALINLS_SHORT_DESC>

Mandatory.

Language dependent short description for a qualification.

<QUALINLS_DESCRIPTION>

Mandatory.

Language dependent description for a qualification.

Tags for Supplier <SUP_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. 'N' stands for 'not to be processed;' that is, the supplier is not inserted or modified. Nevertheless, the supplier information is needed to show the path for underlying objects. For example, if you have already created a supplier and now you want to add another material group, SmartPlant Materials needs to know which supplier the material group belongs to.

<SUPPLIER_SUP_CODE>

Mandatory.

Name (code) of the supplier.

<SUPPLIER_COMPANY_CODE>

Mandatory.

Name of the supplier's company.

<SUPPLIER_CT_CODE>

Mandatory.


Importing Data using XML Files Name (code) of the company type.

<SUPPLIER_CURRENCY>

Optional (default project default ZX_CURCY).

Name (code) of the supplier's preferred currency.

When you create a new supplier, the setting of project default ZX_CURCY is used as the default for the currency. This value can be overwritten.

<SUPPLIER_PO_SALES_LIMIT>

Optional (default 0).

Which overall value may the purchase order have at most?

Please note that this field has only an informative nature. The system does not perform any checks when creating or modifying purchase orders. It is up to you to ensure that this value is not exceeded.

As there is no support by the system, you can use this field alternatively to enter the limit to which the supplier's sales can accumulate.

<SUPPLIER_EDI_IND>

Optional (default ‘Y’).

This check box shows you whether a supplier uses electronic data interchange to transfer data.

<SUPPLIER_APPROVED_IND>


Indicates whether this supplier has been approved.

On the P.50.02 Create Order without Req, P.50.03 Create Order from Req, and P.50.11 Maintain POs screens, only suppliers that have been approved are available.

You need privilege 'ALLOW SUPPLIER APPROVAL' to be allowed to set this check box.

<SUPPLIER_SECRECY_AGREEMENT_IND>


Does a secrecy agreement exist with this supplier?

<SUPPLIER_VRT_CODE>

Optional.

Name (code) of the vendor rating type. This field is mandatory if you insert a tag value for <SUPPLIER_VR_CODE>.


Importing Data using XML Files <SUPPLIER_VR_CODE>

Optional.

Name (code) of the vendor rating.

You can only enter a vendor rating after you have entered a vendor rating (<VRT_CODE>) type.

<SUPPLIER_DTM_CODE>

Optional.

Name (code) of the data transfer medium.

<SUPPLIER_CY_CODE>

Optional.

Name (code) of the supplier's country.

<SUPPLIER_ACCOUNT_CODE>

Optional.

Account code for the supplier.

<SUPPLIER_TAX_ID>

Optional.

Tax identification number.

<SUPPLIER_COMMERCIAL_REGISTRATION>

Optional.

Commercial registration number.

<SUPPLIER_NEAREST_PORT_OF_EXIT>

Optional.

Nearest port of exit for the supplier's shipping location.

<SUPPLIER_APPROVED_DATE>

Optional (default SYSDATE, if SUPPLIER_APPROVED_IND = ‘Y’).

Date when the supplier was approved.

<SUPPLIER_BID_TARGET>

Optional.


Importing Data using XML Files Target of the bid transfer, for example, an e-mail address.

<SUPPLIER_RFQ_EMAIL_IND>

Optional.

Indicates whether notification emails should be sent automatically when approving an inquiry or whether email answers from the supplier should be received or processed.

To use this feature, the supplier must have a communication link, which is defined on the A.10.23 Companies screen, Addresses tab, and which is of the communication type RFQ_EMAIL, and which contains the destination email address.

<SUPPLIER_ALLOWED_IND>

Optional (default ‘P’ = 'PO & Inquiry').

With this field, you control how a supplier can be used.

If you select 'PO & Inquiry', this supplier can be used for the creation of orders and can be assigned to inquiries.

Selecting 'Inquiry Only' means that you can only assign this supplier to inquiries, but you cannot create orders for him.

Setting this field to 'None' means that you cannot use this supplier for orders nor for inquiries.

Only users that own privilege 'DEFINE_INQ_SUPPLIER' are allowed to change this field to 'Inquiry Only'.

Only users that have privilege 'DEFINE_PO_SUPPLIER' (includes DEFINE_INQ_SUPPLIER) are allowed to set the value to 'Inquiry Only' or 'PO & Inquiry'.

Tags for Supplier Qualifications You can insert as many supplier qualifications for a supplier as you want.

<SUPQUALI_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the supplier qualification is not processed, that is, neither inserted nor modified. ‘N’ is not required for the supplier qualification, only for suppliers.

<SUPQUALI_QUALI_SEQ_ID>

Mandatory.

Sequence number used to order the qualifications.


Importing Data using XML Files <SUPQUALI_QUALI_REV_ID>

Mandatory.

Revision.

<SUPQUALI_QUALIFICATION_RESPONSE_IND>


Indicator of whether the supplier has fulfilled this qualification.

<SUPQUALI_DATE_QUALIFIED>

Optional.

Date on which the 'Qualified' check box has been set. If this value is NULL and the tag SUPQUALI_QUALIFICATION_RESPONSE_IND is set to ‘Y’, then this field is filled with SYSDATE.

<SUPQUALI_EXPLANATION_TEXT>

Optional.

Explanatory text of the qualification result.

<SUPQUALI_QUALIFICATION_EXPIRE_DATE>

Optional.

Date on which this qualification will expire.

Tags for Supplier Material Groups You can insert as many supplier material groups for a supplier as you want.

<SUPMG_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the supplier material group is not processed, that is, neither inserted nor modified. ‘N’ is not required for the supplier material group, only for suppliers.

<SUPMG_MGTY_CODE>

Mandatory.

Name (code) of the material group type.



<SUPMG_MG_CODE>

Mandatory.

Name (code) of the material group.

<SUPMG_MG_REVISION_ID>

Mandatory.

Revision.

<SUPMG_QUALIFIED_IND>


Indicator that this supplier is qualified for this material group.

<SUPMG_QUALIFIED_DATE>

Optional.

Date on which the supplier was classified as qualified for this material group. If this tag is NULL and tag <SUPMG_QUALIFIED_IND> is ‘Y’, then this field will be filled with SYSDATE.

<SUPMG_APP_DEPARTMENT>

Optional.

Department that has approved the qualification.

<SUPMG_QUALIFICATION_CLASS>


Classification of a supplier's qualification for a material group.

The following values are available:

Not qualified = 'N'

Potential = 'P'

Hold = 'H'

Qualified as stockist = 'S'

Qualified with conditions

= 'C'

Qualified = 'Q'





Tags for Supplier Manufacturers You can insert as many supplier manufacturers for a supplier as you want.

<SUPMANU_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘N’ means that the supplier manufacturer is not processed, that is, neither inserted nor modified. ‘N’ is not required for the supplier manufacturer, only for suppliers.

<SUPMANU_CT_CODE>

Mandatory.

Name (code) of the company type.

<SUPMANU_COMPANY_CODE>

Mandatory.


Tags for Supplier Attributes You can insert as many supplier attributes for a supplier as you want.

<SUPATTR_PROC_TYPE>

Mandatory.

Processing type.


'I' means that the object is to be inserted. ‘U’ means that an update is to be performed. ‘N’ means that the supplier attribute is not processed, that is, neither inserted nor modified. ‘N’ is not required for the supplier attributes, only for suppliers.

<SUPATTR_ATTR_CODE>

Mandatory.

Name (code) of the attribute.

<SUPATTR_ATTR_VALUE>


Importing Data using XML Files Mandatory.

Value of the attribute.

Processing Logic Data in the XML file is imported and stored in a table. Then, SmartPlant Materials processes the data. Error and log files that contain statistics and error messages for both steps are created.

With OSCI, you can insert and update several data for companies and suppliers according to what the SmartPlant Materials screens allow.

You can insert or update translated descriptions for company types, companies, and qualifications.

For each of these objects [company types, company type description, companies, company descriptions, company contacts, communication links (contacts), assign company types, company addresses, communication links (address), qualifications, qualification description, supplier, supplier qualifications, supplier material groups, supplier manufacturers], the file must contain the information about why it can be found in the file. Use the following tags for this information:

<TYPE_PROC_TYPE>

<TYPENLS_PROC_TYPE>

<COMP_PROC_TYPE>

<COMPNLS_PROC_TYPE>

<COMPCT_PROC_TYPE>

<COMMLINKS_PROC_TYPE>

<ASSIGNCT_PROC_TYPE>

<COMPADDRS_PROC_TYPE>

<COMMLINKS2_PROC_TYPE>

<QUALI_PROC_TYPE>

<QUALINLS_PROC_TYPE>

<SUP_PROC_TYPE>

<SUPQUALI_PROC_TYPE>

<SUPMG_PROC_TYPE>

<SUPMANU_PROC_TYPE>

<SUPATTR_PROC_TYPE>

A tag can be set to I, U, or N for processing:

I means that the object is to be inserted.

U means that an update is to be performed.

N means that the object is not processed, that is, neither inserted nor modified. However, the object information is needed to show the path for underlying objects. For example, if you have already created a company contact person and now you want to add another



communication link, SmartPlant Materials needs to know which company contact the communication link belongs to.

For some data, the values of project defaults are taken if no value is provided in the XML file.

If the file does not contain the tag <SUPPLIER_CURRENCY>, the value of the project default ZX_CURCY is used instead.

Each record that has been processed successfully is committed to the database. Records that are not valid are not imported. Modify the import file data and start OSCI again to import the remaining items.

OSCI creates company types, company type descriptions, companies, company descriptions, company contacts, communication links for contacts, company addresses, communication links for addresses, qualifications, qualification descriptions, suppliers, supplier qualifications, supplier material groups, supplier manufacturers, supplier attributes, and assign company types. It does not create records in referenced tables; these records must already exist. For example, in an XML file, you can only include a supplier material group that is already known in SmartPlant Materials. If the material group cannot be found in SmartPlant Materials, it will not be created automatically and the import will fail.

Document Type Definition (DTD) The document type definition (DTD) looks like this:

<!ELEMENT COMPANY (CS+)> <!ELEMENT CS (CT*, COMP*, COMPCT*, ASSIGNCT*, COMPADDRS*, SUP*)> <!ELEMENT CT (TYPE_PROC_TYPE, CT_CT_CODE, CTNLS*)> <!ELEMENT TYPE_PROC_TYPE (#PCDATA)> <!ELEMENT CT_CT_CODE (#PCDATA)> <!ELEMENT CTNLS (TYPENLS_PROC_TYPE, CTNLS_NLS_ID, CTNLS_SHORT_DESC, CTNLS_DESCRIPTION)> <!ELEMENT TYPENLS_PROC_TYPE #PCDATA)> <!ELEMENT CTNLS_NLS_ID (#PCDATA)> <!ELEMENT CTNLS_SHORT_DESC (#PCDATA)> <!ELEMENT CTNLS_DESCRIPTION (#PCDATA)> <!ELEMENT COMP (COMP_PROC_TYPE, COMP_COMPANY_CODE, COMP_COMPANY_NAME, COMP_PROJECT_CONTEXT?, COMP_KEY_WORD?, COMPNLS*)> <!ELEMENT COMP_PROC_TYPE (#PCDATA)>


Importing Data using XML Files <!ELEMENT COMP_COMPANY_CODE (#PCDATA)> <!ELEMENT COMP_COMPANY_NAME (#PCDATA)> <!ELEMENT COMP_PROJECT_CONTEXT (#PCDATA)> <!ELEMENT COMP_KEY_WORD (#PCDATA)> <!ELEMENT COMPNLS (COMPNLS_PROC_TYPE, COMPNLS_NLS_ID, COMPNLS_SHORT_DESC, COMPNLS_DESCRIPTION)> <!ELEMENT COMPNLS_PROC_TYPE (#PCDATA)> <!ELEMENT COMPNLS_NLS_ID (#PCDATA)> <!ELEMENT COMPNLS_SHORT_DESC (#PCDATA)> <!ELEMENT COMPNLS_DESCRIPTION (#PCDATA)> <!ELEMENT COMPCT (COMPCT_PROC_TYPE, COMPCT_COMPANY_CODE, COMPCT_CCP_CODE, COMPCT_FIRST_NAME?, COMPCT_LAST_NAME?, COMPCT_COMMENTS?, COMPCT_DEPARTMENT?, COMPCT_TELEPHONE?, COMPCT_POSITION?, COMPCT_DEFAULT_SUP_IND?, COMMLINKS*)> <!ELEMENT COMPCT_PROC_TYPE (#PCDATA)> <!ELEMENT COMPCT_COMPANY_CODE (#PCDATA)> <!ELEMENT COMPCT_CCP_CODE (#PCDATA)> <!ELEMENT COMPCT_FIRST_NAME (#PCDATA)> <!ELEMENT COMPCT_LAST_NAME (#PCDATA)> <!ELEMENT COMPCT_COMMENTS (#PCDATA)> <!ELEMENT COMPCT_DEPARTMENT (#PCDATA)> <!ELEMENT COMPCT_TELEPHONE (#PCDATA)> <!ELEMENT COMPCT_POSITION (#PCDATA)> <!ELEMENT COMPCT_DEFAULT_SUP_IND (#PCDATA)> <!ELEMENT COMMLINKS (COMMLINKS_PROC_TYPE, COMMLINKS_CMT_CODE, COMMLINKS_ADDRESS_VALUE, COMMLINKS_DEFAULT_IND?)> <!ELEMENT COMMLINKS_PROC_TYPE (#PCDATA)> <!ELEMENT COMMLINKS_CMT_CODE (#PCDATA)> <!ELEMENT COMMLINKS_ADDRESS_VALUE (#PCDATA)> <!ELEMENT COMMLINKS_DEFAULT_IND (#PCDATA)> <!ELEMENT ASSIGNCT (ASSIGNCT_PROC_TYPE, ASSIGNCT_CT_CODE, ASSIGNCT_COMPANY_CODE)> <!ELEMENT ASSIGNCT_PROC_TYPE (#PCDATA)> <!ELEMENT ASSIGNCT_CT_CODE (#PCDATA)> <!ELEMENT ASSIGNCT_COMPANY_CODE (#PCDATA)> <!ELEMENT COMPADDRS (COMPADDRS_PROC_TYPE,


Importing Data using XML Files COMPADDRS_ADDRESS_TYPE_CODE, COMPADDRS_COMPANY_CODE, COMPADDRS_CY_CODE, COMPADDRS_CITY, COMPADDRS_STPR_CODE?, COMPADDRS_ADDR1?, COMPADDRS_ADDR2?, COMPADDRS_POSTAL_CODE?, COMMLINKS2*)> <!ELEMENT COMPADDRS_PROC_TYPE (#PCDATA)> <!ELEMENT COMPADDRS_ADDRESS_TYPE_CODE (#PCDATA)> <!ELEMENT COMPADDRS_COMPANY_CODE (#PCDATA)> <!ELEMENT COMPADDRS_CY_CODE (#PCDATA)> <!ELEMENT COMPADDRS_CITY (#PCDATA)> <!ELEMENT COMPADDRS_STPR_CODE (#PCDATA)> <!ELEMENT COMPADDRS_ADDR1 (#PCDATA)> <!ELEMENT COMPADDRS_ADDR2 (#PCDATA)> <!ELEMENT COMPADDRS_POSTAL_CODE (#PCDATA)> <!ELEMENT COMMLINKS2 (COMMLINKS2_PROC_TYPE, COMMLINKS2_CMT_CODE, COMMLINKS2_ADDRESS_VALUE)> <!ELEMENT COMMLINKS2_PROC_TYPE (#PCDATA)> <!ELEMENT COMMLINKS2_CMT_CODE (#PCDATA)> <!ELEMENT COMMLINKS2_ADDRESS_VALUE (#PCDATA)> <!ELEMENT SUP (QUALI*, SUPPLIER*)> <!ELEMENT QUALI (QUALI_PROC_TYPE, QUALI_ORDER_SEQ, QUALI_REVISION?, QUALI_QUAL_ITEM_TYPE, QUALINLS*)> <!ELEMENT QUALI_PROC_TYPE (#PCDATA)> <!ELEMENT QUALI_ORDER_SEQ (#PCDATA)> <!ELEMENT QUALI_REVISION (#PCDATA)> <!ELEMENT QUALI_QUAL_ITEM_TYPE (#PCDATA)> <!ELEMENT QUALINLS (QUALINLS_PROC_TYPE, QUALINLS_NLS_ID, QUALINLS_SHORT_DESC, QUALINLS_DESCRIPTION)> <!ELEMENT QUALINLS_PROC_TYPE (#PCDATA)> <!ELEMENT QUALINLS_NLS_ID (#PCDATA)> <!ELEMENT QUALINLS_SHORT_DESC (#PCDATA)> <!ELEMENT QUALINLS_DESCRIPTION (#PCDATA)> <!ELEMENT SUPPLIER (SUP_PROC_TYPE, SUPPLIER_SUP_CODE, SUPPLIER_COMPANY_CODE, SUPPLIER_CT_CODE, SUPPLIER_CURRENCY?,


Importing Data using XML Files SUPPLIER_PO_SALES_LIMIT?, SUPPLIER_EDI_IND?, SUPPLIER_APPROVED_IND?, SUPPLIER_SECRECY_AGREEMENT_IND?, SUPPLIER_VRT_CODE?, SUPPLIER_VR_CODE?, SUPPLIER_DTM_CODE?, SUPPLIER_CY_CODE?, SUPPLIER_ACCOUNT_CODE?, SUPPLIER_TAX_ID?, SUPPLIER_COMMERCIAL_REGISTRATION?, SUPPLIER_NEAREST_PORT_OF_EXIT?, SUPPLIER_APPROVED_DATE?, SUPPLIER_BID_TARGET?, SUPPLIER_RFQ_EMAIL_IND?, SUPPLIER_ALLOWED_IND?, SUPPLIER_PROJECT_SUP?, SUPQUALI*, SUPMG*, SUPMANU*, SUPATTR*)> <!ELEMENT SUP_PROC_TYPE (#PCDATA)> <!ELEMENT SUPPLIER_SUP_CODE (#PCDATA)> <!ELEMENT SUPPLIER_COMPANY_CODE (#PCDATA)> <!ELEMENT SUPPLIER_CT_CODE (#PCDATA)> <!ELEMENT SUPPLIER_CURRENCY (#PCDATA)> <!ELEMENT SUPPLIER_PO_SALES_LIMIT (#PCDATA)> <!ELEMENT SUPPLIER_EDI_IND (#PCDATA)> <!ELEMENT SUPPLIER_APPROVED_IND (#PCDATA)> <!ELEMENT SUPPLIER_SECRECY_AGREEMENT_IND (#PCDATA)> <!ELEMENT SUPPLIER_VRT_CODE (#PCDATA)> <!ELEMENT SUPPLIER_VR_CODE (#PCDATA)> <!ELEMENT SUPPLIER_DTM_CODE (#PCDATA)> <!ELEMENT SUPPLIER_CY_CODE (#PCDATA)> <!ELEMENT SUPPLIER_ACCOUNT_CODE (#PCDATA)> <!ELEMENT SUPPLIER_TAX_ID (#PCDATA)> <!ELEMENT SUPPLIER_COMMERCIAL_REGISTRATION (#PCDATA)> <!ELEMENT SUPPLIER_NEAREST_PORT_OF_EXIT (#PCDATA)> <!ELEMENT SUPPLIER_APPROVED_DATE (#PCDATA)> <!ELEMENT SUPPLIER_BID_TARGET (#PCDATA)> <!ELEMENT SUPPLIER_RFQ_EMAIL_IND (#PCDATA)> <!ELEMENT SUPPLIER_ALLOWED_IND (#PCDATA)> <!ELEMENT SUPPLIER_PROJECT_SUP (#PCDATA)> <!ELEMENT SUPQUALI (SUPQUALI_PROC_TYPE, SUPQUALI_QUALI_SEQ_ID, SUPQUALI_QUALI_REV_ID, SUPQUALI_QUALIFICATION_RESPONSE_IND?, SUPQUALI_DATE_QUALIFIED?, SUPQUALI_EXPLANATION_TEXT?, SUPQUALI_QUALIFICATION_EXPIRE_DATE?)> <!ELEMENT SUPQUALI_PROC_TYPE (#PCDATA)>


Importing Data using XML Files <!ELEMENT SUPQUALI_QUALI_SEQ_ID (#PCDATA)> <!ELEMENT SUPQUALI_QUALI_REV_ID (#PCDATA)> <!ELEMENT SUPQUALI_QUALIFICATION_RESPONSE_IND (#PCDATA)> <!ELEMENT SUPQUALI_DATE_QUALIFIED (#PCDATA)> <!ELEMENT SUPQUALI_EXPLANATION_TEXT (#PCDATA)> <!ELEMENT SUPQUALI_QUALIFICATION_EXPIRE_DATE (#PCDATA)> <!ELEMENT SUPMG (SUPMG_PROC_TYPE, SUPMG_MGTY_CODE, SUPMG_MG_CODE, SUPMG_MG_REVISION_ID, SUPMG_QUALIFIED_IND?, SUPMG_QUALIFIED_DATE?, SUPMG_APP_DEPARTMENT?, SUPMG_QUALIFICATION_CLASS?)> <!ELEMENT SUPMG_PROC_TYPE (#PCDATA)> <!ELEMENT SUPMG_MGTY_CODE (#PCDATA)> <!ELEMENT SUPMG_MG_CODE (#PCDATA)> <!ELEMENT SUPMG_MG_REVISION_ID (#PCDATA)> <!ELEMENT SUPMG_QUALIFIED_IND (#PCDATA)> <!ELEMENT SUPMG_QUALIFIED_DATE (#PCDATA)> <!ELEMENT SUPMG_APP_DEPARTMENT (#PCDATA)> <!ELEMENT SUPMG_QUALIFICATION_CLASS (#PCDATA)> <!ELEMENT SUPMANU (SUPMANU_PROC_TYPE, SUPMANU_CT_CODE, SUPMANU_COMPANY_CODE)> <!ELEMENT SUPMANU_PROC_TYPE (#PCDATA)> <!ELEMENT SUPMANU_CT_CODE (#PCDATA)> <!ELEMENT SUPMANU_COMPANY_CODE (#PCDATA)> <!ELEMENT SUPATTR (SUPATTR_PROC_TYPE, SUPATTR_ATTR_CODE, SUPATTR_ATTR_VALUE?)> <!ELEMENT SUPATTR_PROC_TYPE (#PCDATA)> <!ELEMENT SUPATTR_ATTR_CODE (#PCDATA)> <!ELEMENT SUPATTR_ATTR_VALUE (#PCDATA)>



File Format Example A simple XML file could have the following layout:

<?xml version="1.0" ?> <!DOCTYPE COMPANY SYSTEM "osci_dtd.dtd"> <COMPANY> <CS> <CT> <TYPE_PROC_TYPE>I</TYPE_PROC_TYPE> <CT_CT_CODE>TEST_1436</CT_CT_CODE> <CTNLS> <TYPENLS_PROC_TYPE>I</TYPENLS_PROC_TYPE> <CTNLS_NLS_ID>1</CTNLS_NLS_ID> <CTNLS_SHORT_DESC>VID 1436 Test</CTNLS_SHORT_DESC> <CTNLS_DESCRIPTION>VID 1436 Test English</CTNLS_DESCRIPTION> </CTNLS> </CT> <COMP> <COMP_PROC_TYPE>I</COMP_PROC_TYPE> <COMP_COMPANY_CODE>TEST_1436</COMP_COMPANY_CODE> <COMP_COMPANY_NAME>TEST_1436</COMP_COMPANY_NAME> <COMP_PROJECT_CONTEXT>Y</COMP_PROJECT_CONTEXT> <COMP_KEY_WORD>test</COMP_KEY_WORD> <COMPNLS> <COMPNLS_PROC_TYPE>I</COMPNLS_PROC_TYPE> <COMPNLS_NLS_ID>1</COMPNLS_NLS_ID> <COMPNLS_SHORT_DESC>VID 1436 Test</COMPNLS_SHORT_DESC> <COMPNLS_DESCRIPTION>VID 1436 Test English</COMPNLS_DESCRIPTION> </COMPNLS> </COMP> <COMPCT> <COMPCT_PROC_TYPE>I</COMPCT_PROC_TYPE> <COMPCT_COMPANY_CODE>TEST_1436</COMPCT_COMPANY_CODE> <COMPCT_CCP_CODE>TEST_1436</COMPCT_CCP_CODE> <COMPCT_FIRST_NAME>First</COMPCT_FIRST_NAME> <COMPCT_LAST_NAME>Last</COMPCT_LAST_NAME> <COMPCT_COMMENTS>no comments</COMPCT_COMMENTS> <COMPCT_DEPARTMENT>DOR</COMPCT_DEPARTMENT> <COMPCT_TELEPHONE>123456789</COMPCT_TELEPHONE> <COMPCT_POSITION>no position</COMPCT_POSITION> <COMPCT_DEFAULT_SUP_IND>Y</COMPCT_DEFAULT_SUP_IND> <COMMLINKS> <COMMLINKS_PROC_TYPE>I</COMMLINKS_PROC_TYPE> <COMMLINKS_CMT_CODE>E-MAIL</COMMLINKS_CMT_CODE>


Importing Data using XML Files <COMMLINKS_ADDRESS_VALUE>[email protected]</COMMLINKS_ADDRESS_VALUE> <COMMLINKS_DEFAULT_IND>Y</COMMLINKS_DEFAULT_IND> </COMMLINKS> </COMPCT> <ASSIGNCT> <ASSIGNCT_PROC_TYPE>I</ASSIGNCT_PROC_TYPE> <ASSIGNCT_CT_CODE>SUPPLIER</ASSIGNCT_CT_CODE> <ASSIGNCT_COMPANY_CODE>TEST_1436</ASSIGNCT_COMPANY_CODE> </ASSIGNCT> <COMPADDRS> <COMPADDRS_PROC_TYPE>I</COMPADDRS_PROC_TYPE> <COMPADDRS_ADDRESS_TYPE_CODE>MAILTO</COMPADDRS_ADDRESS_TYPE_CODE> <COMPADDRS_COMPANY_CODE>TEST_1436</COMPADDRS_COMPANY_CODE> <COMPADDRS_CY_CODE>AD</COMPADDRS_CY_CODE> <COMPADDRS_CITY>xxx</COMPADDRS_CITY> <COMPADDRS_STPR_CODE> </COMPADDRS_STPR_CODE> <COMPADDRS_ADDR1>xxx</COMPADDRS_ADDR1> <COMPADDRS_ADDR2>xxx</COMPADDRS_ADDR2> <COMPADDRS_POSTAL_CODE>xxx</COMPADDRS_POSTAL_CODE> <COMMLINKS2> <COMMLINKS2_PROC_TYPE>I</COMMLINKS2_PROC_TYPE> <COMMLINKS2_CMT_CODE>E-MAIL</COMMLINKS2_CMT_CODE> <COMMLINKS2_ADDRESS_VALUE>[email protected]</COMMLINKS2_ADDRESS_VALUE> </COMMLINKS2> </COMPADDRS> <SUP> <QUALI> <QUALI_PROC_TYPE>I</QUALI_PROC_TYPE> <QUALI_ORDER_SEQ>240</QUALI_ORDER_SEQ> <QUALI_REVISION>0</QUALI_REVISION> <QUALI_QUAL_ITEM_TYPE>Y/N</QUALI_QUAL_ITEM_TYPE> <QUALINLS> <QUALINLS_PROC_TYPE>I</QUALINLS_PROC_TYPE> <QUALINLS_NLS_ID>1</QUALINLS_NLS_ID> <QUALINLS_SHORT_DESC>VID 1436 Test</QUALINLS_SHORT_DESC> <QUALINLS_DESCRIPTION>VID 1436 Test English</QUALINLS_DESCRIPTION> </QUALINLS> </QUALI> <SUPPLIER> <SUP_PROC_TYPE>I</SUP_PROC_TYPE> <SUPPLIER_SUP_CODE>TEST_1436</SUPPLIER_SUP_CODE> <SUPPLIER_COMPANY_CODE>TEST_1436</SUPPLIER_COMPANY_CODE>


Importing Data using XML Files <SUPPLIER_CT_CODE>SUPPLIER</SUPPLIER_CT_CODE> <SUPPLIER_CURRENCY></SUPPLIER_CURRENCY> <SUPPLIER_PO_SALES_LIMIT></SUPPLIER_PO_SALES_LIMIT> <SUPPLIER_EDI_IND></SUPPLIER_EDI_IND> <SUPPLIER_APPROVED_IND>N</SUPPLIER_APPROVED_IND> <SUPPLIER_SECRECY_AGREEMENT_IND></SUPPLIER_SECRECY_AGREEMENT_IND> <SUPPLIER_VRT_CODE>DEFAULT</SUPPLIER_VRT_CODE> <SUPPLIER_VR_CODE>FULLY</SUPPLIER_VR_CODE> <SUPPLIER_DTM_CODE>DISK</SUPPLIER_DTM_CODE> <SUPPLIER_CY_CODE>AD</SUPPLIER_CY_CODE> <SUPPLIER_ACCOUNT_CODE>xxx</SUPPLIER_ACCOUNT_CODE> <SUPPLIER_TAX_ID>xxx</SUPPLIER_TAX_ID> <SUPPLIER_COMMERCIAL_REGISTRATION>xx</SUPPLIER_COMMERCIAL_REGISTRATION> <SUPPLIER_NEAREST_PORT_OF_EXIT>Hamburg</SUPPLIER_NEAREST_PORT_OF_EXIT> <SUPPLIER_APPROVED_DATE></SUPPLIER_APPROVED_DATE> <SUPPLIER_BID_TARGET>aser</SUPPLIER_BID_TARGET> <SUPPLIER_RFQ_EMAIL_IND>Y</SUPPLIER_RFQ_EMAIL_IND> <SUPPLIER_ALLOWED_IND></SUPPLIER_ALLOWED_IND> <SUPPLIER_PROJECT_SUP>Y</SUPPLIER_PROJECT_SUP> <SUPQUALI> <SUPQUALI_PROC_TYPE>I</SUPQUALI_PROC_TYPE> <SUPQUALI_QUALI_SEQ_ID>240</SUPQUALI_QUALI_SEQ_ID> <SUPQUALI_QUALI_REV_ID>0</SUPQUALI_QUALI_REV_ID> <SUPQUALI_QUALIFICATION_RESPONSE_IND>Y</SUPQUALI_QUALIFICATION_RESPONSE_IND> <SUPQUALI_DATE_QUALIFIED></SUPQUALI_DATE_QUALIFIED> <SUPQUALI_EXPLANATION_TEXT>test</SUPQUALI_EXPLANATION_TEXT> <SUPQUALI_QUALIFICATION_EXPIRE_DATE></SUPQUALI_QUALIFICATION_EXPIRE_DATE> </SUPQUALI> <SUPMG> <SUPMG_PROC_TYPE>I</SUPMG_PROC_TYPE> <SUPMG_MGTY_CODE>11000</SUPMG_MGTY_CODE> <SUPMG_MG_CODE>1111001</SUPMG_MG_CODE> <SUPMG_MG_REVISION_ID>0</SUPMG_MG_REVISION_ID> <SUPMG_QUALIFIED_IND>Y</SUPMG_QUALIFIED_IND> <SUPMG_QUALIFIED_DATE></SUPMG_QUALIFIED_DATE> <SUPMG_APP_DEPARTMENT>test</SUPMG_APP_DEPARTMENT> <SUPMG_QUALIFICATION_CLASS></SUPMG_QUALIFICATION_CLASS> </SUPMG> <SUPMANU> <SUPMANU_PROC_TYPE>I</SUPMANU_PROC_TYPE> <SUPMANU_CT_CODE>SUPPLIER</SUPMANU_CT_CODE>


Importing Data using XML Files <SUPMANU_COMPANY_CODE>ABFXL</SUPMANU_COMPANY_CODE> </SUPMANU> <SUPATTR> <SUPATTR_PROC_TYPE>I</SUPATTR_PROC_TYPE> <SUPATTR_ATTR_CODE>TEST</SUPATTR_ATTR_CODE> <SUPATTR_ATTR_VALUE>Test</SUPATTR_ATTR_VALUE> </SUPATTR> </SUPPLIER> </SUP> </CS> </COMPANY>


S E C T I O N 4

You must use a CIP XML file to load data using a CIP procedure.

The following sections show an example of load data to use in creating your own CIP procedures. You can write your own CIP procedures in the M_PCK_OSCI_CUSTOM customer package.

Imported Data by CIP XML using .xml files This section outlines the general file format that OSCI requires for xml files, by using the CIP xml_example.

This job type works with the same logic as type OSCI. You can write your own CIP procedures to load an XML file (.xml) into M_OSCI_IMPORT_DATA. This CIP will handle the import of your file into the SmartPlant Materials table M_OSCI_IMPORT_DATA.

You can import XML files. In your CIP, you must make sure that the data arrives in the predefined format in table M_OSCI_IMPORT_DATA. The tags of your XML file must, if the CIP is storing the data in M_OSCI_IMPORT_DATA, use the same tag names and the order of the DTD (osci_dtd.dtd). You can find a file called osci_dtd.dtd on the SmartPlant Materials disk that contains the document type definition (dtd) for a standard OSCI XML file.

These tags are written as keywords into the M_OSCI_IMPORT_DATA table, which is mandatory for the further process of data import.

The example CIP uses the same logic as described in the Data Import (on page 43) section. Please look there for a detailed description.

Imported Data using CIP Logic


Imported Data using CIP Logic


S E C T I O N 5

All OSCI interface operations can be initiated and controlled on the OSCI 10.01 OSCI - Import Jobs screen. Here you can set up job definitions, start OSCI jobs, and check the outcome of job execution by reviewing the log files, analyze files, and error files.

Defining an Import Job Define an OSCI import job by entering a new record on the OSCI 10.01 screen.

Select the job type from the dropdown list in the Type field; this value defines how you want to use OSCI:

OSCI - You can use OSCI to insert or update companies, suppliers, and adjacent objects. This type of job is based on .XML files.

CIP XML - Uses the same logic as the OSCI type, but you define your own CIP procedures to load an .XML file into M_OSCI_IMPORT_DATA. See Imported Data using CIP Logic (on page 41).

Click the Upload button to transfer files from your file system to the web server.

For the 'OSCI'’ and ‘CIP XML’ job types, enter the filename with the file extension .xml.

Data Import


Data Import

OSCI Job Options Select the Insert Data check box to enable the job to insert data.

Select the Update Data check box to enable the job to update data.

If you want the job to analyze a XML file, you must select the Analyze check box.

If you want to use unknown tags of the supplier section as attached supplier attributes, you must enter a group for the attributes in the Group field. If no attribute exists with the name of the unknown tag, a new attribute is created for the entered group.

If you select the Save Imported Data check box, the imported data will be stored in SmartPlant Materials after import execution.

File Upload For an OSCI import job, the import file must be placed on the database server in a directory with write access. Click the Upload button to select a file from your file system and to upload it to the application server. This file will be transferred automatically to the database server.

When you click the Upload button, a browser window opens on which you can select a file from the file system to be uploaded to the application server.


Data Import Click the Browse button to open a new window, displayed below.

Select the file, and click the Open button. Next, click the Submit Query button in the browser window. When the Upload Feedback window appears, close the browser window.

The directory and file name are automatically entered in the Import Path and Import File fields. The file name is created by the string 'OSCIJID' concatenated with the ID of the actual OSCI job.

You can enter any comments in the User Comment field. Now save the new import job on the OSCI.10.01 screen.

Starting the OSCI Job When you have supplied all job parameters, you can click the Start button to start the OSCI job.

A message appears as displayed below.

Click OK to run the job.

The import of the data is done in two steps (no analyze mode).


Data Import In the first step, the data of the XML file is stored in a table, and in the second step, SmartPlant Materials processes the data. The error (.err) and log (.log) files that are created contain statistics and error messages for both steps.

Analyze Mode If you have selected the Analyze check box for your OSCI job, the data of the XML file is stored in a table. The log file (.ana) that is created for the job contains statistics and error messages for this step. You get detailed information about the analyzed XML file, that is, which data was changed by the system or which data cannot be loaded by the OSCI job. The XML file will not be parsed against the osci_dtd.dtd.

If you have entered a group for attached supplier attributes, unknown tags are imported from the supplier section as attached supplier attributes. The value of project default ZI_DF_UNIT is used as the unit for new created attributes.

Unknown tags for other sections will be ignored and not imported.

With the detailed information of the analyze log file, you can modify the imported data and then start the insert or update job for the imported data.

Click the View Import Data button to open a new window.

Here you can change the values in the Col Value fields. If you want to attach the unknown tags as supplier attributes, you must check the Create Attached Attributes check box for the Attached Supplier Attributes record type. Finally, click the Start Online button to import the data.


Data Import SmartPlant Materials processes the data. The error (.err) and log (.log) files that are created contain statistics and error messages.

Reviewing the Import Protocol When an online import job has finished, click the View Online Log or View Error Log buttons to review the log files created by the process:

The OSCI online and analyze log file will include execution statistics, as well as a short summary of any data-related problems or data errors from the main import program.


Data Import All entries of the analyze (.ana), log (.log), and error (.err) files are stored in a table. You can view the detailed information if you click the View Table Log’s button.


A P P E N D I X A

In This Appendix SmartPlant Materials Messages .................................................... 49 ORACLE Messages ....................................................................... 50

SmartPlant Materials Messages Errors are saved in the error log file. Click the View Error Log button on the OSCI 10.01 screen to view the error log file.

yyy in the following table will be replaced by the name of the column that violates any restriction.

Error number Meaning

101 - yyy Null value not allowed

102 - yyy Value too large

103 - yyy Value too small

104 - yyy Value not numeric

105 - yyy Invalid date

106 - yyy Invalid value

107 - yyy Date in future not allowed

108 Unique key violation

109 - yyy Unknown column name

201 Object (company type, company, supplier, ...) does not exist

202 Nls does not exist

203 Object (company type, company, supplier, ...) does not exist or is not uniquely identifiable

Appendix: Messages


Appendix: Messages

Error number Meaning

501 Privilege Define PO Supplier is not available; value will be set to None

502 Privilege Define Inq Supplier is not available; value will be set to None

503 Privilege Allow Supplier Approval is not available; value will be set to N

504 Privilege Allow Supplier Approval is not available; value will be set to NULL

702 Invalid user security

yyy Column not supported

ORACLE Messages The following ORACLE® messages can occur:

ORA-01400: cannot insert NULL into ("M_SYS"."table_name"."column_name")

ORA-00001: unique constraint (M_SYS.table_short_name_UK) violated

ORA-00001: unique constraint (M_SYS.table_short_name_PK) violated


A P P E N D I X B

The following date formats are supported in XML files.

DD-MON-RR

DD-MON-YYYY

DD-MON

MM/DD

MM/RR

MM/YYYY

MM/DD/RR

MM/DD/YYYY

MMDDYYYY

YYYYMMDD

RRMMDD

MMDDRR

YYYY-MM-DD

Appendix: Supported XML Date Formats


Appendix: Supported XML Date Formats


A Analyze Mode • 46 Appendix

Messages • 49 Supported XML Date Formats • 51

D Data Import • 43 Database Configuration • 11 DBA Settings • 12 Defining an Import Job • 43 Document Type Definition (DTD) • 31

F File Format Example • 36 File Upload • 44

G General File Format • 13

I Imported Data by CIP XML using .xml files •

41 Imported Data using CIP Logic • 41 Importing Data using XML Files • 13 Introduction • 9

O ORACLE Messages • 50 Oracle Prerequisites and Data Setup • 11 ORACLE Web Agent and ORACLE

PLSXML • 11 ORACLE XML Parser • 11 OSCI Job Options • 44

P Preface • 7 Processing Logic • 30 Project Defaults • 12

R Reviewing the Import Protocol • 47

S SmartPlant Materials Messages • 49 Starting the OSCI Job • 45

T Tags for Assign Company Types • 18 Tags for Communication Links (Address) •

20 Tags for Communication Links (Contacts) •

18 Tags for Companies • 15 Tags for Company Addresses • 19 Tags for Company Contact People • 16 Tags for Company Data • 13 Tags for Company Descriptions • 16 Tags for Company Type Descriptions • 14 Tags for Company Types • 14 Tags for Qualification Descriptions • 21 Tags for Qualifications • 21 Tags for Supplier • 22 Tags for Supplier Attributes • 29 Tags for Supplier Data • 21 Tags for Supplier Manufacturers • 29 Tags for Supplier Material Groups • 26 Tags for Supplier Qualifications • 25

Index


Documents

SmartPlant Materials Open Supplier/Company Interface (OSCI)spmat.hec.co.kr/marian_webentry/Pdfs/INT-OSCI.pdf · 2014. 11. 6. · The Open Supplier/Company Interface (OSCI) is the