smartplant reference data - spmat.hec.co.krspmat.hec.co.kr/marian_webentry/pdfs/sprd sp3d interface...

SmartPlant Reference Data SmartPlant 3D Interface User's Guide

Version 2011 SP1 (7.0.1)

June 2010 / September 2010

DMAR1-PE-200143A-Updated

Copyright Copyright © 2010 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 ("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 Interface User's Guide 3

Contents Preface .......................................................................................................................................................... 5

Overview ....................................................................................................................................................... 7

Process Workflow Diagram ........................................................................................................................ 9

Transfer Job Set-Up ................................................................................................................................ 9

Prerequisites .............................................................................................................................................. 11

DBA Settings ......................................................................................................................................... 11 Project Defaults ..................................................................................................................................... 11 Excel Template ..................................................................................................................................... 13

Set-Up ......................................................................................................................................................... 15

Sheet Configuration .............................................................................................................................. 15 Sheet Definition .............................................................................................................................. 15 Attribute Definition .......................................................................................................................... 16 Sheet Configs ................................................................................................................................. 18

Templates ............................................................................................................................................. 23 Item Mappings ....................................................................................................................................... 24 Procedures ............................................................................................................................................ 28 Sheets and Attributes Mapping ............................................................................................................. 30 Add, Find and Replace Setup ............................................................................................................... 31 General Configs .................................................................................................................................... 33 Transfer Types ...................................................................................................................................... 34 Destinations and Structures .................................................................................................................. 35 Generic Sheets ..................................................................................................................................... 40

Commodity Attributes ..................................................................................................................... 41 Ident Forming Attributes (Input) ...................................................................................................... 44 Other Ident Attributes (Output) ....................................................................................................... 45 Procedure FILL_GENERIC_TEMPLATE_SHEET ......................................................................... 46 General Config Settings ................................................................................................................. 46 Transfer Job ................................................................................................................................... 47

Gaskets, Nuts, and Washers ................................................................................................................ 48 Gaskets .......................................................................................................................................... 48 Nuts ................................................................................................................................................ 49 Washers ......................................................................................................................................... 49

Codelists ............................................................................................................................................... 49 Mapping using Table Groups and Table Details ............................................................................ 50 Mapping using Table Details .......................................................................................................... 51 Sheet Configs ................................................................................................................................. 52 Restrictions ..................................................................................................................................... 53

Spec Preparation for Export ..................................................................................................................... 55

Mappings ............................................................................................................................................... 55 Short Codes .......................................................................................................................................... 57 Templates ............................................................................................................................................. 58

Contents

4 SmartPlant Reference Data SmartPlant 3D Interface User's Guide

Transfer to SP3D ....................................................................................................................................... 61

Export Job Creation .............................................................................................................................. 61 Export Job Execution ............................................................................................................................ 67

Job Results ..................................................................................................................................... 68 Logfiles ........................................................................................................................................... 70 Workbooks ...................................................................................................................................... 70 Consistency Check ......................................................................................................................... 71 Stages ............................................................................................................................................ 72

SP3D Bulkload API .................................................................................................................................... 75

Software Requirements ........................................................................................................................ 75 SP3D Reference Data Client ................................................................................................................ 75 SP3D Server Configuration ................................................................................................................... 79 SPRD Application Server Configuration ............................................................................................... 80 SmartPlant Reference Data Settings .................................................................................................... 81 How the Bulkload API Works ................................................................................................................ 83 Bulkload API Export Job ....................................................................................................................... 84

Appendixes ................................................................................................................................................ 91

Acronyms .............................................................................................................................................. 93 General Config Items ............................................................................................................................ 95

Index ......................................................................................................................................................... 107


This document describes the SmartPlant 3D (SP3D) interface of SmartPlant Reference Data (SPRD).

Preface

Preface



This document describes the SmartPlant 3D interface of SmartPlant Reference Data. All reference data in SmartPlant 3D is maintained in Excel workbooks. SmartPlant Reference Data provides all needed settings, configurations, and templates to export SPRD data into the applicable Excel sheets. SmartPlant Reference Data delivers standard definitions and configurations for most areas of the SmartPlant 3D interface. The standard data cannot be modified; these records are labeled with the cross-checked Standard check box.

This symbol points to Standard Database (SDB) relevant issues. You can ignore these paragraphs when you are not working with the SDB.

Overview

Overview



Transfer Job Set-Up

Process Workflow Diagram

Process Workflow Diagram



DBA Settings The following is a list of DBA settings in relation to the SP3D interface, to be set and maintained in the screen A.60.04.

XLS_FORMAT Excel Format.

The extension of a workbook might be xls or xlsx.

LOG_ONLINE_JOBS Create log files for online jobs.

If set to Y, online jobs will generate log files.

LOG_FILE_DEST Log file destination for online jobs.

This setting must point to the directory on the Oracle server where log files shall be stored. It must be accessible by the server processes through configuration as UTL_FILE_DIR directory in the instance initialization file. You have the option to define this only here on a global basis, or you can also specify this on a per-project basis with the parameter ZX_MAR_LOG in screen A.20.12/13. If for a specific user environment, the parameter ZX_MAR_LOG is set, then LOG_FILE_DEST from this screen will not be used.

Project Defaults The following is a list of Project Defaults in relation to the SP3D interface, to be set and maintained in the screens A.20.12 or A.20.13.

ZI_SP3D_CO SP3D Company to store catalog data references. The company name is used to store the company ident which will be generated automatically on export. The company ident will be formatted like the SP3D catalog part number: <CommodityCode><Schedule1..n><Size1..n>

ZI_SP3D_CS SP3D Catalog structure to be used in actual project/ pg / discipline. Default for the catalog structure, defined in SP3D 10.09.

ZI_SP3D_CT Alternative SP3D Template to be used for codelists in actual project/ pg / discipline.

ZI_SP3D_DI Name of the base directory for SP3D files. All files (except the logfiles) created by the interface will be written to this base directory, and all files uploaded to the application server to be read by the interface will be stored here.

ZI_SP3D_ED SP3D Destination to be used in actual project/ pg / discipline. Default for the export destination, defined in SP3D 10.05.

ZI_SP3D_GC SP3D General Config to be used in actual project/ pg / discipline. Default for the general config, defined in SP3D 10.01.

Prerequisites

Prerequisites


ZI_SP3D_IC SP3D Import Config to be used in actual project/ pg / discipline. Default for the import config, defined in SP3D 40.01.

ZI_SP3D_IM SP3D Item Mapping to be used in actual project/ pg / discipline. Default for the geometric mapping, defined in SP3D 10.04.

ZI_SP3D_IN SP3D UOM Input. SP3D UOM input used by SDB CIP. Can be imperial (I) or metric (M).

ZI_SP3D_SC SP3D Sheet Config to be used in actual project/ pg / discipline. Default for the sheet config, defined in SP3D 10.07.

ZI_SP3D_TP SP3D Template to be used in actual project/ pg / discipline. Default for the template, defined in SP3D 10.08.

ZI_SP3D_TT SP3D Transfer Type to be used in actual project/ pg / discipline. Default for the transfer type, defined in SP3D 10.04.

ZI_SP3D_UO SP3D UOM Output SP3D UOM output used by SDB CIP. Can be imperial (I) or metric (M).

ZI_SP3D_UR Name of the virtual directory for SP3D files. This setting is used for downloading files from ZI_SP3D_DI. Please enter a string like 'Your_server_name/your_virtual_directory' without 'http://' at the beginning and without a concluding '/'.

ZX_MAR_LOG Directory for log files

This setting must point to the directory on the Oracle server where log files shall be stored. It must be accessible by the server processes through configuration as UTL_FILE_DIR directory in the instance initialization file. You have the option to define this here on a per-project basis, or you can also specify this globally by setting the value LOG_FILE_DEST in screen A.60.04. If for a specific user environment, the parameter ZX_MAR_LOG is set, then LOG_FILE_DEST from screen A.60.04 will not be used.

In case the specification has been created with metric units, but you want the data exported with imperial units (or vice versa), you can set the following project defaults in screen A.20.12:

ZO_NPS_UOM NPS Display Imperial/Metric Can be fraction (F), imperial (I) or metric (M).

ZO_SP3D_UO SP3D UOM Output used by SDB CIP. Can be imperial (I) or metric (M).

Prerequisites


Excel Template Make sure that the Excel template SP3D_EJ_TEMPLATE.xls for the SP3D download is installed in the download folder of the application server and assigned to project default ZI_SP3D_DI.

Prerequisites



The export of workbooks for SmartPlant 3D requires several pre-settings and configurations. The picture below displays all needed definitions with their origins. The subsequent chapters describe the setup in detail.

Sheet Configuration Sheet Definition

All sheets to be transferred to SmartPlant 3D must be defined in screen SP3D 10.02 Sheets. All known standard sheet definitions are delivered with the product; these have the Standard indicator selected. The sheet definitions are project dependent. You may add additional sheets, for example, if you want to create new part classes for SP3D.

The Category indicates the purpose of the sheet and the type of data the sheet will contain. The selectable categories are:

PART_DEFINITION Sheets of this category are for selecting the catalog sheets. In other words: to select the cc’s and idents from the specification(s) or not, depending on what you select to transfer in SP3D2001 Export Jobs.

Sample: 90DegElbow (PipingComponentClass Sheet, -> PipingCatalog workbook)

PART_FILTER Sheets of this category are specification independent and only commodity code dependent.

Sample: PipingCommodityMatlControlData (->PipingSpecification workbook)

Set-Up

Set-Up


SPEC_ITEM_FILTER Sheets of this category are for selecting Spec Line Items from screen S5006. The Piping Commodity Filter sheet defines the data required to select the piping commodity and any additional data required for optional uniqueness per piping material class.

Sample: Piping Commodity Filter (-> PipingSpecification workbook)

SPEC_RULE Sheets of this category are required for selecting the Specification Header information from screen S5006.

Sample: CorrosionAllowance (-> PipingSpecification.xls) Piping Materials Class Rule

GENERAL_LIST Sheets of this category are needed for the internal structure of SP3D. Sheets of this category are commodity code and specification independent.

Sample: Operator17 (ValveOperatorClass Sheet -> CatalogData workbook)

GENERAL_RULE Sheets of this category are considered look-up tables for SP3D. The data is general for all commodity codes and idents. Sheets of this category are commodity code and specification independent.

Sample: MaterialsData (-> PipingSpecification workbook) Piping Specification Rule

CODE_LIST Sheets of this category are considered as translation tables. Sheets of this category are commodity code and specification independent.

Sample: EndPreparation (System code lists -> AllCodelists.xls)

Attribute Definition The SP3D attributes that are used to describe the data columns of the Excel sheets must be defined in screen SP3D 10.03 Attributes. All known standard attribute definitions are delivered with the product; these attributes have the Standard indicator selected.

The Attribute Name is used as column title on the Excel sheets. In screen SP3D 10.07 Sheet Configs, the SP3D attributes are assigned to the sheets. The same attribute can occur on different sheets, if it labels the same thing. The LOV Statement field might be used to define a statement to populate the LOV in SPRD (for example, in screen SP3D 10.04). If this column is empty, the program tries to build a LOV from the

Set-Up


assigned codelist. As a basis for an LOV, use a normal select statement with the following structure:

SELECT <column1> VALUE, NULL CODELIST, <column2> DESCRIPTION FROM ... Alternatively, if there are values to be selected from a template, the structure may look like the following:

TEMPLATE?<Sheetname>?<ValueColumn>,<DescriptiveColumn> The LOV definition is used for validation of the values entered. In the case of the TEMPLATE syntax, it is also used for synchronization of depending attributes. For example, if you change a codelist value in SP3D 10.08, the system will update all references with the same value in SP3D 10.04/.08 if they belong to the same template. If the attribute values are based on a codelist, the codelist table name is specified in the Codelist field. The value of the codelist is expected to be found in SP3D 10.08 on a sheet named as entered in this Codelist field, in a column named <codelistname><blank>'ShortDescription' while the codelist number is fetched from the same sheet from the column that is labeled Codelist Number.

Do not use the 'Codelist' column and the LOV statement on the same attribute. For

referencing codelists, use the 'Codelist' column; for others, use the LOV statement.

Set-Up


Sheet Configs Sheet Configs are pre-defined sets of sheet configurations with attribute mappings and retrieval methods. With the retrieval method, you define how the sheet or the sheet column is populated with data. You might need multiple sheet configs when working with different versions of SmartPlant 3D. The standard configs 1ST_CONFIG_V2009 and 1ST_CONFIG_V2007 are delivered with the product; they have the Standard indicator selected.

The second block is used to assign the sheets to the sheet config and to define the retrieval method for each sheet.

Possible Retrieval Methods for the sheets are:

TEMPLATE_COPY The sheet will be available on the screen SP3D 10.08 Templates.

The export job will create the corresponding sheet by simply copying the values from the template defined on SP3D 10.08 Templates. That means, if the sheet retrieval method is TEMPLATE_COPY, the sheet retrieval source will be ignored.

The retrieval method settings on attribute level are not being used for sheets with retrieval method TEMPLATE_COPY.

For example, almost all codelists with category CODE_LIST have the retrieval method TEMPLATE_COPY assigned.

Set-Up


SHT_STND_METHOD A standard method is called, which has to be assigned in the Source field.

If ‘Default’ is selected as source on the sheet level, the retrieval method is automatically defined by the ‘Sheet Category’.

For example, the Source for almost all part class sheets with category PART_DEFINITION is ‘PartClass’.

SHT_CUST_METHOD This Retrieval Method will call the CIP m_pck_sp3d_custom.sht_cust_method. Per default, this procedure is empty, which means that you must program the logic to export the sheet yourself.

TABLE_DETAILS If the retrieval method is TABLE_DETAILS, the sheet will be generated from the table groups and table details of commodity attribute tables. The table(s) to be considered are defined in the retrieval source. This method is valid only for sheets defined with category as CODE_LIST.

The third block consists of the three tabs ‘Attributes’, ‘Definition Attributes’, and ‘Attached Procedures’.

Attributes The Attributes tab is used to assign the attributes with its properties to the sheet and to define the retrieval method for each attribute.

The attributes will appear on the resulting Excel sheet in the sequence defined in Seq field. The attribute name as displayed in the Attribute field is used as the column title on the Excel sheet. If a default value is defined for the column in field Default Value, this default will be taken when no other value is found, independent of the defined retrieval method. The entries in the Dependencies field are used to indicate on which level the needed information for the attribute is mapped to classes and material in SPRD. This field contains a comma separated list of dependencies. Valid values are: ID for ident (also idents resulting from ident ranges) CC for commodity code (also commodities resulting from commodity ranges) P for commodity part (or group) SI for spec item SH for spec header TD for table detail related mapping independent from group/part (like commodity ranges)

The list above also represents the order in which the procedure evaluates the different levels during the search for a value. Include all levels you consider reasonable. For example, if there is a value that normally depends on the commodity part, but sometimes deviates for distinct commodity codes, you should set the

Set-Up


dependencies to "CC,P". This will enable the program to first look if the actual CC is mapped to the requested parameter. If the CC is not mapped, the mapping on the part level is queried. The Physical Attribute defines the column in the export and inventory tables for the selected attribute, and their names consist of the digits:

A - for Attribute C - for Character (alphanumeric) 0010 - for the maximum length of 10 digits (available lengths: 10, 20, 30, 60, 256, 2000, 4000) 001 - the sequential number for all attributes with the same data type and size

Possible Retrieval Methods for the attributes are:

NONE The column will be left untouched. This is the method of choice if the column remains empty, because NONE saves the time spent calling a retrieval function (which will not find a value because there is simply nothing mapped).

BASE_COLUMN Takes the value from the SPRD base tables, which are associated to the sheet.

Sheets of all categories can use all columns from each base table that is assigned to the sheet via Source on sheet level. Note that the attributes that will form the catalog part number (commodity code, schedules, nominal sizes) must be BASE_COLUMN based. They may use functions that modify the result. The column names in Retrieval Source should always be typed in lowercase and contain the alias. A valid value would be for example, 'NVL(i.input_3,'X')'.

Example

The sheet R-Hierarchy has Source R-ClassNodeDescribes assigned. This Retrieval Source uses the tables with aliases:

m_sp3d_struct_elems cse m_sp3d_exp_dst_cat_structs edcs m_sp3d_cat_struct_e_shts cses m_sp3d_shts sht

The attributes assigned to R-Hierarchy have both retrieval method BASE_COLUMN assigned, with the sources (alias.column or table_name.column or just column when it’s unique):

cse.cse_code (or m_sp3d_struct_elems.cse_code)

Set-Up


sht.sht_code (or m_sp3d_shts.sht_code)

Sheets of category PART_FILTER or PART_DEFINITION can use all columns from base tables:

m_commodity_groups (alias cg), m_parts (alias p), m_commodity_codes (alias cc) m_idents (alias i)

Sheets of category SPEC_RULE can use all columns from base tables: m_spec_headers (alias sh), m_spec_revisions (alias spr)

Sheets of category SPEC_ITEM_FILTER can use all columns from base tables: m_spec_headers (alias sh), m_spec_revisions (alias spr) m_spec_items (alias si), m_commodity_groups (alias cg), m_parts (alias p), m_commodity_codes (alias cc) m_idents (alias i)

ATTR_STND_METHOD Looks into the Retrieval Source field and calls the specified function to fetch the correct value.

ATTR_CUST_METHOD This Retrieval Method will call the CIP m_pck_sp3d_custom.attr_cust_method. Per default, this procedure is empty, which means you must program the logic to export the sheet yourself.

If the sheet retrieval method is TEMPLATE_COPY, the attribute retrieval methods are

ignored. If ‘Default’ is selected as source on attribute level, the value will be searched on SP3D 10.04

Item Mappings. The definition of retrieval sources for the sheets and attributes with its details can be found on the SP3D 10.12 Retrieval Sources screen. Furthermore, this screen can be used to define your own retrieval sources. Defining the SQL statements of the retrieval sources requires a consolidated knowledge in SPRD database table structure. The retrieval sources that are provided with the product are marked as standard.

Set-Up


A retrieval source basically represents SQL code that will be used to populate a sheet or a sheet attribute. Retrieval sources can be used to populate multiple sheets or attributes.

If the In XLS indicator is set, the column will appear on the Excel sheet. If the indicator is not set, the column will be written to the interface table, but not to the Excel sheet later on. If the values of a row are the same in the following row in the sheet, in most cases they can be left out. This saves space, and can make the sheet more readable. If the Suppress Repetition check box is selected, duplicate values are not repeated. For example, the second size range in the PipingCommodityFilter sheet should not use this feature. Otherwise, 2size items could be interpreted as 1size items. If the Mandatory check box is selected, the value of this item may not be null. The Unique Key (UK) item can contain a number between 1 and 9. All attributes that belong to the same unique key get the same number. There is a special handling with hierarchical codelists. In those codelists, the codelist number should be declared as the first UK and any of the "XYZ ShortDescription" fields should also get its own UK. Do not use the UK for other fields in a hierarchical codelist sheet, and do not use UKs combined from more than one column. The Unique Key Sequence item can contain a number between 1 and 99 to indicate the sequence of the attribute within the unique key.

Definition Attributes The sheet definition section is common header information for all items placed on a sheet. If a sheet has no Definition Attributes assigned on this tab, the complete definition section is omitted on the sheet.

Attached Procedures The Attached Procedures tab is used to assign procedures to the sheet, which can be started later on different events, for example, during the export or while maintaining the template on SP3D 10.08. The procedures are defined on the SP3D 10.13 Create Procedures screen and can be selected from the LOV.

Set-Up


Copy Sheet A right mouse-click on the Sheet field in the second (Sheets) block opens a menu with the Copy Sheet command. Selecting this command opens a new window that allows you to copy a sheet with its assigned attributes, definition attributes, and attached procedures from one sheet config to another.

With the check boxes, you can define what is to be copied: Sheet, Attributes, Definition Attributes, or Attached Procedures. The options are: Insert - The item will be inserted if not yet existing in the destination config. Update - If the item already exists in the destination config, its properties will be replaced by

those from the source config. Updating and deleting attributes may also affect the related templates.

Delete - Deletes items from the destination config that are not in the source config. Click the Copy button to start copying the sheet. The process will be displayed in the text field at the bottom of the screen. Click the Cancel button to close the window.

Templates A template is a named set of sheets that can be used by the transfer procedure to fill the data sheets by simply copying the data from the template. These sheets must be configured with the retrieval method ‘TEMPLATE_COPY’ on SP3D 10.07 Sheet Configs. The template holds data that cannot be retrieved from any SPRD object, because either it is not existing or used in standalone SPRD, or it is only needed by the interface to fill the SP3D sheets (like most of the codelists). Generally, every sheet in the transfer can refer to a template sheet, but in some cases, like the PipingMaterialClass or PipingCommodityFilter sheet, it is not reasonable.

Set-Up


The templates are maintained on the SP3D 10.08 Templates screen. The standard templates 1ST_V2009 and 1ST_V2007 are delivered with the product; they have the Standard indicator selected. The templates are project dependent.

The Templates block shows the name of the template with a comment and the Sheet Config assigned to that template. The Sheets block holds all sheets assigned to the template, with its category and help text. The Data block is used to define the data that will be copied from the template to the created sheet at runtime of the transfer job. When you select the Show incomplete records check box, only the records that are incomplete will be displayed. "Incomplete" means: A mandatory field is empty. You can define a field as mandatory on the SP3D 10.07 Sheet

Configs screen in the Attributes folder. All optional fields are empty. Optional fields do not have the Mandatory indicator checked and

the Unique Key field is empty on the SP3D 10.07 Sheet Configs screen in the Attributes folder.

Empty mandatory fields will be displayed with a red background color.

Item Mappings The item mapping is a pre-defined and named set of relations between: sheets and assigned groups/parts/commodity codes/idents sheet attributes and those values that should appear on distinct parts/commodity codes/idents

or specs/spec items Attribute-value to item mapping can be done in the following ways: sheet dependent sheet independent

The sheet dependent mapping is scanned first (on all levels) in each transfer job run. If no mapping is found for the item, the independent mapping will be looked up. The search process proceeds in the following order of levels: Idents, commodity codes, commodity parts or groups, spec items, spec headers.

Set-Up


If on one level no mapping is found, the search continues on the next level. On SP3D 10.07 there is a config setting on the attribute level that may restrict the levels scanned (Dependencies).

If the value is defined to be read from the geometric, and the value is not found in the assigned geometric on SP3D 10.04, the higher mapping levels are automatically ignored, in the same way as if a value would have been found in the assigned geometric.

Sheet Mapping – Sheet dependent The sheet mapping defines the relation between SPRD components and a dedicated sheet.

Components that are not assigned to any PartClass sheet cannot be exported into any sheet. Sheets that have no mappings entered will always be exported as empty sheets. Items like groups/parts/CCs/idents can only be mapped directly to sheets of PART_DEFINITION and PART_FILTER category. Sheet mapping can be made on different levels, such as: group/part commodity code ident code

If you map an SPRD part to a PART_DEFINITION sheet, all idents that will ever be created for this part in SPRD are automatically mapped to this sheet. If you map a commodity code, all idents that will ever be created for this commodity code in SPRD are automatically mapped to this sheet. You can only map a commodity code if the associated part is not yet mapped to the sheet.

Set-Up


If you map an item to a PART_FILTER sheet, this item will be reported (exploded) on a single ident level. Otherwise, it will be output on the commodity code level.

Attribute Mapping – Sheet dependent Sheet dependent attribute value – SPRD component relation can be defined on different levels, such as: group/part commodity ranges commodity code ident spec spec item

The deeper the level, the higher the priority. For instance, mappings in combination with a commodity part have priority over the mappings where only the commodity group is assigned.

Attribute Mapping – Sheet independent Sheet independent attribute value – SPRD component relation can be defined on different levels, such as: group/part

Set-Up


commodity ranges commodity code ident spec spec item table details

The deeper the level, the higher the priority. For instance, mappings in combination with a commodity part have priority over the mappings where only the commodity group is assigned.

Currently, the following sheet independent attributes are assigned to the Group/Part level:

BoltType BoltingRequirements GasketRequirements GasketType PartDataSource ValveOperatorCatalogPartNumber WeldingRequirement

Currently, the following sheet independent attributes are assigned to the Table Detail level:

EndPreparation (1) (2) (3) (4) EndStandard (1) (2) (3) (4) ManufacturingMethod PressureRating (1) (2) (3)

Set-Up


ValveOperatorType

Procedures You can use the SP3D 10.13 Create Procedures screen to define your own logic to be started at different events, or to view the standard procedures provided with the product. These standard procedures have the Standard indicator selected.

The procedure Type indicates the triggering event of the procedure.

Type Start at event Comment

ON_MAINT_TPL_SHT Click Execute Procs button on the SP3D 10.08 Templates screen.

Procedures can be started on clicking button on SP3D 10.08. The placeholders &TPL_ID and &SHT_ID are replaced with the actual values.

Set-Up


Type Start at event Comment ON_EXP_ROW After the standard logic filled the

row on export, before uniqueness check

Procedures fire after the standard logic filled the row on export, but before it is checked for uniqueness and written into database. So the updates to the actual row are picked up by the inventory keeping mechanism of the interface that is setting AMD indicators. Values may not be changed by UPDATE statements, but by accessing the appropriate fields in the processed array.

PRE_EXP_SHT At the FILL_IF_TABS stage of the export job

PRE indicates that the procedure is called before the processing of the specific sheet starts. The placeholders &EJ_ID, &TPL_ID and &SHT_ID are replaced with the actual values during runtime. Updates or inserts, which those procedures do to the exported sheet data of the job, are not reflected by the inventory keeping mechanism of the interface that is setting AMD indicators.

PRE_FILL_SHT At the PRE_IF_TABS stage of the export job

Procedures will run at the PRE_IF_TABS stage of an export job and can be used for example, for filling up templates data (SP3D 10.08 Templates). The placeholders

&EJ_ID, &TPL_ID and &SHT_ID are replaced with the actual values at runtime.

POST_EXP_SHT At the FILL_IF_TABS stage of the export job

POST indicates that the procedure is called after the sheet has been processed. The placeholders &EJ_ID, &TPL_ID and &SHT_ID are replaced with the actual values during runtime. Updates or inserts, which those procedures do to the exported sheet data of the job, are not reflected by the inventory keeping mechanism of the interface that is setting AMD indicators.

STANDALONE Click the Execute button on the SP3D 10.13 Create Procedures screen.

Procedures can be started on this screen by clicking the "Execute" button. There should be no placeholders that are replaced by actual values.

Set-Up


Use the Check button to validate the syntax of the procedure. Validation is also done automatically for each record during scrolling through this block. The validation result is displayed in the Check Result field. Use the Execute button to execute the selected procedure immediately. This is only possible for STANDALONE type procedures.

Sheets and Attributes Mapping You can maintain mappings between geometric tables and generic sheets on the SP3D 10.14 Sheets and Attributes Mapping screen. In the first block, you can assign a geometric table to one or more SP3D Excel sheets, independent of any sheet config. In the second block, you can see all available sheet configurations. The attribute mapping in the third block will be defined depending on the selected sheet config. The Generate Attributes button can be used for the record generation in the third block. When you click this button, the application will create one record for every available SP3D attribute of the selected sheet. Only the attributes that are not part of the unique key defined on SP3D 10.07 Sheet Configs will be considered, which means only output attributes are considered. If an SP3D attribute is already mapped, it will be not used during record generation. This means existing records will not be overwritten. The Table Attribute field will remain empty; it has to be filled manually using the LOV. When the name of the SP3D attribute matches the name of the table attribute, the application will assign the SP3D attribute to this table attribute automatically.

Only generic sheets can be assigned to the geometric tables; the LOV on the Sheet field is restricted to sheets marked as generic.

Set-Up


Add, Find and Replace Setup The Add, Find and Replace feature enables you to view the data that will be exported and to make changes to the data by adding filters and replacement values before it is exported. In addition, this feature allows you to manually add records or comment out records. This functionality is available for the retrieval methods TEMPLATE_COPY, TABLE_DETAILS, and SHT_STND_METHOD. Furthermore, this functionality is only available if the sheet is configured on the SP3D 10.07 Sheet Configs screen with the Extended Customization check box selected. The purpose of the SP3D 10.15 Add, Find and Replace screen is to allow the user to view and modify the data in the sheet(s) before they are finally exported. This screen, when called from SP3D 20.01 Export Jobs, shows the user the data from a selected sheet being exported. Here, the user can define certain filters for this sheet to retrieve only the required data on which modifications need to be done. The user can also see the results of every filter after it may be applied. On the filtered data, the specified replacement values replace the actual values.

The Use in Filter button in the Data based on Sheet block copies the selected record as a filter to the Filters block. The Apply Filter button applies the filter to the data in the Data based on Sheet block and shows the results in the Results block. The replacement values must be entered in the Replacement Information block as required.

Set-Up


To comment out an entry in the Excel sheet during the SP3D export process, you must enter the value ‘!’ in the Action field in the Replacement Information block. This special character (!) will be shown in the Head column to indicate that the corresponding record is commented out in the exported Excel sheet.

Records with ‘!’ in the Action column will not be considered for uniqueness verification. No check will be performed against the existing inventory. These records will be shown in the generated Excel sheet but will not be inserted into the inventory. The second (Manual Data) tab can be used to manually add records to sheets that cannot be created by any other function. When exporting to Excel or completing the job, this manually entered data is appended to the sheet. The manual records will be considered for uniqueness verification and against the existing inventory. The manual records will be stored in the inventory. The find and replace functionality is not applicable on the manual data. The general config items listed below must be set on SP3D 10.01 General Configs. MANUAL_IDENT_CODE MANUAL_SPEC_CODE MANUAL_SPEC_ITEMS

The assigned values will be used as dummy values when creating manual data. You do not have to be concerned with this data (ident code, spec code, spec item) when entering the manual data, but the database requires the data because the corresponding columns are mandatory. To add the manual data, open the SP3D 10.15 Add, Find and Replace screen, select the Sheet Config and the Sheet in the first block and click the Manual Data tab. Now enter the records to be added to the selected sheet as displayed in the picture below.

Creating the sheet during the export job appends the manually added records to the sheet.

Set-Up


The manually added records are displayed with a light blue background color on window 3 of SP3D 20.01 (click the Results button and then select the sheet on window 2).

When filters and replacement values are defined for all required sheets, proceed with the export job. To use this Add, Find and Replace functionality during an export job, you must select the Extended Customization check box on the SP3D 10.07 Sheet Configs screen for all the sheets whose data needs to be viewed or modified before final export. This screen, when called from the menu directly, shows only the related filters and replacement values.

General Configs The General Configs consist of a set of parameters that must be set to control the behavior of the reference data transfer to SmartPlant 3D, launched from SP3D 20.01 Export Jobs.

The General Configs are maintained on the SP3D 10.01 General Configs screen. The standard config 1ST is delivered with the product. The general configs are project dependent. Copying a config will copy the set including all config items with its values. To set a value, it must be activated

Set-Up


by selecting the Activate check box. It’s recommended to create one general config as a company standard. With the general config, you control general settings for SP3D export jobs, for example:

AUTO_SELECT_SHTS_FOR_PARTS

Fill the assigned part class sheets into the job sheet selection, if the related commodity codes were selected?

If set to ‘Y’, the assigned part class sheets as defined on SP3D 10.02 Sheets are filled automatically with the commodity codes from the selected specification(s) during the export job.

If set to ‘N’, you must select the commodity group, part and/or codes manually when defining an export job on SP3D 20.01 Export Jobs, Selected Idents tab.

The purpose of all config items is described in the comment field next to the item name, and in Appendix B at the end of this document.

Transfer Types Transfer Types are pre-defined sets of sheets that will be exported via SP3D 20.01 Export Jobs in a transfer run. The set-up of transfer types allows the definition of multiple sets of sheets for diverse purposes, like codelists, generic sheets, or catalog data sheets. For the export job, the user must assign only the pre-defined Transfer Type instead of specifying the sheets manually. The Transfer Types are project dependent and are maintained on the SP3D 10.06 Transfer Types screen. Even if the transfer type includes CODE_LIST sheets and other sheets, the system will generate two workbooks, one for CODE_LIST sheets and the other for the remaining sheets, because SP3D requires that codelists be loaded separate from the other sheets.

If the Sheets fixed check box is selected, the set of sheets copied from the transfer type will be protected against changes on SP3D 20.01. Transfer types delivered with the product are marked with the Standard indicator and cannot be changed. The available standard transfer types are listed below.

Set-Up


ALL_CODE_LISTS All codelists (originally imported from AllCodelist.xls)

ALL_COMMON The sheets from the AllCommon.xls workbook

ALL_PIPING_N_GENERIC

All piping and generic sheets

ALL_P_N_G_WO_CDLST All piping and generic sheets, but no codelists

PIPING_CATALOG The sheets from the PipingCatalog.xls workbook

PIPING_SPEC_WBK The sheets from the PipingSpecification.xls workbook

SPEC_ITEM_CHANGE Spec item changed, which sheets should be transferred in this case?

TEN_SPECS_CATALOG The sheets from the Ten_Specs_CatalogData.xls workbook

TEN_SPECS_SPECS The sheets from the Ten_Specs_SpecificationData.xls workbook

Destinations and Structures SmartPlant Reference Data can be used to serve multiple SP3D catalog databases. To keep track of what was transferred to which SP3D instance, and to enable incremental (delta) transfers, each transfer job is assigned to a particular destination. These destinations represent the SP3D catalog databases with its specific connection information, like the catalog server, catalog schema server, catalog database and the catalog schema database. The destinations are defined on the SP3D 10.05 Destinations screen.

The fields in the first (Export Destinations) block are listed below.

Set-Up


Field Description

Destination The name of the export destination, which will be assigned to the export job on SP3D 20.01 Export Jobs

Catalog Server The node/machine where the catalog database is running

Catalog Schema Server

The node/machine where the catalog schema database is running

Catalog DB The container for the reference data which is supplied by SPRD

Catalog Schema DB The container for the schema data which is supplied by SPRD, like custom attributes and codelists

Run CIP Default for the Run CIP check box for all transfer jobs created for this destination.

Comment Enter a comment or description for the destination.

You can use the button to copy manual destination data from one destination to another. Select the target destination to which the manual data should be copied and click the button to display the copy dialog box.

Open the LOV in the Source Destination field and select the source destination from which you want to copy the manual destination data. Click the Copy button to close the copy window and to copy the manual data from the selected destination to the target destination. The structure that is assigned to the destination in the second block must be defined on the SP3D 10.09 Catalog Structures screen. The catalog structure is a tree view of the data, reflecting the hierarchy within the SP3D catalog. For different disciplines and for different SP3D catalogs/installations, you might have different catalog structures.

Set-Up


Each end node element in a catalog structure can have one or more sheets attached.

Set-Up


This structure is used on SP3D 20.02 Destination Data to display the inventory data per destination. The inventory reflects the status of the reference data transferred to the SP3D destination. Based on the inventory data, the transfer jobs indicate data as added, modified, or deleted compared to previous jobs.

The symbol in the tree view indicates an existing sheet. A right-click on a sheet name opens this menu:

Selecting ‘Expand All’ from any node will expand the selected node and all sub-nodes. The options ‘Show Sheet Data’ and ‘Show Sheet Definition Attributes’ are described below under list view.

Set-Up


Instead of using the tree view to display the sheets, you can open the flat list view folder on window 2 by clicking the LIST tab.

A right-click on a sheet name in the list view opens a menu.

Selecting ‘Show Sheet Data’ from the tree or list menu or a mouse double-click on the sheet name opens window 2 displaying all details of the sheet.

Here you can manually change values or add missing values. After saving the changes, re-query the data. All changed or added values will be highlighted with a red background color as shown in the example above for the Sort Order values. When starting a new export job run for this destination, all these manual modifications will be applied in the FILL_IF_TABS stage. For further details, read the "Job Results" section in Transfer to SP3D (on page 61).

Set-Up


Selecting ‘Show Sheet Definition Attributes’ from the menu opens window 3 displaying the attribute definitions for the selected sheet.

Generic Sheets Set the general config item AUTO_SELECT_GENERIC_SHEETS to Y on SP3D 10.01 General Configs. This enables adding the generic sheets automatically in case the short codes are associated with the spec code/spec items that are assigned to the generic sheets. Generic data will be generated only for idents specified on the SP3D 20.01 Export Jobs screen, Selected Idents tab. The selected Generic check box indicates a generic sheet. You can find this check box on the SP3D 10.02 Sheets, SP3D 10.07 Sheet Configs, SP3D 10.08 Templates, and SP3D 20.01 Export Jobs screens. Use the SP3D 10.02 Sheets screen to mark sheets as generic. The templates for all generic sheets will be created by the new procedure FILL_GENERIC_TEMPLATE_SHEET as described under SP3D 10.13 Create Procedures. Known generic sheets are:

PipingGenericDataBolted PipingGenericDataFemale PipingGenericDataMechanical PlainPipingGenericData BoltExtension

Set-Up


DINWallThicknessData

You can assign generic sheets to short codes on S.10.08 Short Codes screen window 2 on the Sheets to Short Codes tab.

The attributes of generic sheets have to be distinguished in commodity attributes, ident forming attributes (input), and other ident attributes (output). For each category, a specific functionality was implemented. This is described in detail below.

Commodity Attributes To map commodity code properties to specific SP3D attributes/sheet columns, you must define the SP3D Interface table translations on the A.50.I.01 Interface Tables screen for commodity attribute tables, for example:

SP3D Attribute Translation

EndPreparation ENDP

EndStandard ENDS

PressureRating PRAT

GeometricIndustryStandard GMIS

Set-Up


The translation can be extended by a sequential number. The pictures below show examples.

The value of the EndPreparation, EndStandard, PressureRating, and GeometricIndustryStandard codelist will be fetched from an attribute assigned to the commodity code property.

The picture above displays the attribute definition for a commodity attribute table by means of the example ENDSTANDARD.

Set-Up


The picture above shows the S.20.02 Tablenames with Details screen, displaying the table ENDSTANDARD and its details, including the attribute Codelist_Number. To map this attribute to the corresponding SP3D attribute use the A.50.I.02 Interface Attributes screen. The SP3D Interface attribute translations must be defined as displayed below:

SP3D Attribute Translation

EndPreparation ENDP

EndStandard ENDS

PressureRating PRAT

GeometricIndustryStandard GMIS

Set-Up


The translation can be extended by a sequential number. The pictures below show examples:

If only one attribute is assigned to the commodity attribute table you need not to define the attribute translation. The transfer procedure will automatically select this attribute.

Ident Forming Attributes (Input) The values of Ident Attributes, which are used to build the idents and consequently are part of the unique key (defined on SP3D 10.07), will be automatically identified on the basis of the object parameter details as defined on S.10.05 Object Parameter Details.

SP3D Attribute Kind of Detail

NominalPipingDiameter 1. /2. Nominal Size

Schedule 1. /2. Schedule

NominalDiameterUnits Unit of 1. /2. Nominal Size

Set-Up


Other Ident Attributes (Output) You can maintain mapping between geometric tables and generic sheets on the SP3D 10.14 Sheets and Attributes Mapping screen.

In the first (Sheets Mapping) block, you can assign a geometric table to one or more SP3D Excel sheets, independent of any sheet config. In the second (Sheet Configs) block, you can see all available sheet configs. The attribute mapping in the third (Attributes Mapping) block will be defined depending on the selected sheet config. The Generate Attributes button can be used for the record generation in the third block. When you click this button, the application will create one record for every available SP3D attribute of the selected sheet. Only the attributes that are not part of the unique key defined on SP3D 10.07 Sheet Configs will be considered, which means only output attributes are considered. If an SP3D attribute is already mapped, it will be not used during the record generation. That means existing records will not be overwritten. The Table Attribute field will remain empty; it must be filled manually using the LOV. When the name of the SP3D attribute matches the name of the table attribute, the application will assign the SP3D attribute to this table attribute automatically.

Set-Up


Only generic sheets can be assigned to the geometric tables; the LOV on the Sheet field is restricted to sheets marked as generic.

Procedure FILL_GENERIC_TEMPLATE_SHEET The standard procedure FILL_GENERIC_TEMPLATE_SHEET can be used to prepare the template data for generic sheets. The procedure is of type PRE_FILL_SHT.

The procedures of type PRE_FILL_SHT will be started before the FILL_IF_TABS stage and can be used, for example, for filling up template data (SP3D 10.08 Templates). The placeholders &EJ_ID, &TPL_ID and &SHT_ID are replaced with the actual values at runtime. The procedure FILL_GENERIC_TEMPLATE_SHEET must be assigned to the generic sheets on the SP3D 10.07 Sheet Configs screen, Attached Procedures tab in order to use this enhancement. Template data for generic sheets will be prepared by this procedure.

General Config Settings To activate the above described functionality for generic sheets, you must set two config items on the SP3D 10.01 General Configs screen. The config item AUTO_SELECT_GENERIC_SHEETS specifies if generic sheets will be added to the job automatically. If set to N, the generic sheets will not be added automatically. The user is responsible for adding generic sheets manually or using the appropriative transfer type. If set to Y, the generic sheets associated with the short codes assigned to the spec code/spec items will be added automatically. The config item EXPORT_PRE_IF_TABLES_STOP specifies the job behavior when the stage PRE_ IF_TABS_DONE is reached; it controls whether the export job, having generic sheets assigned, will stop processing. Generic sheets will be created or modified in the templates first. When the template sheet is completed, it will be copied over. The selectable options for this config item are:

Set-Up


STOP_ERROR – The job will stop execution when reaching the PRE_ IF_TABS_DONE stage and only when a data consistency error occurs. For example, empty mandatory fields on SP3D 10.08 Templates would cause such an error.

STOP_ALWAYS – The job will stop execution every time the PRE_ IF_TABS_DONE stage is reached.

STOP_NEVER – The job will continue execution up to the current job goal without stopping at the PRE_ IF_TABS_DONE stage, even if data errors occur.

Transfer Job When running a job with config item EXPORT_PRE_IF_TABLES_STOP set to STOP_ERROR or STOP_ALWAYS, the following message appears:

Acknowledge this message with Yes to open window 5. It will display the generated templates with their status. If the Error check box is selected, it means that the data is inconsistent.

A double-click on the sheet in window 5 will open SP3D 10.08 Templates, which displays the generated sheet with its data. Using the option Show incomplete records on SP3D 10.08 will help you to quickly find errors in the configuration. A double-click on the sheet in folder Selected Sheets of SP3D 20.01 Export Jobs will open SP3D 10.08 Templates for all generic sheets. For other sheet categories, a message is displayed.

With config item AUTO_SELECT_GENERIC_SHEETS set to Y, the job validation produces a new log file. The name of the log file is composed as the log files for the other job stages, but the string VALIDATE_JOB is used instead of the stage name. As usual, the log file can be opened in the tab Logfiles.

Set-Up


Gaskets, Nuts, and Washers SmartPlant 3D requires the following for gaskets, nuts, and washers: The Gasket Thickness should be part of the gasket Commodity Code on the sheets

GasketPartData, PipingCommodityMatlControlData and PipingCommodityProcurementData.

The Bolt Diameter and Nut Height should be part of the bolt Commodity Code on the sheets NutPartData and PipingCommodityMatlControlData.

The Bolt Diameter and Washer Thickness should be part of the washer Commodity Code on the sheets WasherPartData and PipingCommodityMatlControlData.

For the export of gaskets, nuts, and washers from SPRD, the values described above must be appended to the Commodity Codes in the appropriate sheets separated by an underscore. This behavior is controlled by the general config items TRANS_CC_GASKET (for gaskets), TRANS_CC_NUT (for nuts), and TRANS_CC_WASHER (for washers). These config items are defined in SP3D 10.01 General Configs, and the items are listed in Appendix B at the end of this document, with a description and the available values. The purpose of the config items is described in the comment field next to the item name. The logic of appending the values to the gasket, nut, and washer commodity code is implemented in the CIP function m_pck_sp3d_custom.get_trans_cc_gnw. This function is set as the Retrieval Source for the attributes: IndustryCommodityCode of the sheets GasketPartData, NutPartData, and

WasherPartData ContractorCommodityCode of the sheet PipingCommodityMatlControlData CommodityCode of the sheet PipingCommodityProcurementData

The new commodity code with appended values will be stored as a company ident assigned to the company defined by project default ZI_SP3D_CO, so that during BOM import specifying the company, the BOM data can be imported into SPRD. The logic of building company idents for gasket, nut, and washer part data sheets is implemented in the CIP function m_pck_sp3d_custom.set_catalog_part_number.

Gaskets Set the config item TRANS_CC_GASKET to YES to apply the logic described above when exporting the GasketPartData sheet or part filter sheets PipingCommodityMatlControlData and PipingCommodityProcurementData.

GasketPartData If the config item PD_GASKET_TRANS_LEVEL is set to IDENT, the Commodity Code is appended with the gasket thickness value, separated by an underscore. The gasket thickness value will be fetched from the Ident input_2.

PipingCommodityMatlControlData and PipingCommodityProcurementData If the config item PF_TRANSLATION_LEVEL is set to IDENT or CC_OR_IDENT, the values to be appended to the gasket commodity codes are to be fetched from the Ident inputs. When the config item is set to CC_OR_IDENT, this new logic will apply only to the records at Ident level. The gasket commodity codes will be identified by the assignment of parts to the GasketPartData sheet on the SP3D 10.04 Item Mappings screen.

Set-Up


Nuts Set the config item TRANS_CC_NUT to YES to apply the logic described above when exporting the NutPartData sheet or the part filter sheet PipingCommodityMatlControlData.

NutPartData If the config item PD_NUT_TRANS_LEVEL is set to IDENT, the Commodity Code is appended with the bolt diameter and the nut height values, separated by an underscore. The bolt diameter and the nut height values will be fetched from the Ident input_1 (bolt diameter) and input_2 (nut height).

PipingCommodityMatlControlData If the config item PF_TRANSLATION_LEVEL is set to IDENT or CC_OR_IDENT, the values to be appended to the nut commodity codes are to be fetched from the Ident inputs. When the config item is set to CC_OR_IDENT, this new logic will apply only to the records at Ident level. The nut commodity codes will be identified by the assignment of parts to the NutPartData sheet in the SP3D 10.04 Item Mappings screen.

Washers Set the config item TRANS_CC_WASHER to YES to apply the logic described above when exporting the WasherPartData sheet or part filter sheet PipingCommodityMatlControlData.

WasherPartData If the config item PD_WASHER_TRANS_LEVEL is set to IDENT, the Commodity Code is appended with the bolt diameter and the washer thickness values, separated by an underscore. The bolt diameter and the washer thickness values will be fetched from the Ident input_1 (bolt diameter) and input_2 (washer thickness).

PipingCommodityMatlControlData If the config item PF_TRANSLATION_LEVEL is set to IDENT or CC_OR_IDENT, the values to be appended to the washer commodity codes are to be fetched from the Ident inputs. When the config item is set to CC_OR_IDENT, this new logic will apply only to the records at Ident level. The washer commodity codes will be identified by the assignment of parts to the WasherPartData sheet on the SP3D 10.04 Item Mappings screen.

Codelists To ensure consistency between codelists and part classes, the codelists should be generated during the export using the table groups and table details of the commodity attribute tables instead of SP3D templates. For this purpose, you can use the retrieval method TABLE_DETAILS on the SP3D 10.07 Sheet Configs screen. For mapping of sheet attributes to SPRD database columns, two methods are supported: ‘Mapping using table groups and table details’ and ‘Mapping using table details’.

Set-Up


Mapping using Table Groups and Table Details The PressureRating sheet displayed in the picture below will be used as an example of the table group/detail method.

The RatingPractice ShortDescription and LongDescription values are fetched from the table group short desc/description and the corresponding codelist number from the attribute CODELIST_NUMBER1, which is assigned to the table group attr_num1. See the picture below. The table group is considered as level 1.

Set-Up


The PressureRating ShortDescription and LongDescription values are fetched from the table detail short desc/description and the corresponding codelist number from the attribute CODELIST_NUMBER, which is assigned to the table detail attr_num1. See the picture below. The table detail is considered as level 0.

Mapping using Table Details The EndPreparation sheet displayed in the picture below will be used as an example of the table detail method.

Because the codelist data will be fetched from table details of one commodity attribute table, the hierarchy (level structure) must be defined using the Parent Table Details field on the S.20.02 Tablenames with Details screen. The EndPreparation ShortDescription and LongDescription values are fetched from the table detail short desc/description and the corresponding codelist number from the attribute Codelist_Number, which is assigned to the table detail attr_num1. In our example, the table details AA, AB, AC, AD with parent table detail XA (Flanged) assigned are considered as the lowest level 0 (zero) because the table details are not assigned as the parent table detail to other table details.

The TerminationSubClass ShortDescription and LongDescription values are fetched from the table detail short desc/description and the corresponding codelist number from the attribute

Set-Up


Codelist_Number. The table details XA, XB with parent table detail YA (Bolted) assigned are considered as level 1. The TerminationClass ShortDescription and LongDescription values are fetched from the table detail short desc/description and the corresponding codelist number from the attribute Codelist_Number. This table detail does not have a parent table detail assigned, so it is considered as the highest level 2.

Sheet Configs The retrieval method for the codelist sheets must be defined on the SP3D 10.07 Sheet Configs screen as TABLE_DETAILS. The picture below shows the example for the PressureRating sheet.

Select the commodity attribute table, which is used to hold the relevant data, from the LOV in the Source field. The Extended Customization indicator is automatically checked when TABLE_DETAILS is selected as the retrieval method. Next, define the retrieval methods for the assigned sheet attributes on the Attributes tab.

Select the retrieval method BASE_COLUMN from the dropdown list in the Retrieval Method field for all sheet attributes except for Sort Order. The retrieval method for the Sort Order attribute must be kept as NONE; this attribute will be used internally by the export procedure to sort the records. Select the appropriate column for each attribute from the LOV in the Source field. In our example of the PRESSURERATING table, the RatingPractice ShortDescription and LongDescription values are fetched from the table group short desc/description. The PressureRating ShortDescription and LongDescription are fetched from the table detail short desc/description. The corresponding codelist numbers are fetched from the attributes assigned to the table group/table detail attr_num1.

The codelist number attributes on table group and table detail level must be assigned to the same physical attribute, TG.NUM1 and TD.NUM1, or TG.NUM2 and TD.NUM2, or TG.NUM3 and TD.NUM3.

Set-Up


To complete the sheet attribute definition, set the level for each attribute except ‘Codelist Number’ and ‘Sort Order’ in the Level field.

In our example, the PressureRating descriptions are defined as table details on the lowest level, which is 0 (zero). The RatingPractice descriptions are defined as table groups on the next level 1. Finally, enter 1 in the Order by field for attribute ‘Sort Order’. The picture below displays the sheet attribute definitions for the example of the EndPreparation sheet.

Since all attributes except ‘Codelist Number’ and ‘Sort Order’ are mapped to table details, the column to be selected from the LOV in the Source field is either TDN.SHORT_DESC for the ShortDescription attributes or TDN.DESCRIPTION for the LongDescription attributes. The corresponding codelist numbers are fetched from the attribute assigned to the table detail attr_num1. The level must be entered in the Level field according to the hierarchy definition as explained above. The value 1 must be entered in the Order by field for attribute ‘Sort Order’.

Restrictions The maximum hierarchy level supported by the retrieval method ‘TABLE_DETAILS’ is 7. The new retrieval method ‘TABLE_DETAILS’ supports only sheets of category ‘CODE_LIST’. The procedures of type ‘POST_EXP_SHT’ and ‘PRE_EXP_SHT’ will be available for this

retrieval process.


The data maintained on S.50.06 Specification Management screen will be used to export to SP3D.

Sheet Origin

ServiceLimits Spec Limits

PipeNominalDiameters Nominal Sizes

PipeBranch Branch Table

PipingCommodityFilter Will automatically be generated.

PipingMaterialClassData Will automatically be generated.

BoltSelectionFilter GasketSelectionFilter NutSelectionFilter WasherSelectionFilter

Need to be maintained via SP3D 10.08 Templates.

BendAngles CorrosionAllowance InsideSurfaceTreatment JointQualityFactor PermissibleTaps PipeTakedownParts

Depend on customer requirements.

Mappings Right-clicking the Spec Code field on S.50.06 Specification Management or the Short Code field on window 2 opens a menu.

Spec Preparation for Export



Select SP3D Mappings to open the SP3D 30.02 Spec Mappings screen.

Existing mappings for the current spec are displayed, and further spec item mappings are shown when the screen is called from S.50.06 window 2. You can maintain these mappings or define new spec related mappings, instead of doing it on SP3D 10.04 Item Mappings. The mappings defined on SP3D 30.02 are stored under the Item Mapping which is assigned to project default ZI_SP3D_IM. You can see the result on SP3D 10.04 on the Sheet Dependent tab, Attribute Mapping sub-tab, at the Spec and Spec Items tabs.



Short Codes

Right-clicking the Short Code field on S.50.06 window 2 opens a menu. Select SP3D Short Codes to open a new window that allows you to assign SP3D Short Codes to the selected spec item by means of a list of values.



Templates

Right-clicking the Spec Code field on S.50.06 opens a menu. Select SP3D Templates to open the SP3D 10.08 Templates screen.

Click the Execute Procs button in the first (Templates) block to run all procedures assigned to any sheet of the selected template. The Execute Procs button in the second (Sheets) block executes the procedures assigned to the selected sheet. For the details of the procedures, refer to Procedures (on page 28) (SP3D 10.13 Create Procedures) and Sheet Configs – Attached Procedures (see "Attached Procedures" on page 22) (SP3D 10.07 Sheet Configs).



Click the Fill Spec Rule Sheets button to start the generation of data for the selected sheet.

Acknowledge with Yes to start the procedure M_PCK_SP3D_CUSTOM.FILL_SPEC_RULE_SHEETS. This procedure will generate spec rule sheet data for the current spec and the selected sheet. Currently, it covers the sheets NutSelectionFilter, BoltSelectionFilter, GasketSelectionFilter, and WasherSelectionFilter. This procedure can easily be extended to create data for other spec rule sheets.

Click the Copy from Spec button to copy sheet dependent data definition from another spec to the current spec. Clicking this button will open a small window where you can select the source spec and start copying the template data by clicking the Copy button.

The Copy from Spec button is only enabled when the Standard indicator of the template is not checked, and the cursor is positioned on a template sheet of the SPEC_RULE category.


The user starts a transfer job in SPRD, which writes selected data to interface tables. The data can be modified there. Afterwards, the system creates Microsoft Excel workbooks from the interface table data. These workbooks can be downloaded and bulkloaded into SP3D.

Export Job Creation To define and maintain transfer jobs, use the SP3D 20.01 Export Jobs screen. The jobs are used to generate the workbooks with sheets for SP3D bulkloading. To create a new export job, press the F6 function key or click the New Record icon . All mandatory fields are displayed with a green background color.

The following fields must be filled to create a new export job:

Job The job name identifies the job.

Destination Open the LOV on the Destination field by pressing the F9 function key or clicking the LOV icon to select a destination. The destination identifies the target SP3D catalog database that should be populated with SPRD data. The LOV will display all pre-defined destinations from the SP3D 10.05 Destinations screen.

Transfer to SP3D

Transfer to SP3D


Transfer Type

Open the LOV on the Transfer Type field by pressing the F9 function key or clicking the LOV icon to select a transfer type. The transfer type determines the sheets that should be generated by the export job. The LOV will display all pre-defined transfer types from the SP3D 10.06 Transfer Types screen. When saving the new export job, the message in the above screenshot appears. This message must be acknowledged with Yes to copy the sheets from the selected transfer type to the Selected Sheets tab in the second block. To activate this functionality, the general config setting AUTO_SELECT_SHTS_FOR_PARTS must be set to ‘Y’ in SP3D 10.01 General Configs, for the general config that is assigned to the export job.

If you select a transfer type that is defined with fixed sheets, the related sheets must be copied, or the selection/update will not be accepted. After insertion of these fixed sheets, you will not be able to use the Delete Selection button, or add or remove sheets manually for the job. Additionally, the automatic selection features that may be configured in SP3D 10.01 to fire at export job validation time, will not change a set of sheets if a ‘Sheets fixed’ transfer type is used.

To export US Specifications, Transfer Type SDB_PIPING_SPEC_WBK should be used. If part class sheets are not automatically exported with the specification, Transfer Type SDB_SIX_SPEC_CATALOG should be used for part data. To export DIN Specifications, Transfer Type SDB_DIN_ALL_WO_CDL should be used.

Bulkload Method

Select a bulkload method from the combo box. These options are available:

NEW – Creates a new catalog.

DELETE_AND_REPLACE – Erases the old catalog data of the sheet in process and inserts new data.

ADD_MODIFY_DELETE - This bulkload mode compares the data in process to the data previously exported. If a line is new, altered or no longer there, the appropriate flags A (added), M (modified) and D (deleted) are set in the sheets in the first column of each row, to be interpreted by the SP3D bulkload utility

It is recommended to always use the ADD_MODIFY_DELETE bulkload method.

Transfer to SP3D


Job Goal Each job has multiple process stages that describe the level of completeness. These stages are related to distinct tasks. The job goal defines to which stage the job should run.

Job Goal Stage Stage Description NO_STAGE Export Job was not yet started

PRE_IF_TABS PRE_IF_TABS_DONE

The interface temporary tables are filled with data when Extended Customization checkbox is ticked in SP3D 10.07 Sheet Configs. The user can view the data in the SP3D 10.15 Find and Replace screen. Here the user can apply filters and add replacement values on these data.

The generic sheet templates are created.

FILL_IF_TABS IF_TABS_FILLED The interface tables are filled

VERIFY_CSTCY

CSTCY_VERIFIED The data consistency is verified

WRITE_XLS XLS_WRITTEN Write the contents of the interface tables into XLS files (and load them into SP3D)

BULKLOAD BULKLOAD_DONE Bulkload the workbooks into SP3D

ANALYZE_LOG

LOG_ANALYZED Analyze the Bulkload log file to inform SPRD which lines were loaded, which were skipped

VERIFY_SP3D SP3D_VERIFIED Verify the catalog within SP3D

IMP_GUIDS GUIDS_IMPORTED Load the GUIDs back to SPRD

COMPLETE_JOB

JOB_COMPLETE Synchronize the SPRD inventory of SP3D with the data produced by the actual job

Config Open the LOV on the Config field by pressing the F9 function key or clicking the LOV icon to select a general config. With the assignment of a general config, a list of defaults is defined and general settings for an export job are made, which will control its behavior. The LOV will display all pre-defined general configs from the SP3D 10.01 General Configs screen.

Transfer to SP3D


Item Mapping

Open the LOV on the Item Mapping field by pressing the F9 function key or clicking the LOV icon to select an item mapping set. With the assignment of an item mapping set, the relations between sheets/sheet attributes and assigned groups/parts/commodity codes/idents are established. The LOV will display all pre-defined item mappings from the SP3D 10.04 Item Mappings screen.

With the assignment of the item mapping, the template linked to the item mapping is automatically filled in, and further the sheet config that is linked to the template.

Currently, there are two item mapping configurations available; SDB_ITEM_MAPPING is used by ASME components and SDB_DIN_MAPPING by DIN components.

Template The template that is linked to the item mapping is automatically filled in when selecting the item mapping. If you want to select a different template, use the LOV on the Template field by pressing the F9 function key or clicking the LOV icon . With the assignment of a template, you identify the sheets that will be filled by the transfer procedure by simply copying the data from the template. The LOV will display all pre-defined templates from the SP3D 10.08 Templates screen.

The template SDB_TEMPLATE is updated with the codelists used in the extraction of datasheets for SP3D. The template SDB_DIN_TEMPLATE must be chosen when the export job is for DIN components.

Sheet Config The sheet config cannot be assigned to an export job directly; the sheet config that is linked to the template is automatically filled in when selecting the item mapping or when changing the template. The details of sheet configs are defined on the SP3D 10.07 Sheet Configs screen.

When saving the new export job definition, the message below appears.

Transfer to SP3D


When this message is acknowledged with Yes, the sheets assigned to the selected transfer type will be populated and displayed on the Selected Sheets tab in the second block. To activate this functionality, the general config setting AUTO_SELECT_SHTS_FOR_PARTS must be set to ‘Y’.

Sheets can be added manually by creating a new record by pressing the F6 function key or clicking the New Record icon and selecting a sheet from the LOV. Assigned sheets can be deleted by pressing Shift + F6 or clicking the Delete icon . The Delete Selection button will remove all selected sheets from the job. When the scope of the export job should cover spec dependent data, you must select the specifications to be transferred to SP3D. Use the Insert Specs button on the Selected Spec Items tab to insert all specs of the current project. Or, select specs manually using the LOV on the Spec Code field. The Delete Selection button will remove all selected specs from the job.

Transfer to SP3D


The Validate Job button starts the validation of the data the job is based on.

Additionally, if the job was not yet started and the job stage is NO_STAGE, some data is added as requested: 1. It fills the Selected Idents tab with commodity codes from the selected spec items. This only

takes place if the general config item AUTO_SELECT_IDENTS_FROM_SPEC is not set to NO_SELECTION.

2. It fills the CustomInterfaces sheet to the selected sheets tab. This only takes place if the SP3D config item AUTO_SELECT_CUST_INTF_FOR_PART_DEFS is set to Y, and the sheet selection already contains PartClasses, and CustomInterfaces is not yet selected.

Click the Delete Selection button to remove all selected idents from the job. The progress of the validation is displayed on the Progress tab:

Transfer to SP3D


Export Job Execution The Start Job button starts the execution of the transfer job in online mode. The same validation done when clicking the Validate Job button is performed prior to starting the transfer. A message must be acknowledged with OK to launch the transfer job.

The progress of the job execution is displayed on the Progress tab as shown above. The status of a job is shown in the Status field; possible values are:

Status Description

NEW New export job, not yet started.

RUNNING Export job was started and is still running.

ERROR Export job was aborted due to an error. When the cause of error is cleared, the job can be started again with Start Job.

CANCELED Export job was canceled by the user with Cancel Job button.

STAGE_FINISHED Export job has reached the defined job goal. To re-start the job, select a higher job goal and click the Start Job button.

JOB_FINISHED Export job successfully completed. The stage of a job is shown in the Stage field; the possible values are listed below.

Stage Stage Description

NO_STAGE Export Job was not yet started.

PRE_IF_TABS_DONE The interface temporary tables are filled with data when the Extended Customization check box is selected on SP3D 10.07 Sheet Configs. The user can view the data on the SP3D 10.15 Find and Replace screen. Here the user can apply filters and add replacement values on the data.

The generic sheet templates are created.

IF_TABS_FILLED The interface tables are filled.

CSTCY_VERIFIED The data consistency is verified.

Transfer to SP3D


XLS_WRITTEN Write the contents of the interface tables into XLS files (and load them into SP3D).

BULKLOAD_DONE Bulkload the workbooks into SP3D.

LOG_ANALYZED Analyze the Bulkload log file to inform SPRD which lines were loaded and which were skipped.

SP3D_VERIFIED Verify the catalog within SP3D.

GUIDS_IMPORTED Load the GUIDs back to SPRD.

JOB_COMPLETE Synchronize the SPRD inventory of SP3D with the data produced by the actual job.

Job Results When the export job was stopped due to an error or finished, click the Show Results button (or double-click the job code) to open the next window, which displays the output data of the job. If the export job has passed the FILL_IF_TABS stage, you can manually update the destination created by the job. This manually modified data will be considered by the next export job run.

The symbol in the tree view indicates an existing sheet. A right-click on a sheet name opens a menu:

Selecting ‘Expand All’ from any node will expand the selected node and all sub-nodes.

Transfer to SP3D


Selecting ‘Show Sheet Data’ from the menu or a double-click on the sheet name opens window 3 displaying all details of the sheet.

Here you can manually change values created by the job or add missing values. After saving the changes, re-query the data. All changed or added values will be highlighted with a red background color as shown in the example above for the Flange Thickness values. When all manual modifications are done, cancel the job in window 1, create a new run, and start this new job to apply these manual modifications in the FILL_IF_TABS stage. It will copy the changed data to the interface tables. After that new run, the manual modifications will be displayed with a green background color to indicate that the values were manually entered/changed and transferred to SP3D. You can also do the modifications on the SP3D 20.02 Destination Data screen. The manual changes will then be considered in the next export job run. Modifications are only allowed on the non-unique key columns. If no unique key is defined for the sheet, then update of none of the columns is allowed.

Manual modifications are indicated by a different background color. Manually updated data that is not yet copied to the interface tables is indicated by the RED color, and the manual changes that were copied by the previous export job run are indicated by the GREEN color. Selecting ‘Show Sheet Definition Attributes’ from the menu opens window 4 displaying the attribute definitions for the selected sheet.

Transfer to SP3D


Instead of using the tree view to display the sheets, you can open the flat list view folder on window 2 by clicking the LIST tab.

A right-click on a sheet name in the list view opens a menu.

Selecting ‘Show Sheet Data’ from the menu or a double-click on the sheet name opens window 3 displaying all details of the sheet, as described above. Selecting ‘Show Sheet Definition Attributes’ from the menu opens window 4 displaying the attribute definitions for the selected sheet, as described above.

Logfiles All actions done during job execution are logged in multiple protocols, and each stage of the export job creates a separate logfile. The Logfiles tab shows all logfiles created during the transfer job. The logfile names consist of the string ‘SP3D_EJ_’ followed by the job_id formatted with leading zeros, the stage, and a logfile_id. The job_id is the internal identifier of the export job combined with the run number. The logfile_id is a sequence number. Double-click the file name to open and display the logfile. Or, retrieve the files from the log file directory, defined with DBA setting LOG_FILE_DEST or project default ZX_MAR_LOG.

Workbooks An export job may produce one or more Excel workbooks during the process. For example, for codelists, a separate workbook is created. The Workbooks tab shows all Excel workbooks created during the transfer job. The workbook names consist of the string ‘SP3D_EJ_’ followed by the job_id formatted with leading zeros. Next, information about the data in the workbook is displayed: CDLST indicates the workbook contains codelists, OTHER workbooks contain all other sheets of the current run. GUIDS is the workbook that was uploaded from the client containing the changed GUIDs updated by the bulkload utility. The name is concluded by a logfile_id, which is a sequence number to ensure unique filenames on the server. Double-click the file name to open and display the workbook.

Transfer to SP3D


Consistency Check The results of the consistency check will be displayed on the Consistency Results tab.

Clicking the Show Results button or double-clicking a record on the Consistency Results tab opens a second window showing the sheets in the verification results for the selected record.

The display can be restricted to sheets listed in the consistency results by clicking the Verification Result radio button. In the sheet list, export data for each sheet can be seen by either double-clicking the selected record or by using the menu associated with the right mouse button.

If the sheet list has been opened by double-click on the Consistency Results tab, the display of the export data is automatically restricted to the detail information (Commodity Code, Ident, Spec Code) listed in the selected record of the ‘Consistency Results’.

Transfer to SP3D


Stages After an export job has been started, the following steps are automatically executed.

Stage PRE_IF_TABS The generic sheet templates are created. The temporary job tables are filled, when the Extended Customization check box is selected on SP3D 10.07 Sheet Configs. When the export job reaches the job stage PRE_IF_TABS_DONE, double-click the sheet name on the Selected Sheets tab to call the SP3D 10.15 Add, Find and Replace screen. This screen is called only for those non-generic sheets that have Extended Customization checked on SP3D 10.07 Sheet Configs. On the SP3D 10.15 screen, you can add filters and replacement values, using the Use in Filter and Apply Filter buttons, and entering the replacement value in the Replacement Information block as required. Furthermore, you can add manual data using the Manual Data tab of SP3D 10.15. When needed, this has to be done for each sheet. When filters and replacement values are defined for all required sheets, proceed with the export job. For further details about the SP3D 10.15 screen, refer to Add, Find and Replace Setup (on page 31).

The data is stored in Oracle global temporary tables in the PRE_IF_TAB_DONE job stage. If the user logs out and closes the SPRD session at this stage, this data will be lost. The user needs to start the job again from PRE_IF_TABS after deleting or cancelling the previous job.

Stage FILL_IF_TABS Fill the interface tables (stage FILL_IF_TABS). This step performs the collection of ALL required data for later export. The data is stored in the so-called interface tables. Once a job has collected data for a component, a specification or a template (that is, a codelist), no other job can access this data for the same destination unless the first job is not completed or canceled.

Stage VERIFY_CSTCY Consistency Check (stage VERIFY_CSTCY).

Stage WRITE_XLS Export content of interface tables to XLS files and load into SP3D (stage WRITE_XLS). After all the needed data for the current export job are collected into the interface tables, the Transfer job exports the data from the interface tables into the sheets of the Excel workbook(s).

Transfer to SP3D


Stage BULKLOAD Bulkload the workbook (stage BULKLOAD).

Stage ANALYZE_LOG Analyze the Bulkload log file to inform SPRD which lines were loaded and which were skipped (stage ANALYZE_LOG).

Stage VERIFY_SP3D Verify the catalog within SP3D (stage VERIFY_SP3D).

Stage IMP_GUIDS Load the GUIDs back into SPRD (stage IMP_GUIDS).

Stage COMPLETE_JOB Synchronize the SPRD inventory of SP3D with the data produced by the actual job (stage COMPLETE_JOB). Each of above mentioned job stages can fail due to incorrect settings in the job environment. In case of an error, the user must check the log files to identify the cause. For detailed information about export job errors, refer to the Troubleshooting SmartPlant 3D Export Jobs document (STO-SP3D-ERRs.pdf). Once a job is successfully completed, the prompt "Do you want to download the files?" will appear. Click on Yes to download or No to cancel. Alternately, you can open the file by double-clicking on it under the ‘Workbooks’ tab. Clicking the Cancel Job button will terminate a job. The reserved sheets will be unlocked and the job stage will be set to JOB_COMPLETE, but the status will be CANCELED. The inventory will not be synchronized with the job data.

Transfer to SP3D



Instead of performing a data transfer with these steps: creating Excel workbooks feeding the SP3D bulkload utility with this data analyzing the bulkload logfile loading the GUIDs back from SP3D synchronizing the inventory

you can directly feed the SP3D database with the SPRD data by calling the SP3D bulkload API. Using the API, there is no need to create the Excel workbooks. Furthermore, this method ensures that SP3D and the SPRD inventory will be accurately synchronized, because only data that is successfully transferred to SP3D will be written into the inventory.

Software Requirements SmartPlant 3D V2009.1 or higher SmartPlant Reference Data 6.3.8 or higher SmartPlant 3D software Reference Data Client V2009.1 from the CD must be installed on the

SmartPlant Reference Data application server. The SmartPlant 3D database on its server needs to be available from the SmartPlant

Reference Data application server. In the case of SmartPlant 3D on SQL Server, the appropriate SQL Server Client needs to

be installed on the SmartPlant Reference Data application server. In the case of SmartPlant 3D on Oracle, the Oracle Client needs to be on the SmartPlant

Reference Data application server. The Oracle Client is the same as the one needed when running the SmartPlant Reference Data application under .NET. For details, refer to the SmartPlant Reference Data Plus Installation Guide.

SP3D Reference Data Client Start the installation of the SP3D Reference Data Client tool on your application server from the CD. The folder is <SPMat-Install-Folder>\others\SPRDClient\2009.1.

SP3D Bulkload API

SP3D Bulkload API


Double-click SP3DSPRDClient.msi to launch the installation. The Welcome box appears. Click Next to continue.

Enter your name and organization in the corresponding fields, and click Next to continue.

SP3D Bulkload API


Select your country from the dropdown list and click Display to show the License Agreement. After reading it, close the document and click Yes to accept the license agreement and to continue with the installation.

Check the destination folder. If you want to change this folder, use the Browse button and select another folder. Click Next to continue.

SP3D Bulkload API


Click Next to continue.

This will perform the installation. To stop the installation, click the Cancel button. When the installation succeeds, click the Finish button to exit.

SP3D Bulkload API


SP3D Server Configuration Start the SPRDListener.exe from the Explorer window or from the command line. C:\Program Files\SmartPlant\3D\CatalogData\BulkLoad\Bin\SPRDListener.exe The SPRDListener.exe file is located in the SP3D installation path, in the same directory as Bulkload.exe.

After starting, it will show its own symbol in the system tray on the Windows task bar, but the program does not start automatically on computer startup.

When not yet existing, a plant must be created in the SP3D database using the SP3D Project Manager. The general config item LOAD_AND_VERIFICATION_PLANT_NAME must point to this plant; see SPRD Application Server Configuration (on page 80) below. The user who connects from SPRD during the bulkload needs to be known in the SP3D database also. In our example, it will be the local administrator performing the bulkload; thus, this user must be created in the SP3D database. Open a SQL*Plus session and connect as sys against the SP3D database. Then perform the commands below to create the user and grant the needed rights. create user administrator identified externally; grant connect, sp3duser, sp3d_project_administrators to administrator;

To enable user authentication by the operating system, use the command below. This allows the SPRD user to connect to the SP3D database located on a remote host. alter system set remote_os_authent=true scope=spfile;

After, restart the database instance to apply the changed spfile.

SP3D Bulkload API


SPRD Application Server Configuration The SP3D database on its server needs to be available from the SPRD application server. In the case of SP3D on SQL Server, the SQL Server Client on the SPRD application server must be enabled to connect to the SP3D database. In the case of SP3D on Oracle, set SQLNET.AUTHENTICATION_SERVICES= (NTS) in sqlnet.ora of the Oracle client home.

In the tnsnames.ora of the same home, enter the database alias of the SP3D database. Do the same steps in the ias-home on the SPRD application server.

As the bulkload API is called from Oracle Forms, it will use the same Oracle home. The default.env (or the env file you are using) must contain the path that points to the Oracle software. You may issue a SET command from the DOS box and copy the complete "path=..." data to the end of the env file. You can find the default.env file in the <oracle_home>\oraias\forms\server folder .

You may face problems connecting to the SP3D database because the Oracle application server processes are running under the local SYSTEM account, and this account could be unable to authenticate with the SP3D database. If this is the case, you may change the Oracle services AS

SP3D Bulkload API


Control and AS ProcessManager so that they run as a "real" user that can log on to the SP3D database.

In this example, the logon properties of both services were changed to run under the local Administrator account.

SmartPlant Reference Data Settings The following config items have to be set on the SP3D 10.01 General Configs screen for the use of the SP3D bulkload API. ANALYZE_BL_LOG BULKLOAD_SP3D BL_EXE_PATH_N_NAME LOAD_AND_VERIFICATION_HOST_NAME LOAD_AND_VERIFICATION_PLANT_NAME

ANALYZE_BL_LOG Has to be set to Y. This is only needed for the analyze bulkload stage. If is it set to Y, the logfile is uploaded and interpreted to determine the success of the SP3D import.

SP3D Bulkload API


BULKLOAD_SP3D Has to be set to AUTOMATIC_DIRECT. Starts the bulkload without user interaction and uses the bulkload API, so no Excel sheet will be generated.

BL_EXE_PATH_N_NAME With this setting, you specify the path and the executable for automatic bulkload on the application server. It usually must be set to: <SPRD_installation_dir>\others\SP3DUtility\V2009.1\SP3DutilityRun where <SPRD_installation_dir> must be replaced with the actual installation folder.

SP3D Bulkload API


LOAD_AND_VERIFICATION_HOST_NAME This setting specifies the host name of the SP3D database server where the bulkload and verification takes place. It must point to the SP3D host name in the case of a SQL Server database, and to the Oracle Database alias if it is an Oracle database.

LOAD_AND_VERIFICATION_PLANT_NAME This setting specifies the name of the plant defined in SP3D that should be analyzed by SP3D load and verification.

To keep track of what was transferred from SPRD to which SP3D instance, each export job is assigned to a particular destination. These destinations represent the SP3D catalog databases with specific connection information, like the catalog server, catalog schema server, catalog database and the catalog schema database. The destinations are defined on the SP3D 10.05 Destinations screen. The data can be taken from the SP3D Bulkload tool. In the Catalog Server field, enter the node/machine where the catalog database is running. In the Catalog Schema Server field, enter the node/machine where the catalog schema database is running. In the Catalog DB field, enter the container for the reference data that is supplied by SPRD. In the Catalog Schema DB field, enter the container for the schema data that is supplied by SPRD, like custom attributes and codelists.

How the Bulkload API Works If the BULKLOAD_SP3D config item is set to AUTOMATIC_DIRECT, the export job will no longer produce Excel workbooks when the job achieves the WRITE_EXCEL goal. The progress screen and the summary will indicate that writing to Excel was not requested. Once the job comes to the

SP3D Bulkload API


BULKLOAD goal, it will transfer all data to the API that previously was stored in Excel. This data will be bulkloaded to the SP3D catalog. In the same step the GUIDs data will be returned from SP3D if updates were needed to be made here. The GUIDs will be written to the template sheet of the template that is attached to the job. Hence, the later job goal IMP_GUIDS becomes meaningless when using the API. The job will still undergo this stage to support customers who are using Excel sheets, but nothing will be done if the BULKLOAD_SP3D config item is set to AUTOMATIC_DIRECT. All this is done when achieving the BULKLOAD goal. The Bulkload will return a logfile, which will be read by SPRD when striving for the ANALYZE_LOG goal. If the bulkload logfile indicates that certain sheets or single lines have not been imported to SP3D, the export program will automatically remove the AMD indicators from the related lines in the export job result data. So once the user chooses to let the job run to COMPLETE_JOB, only the data that was successfully loaded into SP3D will be transferred to the inventory. This ensures that the inventory in SPRD is always in sync with the data in SP3D. As usual, the user may review the job data on SP3D 20.01 Export Jobs. Now, after stage LOG_ANALYZED is passed, the same windows will display also the proper bulkload status and cause of error on the sheet- and row-level.

Bulkload API Export Job Create an export job, assign the pre-defined destination, and select the job goal BULKLOAD.

SP3D Bulkload API


The job displayed in the picture below will create and transfer the PipingCommodityFilter sheet for the selected spec SDB_1CS150.

After saving the job, click the button to run the job.

SP3D Bulkload API


When the job succeeds, you will receive the message displayed. Acknowledge the message with OK and check the logfiles and the results of the job.

SP3D Bulkload API


Open the Logfiles tab and double-click the logfile to open it in a separate window.

SP3D Bulkload API


Or, open the file from the file system, either in db utl_file_dir or in the AS download folder.

Then click the button on window 1 to open window 2 with the results of the export job.

SP3D Bulkload API


Navigate to the PipingCommodityFilter sheet as shown and double-click the node to open window 3 with the details.

Next, check the result in SP3D. Open an SP3D session and select the Catalog item from the Tasks submenu.

SP3D Bulkload API


Now navigate down the tree: Piping -> Piping Specification -> Piping Materials Classes. Select the pipe spec SDB_1CS150, which was transferred during the export job.

Select the PipingCommodityFilter sheet to display the details on the right side.


Appendixes


A P P E N D I X A

Acronyms Acronym Meaning

SPRD SmartPlant Reference Data

SP3D SmartPlant 3D

SDB Standard Database

LOV List of values. To be called with the function key F9 or the LOV icon on the toolbar.

Appendixes



A P P E N D I X B

General Config Items Config Item Comment Item Values

ANALYZE_BL_LOG Analyze the bulkload logfile? The logfile can be uploaded and interpreted to determine the success of the SP3D import.

Y - Analyze (default)

N - Do not analyze

AUTO_SELECT_CUST_INTF_FOR_PART_DEFS

Should the CustomInterfaces sheet be selected automatically, when sheets were selected that are categorized as PART_DEFINITION? Part definition sheets often contain user defined attributes, and the bulk load of those attributes requires that they appear on the CustomInterfaces sheet. The auto selection takes place during job validation.

Y - Yes, CustomInterfaces sheet will be selected as soon as one PART_DEFINITION sheet is selected for transfer

N - No, the CustomInterfaces sheet will not be automatically selected

AUTO_SELECT_GENERIC_SHEETS

When a spec/spec items are selected on SP3D 20.01 Export Jobs, should the generic sheets assigned to the short codes also be selected for transfer? The auto selection takes place during job validation.

N – No, generic sheets will not be automatically selected. (User is responsible for adding generic sheets manually or using appropriate transfer type)

Y - Yes, generic sheets will be selected when they are assigned to the short codes existing within spec code/spec items

AUTO_SELECT_IDENTS_FROM_SPEC

When a spec/spec items are selected on SP3D 20.01, should the used groups/parts/ccs also be selected for transfer? The auto selection takes place during job validation.

COMMODITY_REPLACE - The used commodity codes from the selected specs/spec items will be added to the idents selection of the job after the existing selection entries were deleted

IDENT_REPLACE - The used idents from the selected specs/spec items will be added to the idents selection of the job after the existing selection entries were deleted

IDENT - The used idents from the selected specs/spec items will be added to the idents selection of the job

Appendixes


COMMODITY - The used commodity codes from the selected specs/spec items will be added to the idents selection of the job

NO_SELECTION - The automatic selection feature is disabled

AUTO_SELECT_SHTS_FOR_PARTS

Fill the assigned part class sheets into the job sheet selection, if the related commodity codes were selected?

Y - Yes, part class sheets shall be automatically selected for all selected commodity codes

N - No, the part classes will not be selected automatically

AUTO_SELECT_VALVEOP_CLASS_SHTS

Select ValveOperator class sheets if ValveOperatorMatlControlData sheet is selected?

Y - Yes, select the ValveOperator class sheets if ValveOperatorMatlControlData sheet is selected

N - No, the ValveOperator classes will not be selected automatically

AUTO_SELECT_VALVEOP_CTRL_DTA_SHT

Select the ValveOperatorMatlControlData sheet if PipingMatlControlData sheet is selected?

Y - Yes, select the ValveOperatorMatlControlData sheet if PipingMatlControlData sheet is selected

N - No, the ValveOperatorMatlControlData sheet will not be selected automatically

BL_CALL_METHOD Specify which method should be used to start the SP3D bulkload. Only relevant if BULKLOAD_SP3D is set to automatic.

BATCH - Use command line call as scheduled task

API - Use API call

HOST - Use command line host call

BL_DB_PROVIDER Specify the database provider for automatic bulkload.

MSSS - Microsoft SQL Server

ORACLE - Oracle Database

BL_EXE_PATH_N_NAME

Specify the path and executable on the appserver for automatic bulkload.

Example:

C:\Program Files\SmartPlant\3D\CatalogD

Appendixes


ata\Bulkload\Bin\Bulkload

BL_SYMBOL_PATH Specify the symbol path on the appserver for automatic bulkload.

Example:

C:\

BL_UPDATE_VIEWS Should the bulkload update views and BOC nodes for all part classes?

Y - This is the standard behavior

N - This is the standard behavior

BULKLOAD_SP3D Should the bulkload be initiated automatically from the appserver, or manually from client?

MANUAL - User handles bulkload

AUTOMATIC_DIRECT - Start without user interaction and use the load API, so no XLS will be generated

AUTOMATIC - Start without user interaction

EXPORT_PRE_IF_TABLES_STOP

Specify whenever the job, having generic sheets, will stop processing.

Generic sheets will be created or modified in the templates first. When the template sheet is completed, it will be copied over.

STOP_NEVER - Job will not stop even when some errors occurred, for example, mandatory output fields are empty

STOP_ALWAYS - Job will stop always

STOP_ERROR - Job will stop only when errors occurred

EXPORT_SCOPE Shall the interface consider the current job contents as complete project or as parts of it?

INDIVIDUAL - The interface will treat the result of each export job as a subset of the actual project, for example, one or more specs plus part definitions

ENTIRE_PROJECT - The interface will keep SP3D in sync with what is in the current job. The current job result defines completely what is in the actual project

LOAD_AND_VERIFICATION_HOST_NAME

Specify the host name of the server where SP3D load and verification takes place.

LOAD_AND_VERIFICATION_PLANT_NAME

Specify the plant that should be analyzed by SP3D load and verification.

MANUAL_IDENT_CODE Specify the ident code that SPRD The assigned ident will be used

Appendixes


will use internally while creating manual sheet data for sheet categories PART_FILTER and PART_DEFINITION on the SP3D 10.15 Add, Find and Replace screen.

as a dummy value when creating manual data.

MANUAL_SPEC_CODE Specify the spec code that SPRD will use internally while creating manual sheet data for sheet categories SPEC_RULE on the SP3D.10.15 Add, Find and Replace screen.

The assigned spec code will be used as a dummy value when creating manual data.

MANUAL_SPEC_ITEM Specify the spec item that SPRD will use internally while creating manual sheet data for sheet categories SPEC_ITEM_FILTER on the SP3D 10.15 Add, Find and Replace screen.

The assigned spec item will be used as a dummy value when creating manual data.

PD_BOLT_TRANS_LEVEL

The translation level for part definition of bolts determines the resolution in the 'BoltPartData' sheet.

IDENT - Each Ident results in one line in the part definition

COMMODITY - Each Commodity Code results in one line in the part definition

PD_GASKET_TRANS_LEVEL

The translation level for part definition of gaskets determines the resolution in the 'GasketPartData' sheet.



PD_NUT_TRANS_LEVEL

The translation level for part definition of nuts determines the resolution in the 'NutPartData' sheet.



PD_TRANSLATION_LEVEL

The translation level for part definition determines the resolution in all part definition sheets, except those which have their own translation level parameter, like bolt, gasket, nut, washers.

Ident is the default, if none is selected.



PD_WASHER_TRANS_LEVEL

The translation level for part definition of washers determines the resolution in the 'WasherPartData' sheet.



Appendixes


PF_TRANSLATION_LEVEL

The translation level for part filter defines the resolution in sheets of the PART_FILTER category.

COMMODITY - Each Commodity Code results in one line in the part filter

CC_OR_IDENT - All groups/parts/CCs/idents which are explicitly mapped to the sheet in SP3D 10.04 will be reported on ident level. All other items appear on commodity level

IDENT - Each Ident results in one line of the part filter

SI_BOLT_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as Bolts. Each value must be enclosed in single quotes.

Bolts have no short code in SP3D.

Bolts are excluded from the PipingCommodityFilter sheet but they appear on the BoltSelectionFilter sheet.

Example:

'BLTG'

SI_CLAMP_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as Clamps. Each value must be enclosed in single quotes.

Clamps have no short code in SP3D.

Clamps are excluded from the PipingCommodityFilter sheet but they appear on the ClampSelectionFilter sheet.

Example:

'CLMP'

SI_GASKET_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as Gaskets. Each value must be enclosed in single quotes.

Gaskets have no short code in SP3D.

Gaskets are excluded from the PipingCommodityFilter sheet but they appear on the GasketSelectionFilter sheet.

Example:

'GSKT'

Appendixes


SI_NUT_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as Nuts. Each value must be enclosed in single quotes.

Nuts have no short code in SP3D.

Nuts are excluded from the PipingCommodityFilter sheet but they appear on the NutSelectionFilter sheet.

Example:

'NUTS'

SI_OPTIMIZE_PERFORMANCE

Provides a means of changing the internal structure of the statement issued against the DB to overcome bad performance generating a spec item sheet. The option with the best response time depends on the database and data settings. Default is OPT1.

OPT1 - Option 1

OPT2 - Option 2

SI_PIPING_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as piping. Each value must be enclosed in single quotes.

The list is evaluated when the piping items are exploded to ident granularity. See config item SI_SCHEDULE_MTHD_PIPING.

Example:

'PIP','PIPE','PIPING','PI','Piping'

SI_SCHEDULE_MTHD_NONPIPING

The schedule method for non piping items (flanges, valves etc) in the SPEC_ITEM_FILTER sheets.

GEOMETRIC - The schedule is derived from the ident geometric information. This setting will only be in effect if the SI_SCHEDULE_METHOD_PIPING is also set to GEOMETRIC.

This option implies, that all spec items are exploded, so that a new spec item appears in SP3D as the schedule changes. Choosing this option works if the config item SI_TRANSLATION_LEVEL is set to COMMODITY, but it is overridden if the translation level is set to IDENT

SP3D 10.04 - The schedule is mapped in SP3D 10.04. Note: if you map the schedule on ident level, the spec items are not exploded automatically (set the config item

Appendixes


SI_TRANSLATION_LEVEL to IDENT if needed)

S.20.08 - The schedule is expected to be mapped in S.20.08. The mapping name in A.50.I.01 must be SCHEDULE for the green connect point and ASCHEDULE for the red connect point. You can have more than one table for this purpose. Map additional tables by appending a running number to the mapname like <mapname>_1 and so on in A.50.I.01

SI_SCHEDULE_MTHD_PIPING

The schedule method for piping items in the SPEC_ITEM_FILTER sheets. If the piping schedule is not contained in the commodity code, the option GEOMETRIC is recommended. GEOMETRIC is the default. Alternatively it is possible to create a separate spec item as soon as a piping element has a different schedule, and use SP3D 10.04 to map the schedule for each piping spec item. For example, instead of having one spec item for pipe from 4 to 20 inches, have two lines: One from 4 to 6 inches (schedule S-XS) and another one from 8 to 20 inches (schedule S-STD).

SP3D 10.04 - The schedule is mapped in SP3D 10.04. Note: if you map the schedule on ident level, the spec items are not exploded automatically (set the config item SI_TRANSLATION_LEVEL to IDENT if needed)

S.30.01 (S.20.08) - The schedule is expected in the Commodity Code. If no specific Commodity Code is found, the procedure looks for a mapping in S.20.08. The mapping name in A.50.I.01 must be SCHEDULE for the green connect point and ASCHEDULE for the red connect point. You can have more than one table for this purpose. Map additional tables by appending a running number to the mapname like <mapname>_1 and so on in A.50.I.01.

If the mentioned table is not directly a table in the Commodity Code but a master link table of the Commodity Code that contains this table as

Appendixes


a link table, the SP3D Interface will also be able to find the information

GEOMETRIC - The schedule is derived from the ident geometric information (more exactly: from the second input column).

This option implies that the piping spec items are exploded, so that a new spec item appears in SP3D as the schedule changes. Choosing this option works if the config item SI_TRANSLATION_LEVEL is set to COMMODITY, but it is overridden if the translation level is set to IDENT. In this context, the config item SI_PIPING_SHORT_CODE_LST provides the short codes that are used in this setting

SI_TRANSLATION_LEVEL

The translation level for spec items defines the resolution in sheets of the SPEC_ITEM_FILTER category. COMMODITY is the default.

IDENT - Each spec item results in so many SP3D spec items, as idents belong to it

IDENT_FOR_PIPING - Each pipe spec item results in so many SP3D spec items, as idents belong to it. The setting for SI_SCHEDULE_MTHD_NONPIPING should be SP3D 10.04, SI_SCHEDULE_MTHD_PIPING can be SP3D 10.04 or GEOMETRIC. Pipes are recognized if they are in SI_PIPING_SHORT_CODE_LST

COMMODITY - Each spec item in SmartPlant Reference Data results in one SP3D spec item. This option will be overridden if indicated by the SI_SCHEDULE_MTHD% config items

Appendixes


SI_WASHER_SHORT_CODE_LST

List (comma separated) of the short codes which should be considered as Washers. Each value must be enclosed in single quotes.

Washers have no short code in SP3D.

Washers are excluded from the PipingCommodityFilter sheet but they appear on the WasherSelectionFilter sheet.

Example:

'WSHR'

TRANS_CC_GASKET Translate the gasket commodity code in the part data sheet GasketPartData and in the part filter sheets PipingCommodityMatlControlData, PipingCommodityProcurementData. This config item is valid only when the translation level for GasketPartData sheet is set to IDENT as decided by the config item PD_GASKET_TRANS_LEVEL and the translation level for PipingCommodityMatlControlData, PipingCommodityProcurementData sheets is set to IDENT/ CC_OR_IDENT as decided by the config item PF_TRANSLATION_LEVEL.

NO - No translation of the gasket commodity code. This config item value is the default.

YES - The gasket commodity code in the sheets GasketPartData, PipingCommodityMatlControlData, and PipingCommodityProcurementData will be translated. Commodity Code will be appended with Gasket Thickness value (ident input 2). The commodity code with appended values will be stored as company ident against the company given by the project default ZI_SP3D_CO.

TRANS_CC_NUT Translate the nut commodity code in the part data sheet NutPartData and in the part filter sheets PipingCommodityMatlControlData, PipingCommodityProcurementData. This config item is valid only when the translation level for NutPartData sheet is set to IDENT as decided by the config item PD_NUT_TRANS_LEVEL and the translation level for PipingCommodityMatlControlData, PipingCommodityProcurementData sheets is set to IDENT/ CC_OR_IDENT as decided by the config item PF_TRANSLATION_LEVEL.

NO - No translation of the nut commodity code. This config item value is the default.

YES - The nut commodity code in the sheets NutPartData, PipingCommodityMatlControlData, and PipingCommodityProcurementData will be translated. Commodity Code will be appended with Bolt Diameter value (ident input 1) and Nut Height value (ident input 2). The commodity code with appended values will be stored as company ident against the company given by the project default ZI_SP3D_CO.

TRANS_CC_WASHER Translate the washer commodity code in the part data sheet WasherPartData and in the part

NO - No translation of the washer commodity code. This config item value is the default.

Appendixes


filter sheets PipingCommodityMatlControlData, PipingCommodityProcurementData. This config item is valid only when the translation level for WasherPartData sheet is set to IDENT as decided by the config item PD_WASHER_TRANS_LEVEL and the translation level for PipingCommodityMatlControlData, PipingCommodityProcurementData sheets is set to IDENT/ CC_OR_IDENT as decided by the config item PF_TRANSLATION_LEVEL.

YES - The washer commodity code in the sheets WasherPartData, PipingCommodityMatlControlData, and PipingCommodityProcurementData will be translated. Commodity Code will be appended with Bolt Diameter value (ident input 1) and Washer Thickness value (ident input 2). The commodity code with appended values will be stored as company ident against the company given by the project default ZI_SP3D_CO.

VERIFICATION_BOLT_LENGTHS

Specify if bolt lengths should be included in SP3D verification.

Y

N

VERIFICATION_CALL_METHOD

Specify which method should be used to start the SP3D verification. Only relevant if VERIFY_SP3D is active.

BATCH - Use command line call as scheduled task

API - Use API call

HOST - Use command line host call

VERIFICATION_EXE_PATH_N_NAME

Specify the path and executable on the appserver for SP3D verification.

Example:

C:\SPMAT2008\SP3D

VERIFICATION_MATERIAL_DESC

Specify if material descriptions should be included in SP3D verification.

Y

N

VERIFICATION_SYMBOL_PLACEMENT

Specify if symbol placement should be included in SP3D verification.

Y

N

VERIFICATION_WEIGHT_DATA

Specify if weight data should be included in SP3D verification.

Y

N

VERIFY_CONSISTENCY Check the quality of exported data? This takes place directly after the interface tables have been filled on the SPRD side. Verification is not required to proceed with further steps of the job, and verification alerts can also be ignored.

Y - Verify the data. You may find a logfile VERIFICATION_REPORT with the results, and a logfile CONSISTENCY_CHECK documenting the check process

N - Don't verify the data

Appendixes


VERIFY_SP3D Perform consistency check on SP3D side? This validates the SP3D catalog, not only the contents of the current export job. May take some time.

Y

N

Appendixes



A Acronyms • 93 Add, Find and Replace Setup • 31 Appendixes • 91 Attached Procedures • 22 Attribute Definition • 16 Attributes • 19

B Bulkload API Export Job • 84

C Codelists • 49 Commodity Attributes • 41 Consistency Check • 71 Copy Sheet • 23

D DBA Settings • 11 Definition Attributes • 22 Destinations and Structures • 35

E Excel Template • 13 Export Job Creation • 61 Export Job Execution • 67

G Gaskets • 48 Gaskets, Nuts, and Washers • 48 General Config Items • 95 General Config Settings • 46 General Configs • 33 Generic Sheets • 40

H How the Bulkload API Works • 83

I Ident Forming Attributes (Input) • 44 Item Mappings • 24

J Job Results • 68

L Logfiles • 70

M Mapping using Table Details • 51 Mapping using Table Groups and Table

Details • 50 Mappings • 55

N Nuts • 49

O Other Ident Attributes (Output) • 45 Overview • 7

P Preface • 5 Prerequisites • 11 Procedure

FILL_GENERIC_TEMPLATE_SHEET • 46 Procedures • 28 Process Workflow Diagram • 9 Project Defaults • 11

R Restrictions • 53

S Set-Up • 15 Sheet Configs • 18, 52 Sheet Configuration • 15 Sheet Definition • 15 Sheets and Attributes Mapping • 30 Short Codes • 57 SmartPlant Reference Data Settings • 81 Software Requirements • 75 SP3D Bulkload API • 75 SP3D Reference Data Client • 75 SP3D Server Configuration • 79 Spec Preparation for Export • 55

Index

Index


SPRD Application Server Configuration • 80 Stage ANALYZE_LOG • 73 Stage BULKLOAD • 73 Stage COMPLETE_JOB • 73 Stage FILL_IF_TABS • 72 Stage IMP_GUIDS • 73 Stage PRE_IF_TABS • 72 Stage VERIFY_CSTCY • 72 Stage VERIFY_SP3D • 73 Stage WRITE_XLS • 72 Stages • 72

T Templates • 23, 58 Transfer Job • 47 Transfer Job Set-Up • 9 Transfer to SP3D • 61 Transfer Types • 34

W Washers • 49 Workbooks • 70

smartplant reference data - spmat.hec.co.krspmat.hec.co.kr/marian_webentry/pdfs/sprd sp3d interface...

Documents