spmat.hec.co.krspmat.hec.co.kr/marian_webentry/PDFs/INT-SP3D.pdf · Use of this software product is...

SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data

Version 2008.2 (6.3.3) January 2009 DMAR1-PE-200125A

Copyright Copyright © 2009 Intergraph Corporation. All Rights Reserved.

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 P.O. Box 240000 Huntsville, AL 35813 Street address: 170 Graphics Drive, Madison, AL 35758

Terms of Use Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("EULA") delivered with this 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. 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.

Warranties and Liabilities All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. 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 discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies. 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.

Trademarks Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler 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 Reference Data SmartPlant 3D: Importing Catalog & Spec Data i

Contents Preface ........................................................................................................................................................ iii

Import Workflow ........................................................................................................................................ 1

Overview ................................................................................................................................................ 1 Workflow ......................................................................................................................................... 2

Import Interface (SP3D 40.21) ................................................................................................................ 13

SP3D 40.01 .......................................................................................................................................... 13 SP3D 40.21 .......................................................................................................................................... 14 Getting Started ..................................................................................................................................... 20

DBA Settings ................................................................................................................................. 20 Project Defaults ............................................................................................................................. 20 Import Config Items ...................................................................................................................... 20

Troubleshooting ........................................................................................................................................ 22

Import Job Settings .............................................................................................................................. 22 Errors and Stages.................................................................................................................................. 22 Errors in Progress Display ................................................................................................................... 23 Errors in Logfiles ................................................................................................................................. 23

The Logfile Name .......................................................................................................................... 23 Finding the Error in the Logfile ..................................................................................................... 23

Typical Error Situations ....................................................................................................................... 24

Appendix .................................................................................................................................................... 30

Appendix A: SP3D_ANSI Product Groups ......................................................................................... 30 Appendix B: Import Config Items ....................................................................................................... 33

Contents

ii SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data

Preface

This document explains the SmartPlant 3D (SP3D) to SmartPlant Reference Data (SPRD) import workflow (referred to as the SP3D Import tool). In subsequent sections of the document, the Import Interface screens, various import configuration items, and the actual loading of SP3D Excel sheets are detailed.

Also, a section on troubleshooting is included to assist users in resolving and preventing errors beforehand..

Documentation Comments We welcome comments or suggestions about this documentation. You can send us an email at: [email protected].

SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data iii

Preface

iv SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data

Import Workflow

Overview The SPRD-SmartPlant 3D integration is currently a file transfer based point-to-point interface that permits the engineer to import SmartPlant 3D Piping Reference Data into an empty product group of SPRD and generate all SmartPlant 3D Piping Reference Data from an existing SPRD library.

The interface has two components -

1. Import Utility 2. Export Utility The Import Utility reads SP3D workbooks sheet by sheet and imports workbook structure information into SPRD and then imports data from the workbook into SPRD. The Export Utility re-produces the workbook, taking data from SPRD. The figure below describes the interface –

The import tool of the SP3D interface in SmartPlant Materials imports SP3D Excel sheets into an empty product group of SPRD. The interface helps users to create catalog and specification data in SPRD, reading from SP3D Excel workbooks, and configures the SP3D interface for exporting the data back to the same Excel workbook format for SP3D.

Engineering companies and operators typically invest a considerable amount of resources for the creation of intelligent and high quality piping standards. The advantage of the SPRD-SmartPlant 3D integration is that it permits the engineers to re-use and maintain this knowledge asset while leveraging it for their SmartPlant 3D projects.

SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data 1

Import Workflow

2 SmartPlant Reference Data SmartPlant 3D: Importing Catalog & Spec Data

Workflow The entire workflow is divided into two main steps as shown in the figure below. In the first step, all the basic tables that are needed to create basic catalog items are imported and the catalog items are inserted if they do not yet exist in SPRD.

In the second step, the SP3D worksheets are read. The major part of the SPRD catalog and spec data import operation takes place. The import of catalog and specs is done in a specific order:

1. The Part Definition sheets are handled first. 2. Then, spec item filter and other spec related data are handled. Each of the steps includes creation of the related items in SPRD wherever required.

Preparation

In this step, users prepare the sheets in the SPRD Commodity Code Rule.xls workbook. This workbook is very similar to the Industry Commodity Code Rule.xls workbook that is delivered with SP3D and is used by the PDS translator tool. Some sheets and attributes are added and/or renamed. This workbook is prepared and maintained by consulting various SP3D workbooks. Once this workbook is completely prepared, it is imported into SPRD using the SP3D Import interface (Refer to the section Import Interface (SP3D 40.21) for details on how to import).The sheets should be treated the following way.

Import Workflow


The subsequent sections of this document will describe how to prepare data in SPRD Commodity Code Rule.xls taking the following SP3D standard workbooks as an example:

a. AllCodeLists.xls

b. Industry Commodity Code Rule.xls

c. Ten_Specs_CatalogData.xls

d. Ten_Specs_SpecificationData.xls

Sheet 1: SPRD Commodity Tables This sheet contains the SPRD commodity names, descriptions, and the mapping string, which can be used later to look up values. Additionally, users can specify up to three fields to reference the codelist numbers related to the data that is stored in the commodity tables (three for three ports that may have different values). Following are the columns in this sheet –

Commodity Table Name – This field represents a table name in SPRD. In order to get this name, the user should first refer to the Formats sheet of the Industry Commodity Code Rule.xls workbook. The user shall first identify the unique set of SP3D tables that are present across the rules. The user can then decide on a distinct SPRD table name for each SP3D table. The data can be reviewed on screen A.50.02 Tables in SPRD after import.

Commodity Table Short Description – This field represents the short description for the Commodity Table Name that is discussed above. The data can be reviewed on screen A.50.02 Tables in SPRD after import.

Commodity Table Description – This field represents the long description for the Commodity Table Name that is discussed above. The data can be reviewed on screen A.50.02 Tables in SPRD after import.

Commodity Table Mapping – This field represents the unique mapping name for the Commodity Table Name. For each of the identified Commodity Table Names, the user shall associate a unique translation name. This data can be reviewed on screen A.50.I.01 Interface Tables after import against the interface SP3D.

Codelist Ref Field – Each of the identified Commodity Table Names can have a maximum of zero or more ports associated to it. The user shall identify them from their corresponding codelist number. In order to identify them, the user shall review data on the corresponding sheet of the Industry Commodity Code Rule.xls workbook. If the Commodity Table Name has at least one port associated to it, then the user shall ideally enter NUM1 for this field. This indicates that in SPRD the codelist value for the first port is stored on the first attribute of the corresponding table and has a numeric value. The data can be reviewed on screen A.50.03 Tables/Attributes in SPRD after import.

Codelist Ref Field2 – As discussed above for Codelist Ref Field, if the Commodity Table Name has at least two ports associated to it, then the user shall ideally enter NUM2 for this field. This indicates that in SPRD the codelist value for the second port is stored on the second attribute of the corresponding table and has a numeric value. The value for the Codelist Ref Field field shall ideally be NUM1 in this case. The data can be reviewed on screen A.50.03 Tables/Attributes in SPRD after import.

Import Workflow


Codelist Ref Field3 – As discussed above for Codelist Ref Field, if the Commodity Table Name has at least three ports associated to it, then the user shall ideally enter NUM3 for this field. This indicates that in SPRD the codelist value for the third port is stored on the third attribute of the corresponding table and has a numeric value. The values for Codelist Ref Field and Codelist Ref Field2field shall ideally be NUM1 and NUM2 respectively in this case. The data can be reviewed on screen A.50.03 Tables/Attributes in SPRD after import.

Sheet 2: SPRD Commodity Table Groups This sheet contains the SPRD commodity table groups for the commodity tables entered on “Sheet 1: SPRD Commodity Tables”, each with its name, description, and the mapping string, which can be used later to look up values. Any table that contains table details must have at least one entry here with a table group declaration.

For examples on how the grouping might be organized, refer to Appendix A: SP3D_ANSI Product Groups, which shows product groups from the best practice database (Commodity Table Groups).

Users can review the data on screen S.20.01 Tablenames with Groups after importing data from this sheet.

The following are the columns on this sheet –

Commodity Table Name – This field represents a table name in SPRD. This is the same SPRD table that was discussed earlier for the SPRD Commodity Tables sheet.

Commodity Table Group Name – This field represents a table group name in SPRD. Codelist values for a table can be organized under one or more table groups. In order to decide on the table groups for each table, users can refer to the sheets corresponding to the tables in the Industry Commodity Code Rule.xls and/or AllCodeLists.xls workbooks. In AllCodeLists.xls, you may find that data is logically grouped. You can follow the same pattern, or you can opt for a different grouping of code lists.

Commodity Table Group Short Description – This field represents the short description for the identified table group name.

Commodity Table Group Description – This field represents the long description for the identified table group name.

IndustryStd Name – This field represents the industry standard corresponding to the identified table group name.

Sheet 3: SPRD Commodity Rules This sheet contains the SPRD commodity rules, each with its name and details. The Part Class Attribute contains the column name in the part class sheet (without the trailing connect point information like “[1]”). The Alternate Part Class Attribute is used if the same commodity attribute can refer to more than one column in the part class.

The following are the columns in this sheet –

Commodity Rule Name – This field specifies the Commodity Rule Name according to which the Commodity Codes are built. In order to determine the Commodity Rule Name, users can refer to the Formats sheet in the Industry Commodity Code Rule.xls workbook.

Import Workflow


Commodity Rule Digits – This field specifies the digits of the Commodity Code that are filled by the corresponding characters from the associated Commodity Rule Table. The specified table applies to the mentioned Commodity Rule. The Commodity Rule is not repeated for each record of Commodity Code Digits. In order to determine the Commodity Rule Name, users can refer to the Formats sheet in the Industry Commodity Code Rule.xls workbook.

Commodity Rule Table – This field specifies the table that constitutes specific characters of the Commodity Code. In order to determine the Commodity Rule Name, users can refer to the Formats sheet in the Industry Commodity Code Rule.xls workbook.

Part Class Attribute – This field specifies the name of the Part Class Attribute. The values of this attribute on the part class sheet correspond to the specified table in the commodity rule. Users can refer the corresponding part class sheets to get the part class attributes in Ten_Specs_CatalogData.xls. Users shall exclude the characters from ‘[‘to‘]’ when mentioning the attribute.

Alternate Part Class Attribute - This field specifies the Alternate Part Class Attribute. Users shall refer the corresponding part class sheets to get the part class attributes in the corresponding catalog workbook.

Sheet 4: SPRD Object Parameters This sheet contains the SPRD object parameters and details. For the object parameter there is some manual preparation required by the user. The object parameter gets a unit set to express the unit of measure for the item, and the object parameter details, which describe dimensions, have units as well. It is assumed that data is available on the following screens of SPRD and those data only shall be referred to on this sheet. A.10.06 Unit Systems A.10.07 Unit Sets A.10.12 .Unit of Measure

Users can review the data on screens S.10.04 Object Parameter and S.10.05 Object Parameter Detail after importing data from this sheet.

Prior to filling in data on these sheets, users shall analyze all the part class sheets from the catalog workbook. Users shall derive the objects with a distinctive number of inputs and outputs for the same. The objects can correspond to one or more parts and can be applied to one or more part class sheets. The following are the columns in this sheet –

ObjParm Name - This field specifies the name of the Object Parameter. Users determine an Object Parameter depending on the number of inputs and output object parameter details. The object parameter name must not be repeated for each object parameter detail.

ObjParm Short Description - This field specifies the short description of the Object Parameter.

ObjParm Unit Set – This field describes the Unit Set that applies to the corresponding Object Parameter.

ObjParmDet Name – This field specifies the name of the Object Parameter Detail. In order to get the value of this field, users shall refer to the input and output attributes of those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated. Users shall identify a unique name for each input and output. For example, let’s refer to the

Import Workflow


BallValve part class sheet in the Ten_Specs_CatalogData.xls workbook. You find two input part class attributes: Npd[1] and Npd[2] on this sheet. You also find an output attribute FacetoFace on this sheet. We can name the input object parameter details NPD1 and NPD2, respectively and the output object parameter details as FACE2FACE. Users can follow their own nomenclature methodologies.

ObjParmDet In Or Out – This field specifies whether the identified Object Parameter Detail is an input or output parameter. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

ObjParmDet Used For Ident - This field specifies whether the identified Object Parameter Detail is used for building the Ident. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

ObjParmDet Optional - This field specifies whether the identified Object Parameter Detail is optional, that is, whether the value must be present or not. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

ObjParmDet Short Description - This field specifies the short description of the identified Object Parameter Detail. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter in intended to be associated.

ObjParmDet Kind of Detail - This field specifies the kind of object parameter detail. It can be one of the following types:-

a. 1. Nominal Size

b. 2. Nominal Size

c. 1. Schedule

d. 2. Schedule

e. Nominal Pressure

f. Size Range From

g. Size Range To

h. Bolt Diameter

i. Bolt Length

j. Other

Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

Attr Group – A specific attribute is always associated with the object parameter detail. This field specifies the attribute group of the attribute that will be associated with the object parameter detail. The attribute group gets created on screen A.50.01 Attributes in SPRD.

Attr Name –This field specifies the attribute that will be associated with the object parameter detail. The attribute gets created on screen A.50.01 Attributes in SPRD.

Import Workflow


Attr Unit – This field specifies the unit of the object parameter detail. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

Attr DataType – This field specifies the data type of the object parameter detail. Users need to identify these through those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated. It could be one of the following:-

a. CHAR

b. DATE

c. NUMBER

Attr Data Size – This field specifies the maximum data size of the object parameter detail. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated. Users can specify the precision and scale for those values that have data type NUMBER.

Part Class Attribute - This field specifies the part class attribute (sheet attribute where to look for data for this Object Parameter Detail) corresponding to the identified object parameter detail. Users need to identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

Alternate Part Class Attribute - This field specifies alternate part class attribute (sheet attribute where to look for data for this Object Parameter Detail) corresponding to the identified object parameter detail. Users can identify these by analyzing those part classes (of the catalog workbook) with which the corresponding Object Parameter is intended to be associated.

Sheet 5: SPRD Short Codes This sheet is used to maintain SPRD short codes for SP3D short codes. SPRD allows short codes only in uppercase and limited in length to 10 chars. This sheet is not required when –

1. If the short codes in SPRD are completely identical to SP3D, and it is sufficient to set the short description and description of the short code to the same value as the short code itself.

2. Short code data is already available in SPRD. The sheet is needed if SPRD short codes should be directly mapped to multiple SP3D short codes. Enter all possible combinations, regardless of whether they appear in each spec or not. Once the import tool inserts spec items, it can identify the relation between the SPRD short code and the one found on the PipingCommodityFilter sheet by means of these combinations. The combinations will be overridden by those on the SPRD Commodity Parts sheet of SPRD Commodity Code Rule.xls.

The following are the columns in this sheet:–

SPRD Short Code - This field specifies the short code that is used within SPRD. To realize this, users shall refer to the ShortCodeHierarchyRule sheet in the Ten_Specs_SpecificationData.xls workbook. Users shall identify (as per details and constraints mentioned above) a distinct value for each of the mentioned short codes on this sheet. The identified values will act as the SPRD Short Codes.

Import Workflow


Short Code Short Description – This field specifies the short description of the short code that is used within SPRD. Users shall determine the short description corresponding to the identified SPRD short codes.

SP3D Short Code – This field specifies the short code that is referred to on the ShortCodeHierarchyRule sheet in the Ten_Specs_SpecificationData.xls workbook.

Selection Basis - This field specifies the Selection Basis that is applicable for the identified short code.

Sheet 6: SPRD Commodity Groups This sheet contains the SPRD commodity group names, descriptions, and industry standards. The Commodity Rule Name column must contain a valid rule name from the SPRD Commodity Rules sheet. The data for Commodity Groups can be reviewed on screen S.10.02 Commodity Group.


Commodity Group Name – This field specifies the Commodity Group name. In order to determine the Commodity Group name, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook. Users can identify and group the piping commodity types. Each group can be treated as a commodity group. A commodity group cannot be more than 10 characters long.

Commodity Group ShortDescription – This field specifies the Commodity Group’s short description. In order to determine the Commodity Group Name, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook.

Commodity Group Description – This field specifies the Commodity Group’s long description. In order to determine the Commodity Group Name, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook.

IndustryStd Name – This field specifies the industry standard that is applicable for the identified Commodity Group.

Commodity Rule Name – This field specifies the Commodity Rule that is applicable to the identified Commodity Group. In order to determine this, users need to analyze the part class sheets corresponding to the identified commodity group. Note that the commodity rule names are already identified on the SPRD Commodity Rules sheet in SPRD Commodity Code Rule.xls.

Sheet 7: SPRD Commodity Parts This sheet contains the SPRD commodity parts, the groups they belong to, descriptions, and industry standards. The “Commodity Rule Name” must contain a valid rule name from the SPRD Commodity Rules sheet. Each part contains one or more object parameters from the SPRD Object Parameters sheet. To assign more than one object parameter to the same part, the user can simply insert a new row directly under the current one. Optionally, each part can be assigned to one or more SP3D short codes. Once the import tool inserts spec items, it can identify the relation between the actual commodity part and the short code found on the PipingCommodityFilter sheet by means of these combinations. The combinations override by those on the SPRD Short Codes sheet.


Import Workflow


Commodity Group Name – This field specifies the Commodity Group name. In order to determine the Commodity Group Name, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook. Note that the commodity group names are already identified on the SPRD Commodity Groups sheet in SPRD Commodity Code Rule.xls.

Commodity Part Name – This field specifies the Commodity Part name. In order to determine the Commodity Part name, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook. Each record of this sheet can be treated as a separate commodity part.

Commodity Part Short Description - This field specifies the Commodity Part’s short description. In order to determine this, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook.

Commodity Part Description - This field specifies the Commodity Part’s long description. In order to determine this, users can refer to the Piping Commodity Type sheet in the Industry Commodity Code Rule.xls workbook.

IndustryStd Name – This field specifies the industry standard that is applicable for the identified Commodity Part.

Commodity Rule Name - This field specifies the Commodity Rule that is applicable for the identified Commodity Part. In order to determine this, users can refer to the part class sheets in Ten_Specs_CatalogData.xls. Note that the commodity rule names are already identified on the SPRD Commodity Rules sheet in SPRD Commodity Code Rule.xls.

ObjParm Name - This field specifies the Object Parameter that is applicable for the identified Commodity Part. In order to determine this, users can refer to the part class sheets in Ten_Specs_CatalogData.xls. Note that the object parameter names are already identified on the SPRD Object Parameters sheet in SPRD Commodity Code Rule.xls.

SPRD Short Code - This field specifies the SPRD Short Code that is applicable for the identified Commodity Part. Note that the short code names are already identified on the SPRD Short Codes sheet in SPRD Commodity Code Rule.xls.

SP3D Short Code - This field specifies the SP3D Short Code that is applicable for the identified Commodity Part. In order to determine this, users can refer to the part class sheets in Ten_Specs_CatalogData.xls.

Selection Basis - This field specifies the Selection Basis that is applicable for the identified Commodity Part.

Sheet 8: SPRD Spec Hierarchy Each spec to be imported must be assigned to one spec type. Each spec type has a spec rule in SPRD. Users should enter the assignment as desired. The assignment is only important for specs that will be imported in the current run.


Spec Type Name - This field corresponds to the Spec Type of SPRD (screen S.50.02 Specification Types). Users can refer to the PipingMaterialsClassData sheet in the Ten_Specs_SpecificationData.xls workbook to identify the Specs and associate them to the corresponding Spec Type.

Import Workflow


Spec Rule Name - This field corresponds to the Spec Rule (screen S.50.01 Specification Rules) of SPRD. Users can refer to the PipingMaterialsClassData sheet in the Ten_Specs_SpecificationData.xls workbook to identify the Specs and associate them to the corresponding Spec Rule.

Spec Header Name - This field specifies the Spec Name. Users can refer to the PipingMaterialsClassData sheet in the Ten_Specs_SpecificationData.xls workbook to identify the Specs.

Spec Header Short Description - This field specifies the short description of the Spec Name.

Spec Header Description - This field specifies the long description of the Spec Name.

Sheet #: SPRD Commodity Table Details There is no sheet with this name. These sheets will be created by the user. The commodity table details will be included in the workbook with sheets having the name of the table and table group. For example, the geometric industry standard has one group US for the standards and one group UM for the manufacturers. If the user likes to group his data this way, one sheet might be called GEOM_STD_OR_MNFCT#US and the other one GEOM_STD_OR_MNFCT#UM. The group name is simply appended to the table name, separated by a hash symbol. While preparing this sheet, please make sure that the title row has the keyword “HEAD” in the first column, while the data below must be enclosed in “START” and “END” tags. The order of the different commodity details sheets is not important.


Codelist Number Ref – This field specifies the code list number reference. To identify this data, users can refer to the corresponding sheets in the Industry Commodity Code Rule.xls and/or AllCodeLists.xls workbooks.

Commodity Code Chars – This field specifies the commodity code characters. To identify this data, users can refer to the corresponding sheets in the Industry Commodity Code Rule.xls and/or AllCodeLists.xls workbooks.

Commodity Code Short Description – This field specifies the short description of the code listed value. To identify this data, users can refer to the corresponding sheets in the Industry Commodity Code Rule.xls and/or AllCodeLists.xls workbooks.

Commodity Code Description – This field specifies the short description of the code listed value. To identify this data, users can refer to the corresponding sheets in the Commodity Code Rule.xls and/or AllCodeLists.XLS workbooks.

Users can refer to Industry Commodity Code Rule.xls for Table Details sheet preparation.

The sheets need the following standardizing changes.

Consider “Bolt Diameter” as an example:

1. Column titles like “Bolt Diameter Codelist Number” must be renamed to “Codelist Number Ref”.

2. Column titles like “Bolt Diameter Chars” must be renamed to “Commodity Code Chars”. 3. Column titles like “Bolt Diameter Value” must be renamed to “Commodity Code Short

Description”.

Import Workflow


4. Add the Commodity Code Description column, copying the contents of the short description. 5. The title row needs the keyword “HEAD” in its first column, while the data below must be

enclosed in “START” and “END” tags. The same process must be followed for all the Table Detail sheets.

Import Configuration Sheet

At this stage, the user imports the SPRD Commodity Code Rule.xls workbook prepared in the previous step. The workbook should be imported completing the first and second import stages. Afterward, the user must make sure that the “Suppress Repetition” option is set correctly, depending on if the user wants empty cells to be filled with the value from the row above.

While the user can change any data on the configuration sheets, he/she should not change the name (except for the name of the commodity detail sheets) and structure (mainly the header row). It is allowed to insert comment rows marked with an exclamation mark in the first column of the sheet.

If the import of the workbook is successfully done up to the stage “COMPLETE_JOB”, this will create all SPRD basic data required to import SP3D catalog and spec data. At this stage, the following SPRD data is created –

1. Commodity Tables 2. Commodity Table Groups 3. Commodity Table Details 4. Commodity Rules 5. Object Parameters 6. Short Codes 7. Commodity Group 8. Commodity Parts 9. Spec. Hierarchy For details on how a job to import the Excel workbook is created and run, refer to the Import Interface (SP3D 40.21) section of this document.

Import Codelist Data

At this stage, the user can import the codelist data from SP3D Excel workbooks. On SP3D 40.21, the user will have to run another import job specifying the workbook with the codelist data. The system expects the codelist data in a pre-specified format. The codelist data in the workbook must be in the same format you find in AllCodeLists.xls, which is a standard Excel file supplied by Intergraph with the SP3D software. The user can change the data in the workbook, but the format of the workbook such as the sheet name, header of the sheet, start and end tags, and so forth must not be altered.

Here are the steps to import a codelist workbook –

1. Define a job on SP3D 40.21 using same configuration and item mapping used in the previous step.

2. Upload the workbook with the codelist data. 3. Run the job to import the workbook.

Import Workflow


Import Catalog Data

At this stage, the user can import the catalog data from SP3D Excel workbooks. On SP3D 40.21, the user must run another import job specifying the workbook with the catalog data. The system expects the catalog data in a pre-specified format. The catalog data in the workbook must be in the same format as you find in Ten_Specs_CatalogData.xls, which is a standard Excel file supplied by Intergraph with the SP3D software. The user can change the data in the workbook, but the format of the workbook such as sheet name, header of the sheet; start and end tags, and so forth must not be altered.

Please note that before starting the import process, the user must move the PipingCommodityMatlControlData sheet from Ten_Specs_SpecificationData.xls to Ten_Specs_CatalogData.xls.

Here are the steps to import the catalog data workbook –

1. Define a job on SP3D 40.21 using the same configuration and item mapping used in the previous step.

2. Upload the workbook with the catalog data. 3. Run the job import the workbook.

Import Spec Data

At this stage, the user can import the specs from SP3D Excel workbooks. On SP3D 40.21, the user must run another import job specifying the workbook with the spec data. The system expects the spec data in a pre-specified format. The spec data in the workbook must be in the same format as you find in Ten_Specs_SpecificationData.xls, which is a standard Excel file supplied by Intergraph with the SP3D software. The user can change the spec data in the workbook, but the format of the workbook such as sheet name, header of the sheet, start and end tags, and so forth must not be altered.

Here are the steps to import the spec workbook –

1. Define a job on SP3D 40.21 using the same configuration and item mapping used in the previous step.

2. Upload the workbook with the spec data. 3. Run the job to import the workbook. After successful completion of the import, the user can check the imported specs in SPRD, reviewing the data on S.50.06.

Import Interface (SP3D 40.21)



The screens related to the SP3D Import interface, SP3D 40.01 Import Configs and SP3D 40.21 Import Jobs, are detailed in this section.

SP3D 40.01 On the screen SP3D 40.01 Import Configs you define the import configuration. The import configuration contains different settings that will be used during the import of data from SP3D. It is important that the user understands each of the settings and sets the values as per his/her data prior to import from the screen SP3D 40.21 Import Jobs.

Import Configs SPRD can store different sets of settings. These settings are project independent. Copying a config will copy all details (config items and their values).

Config: This field specifies the name of the import config.

Standard: This field specifies whether this configuration is part of the standard delivered by Intergraph or not. If checked, then it is part of the Standard. Standard configs are those that are delivered by Intergraph. They can be used as-is, or copied and modified. Do not modify standard data because it could be updated with future service packs due to changes in the software.



Comment: This field specifies additional comments for the config.

Config Items The import config items define different aspects of the SP3D interface. Normally, it makes no sense for the user to create new config items. However, if a config item is missing from the config, it can be added on SP3D 40.01 using the LOV, which looks up the standard configs.

Item: This field specifies the name of the import config item.

Comment: This field specifies additional remarks that describe the purpose of the config item.

Item Values Each config item can have one or more valid values that can be activated and deactivated. If a config item value is missing from the config, it can be added on SP3D 40.01 using the LOV, which looks up the standard configs.

Only one value can be active for the same config item at the same time.

Active: This field specifies if the value is active or not. If checked, then this value is active. Only one value can be active at the same time for the same config item.

Value: This filed specifies the valid value for import config items.

Comment: This field specifies additional remarks explaining the effect of setting the config item to the actual value.

Import Config Items – More Information Refer to Appendix B: Import Config Items, which shows all settings on screen SP3D 40.01 Import Configs. Those Item values with a ‘Y’ in the Active column are the valid settings for best practices.

SP3D 40.21 On screen SP3D 40.21, you define an Import Job. The Import job lets the user import SP3D Excel sheets into an empty product group of SPRD. It will create catalog and specification data and configure the SP3D interface for exporting the data back to SP3D.

If the config item IMPORT_CAT_AND_SPEC is set to YES, then the system creates missing data like Commodity Codes, Idents, Specs, and Spec Items. In this case, all the basic data required for creating the catalog items (SPRD Commodity Code Rule.xls) should be loaded before any SP3D Excel sheet is loaded.

If the Commodity Codes, Idents, Specs, and Spec Items data is already available and only SP3D interface needs to be configured, then the config item IMPORT_CAT_AND_SPEC should be set to NO.



Import Jobs This block lets the user start an import job, which reads the SP3D Microsoft Excel workbooks, creates catalog and specification data, and configures the SP3D interface.

Job: This field specifies the name of the import job.

Run Number: Each import job is identified by a code field and a sequence number unique to this code within the project. When a new import job (with a new code entry) is entered, this run number gets the value 1. When the New Run button is clicked, a new run number with the same job name is created. This copies all of the selection parameters from the old job.

New Run: Press this button to create a new job run of the same name and properties as the one currently displayed.

Comment: This field specifies additional remarks on the job/run.

Item Mapping: This field specifies the name of the Item Mapping.

Template: This field represents the name of the Template.

Sheet Config: This field represents the name of the Sheet Config.

Job Goal: The job has five process stages (also see item "stage"). You can define your job goal to reach one or more of these goals.

Config: This field specifies the name of the import config.

Destination: This field specifies the name of the export destination.

When the config item FILL_INVENTORY is set to YES, the import data is populated into the export destination tables so that SPRD can keep track of what was transferred to which SP3D



instance, enabling incremental (delta) transfers. If the config item FILL_INVENTORY is set to YES, then you must specify the destination against the import job.

Summary: This field displays the execution summary of the job.

Start Job: Click this button to start the Job in online mode.

Cancel Job: Cancelling a job will skip a job. The reserved sheets will be unlocked and the job stage will be JOB_COMPLETE, but the status will be CANCELED. The inventory will not be synchronized with the job data.

Job Execution This block contains information regarding Job Execution.

Status: Status of the import job. The status is ERROR when a step in the process did not finish normally. The status is STAGE_FINISHED when the actual stage of the process finished successfully. JOB_FINISHED signals that the complete job came to an end in a good completion state. RUNNING means that the job is actually in progress. This is especially for other processes/users looking at it. A job is SCHEDULED when it is waiting for batch processing. NEW is the initial status of a job. CANCELED is a job that the user did not consider worth being completed normally. The reserved sheets will be unlocked, and the inventory will not be updated.

Stage: The job has five process stages that describe the level of completeness. These stages are related to distinct tasks:

1. Import structures 2. Adjust sheet configs 3. Import sheet data 4. Populate templates 5. Populate mappings (Complete Job) You can define your job goal to reach one or more of these goals (also see item "goal").

Start User: This field specifies the user who has started this import job.

Start Date: This field specifies the start date of this job.

End Date: This field specifies the end date of this job. If the final job status was not reached, this field contains the end date of the actual stage.

Sheets This block displays the sheets from the workbook that will be imported by the actual job.

Sheet: This field specifies the name of the sheet.

The sheet name can contain a trailing underscore for the occasional case in which a codelist sheet has the same name as another sheet.

Category: This field specifies the sheet category.

Help Text: This field specifies additional information about the usage and purpose of this sheet.



Data This block displays the sheet data read from the workbook and transferred to the temporary tables.

Values This block displays the attribute values that appear in the definition section of the sheet.

Seq: The sequence is used to determine the order of the columns on the Excel sheet.

Attribute: This field represents the Attribute Name used as a column title on the Excel sheet.

Value: This field represents the sheet definition attribute value.

Occurrence: This field specifies if this attribute is an occurrence attribute for the actual sheet. It will be checked if on the sheet on the definition line the attribute is prefixed with "OA:".

Occurrence attributes are a means to allow users to update attribute values on the property sheets in SP3D.

Log Files All actions done during the job run are logged in multiple import protocols.

Seq: This field specifies the sequence the log file was generated, in relation to other log files of the actual job run.

Logfile: This field specifies the log file path and name. Double-click this field to display the contents of the log file.

The log file name starts with "SP3D_IJ_" and the job id formatted with leading zeros. The job id is identical for all files of the same job name and same run number.

After that is information about the stage of the log file. IMPORT_STRUCTS is the first stage, ADJUST_CONF the second, IMP_DATA the third, POPULATE_TPL the fourth, and COMPLETE_JOB is the last one.

After this part is a log file id to ensure unique filenames on the server.

Created: This field represents the creation date of Logfile.

Progress This block displays the progress of validation and import. It contains major steps and fatal error messages. The contents of the progress window are not stored in the database.

Stages Below you find exactly what happens in each of the stages once the import process is initiated.

Stage 1: Import structures 1. Reads the workbook sheet by sheet. 2. Ignores sheets like Index and Revision History. 3. Creates sheets and attributes in SPRD (SP3D 10.02 and SP3D10.03).



4. Creates the association between Sheets and Attributes (SP3D 10.07). 5. For Part Class sheets, creates definition attributes and their associations.

Stage 2: Adjust sheet configs 1. Adjusts the sequence of the attributes (for definition as well). 2. Finds a match for the sheet to copy the properties of the attributes. There are different methods

to find a match of the sheet. The following are the methods:

a. OTHER_CONF – Finds the match in some specified sheet config. The config where to look for a match is represented by a parameter.

b. BEST_FIT Algorithm – Applies the following in all configs to find a match:

i. All attributes(exactly)

ii. All attributes (exactly) + some more

iii. All attributes (exactly) – one

c. OTHER_CONF_BEST_FIT- Hybrid of the above two mechanisms.

3. After the first phase of adjustment (Step 1 and 2), the software ensures that the settings will match the data that is about to be imported.

Stage 3: Import sheet data 1. All data in the workbook will be read and transferred to temporary tables. 2. While transferring, SPRD references are evaluated and recorded.

In matching the values in SPRD, various config items are considered:

Ex. MATCH_COMMODITY_CODE can be set to:

a. SPRD - Commodity code in Excel is interpreted as SPRD CC.

b. COMPANY_FIRST - Commodity Code in Excel is interpreted as company-dependent CC and if it is not found in that, then it will look for SPRD CC.

c. COMPANY - Commodity Code in Excel is interpreted as company-dependent CC.

If the config item IMPORT_CAT_AND_SPEC is set to YES, then the system creates missing data like Commodity Codes, Idents, Specs, and Spec Items if the corresponding look up data is not found in SPRD when processing a sheet row.

If the config item IMPORT_CAT_AND_SPEC is set to NO, then there is no creation of missing data. The sheet row is either skipped or the process is aborted based on the config items LKP_CC_FAILS, LKP_ID_FAILS, LKP_SP_FAILS, LKP_SI_FAILS value when no look up is found in SPRD.

3. When data on the SP3D sheet is not repeated in the next row (ex- on PipeStock sheet, Industry CC), the import job decides if duplicate values should repeat from row to row by evaluating the Suppress Repetition indicator specified on SP3D 10.07 against the sheet attribute.

4. The data transferred to the temporary tables are used at later stages to create SPRD data.



Stage 4: Populate templates 1. The template data will be imported into SP3D 10.08 if the sheet retrieval method is template

copy (SP3D 10.07) and the sheet category is one of the following: a. Code List

b. General Rule

c. General List

d. Spec Rule

2. If data is already there, then one of the following can happen depending on the config setting – a. The old contents for the sheet will be removed and the newly imported data will be filled

in.

b. The new rows will be added to the existing ones (Append).

c. The new rows are inserted if they are really new (with respect to the PK defined on the sheet) and the existing is updated. (Merge)

d. For spec rules, one of the above will happen for the specs that are in the Excel workbook. Previously imported specs that are not on the sheet will be left as they are.

Stage 5: Populate mappings (Complete Job) 1. At this stage, imported data is mapped and SP3D 10.04 is populated.

If the config item IMPORT_CAT_AND_SPEC is set to YES, then prior to mapping, it will create catalog and specification data also.

2. The following mapping happens – a. Sheet-dependent Sheet Mappings, that is, mapping parts to the sheets, will be done by

evaluating the relation between the sheet and the Group, Part, Commodity Code, and Ident.

Ex – If all idents of a CC are on different sheets, then mapping will happen at the ident level. If they are on the same sheet, then mapping will happen at the next higher level, that is, at CC level.

b. Attribute Mapping will be done if the sheet method of the actual sheet is SHT_STND_METHOD , the sheet category is one of PART_DEFINITION, PART_FILTER, SPEC_ITEM_FILTER, SPEC_RULE, the attribute retrieval method is ATTR_STND_METHOD, and the retrieval source is Default.

i. Attributes are mapped to ident level, CC level, Part level, Group level, or Spec or Spec Item level. The attribute mapping will be optimized to take place at the highest possible level.

ii. Two types of attribute mapping are done

Sheet-Dependent attribute mappings are performed for attributes like Material Grade (Sheet - Pipe Stock), which are sheet-specific.

Sheet-Independent mappings are performed for attributes like Commodity Type, which are sheet-independent.

c. Later, this mapping data is used to export SPRD data back into the Excel sheet.



Each of the above stages is largely controlled by the import config parameters on SP3D 40.01. Users must make sure that they review the config settings prior to import.

Getting Started Prior to starting the SP3D Import process in SPRD, the interface needs several basic configurations.

In order to allow SPRD to read the Excel workbooks and sheets, the application server needs to have a valid Excel installation.

DBA Settings The table below shows the definition of DBA Settings used for the Import Interface. DBA Settings are defined on screen A.60.04 DBA Settings.

DBA Setting Short Desc Description

SERVLET_PATH Web server path Path in the file system of the web server for servlets

Project Defaults The table below shows the definition of project defaults used for the Import Interface. Project defaults are defined on screen A20.12 Project Defaults.

Project default

Short Desc Description

ZI_SP3D_CO SP3D Company SP3D Company to store catalog data references

ZI_SP3D_DI Dir for SP3D files Name of the base directory for SP3D files. The imported Excel files uploaded by the SP3D interface will reside in this base directory on the application server. In the best practice database, this value is 'C:\MARIAN\download'.

ZX_UNITSYS Unit System Unit System for this project

Import Config Items Prior to import, make sure that you review each of the config settings on the screen SP3D 40.01 Import Configs for the import config selected against the import job on SP3D 40.21 Import Jobs.

Running an Import Job For running an SP3D import job, do the following:



1. Create an empty product group in SPRD. 2. Create a blank sheet config on SP3D 10.07 Sheet Configs. 3. Create a blank template on SP3D 10.08 Templates using the sheet config that is defined in

step 2. 4. Create a blank item mapping on SP3D 10.04 Item Mappings using the template defined in

step 3. 5. Ensure that all the Import configs are properly set on SP3D 40.01 Import Configs. 6. Define an Import Job on SP3D 40.21 Import Jobs using the Item Mapping created in step 4

and the Import Config set in step 5. 7. Load the Excel SPRD Commodity Code Rule.xls workbook using the import job. This will

create basic SPRD data in the system. 8. Now we can import the SP3D Excel files. Define a new job on SP3D 40.21 using the same

settings. Load the SP3D Excel files, and run the job with the job goal to import the SP3D workbook in SP Materials. Loading of the Excel sheets should be in the order shown below.

a. SPRD Commodity Code Rule sheet

b. Codelist sheets

c. Catalog sheets

d. Spec Item filter and Spec-related data sheets

Troubleshooting


Troubleshooting

This section helps users understand why an import job does not produce the desired results.

Import Job Settings Each import job uses an import configuration set, a set of mappings, a set of template sheets, and so forth. Sometimes the user checks a set that is different from what the import job really uses. He changes the configuration, but the behavior of the import run is unchanged. Make sure that you check the settings that the job uses:

Errors and Stages Imagine you start a job covering all five stages. The first stage succeeds, but the second, Adjust sheet config for an XLS workbook, raises an error. In this case, the import structure remains because this stage was already finished. Correct the error in stage 2, and start the same job run again. The process does not import structure again. It starts directly with the second stage.

The following graphic displays another case: It shows job status ERROR, which signals a program halt. The job goal was ADJUST_CONF, but the stage finished is NO_STAGE. Also, in the Summary field, you can see where the error appeared. In this case, if you change the configuration and start the same run again, the structure of sheets is empty; IMP_STRUCTS is automatically started to fill them. So in this latter case, it is the same as if you start a new job run.

Troubleshooting


Errors in Progress Display If a fatal error exists, it is also sent to the progress screen. Scrolling down to the bottom of the display area reveals an error message that provides information about the error.

Errors in Logfiles If the error message in the progress display does not help, you can use the logfile. If fatal errors occur in a stage, they are written into the related logfile, which can be seen on the Logfiles tab of SP3D 40.21.

The Logfile Name The logfile name starts with "SP3D_IJ_", and the job_id is formatted with leading zeros. The job_id is identical for all files of the same job name and same run number. Following the job_id is the stage to which the logfile belongs. IMP_STRUCTS is the first stage, ADJUST_CONF the second, IMP_DATA the third, POPULATE_TPL the fourth, and COMPLETE_JOB is the last one.

Finding the Error in the Logfile It may be that there are multiple logfiles displayed on SP3D 40.21 for the same stage. This happens if the job ends in error, and the stage is restarted after the user thinks he has solved the problem. The logfiles are sequenced and ordered in descending order, so the uppermost logfile is the actual one.

The logfile contents can be accessed by double-clicking the logfile on SP3D 40.21.

However, if the logfiles are big, it might be faster to set up a network share to the logfile directory on the database server, and open the file with a text editor.

Troubleshooting


In certain cases, the logfile is not completely written to disk. If you do not see an error message at the end of the logfile and do not see a success message, the logwriter process of the database might not have unloaded its buffer into the file yet.

A fatal error can always be found at the end of the logfile.

Typical Error Situations Some of the typical errors and the reason for the errors are described below.

1. Error: -------

Error: in procedure fill_data_into_exp_dta

ORA-01400: cannot insert NULL into

("M_SYS"."M_SP3D_EXP_DST_SHTS"."ED_ID")

Error: in procedure fill_data_to_repository

ORA-01400: cannot insert NULL into ("M_SYS"."M_SP3D_EXP_DST_SHTS"."ED_ID")

Error: MAR-40516 SP3D Import process aborted due to fatal error.

Reason:

The Destination field on screen SP3D 40.21 is set to Null. When the import config item “FILL_INVENTORY” value is set to “Yes”, it must be set to the value of the Destination field on SP3D 40.21.

Action:

Either set the value of the Destination field or set the value of the import config item “FILL_INVENTORY” value to “No”.

2. Error: --------

Attribute dependencies specified for <QuantityOfReportableParts> are <CC, P, TD>.

Not a valid value <TD> in attribute dependencies field in SP3D 10.07.

Process aborted.

Error: MAR-40502 Attribute dependencies value in SP3D 10.07 is invalid.

Reason:

Troubleshooting


For Spec Item Filter (sheet 'PIPINGCOMMODITYFILTER') attribute mappings, the valid values for the Dependencies field on SP3D 10.07 can be a combination of one or more of the values 'CC','P','G', 'SH', or 'SI'. Any other value than those specified is invalid.

i.e. 'CC','P','SH' is valid.

'CC', 'X' is invalid.

For Part Class Sheet attribute mappings, the valid values for the Dependencies field on SP3D 10.07 can be a combination of one or more of the values 'ID','CC','P', or 'G'. Any other value than those specified is invalid.

i.e. 'CC', 'ID' is valid.

'CC','P','SH' is invalid.

Action:

Please specify the valid value for the attribute mappings on screen SP3D 10.07 as specified in the reason.

3. Error: ---------

Lowest level specified in attribute dependencies is <CC>.

Highest level specified in attribute dependencies is <P>.

Mapping at the lowest level in dependencies field is not possible.

Process aborted.

Error: MAR-40503 Mapping as per dependencies field is not possible.

Reason:

The system will map the attribute on SP3D 10.04 to the levels specified in the Dependencies field on SP3D 10.07. For example, if there is a value that normally depends on the commodity group but sometimes can deviate for distinct commodity parts, you should set the dependencies to "P,G".

The system then maps the attribute value at the highest level 'G', in this case. If for some group there are distinct values for the attribute, then the system tries to map such attribute values at the next level 'P' provided for the same Commodity part the attribute value does not differ.

However, if for some Commodity Part there are distinct attribute values, then the system will issue an error message as above since it is not even able to map the attribute values at the lowest level specified in the Dependencies field on SP3D 10.07.

Troubleshooting


The user must specify the Dependencies value according to his/her data. Even if all the possible levels are specified, the system tries to map the attribute values from the highest level possible to the lowest level.

Action:

Specify a valid dependency value according to the data on screen SP3D 10.07.

4. Error: No physical attribute that is large enough to hold this value is free.

Process aborted.

Reason:

If the length of the actual sheet data for the attribute under consideration is more than the length of the physical attribute assigned, then the system tries to find a physical attribute with the next higher length. If the next higher length physical attribute is also not free, then it checks for the next higher length and so on. If none of the higher length physical attributes are free to assign, then the following error message is raised.

Action:

Specify the data that is less in length when compared to the length of the physical attribute.

5. Error: User opted for <Cancel>

Process was terminated/aborted upon user’s request.

Reason:

User clicked the Cancel button in the middle of the SP3D Import.

Action:

No action required.

6. Error: No Header row found.

SQLERRM: 100501: non-ORACLE exception

Troubleshooting


Reason:

There is no HEAD tag specified in the Excel sheet that is being imported. The tags HEAD, START, and END must be specified on the Excel sheets for the system to understand the Excel sheet.

Action:

Specify the HEAD tag in the Excel sheet that is to be imported.

7. Error: The default Company <ZI_SP3D_CO> cannot be NULL. Process aborted.

Error: in function create_cc_main

User-Defined Exception

Error when creating Commodity Codes.

Reason:

The project default “ZI_SP3D_CO” is not set.

Action:

Set the project default “ZI_SP3D_CO”, and try again.

8. Error: Error: Default unit system is invalid or undefined

Error: Default unit system is invalid or undefined

Error: while creating Geometric and Geometric Detail in procedure create_geom_and_details.

User-Defined Exception

Reason:

The default unit set is not set for the current project using the project default “ZX_UNITSYS”.

Action:

Troubleshooting


Set the default unit set for the current project by setting the value of the project default “ZX_UNITSYS”.

9. Error: The table is there in the Product Group.

Updating Nls descriptions for table in Product Group from Project is not allowed as per config item IMP_CTLG_PG_MODIFY value.

Error in procedure create_or_upd_tab.

Error Occurred while processing sheet SPRD Commodity Tables. User-Defined Exception

Reason:

When SP3D Import is running in a project, data related to the import is already present in the Product group, and config item IMP_CTLG_PG_MODIFY is set to “STOP”, then this error appears. The Product Group data cannot be modified by the Project if the config item IMP_CTLG_PG_MODIFY is set to “STOP”

Action:

Set the value of the config item IMP_CTLG_PG_MODIFY to “MODIFY” to modify the data of Product Group from the Project.

10. Error: Error in function create_cc_deactivated. Code GGMAHACABXBEPUS as ContractorCommodityCode not found in the sheet 'PipingCommodityMatlControlData'.

Error in function create_cc_main User-Defined Exception

Error when processing Part Definition data and creating missing SPRD data.

Reason:

If the config item 'IMP_CTLG_CC_TO_ANALYZE' is set to 'INDUSTRY', then the IndustryCommodityCode on the part class sheet is compared to the ContractorCommodityCode on the PipingCommodityMatlControlData sheet to fetch the Short and Long descriptions.

If IndustryCommodityCode on the part class sheet is not found as the ContractorCommodityCode on the PipingCommodityMatlControlData sheet, then the above error is raised.

Troubleshooting


11. Error: The attribute GeometricIndustryStandard or GeometricIndustryStandard[1] is not found.

Error in function create_cc_main User-Defined Exception

Error when processing Part Definition data and creating missing SPRD data.

Reason:

The Part Class Attribute/Alternate Part Class Attribute specified in the Commodity Rule is not available as an attribute on the part class sheet.

Appendix


Appendix

Appendix A: SP3D_ANSI Product Groups These product groups are taken from the best practice database (Commodity Table Groups).

Table Name Group Code Short Desc Description

ENDPREPARATION Could be derived uppercase from the TerminationClass Short Description in the EndPreparation codelist

Could be derived from the TerminationClass Short Description in the codelist

Could be derived from the TerminationClass Long Description in the codelist

GEOM_STD_OR_MNFCT Could be derived uppercase from the GeometricIndustryPractice Short Description in the GeometricIndustryStandard codelist

Could be derived from the GeometricIndustryPractice Short Description in the codelist

Could be derived from the GeometricIndustryPractice Long Description in the codelist

MAT_STD_AND_GRADE Could be derived uppercase from the MaterialsGradePractice Short Description in the MaterialsGrade codelist. Only use the country name for this field and truncate the “Practice (…)” portion

Could be derived from the MaterialsGradePractice Short Description in the codelist

Could be derived from the MaterialsGradePractice Long Description in the codelist

PRESS_RAT Could be derived uppercase from the RatingPractice Short Description in the PressureRating codelist. Only use the country name for this field and truncate the “Practice (…)” portion

Could be derived from the RatingPractice Short Description in the codelist

Could be derived from the RatingPractice Long Description in the codelist

VALVE_TRIM Could be derived uppercase from the ValveTrimPractice Short Description in the ValveTrim codelist. Only use the country name for this field and truncate the “Practice (…)” portion

Could be derived from the ValveTrimPractice Short Description in the codelist

Could be derived from the ValveTrimPractice Long Description in the codelist

SURF_PREP_OR_LNG Two Groups:

LINING and SURFACE

Lining Material for one group, Surface Preparation for the other

Lining Material for one group, Surface Preparation for the other

FLG_FCE_SURF_FINISH ALL FlangeFaceSurfaceFinish

FlangeFaceSurfaceFinish

VLV_MNFCT_MOD_NO ALL Manufact+Model Num Valve Manufacturer and Model Number

Appendix


MNFCT_METHOD ALL Manufact Method Manufacturing Method

BOLT_COATING Could be derived uppercase from the CoatingRequirement Short Description in the CoatingType codelist:

UNDEFINED,

NONE,

METALLIC,

NON_METAL,

PAINTING

Could be derived from the CoatingRequirement Short Description in the codelist

Could be derived from the CoatingRequirement Long Description in the codelist

GEOM_PRACTICE ALL Geometric Practice Geometric Industry Practice

REQ_CLASS Could be derived uppercase from the MiscRequisitionComponentType Short Description in the MiscRequisitionClassification codelist:

UNDEFINED,

VALVES,

FLANGES,

FIT_MISC,

FIT_DI_CHG,

FIT_BRA,

FIRE_SAFE,

PIP_NIP,

DIST_PCS,

TUBING,

HOSE,

SPECIALTY,

INSTRUMENTS

Could be derived from the MiscRequisitionComponentType Short Description in the codelist

Could be derived from the MiscRequisitionComponentType Long Description in the codelist

NPL_LGTH_PURCH 4 groups:

NIPPLE_IMP,

NIPPLE_MTR,

PURCH_IMP,

PURCH_MTR,

UNDEFINED

Nipple length for one group, Purchase Length for the other

Nipple length for one group, Purchase Length for the other

GASKET_THCK Two Groups: IMPERIAL, METRIC,

UNDEFINED

Gasket Thickness Imperial/ Metric

Gasket Thickness Imperial/ Metric

Appendix


BOLT_DIAMETER Two Groups: IMPERIAL, METRIC,

UNDEFINED

Bolt Diameter Imperial/ Metric

Bolt Diameter Imperial/ Metric

WASHER_THCK Two Groups: IMPERIAL, METRIC,

UNDEFINED

Washer Thickness Imperial/ Metric

Washer Thickness Imperial/ Metric

BOLT_LENGTH Two Groups: IMPERIAL, METRIC,

UNDEFINED

Bolt Length Imperial/Metric

Bolt Length Imperial/Metric

BOLT_SET_QTY ALL Bolt Set Quantity Bolt Set Quantity

Appendix


Appendix B: Import Config Items Import Config Item

Import Config comment

Active Item Value

Import Config Item Value comment

ADJUST_SC This config item decides copying config settings from existing configs to the newly imported sheet.

Y BEST_FIT Finds out the most similar sheet of same category, which uses the most identical attributes ideally all of them. If the sheet is a part class, the sheet will only be regarded if at least 4 attributes on it have other physical attributes than AC0010%. If there is no sheet with exactly the same set of attributes, finds out the one which has more attributes, but at least all of those, which are in the newly imported sheet. If there is no sheet found, finds out a sheet with one attribute differing. If no such sheet is found, finds out a sheet which has more attributes, but at least all but one of those, which are in the newly imported sheet. If nothing found, it continue to search for a sheet with two attributes differing and so on… This config item value is the default.

N OTHER_CONF

The sheet configuration for the newly imported sheet is searched in the other sheet configs. User may enter the name of the preferred sheet config in the config item ADJUST_SC_CONF. If this is not filled, the program takes the config sheet with the most actual last modification date.

N OTHER_CONF_BEST_FIT

The same as OTHER_CONF, but if the new sheet was not found in another config, the action defined for setting BEST_FIT will be started.

ADJUST_SC_ATTR_SEQ

This config item controls the sequence of the sheet config sheet attributes.

Y KEEP The existing sheet config attributes order will remain. New attributes will be added at the end. This config item value is the default.

N NEW The order of the definition will be taken from the newly imported sheet while attributes which are already in the existing config but not on the newly import sheet will move to the end.

Appendix


ADJUST_SC_CONF

This config item holds the name of the preferred sheet config to be searched for in identifying the sheet to copy config settings for the newly imported sheet. This config item is valid when the option selected is OTHER_CONF for the config item ADJUST_SC.

ADJUST_SC_DFN_ATTR_SEQ

This config item controls the sequence of the sheet config sheet definition attributes.

Y KEEP The existing sheet config definition attributes order will remain. New definition attributes will be added at the end. This config item value is the default.

N NEW The order of the definition attributes will be taken from the newly imported sheet while definition attributes which are already in the existing config but not on the newly import sheet will move to the end.

ADJUST_SC_INCOMP_DTA

This config item controls dealing with incompatible data type of attribute and Excel data. Data is considered incompatible when attribute is of data type NUMBER but the Excel value for the attribute is not numeric, DATE but the Excel value for the attribute is not DATE.

Y SKIP If the Excel data for the attribute is incompatible to the data type of the attribute, the imported value is set to NULL and the process continues. If the attribute is mandatory attribute then the process will be aborted. This config item value is the default.

N STOP If the Excel data for the attribute is incompatible to the data type of the attribute, the process will be aborted.

ADJUST_SC_NO_EXAMPLE

This config item controls whether to allow or disallow importing completely new structured sheets.

Y ASK If there is no similar sheet to copy config settings, the system alerts the user whether to skip copy config settings from similar sheet and continue or stop the process. This config item value is the default.

N SKIP If there is no similar sheet to copy config settings, the system skips copy config settings from similar sheet and continues with rest of the validation checks.

N STOP If there is no similar sheet to copy config settings, the system aborts the process.

Appendix


ADJUST_SC_PHYS_ATTR

This config item controls if the attributes physical attribute settings will match the data which is about to be imported.

Y ASK_IF_IN_DEST

If in the Excel if the actual values are too big the program will ask if the user wishes to Change or Keep the physical attribute or Cancel the whole process if and only if there are already rows for this sheet in the export destination. This config item value is the default.

N ALWAYS_KEEP

The physical attribute is left unchanged regardless the Excel data will fit or not.

N ALWAYS_UPDATE

If in the Excel the actual values are too big, the program will change the physical attribute with the next higher length physical attribute available.

N ASK If in the Excel if the actual values are too big the program will ask if the user wishes to Change or Keep the physical attribute or Cancel the whole process.

ADJUST_SC_REUSED

This config item controls the adjustment phase of the reused sheet configs whether to adjust or not.

Y ASK The user will be prompted whether he wish to adjust or skip the adjustment phase of the reused sheet config or cancel the whole process. This config item value is the default.

N ADJUST The adjustment phase of the sheet config is carried out.

N SKIP If the sheet config is reused, then the adjustment phase is skipped.

FILL_INVENTORY

This config item decides whether the inventory needs to be filled by import or not. If the inventory is filled then, the following export jobs may determine the difference and export only the delta.

Y NO The import will not fill the inventory. This config item value is the default.

N YES The import will fill the inventory. The import will only insert lines which don’t exist with the column / value combination.

IMPORT_CAT_AND_SPEC

This config item controls whether the missing lookup information like Group Id, Part Id, Commodity Id, Ident, Spec Header Id, Spec Item Id needs to be created in SPRD or not.

Y NO If the lookup information is not found then either the row is skipped or the process is aborted as decided by other config items LKP_CC_FAILS, LKP_ID_FAILS, LKP_SP_FAILS, LKP_SI_FAILS. This config item value is the default.

Appendix


N YES If the lookup information is not found then the data of all the sheets in the current run is imported. The config items LKP_CC_FAILS, LKP_ID_FAILS, LKP_SP_FAILS, LKP_SI_FAILS are ignored i.e. no skip or stop.

IMP_CTLG_BLD_CC

This config item decides on the methodology for building the Commodity Codes.

Y ANALYZE_PC_ATTRS

In this method, the Commodity Group and Part information is fetched from the Commodity Type attribute. From the Part identified the Rule is fetched. The Rule attribute values (Table Details) will be retrieved from the part class row. This config item value is the default. If a Table Detail is not found then, the config item IMP_CTLG_CREATE_INCPL_CC is evaluated.

N ANALYZE_CC

The Commodity Code will be built by analyzing the SP3D Commodity Code string itself i.e. the SP3D Commodity Code is parsed to get the Table Details. If a Table Detail is not found then, the config item IMP_CTLG_CREATE_INCPL_CC is evaluated.

N ANALYZE_CC_THEN_PC_ATTRS

In this method, first the process described in ANALYZE_CC is performed. If a Table Detail is not found and the config item IMP_CTLG_CREATE_INCPL_CC was set to ERROR or the user opted for ERROR then, the part class attribute analysis will be done. ERROR in this case means continue with part class attributes. Even after this if Table Detail is not found then the config item IMP_CTLG_BLD_CC_ERRORS will be considered.

N DEACTIVATED

The system will copy the commodity code from SP3D. No Table details will be created. The descriptions and layouts will be copied from PipingCommodityMatlControlData ShortMaterialDescription and LongMaterialDescription.

Appendix


IMP_CTLG_BLD_CC_ERRORS

If the config item IMP_CTLG_CREATE_INCPL_CC is set to ERROR and one of the Table Detail is found missing for a Commodity Code then, this config item decides on whether to create the Commodity Code as per DEACTIVATED methodology of IMP_CTLG_BLD_CC or abort the process.

Y STOP If a Table Detail is found missing for a Commodity Code then, the process is aborted. This config item value is the default.

N USE_SP3D_CC

If a Table Detail is found missing for a Commodity Code then, the Commodity Code is created as per the DEACTIVATED methodology of IMP_CTLG_BLD_CC.

IMP_CTLG_BLD_ID

This config item defines the Ident Code.

Y SPRD_STD The Ident Code will look like generated from S.80.01. This config item value is the default.

N PROCUREMENT_DATA

The Ident Code will be the ClientCommodityCode from the PipingCommodityProcurementData. This config item is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_YES_SPEC_NO.

N SP3D_ICC The Ident Code is the size dependent industry commodity code from the part classes. This config item is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_YES_SPEC_YES.

N SP3D_STD The ident code will be the IndustryCommodityCode plus schedules and sizes.

IMP_CTLG_CC_SIZE_DEP

This config item specifies whether size information is part of Commodity Code or not.

Y CATALOG_NO_SPEC_NO

This means that the Commodity Code is not size dependent. It is not in the Catalog and not in the Spec. This config item value is the default.

N CATALOG_YES_SPEC_NO

This means that the Commodity Code in the Catalog is size dependent but not in the Spec.

N CATALOG_YES_SPEC_YES

This means that the Commodity Code is size dependent. It is in both the Catalog and Spec.

IMP_CTLG_CC_TO_ANALYZE

This config item defines what is meant by the SP3D Commodity Code for Commodity Code building.

Y INDUSTRY The industry commodity code that appears on any part class sheet is the SP3D Commodity Code. This config item value is the default.

Appendix


N CONTRACTOR

The ContractorCommodityCode from PipingCommodityMatlControlData is the SP3D Commodity Code. This is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_NO_SPEC_NO.

IMP_CTLG_CC_TO_REPORT

This config item defines the SP3D Commodity Code that needs to be considered for Company dependent Commodity Code assignments.

Y INDUSTRY The industry commodity code that appears on any part class sheet is the SP3D Commodity Code. This config item value is the default.

N CONTRACTOR

The ContractorCommodityCode from PipingCommodityMatlControlData is the SP3D Commodity Code. This is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_NO_SPEC_NO.

IMP_CTLG_CREATE_INCPL_CC

If a Table Detail is not found for a Commodity Code then, this config item will decide on whether to error out or set the value of Undefined for the missing Detail or keep the incomplete Commodity Code. This config item is valid only when IMP_CTLG_BLD_CC is other than DEACTIVATED.

Y ASK If a Table Detail is not found for a Commodity Code then, the system alerts the user the same and based on user choice it will error out or set the value of Undefined for the missing Detail or keep the incomplete Commodity Code. This config item value is the default.

N ERROR If a Table Detail is not found for a Commodity Code then, the config item IMP_CTLG_BLD_CC_ERRORS will be evaluated and based on the value set creates the Commodity Code as per DEACTIVATED methodology of IMP_CTLG_BLD_CC or abort the process.

N KEEP If a Table Detail is not found for a Commodity Code then, the system keeps the Commodity Code with generated by value ‘SP3D 40.21’ and attr_char1 set to ‘CC INCOMPLETE’.

Appendix


N SET_UNDEFINED

If a Table Detail is not found for a Commodity Code then, the system sets the Table Detail value corresponding to Undefined for the missing attribute. If there is no ‘Undefined’ defined for the attribute the system will ask whether to keep or abort process.

IMP_CTLG_DEF_GROUP

This config item holds the default Commodity Group for creating unstructured Commodity Codes. This setting is valid only when IMP_CTLG_BLD_CC is set to DEACTIVATED.

IMP_CTLG_DEF_PART

This config item holds the default Commodity Part for creating unstructured Commodity Codes. This setting is valid only when IMP_CTLG_BLD_CC is set to DEACTIVATED.

IMP_CTLG_DEF_RULE

This config item holds the default Commodity Rule for creating unstructured Commodity Rules. This setting is valid only when IMP_CTLG_BLD_CC is set to DEACTIVATED.

IMP_CTLG_DEF_SPEC_TYPE

This config item holds the name of the Spec Type to be considered for lookup of Spec Header Id information in SPRD. This config item is valid only when a Spec Code appears multiple times under different Spec Types.

IMP_CTLG_GEOM_INCL_UNITS

This config decides on whether the units if any as part of attribute value need to be included or stripped off when creating Geometric Detail.

Y STRIP The units if any as part of attribute value are stripped off when creating Geometric Detail. This config item value is the default.

N INCLUDE The units if any as part of attribute value are included when creating Geometric Detail.

Appendix


IMP_CTLG_INS_TAB_ATTRS

For a Commodity Table under consideration, if the physical attribute is already in use with a different attribute (other than TD.NUM1 => CDLST_NUM, TD.NUM2 => CDLST_NUM2, and TD.NUM3 => CDLST_NUM3) then, this config decides whether to keep the existing attribute and store the Codelist Number or stop the import process.

Y ASK If the physical attribute is already in use with a different attribute then, the user will be alerted whether he / she want to keep the existing attribute and store the Codelist Number or stop the import process .This config item value is the default.

N KEEP If the physical attribute is already in use with a different attribute then, the existing attribute shall be used to store the Codelist Number.

N STOP If the physical attribute is already in use with a different attribute then, the import process is aborted.

IMP_CTLG_PG_MODIFY

This config item controls whether the Product Group information can be created / modified from within the Projects. Product Group data can always be reused in Projects.

Y STOP Any attempt to update / create information in Product Group from Projects aborts the import process. This config item value is the default.

N MODIFY The Product Group information shall be modified / new data shall be created in Product Group from Projects.

IMP_CTLG_SP3D_CC

This config item controls Company dependent Commodity Code mappings. This config item is valid only when the config item IMP_CTLG_BLD_CC is other than DEACTIVATED.

Y CCC The SP3D Commodity Code will be the Company Commodity Code. The Company dependent Commodity Code mapping is always done. This config item value is the default.

N CCC_IF_DIFFERENT

The SP3D Commodity Code will only be recorded as company code, if the newly built Commodity Code looks different than the old one.

Appendix


IMP_CTLG_SP3D_ID

This config item defines the Company Ident Code. This config item is valid only when the config item IMP_CTLG_BLD_ID is set to SPRD_STD.

Y SP3D_STD The company ident code will be the IndustryCommodityCode plus schedules and sizes. This config item value is the default.

N PROCUREMENT_DATA

The company ident code will be the ClientCommodityCode from the PipingCommodityProcurementData. This is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_YES_SPEC_NO.

N SP3D_ICC The ident code is the size dependent industry commodity code from the part classes. This is valid only when IMP_CTLG_CC_SIZE_DEP is set to CATALOG_YES_SPEC_YES.

IMP_CTLG_UPD_CG

This config item decides whether to update the descriptions, Standard, Rule for the existing Commodity Group or not.

Y NO Descriptions, Standard, Rule for the existing Commodity Group are not updated. This config item value is the default.

N YES Updates descriptions, Standard, Rule for the existing Commodity Group.

IMP_CTLG_UPD_CP

This config item decides whether to update the descriptions, Standard, Rule for the existing Commodity Part or not.

Y NO Descriptions, Standard, Rule for the existing Commodity Part are not updated. This config item value is the default.

N YES Updates descriptions, Standard, Rule for the existing Commodity Part.

IMP_CTLG_UPD_CR

This config item decides whether to update the descriptions, delete Commodity Rule Details, Commodity Keys, Commodity Layout and create newly for the existing Commodity Rule or not.

Y NO No update of descriptions / deletion of Commodity Rule Details, Commodity Keys, and Commodity Layout for the existing Commodity Rule. This config item value is the default.

N YES Updates descriptions, deletes Commodity Rule Details, Commodity Keys, and Commodity Layout for the existing Commodity Rule. Creates newly the Commodity Rule Details, Commodity Keys, and Commodity Layout from the sheet data.

Appendix


IMP_CTLG_UPD_CT

This config item decides whether to update the descriptions and mapping name for the existing Commodity Table or not.

Y NO Descriptions and mapping name for existing Commodity Table are not updated. This config item value is the default.

N YES Updates descriptions and mapping name for the existing Commodity Table.

IMP_CTLG_UPD_OP

This config item decides whether to update the descriptions, delete Object Parameter Details, Object Parameter Layout and create newly for the existing Object Parameter or not.

Y NO No update of descriptions / deletion of Object Parameter Details, Object Parameter Layout for the existing Object Parameter. This config item value is the default.

N YES Updates descriptions, deletes Object Parameter Details, Object Parameter Layout for the existing Object Parameter. Creates newly the Object Parameter Details and Object Parameter Layout from the sheet data.

IMP_CTLG_UPD_SC

This config item decides whether to update the descriptions for the existing Short Code or not.

Y NO Descriptions for the existing Short Code are not updated. This config item value is the default.

N YES Updates descriptions for the existing Short Code.

IMP_CTLG_UPD_SH

This config item decides whether to update the descriptions for the existing Spec Code or not.

Y NO Descriptions for the existing Spec Code are not updated. This config item value is the default.

N YES Updates descriptions for the existing Spec Code.

IMP_CTLG_UPD_TD

This config item decides whether to update the descriptions and Codelist Number for the existing Table Detail or not.

Y NO Descriptions and Codelist Number for existing Table Detail are not updated. This config item value is the default.

N YES Updates descriptions and Codelist Number for the existing Commodity Table Detail.

IMP_CTLG_UPD_TG

This config item decides whether to update the descriptions for the existing Commodity Table Group or not.

Y NO Descriptions for existing Commodity Table Group are not updated. This config item value is the default.

N YES Updates descriptions for the existing Commodity Table Group.

Appendix


IMP_TPL This config item controls insertion of template data if template data already exists for a sheet and sheet category is one of code list, general rule, general list or spec rule.

Y MERGE The new rows from the imported data will be inserted after the last row which was there before import. For hierarchical code list the new rows are inserted within the correct master. The new rows are identified with the primary key defined on sheet in SP3D 10.07. If the import row already exists in the template with respect to the primary key but non unique key columns are changed then such columns are updated in the template. This config item value is the default.

N APPEND The new rows from the imported data will be inserted after the last row which was there before import. For hierarchical code list the new rows are inserted within the correct master.

N DELETE_AND_REPLACE

The template data already existing for the sheet is removed and the newly imported data is populated.

IMP_TPL_HRL_CDLST_NO_MASTER

This config item controls dealing with the inconsistent data (parent record not specified) in the SP3D Excel hierarchical code list sheet.

Y STOP If in the hierarchical code list Excel sheet the master record information is not present the process is aborted. This config item value is the default.

N APPEND If in the hierarchical code list Excel sheet the master record information is not present the record will be inserted into the last master.

N SKIP If in the hierarchical code list Excel sheet the master record information is not present the line will be skipped and the processing continues with the next record.

IMP_TPL_NULL_ON_REQ_FIELDS

This config controls dealing with attributes specified as required but NULL values found in Excel data.

Y STOP If in the Excel NULL value is found for an attribute but the attribute is mandatory the process is aborted. This config item value is the default.

N SKIP If in the Excel NULL value is found for an attribute but the attribute is mandatory the Excel row is skipped and processing continues with the next row.

IMP_TPL_SP This config item is considered only when sheet category is spec rule and the value for config item IMP_TPL is DELETE_AND_REPLACE.

Y KEEP_OTHER_SPECS

Only the template data corresponding to the specs in the newly import sheet are deleted and the newly import data is populated. This config item value is the default.

Appendix


N TOUCH_ALL

Template data for all the specs are deleted and the newly import data is populated.

INSERT_ATTRIBUTES

This config item controls the insertion of SP3D Excel sheet attribute into SmartPlant Materials, if the attribute already exists.

Y ASK The user will be alerted on attribute existence, whether he wants to reuse the existing attribute, insert a new one or cancel the whole process. This config item value is the default.

N NEW New attribute will be inserted appending an underscore to the attribute. If an attribute with an underscore exists then it appends one more underscore and so on. The underscore will be removed when this sheet is exported to a workbook later on.

N REUSE Existing attribute is reused.

INSERT_SC This config item controls, whether the template data, sheet dependent mappings data should be deleted and replaced by the newly import sheet data or reused, in case if the sheet config sheet is already existing.

Y ADD_OR_MODIFY

Existing sheet config sheet is considered i.e. the sheet dependent data and template data will be reused. This config item value is the default.

N DELETE_AND_REPLACE

All the template data, sheet dependent mapping data and sheet assignment to template will be deleted, before the contents of the current sheet will be inserted.

INSERT_SC_ATTRS

This config item controls the addition of newly import sheet attributes or deletion of existing sheet config sheet attributes.

Y ASK_ON_MORE_OR_LESS_ATTRS

If the existing config contains attributes which are not on the newly imported sheet, then the job will ask if the attribute should be deleted or ignored or job should be canceled. If the newly imported sheet contains more attributes than are in the existing sheet config, then the job will ask if the attribute should be added or ignored or the job should be cancelled. This config item value is the default.

N ADAPT_ATTRS

New attributes will be added and attributes not existing in the newly imported sheet will be deleted from the existing sheet config.

N ADD_NEW_ATTRS

New attributes will be added and attributes not existing in the newly imported sheet will be left untouched from the existing sheet config.

Appendix


N ASK_ON_LESS_ATTRS

If the existing config contains attributes which are not on the newly imported sheet, the job will ask if the attribute should be deleted or ignored or job should be canceled.

N ASK_ON_MORE_ATTRS

If the newly imported sheet contains more attributes than are in the existing sheet config, then the job will ask if the attribute should be added or ignored or the job should be cancelled.

INSERT_SC_DFN_ATTRS

This config item controls the addition of newly import sheet definition attributes or deletion of existing sheet config definition attributes.

Y ASK_ON_MORE_OR_LESS_ATTRS

If the existing config contains attributes which are not on the newly imported sheet, then the job will ask if the definition attribute should be deleted or ignored or job should be canceled. If the newly imported sheet contains more definition attributes than are in the existing sheet config, then the job will ask if the definition attribute should be added or ignored or the job should be cancelled. This config item value is the default.

N ADAPT_ATTRS

New definition attributes will be added and definition attributes not existing in the newly imported sheet will be deleted from the existing sheet config.

N ADD_NEW_ATTRS

New definition attributes will be added and definition attributes not existing in the newly imported sheet will be left untouched from the existing sheet config.

N ASK_ON_LESS_ATTRS

If the existing config contains definition attributes which are not on the newly imported sheet, the job will ask if the definition attribute should be deleted or ignored or job should be canceled.

N ASK_ON_MORE_ATTRS

If the newly imported sheet contains more definition attributes than are in the existing sheet config, then the job will ask if the definition attribute should be added or ignored or the job should be cancelled.

INSERT_SC_DFN_ATTR_VALS

This config item controls updating the definition attribute value for definition attributes which already exist but the value is changed.

Y DO_NOT_ERASE

The existing definition attribute value is updated with the newly imported sheet data if and only if the new sheet the value is NOT NULL. This config item value is the default.

N UPDATE The existing definition attribute value is updated with the newly imported sheet data always.

Appendix


N UPDATE_ONLY_NULLS

The existing definition attribute value is updated with the newly imported sheet data if it was NULL before.

INSERT_SHEETS

This config item controls the insertion of SP3D Excel sheet into SmartPlant Materials, if the sheet already exists.

Y ASK The user will be alerted on sheet existence, whether he wants to reuse the existing sheet, insert a new one or cancel the whole process. This config item value is the default.

N NEW New sheet will be inserted appending an underscore to the sheet name. If a sheet with an underscore exists then it appends one more underscore and so on. The underscore will be removed when this sheet is exported to a workbook later on.

N REUSE Existing sheet is reused.

ITM_MAP_ATTRS_LEV_DEPCS

This config item controls if in determining the mapping level for attribute mappings should the attribute dependencies field data in SP3D 10.07 be considered.

Y YES In determining the mapping level for attribute mappings the levels specified in attribute dependencies field in SP3D 10.07 is only considered. If dependencies for an attribute are not specified (NULL) then optimization includes all levels and mapping will done at the highest possible level. This config item value is the default.

N NO In determining the mapping level for attribute mappings all the levels are considered and mapping will be done at the highest possible level.

ITM_MAP_SHT_IDT_LEV_KEEP

This config item controls if the levels of mapping already existing in sheet dependent sheet mappings should be respected. The config item ITM_MAP_SHT_IDT_LEV_OPT is considered only when the value is NO and has no effect when value is YES.

Y YES The program stays on the pre-existing mapping level i.e. if there mappings for a sheet on some level (say commodity level) the program will not try to reach a mapping on higher level (part or group levels). The config item ITM_MAP_SHT_IDT_LEV_OPT has no effect. This config item value is the default.

N NO The program checks if a mapping at a higher level is possible. If possible deletes the lower level mappings and maps at the highest level possible. The config item ITM_MAP_SHT_IDT_LEV_OPT is considered.

Appendix


ITM_MAP_SHT_IDT_LEV_OPT

This config item determines when a higher level should be chosen for sheet dependent sheet mappings.

Y IF_NOT_ELSEWHERE

The program considers the newly import data and the existing mapping data in determining the level and reaches the maximum level possible. Deletes the lower level mappings if any and maps at the maximum level. This config item value is the default.

N IF_COMPLETE

The program considers the newly import data and the existing mapping data and the Smart Plant Reference Data in determining the level. The next level will only be considered if really all idents (existing in Smart Plant Reference Data) are on the same sheet. Deletes the lower level mappings if any and maps at the maximum level possible.

LKP_CC_FAILS

This config item controls the import process when the commodity code look up information is not found in SmartPlant Reference Data.

Y STOP If the look up information cannot be found, the job is cancelled. This config item value is the default.

N SKIP The SP3D Excel record for which the look up information cannot be found is skipped and the processing continues with the next record.

LKP_ID_FAILS This config item controls the import process when the ident look up information is not found in SmartPlant Reference Data.

Y STOP If the look up information is not found, the job is cancelled. This config item value is the default.

N IGNORE If the look up information for ident is not found for the SP3D Excel record, the record will still be loaded into the temporary import table but with ident data NULL.


LKP_SI_FAILS This config item controls the import process when the spec item look up information is not found in SmartPlant Reference Data.



Appendix


LKP_SP_FAILS This config item controls the import process when the spec code look up information is not found in SmartPlant Reference Data.



MATCH_CC_COMPANY

This config item controls which company to take for finding the commodity lookup information. It is used in config item MATCH_COMMODITY_CODE.

Y PROJECT_COMPANY

The company specified against the project is taken for finding the commodity look up information. If not specified (NULL) then the process will be aborted. This config item value is the default.

N ZI_SP3D_CO

The company specified in the project default parameter ZI_SP3D_CO is taken for finding the commodity look up information. If not specified (NULL) then process will be aborted.

MATCH_COMMODITY_CODE

This config item is used for interpreting the commodity code occurring in the SP3D Excel sheet and accordingly fills up the look up fields in temporary import tables.

Y SPRD In filling up the lookup fields in temporary import tables the commodity code in SP3D Excel sheet is interpreted as SmartPlant Reference Data commodity code. This config item value is the default.

N COMPANY In filling up the lookup fields in temporary import tables the commodity code in SP3D Excel sheet is interpreted as company dependent commodity code. In MATCH_CC_COMPANY will be defined, where the company is read from.

N COMPANY_FIRST

In filling up the lookup fields in temporary import tables the commodity codes in SP3D Excel sheet are first searched against company dependent commodity codes and then only a search is done against SmartPlant Reference Data commodity code. In MATCH_CC_COMPANY will be defined, where the company is read from.

Appendix


MATCH_SHORT_CODE

This config item is used for interpreting the short code occurring in the SP3D Excel sheet and accordingly fills up the look up fields in temporary import tables.

Y SHORT_CODE

In filling up the lookup fields in temporary import tables the short code in SP3D Excel sheet is interpreted as SmartPlant Reference Data short code. This config item value is the default.

N DESCRIPTION

In filling up the lookup fields in temporary import tables the short code in SP3D Excel sheet is interpreted as SmartPlant Reference Data short code long description.

N MAPPED_SHORT_CODE

In this case one SPRD short code can represent multiple short codes in SP3D. The program will first lookup the Short Codes assigned at Part level. If not found then lookup is performed at Short Code level without Group / Part.

SI_PIPING_SHORT_CODE_LST

This config item holds the short codes corresponding to the piping spec items. The spec items with short codes listed in this config item are considered for building filter geometric for a Spec Code. The default value for this config item is 'PIP','PIPE','PIPING','PI','Piping'.

spmat.hec.co.krspmat.hec.co.kr/marian_webentry/PDFs/INT-SP3D.pdf · Use of this software product is...

Documents

Transcript of spmat.hec.co.krspmat.hec.co.kr/marian_webentry/PDFs/INT-SP3D.pdf · Use of this software product is...