smartplant reference data smartplant isometrics...

SmartPlant Reference Data SmartPIant Isometrics Integration

Version 2011 SP2 (7.0.2) December 2010 DMAR1-PE-200118B

Copyright Copyright © 2008-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.

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 Huntsville, Alabama 35894-0001

Warranties and Liabilities All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract, 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.

Trademarks Intergraph, the Intergraph logo, PDS, SmartPlant, SmartSketch, and FrameWorks are registered trademarks and SupportModeler and SupportManager are trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of their respective owners.

Table of Contents

Table of Contents Preface .................................................................................................................................4

Configuring the Export Interface .....................................................................................5

Project Defaults ............................................................................................................5 Interface Creation..........................................................................................................6 Interface Units ...............................................................................................................6 Interface Attributes .......................................................................................................8 SmartPlant Isometrics Master Data ............................................................................10

Symbol Keys ..................................................................................................................... 11 Configuration Codes ......................................................................................................... 13 Item Group Codes ............................................................................................................. 14 PCF Component Types ..................................................................................................... 15

SKEY Mappings .........................................................................................................16 Mapping SKEYs to Commodity Codes ............................................................................ 16 Mapping SKEYs to Attributes .......................................................................................... 24

Mapping Bolts ............................................................................................................27 Check SKEY Mappings ..............................................................................................31 File Configuration .......................................................................................................32

Workflow: Exporting Catalog Data using the Standard Template ............................36

Job Creation ................................................................................................................37 Job Execution .............................................................................................................42

Appendix A – Export File Configuration ......................................................................45

Standard Template ......................................................................................................46 Standard Master Template ..........................................................................................60

SmartPlant Reference Data SmartPIant Isometrics Integration 3

Preface

Preface SmartPlant® Reference Data exports catalog data, which SmartPlant Isometrics imports. This functionality was first available in SmartPlant Reference Data in Version 6.2.4 Service Pack 8.

This document includes:

• Explanation of how to configure the SmartPlant Reference Data SmartPlant Isometrics (formerly named I-Sketch) interface to export the catalog data

• An example workflow of a standard export of catalog data

4 SmartPlant Reference Data SmartPIant Isometrics Integration

Configuring the Export Interface

Configuring the Export Interface This section explains how to configure SmartPlant Reference Data for the export interface to SmartPlant Isometrics (formerly named I-Sketch).

Project Defaults Use A.20.12 Project Defaults to set values accordingly.

• ZI_ISK_DIR: Application Server folder where the exported catalog files will be saved.

• ZI_ISK_URL: URL where clients will download the files created from the Application Server

• ZI_ISK_ZIP: Yes/No (Y/N) value to determine whether a set of exported catalog files will be packaged and compressed by a Zip tool



Interface Creation On the A.70.01 Interfaces screen, add a new entry with the Interface column completed with the I-SKETCH value, as shown in the following graphic.

The value must be I-SKETCH (uppercase only), or the export of the catalog files will fail.

Interface Units On the A.10.14 Interface Dependent Units screen, define entries to map the I-SKETCH interface for the MM and Inch units as shown in the following graphic. The spelling must be exact, and the entry fields are case-sensitive.



The groups and units that must be added depend on the units used to define the geometrics.



Interface Attributes Use the A.50.I.02 Interface Attributes screen to set the attributes used for bolt length, bolt diameter, and bolt quantity. The attributes must match these translations used in I-Sketch:

• BDIA for bolt diameter

• BLGT for bolt length

• BQTY for bolt quantity



Add a number value to BDIA, BLGT, or BQTY when there is more than one attribute for each translation. The values must be unique for each translation. For example, the following screenshot shows that P_BOLT_DIA is translated to BDIA2.



The SmartPlant Reference Data menu includes the I-Sketch Interface menu. Use the I-Sketch screens to configure and start the catalog data export.

SmartPlant Isometrics Master Data The I-Sketch 10.01 Master Data screen allows users to view and edit data stored in SmartPlant Reference Data to reflect the SmartPlant Isometrics master data needed to run the export interface. The most common Symbol Keys (SKEYs) are installed and available in SmartPlant Reference Data when you install 6.2.4 Service Pack 8 or later. You can use the Master Data screen or the SKEYs to display the interface.



Symbol Keys The I-SKETCH 10.01 Master Data screen has four tab pages. The Symbol Keys page displays the main information, as shown in the following screenshot.

The first (SKEY Sets) block on the Symbol Keys tab of the I-Sketch 10.01 Master Data screen enables the grouping of SKEYs by SKEY Sets. This allows you to assign different mappings and attributes to the same SKEY. When defining an export job, this SKEY set can be selected to determine which attributes will be considered.

Depending on the settings of each SKEY set, the assignment of SKEYs to a specification item follows certain rules:

1. The SKEY set assigned to the export job will be searched first. If an SKEY is found, other sets won't be searched. Otherwise, processing continues with step 2.

2. The Lookup Others? option of the selected SKEY set must be checked to continue the search. If this is the case, continue with step 3.

3. The SKEY set that has the Allow Use By Others? option checked and has the lowest value in the Order field will be searched next. This step will be processed until an SKEY is found or no more SKEY sets are available.

You can create your own SKEY set by copying an existing set. To do this, you must select Copy SKEY Set from the right mouse/context menu on the Order or SKEY Set field. The complete set of SKEYs will be copied to the new SKEY set.



By setting the sort order in the Order field, it can be determined where to look for mapped attributes first.

SmartPlant Materials is delivered with a default set of SKEYs. This DEFAULT set has the Standard indicator selected and it cannot be deleted or modified.

The Lookup Others? indicator determines if it is allowed for this set to search other sets to find attribute mappings. The Allow Use By Others? marks all sets that are allowed to be searched.

The pre-assigned bore unit and dimension unit will be copied from the Bore Unit and Dimension Unit fields to the export job when selecting an SKEY set on I-Sketch 20.05 Export Jobs.

The User Comment field can be used to add a comment or description to the selected SKEY set.

In the second (Symbol Keys (SKEY)) block, you can assign and edit Symbol Keys (SKEYs). SmartPlant Reference Data comes with a variety of SKEYs already configured, assigned to the DEFAULT SKEY set.

If you assign additional SKEYs, be sure they are assigned to an item group, configuration code, and PCF component type that can be selected by pick lists. This data is also already available and can be found on the other tab pages of the Master Data screen.

When the Reversible check box is checked, it indicates that parts belonging to the SKEY can be used independently from the flow direction. This value is also written to the export files.

When the Bolting Material check box is checked, it indicates that the parts belonging to the SKEY are bolting material. This is a necessary setting to allow bolts to be placed in the exported bolting file.



Configuration Codes The Configuration Codes page displays the available configuration codes with some additional information.

It is possible for customers to apply their own diagrams to illustrate the meaning of bores and dimensions for parts belonging to this Configuration Code. The graphic format of a new picture file to be loaded can be GIF, BMP, or JPG. The path on the application server containing the diagram and the file name must also be specified. Click the Load Image command to load an image from a source you will specify.

If the file is not available on the application server, it can be uploaded. Click Browse to display a dialog box to navigate your local environment to transfer a graphic file from your local environment to the application server.

Set the mandatory and optional settings for bores and dimensions here.

When mapping attributes for SKEYs on the I-SKETCH 10.02 SKEY Mappings screen, these settings along with the diagram will be displayed. The settings are to be understood as a recommendation when mapping SKEYs. There is no check programmatically if the attributes are set or not.



Item Group Codes Use the Item Group Codes screen to view and edit the Group and Group Number.



PCF Component Types Use the PCF Component Types screen to view and edit the PCF Component Type and the PCF Number.

Note

• When exporting catalog files, number values such as config number, group number, and PCF number are always relevant to the export. Therefore, they must be set to SmartPlant Isometrics rules. The code values are used in SmartPlant Reference Data and are not exported to the catalog files.

For more information regarding code and number values of SmartPlant Isometrics related master data, refer to the SmartPlant Isometrics documentation.



SKEY Mappings The I-Sketch 10.02 SKEY Mappings screen defines the mappings between I-Sketch SKEYs and SmartPlant Reference Data. Each SKEY needs filter criteria to define the commodity codes belonging to the SKEY. Furthermore, for each SKEY, a set of SmartPlant Reference Data attributes must be mapped to define which attributes are to be used as bores and which ones are used as dimensions.

Mapping SKEYs to Commodity Codes The following screenshots are examples of the different ways to define mappings:

• By Commodity Code – Most useful for mapping exceptions, which will be mapped to their own SKEY

• Group/Part only – Most useful for mapping an entire group or set of parts to a separate SKEY

• Group/Part with Table Details – Most useful for more complex environments where table details are required and have their own SKEY

• By Commodity Code directly – Most useful for mapping exceptions, which are all mapped to their own SKEY



By Commodity Code Directly

The example shows the SKEY ELBW mapped directly to a commodity code. This method is most useful for mapping exceptions. The codes mapped this way will be mapped to their own SKEY, which will be different than the SKEY used for other commodity codes.



By Group/Part Specify one or more commodity groups and parts to assign commodity codes to the SKEY. Most mapping will be done using this method.

In the above example, the ELBW SKEY maps to one group/part only. As a result, all commodity codes belonging to this group and part are mapped to this SKEY.

Click Show Commodity Codes to display all affected commodity codes on the Matching Commodity Codes page.



By Table Details For SmartPlant Reference Data environments where the data is modeled in a more complex way, it may not be sufficient to use Group/Part entries for mapping to SKEYs.

To be more specific, it is possible to add table details for each row of the Group/Part block as criteria to identify the commodity codes belonging to the SKEY.

In this example, the Table Details information is used as criteria to filter commodity codes of commodity group B part E9L by end preparation and material.



Table Details Filter Criteria Rules When creating filter criteria for table details, the fields in this block are to be filled following some rules:

Group Rows with the same group number will be enclosed in brackets when building the query.

Sequence (Seq) Rows belonging to a group have a unique number within the group. This number is an order sequence used to sort the criteria when building the query.

Tablename/ Group/ -Detail

Name of the table and the table detail/-group/-detail.

Operator Values AND/OR to determine how the table detail results should be combined.

Within one group, the AND row operator means that a commodity code must have both table details.

The OR operator means that a commodity code must have at least one of the table details.

Rows belonging to a group must show a row operator (AND/OR) except for the last row of this group.

Group Operator The AND/OR values determine how the results of each group should be combined when calculating the total results.

The AND operator means that commodity codes must be in both groups. The OR operator means that commodity codes must be in one or the other group.

The last row of a group must show a group operator (AND/OR) except for the last group.



The following screenshot is another example with more Table Detail criteria.

The table detail criteria in the example shown above can be interpreted as follows.

A commodity code belongs to SKEY ELBW if:

its commodity group is ‘B’ and its part is ‘E9L’

AND (It has table details

(P_END_PREP/WELD/BE)

AND (P_MATERIAL/WRGT_US/CK)

OR

It has table details

(P_END_PREP/WELD/BE)

AND (P_MATERIAL/WRGT_US/CL)

)



Note

When the SKEY mappings are done, it may be that a commodity code maps to more than one SKEY or that it is not mapped at all. Check the mapping before the export. Also, you can check the export log files.

Check the mapping before export on the I-Sketch 10.03 Commodity Code SKEYs screen, which can be called from S.50.06 Specification Management.

The following graphic explains the processing logic used to identify the SKEY belonging to a commodity code. Understanding this logic may help to define SKEY mappings properly.

Lookup SKEY for Commodity Code

(CC)

Log Error

SKEY found

Is CC mapped directly?

Is CC mapped with table details?

Is CC mapped with group/part?

Yes

Yes, but 1:n

No

No

Yes

Yes



Special Case Bolting Material For bolts, make sure the Bolting Material checkbox is checked when you are mapping to the BOLT SKEY with the group and part as shown in the following example.

Note

• Usually, this applies to SKEY 'BOLT,' only, but this is a necessary requirement to identify bolts and to create the bolting file.



Special Case Default Choice For each SKEY, it can be decided separately if the commodity codes belonging to the SKEY should appear in the exported Default Choice file or not. If the Allow Default Choice check box is unchecked, the software prevents commodity codes from appearing in the Default Choice file.

Mapping SKEYs to Attributes When exporting SmartPlant Isometrics catalog files, it is necessary to apply nominal sizes (Bore A – C) and physical length (Dimensions A – D) where it is appropriate.

Therefore, a mapping of corresponding attributes defined on A.50.01 Attributes to bores and dimensions is necessary.



The following example shows the attribute mapping for SKEY ELSW.

Bore A and bore B are equally defined by NPS1 in this example. Dimensions A and B come from attributes reflecting face-to-center and end-to-center length.

Each field for bores and dimensions has a pick list attached. The pick list will only show attributes used by commodity codes belonging to one of the group/part records specified. That means also that the group/part selection must be done before the attributes can be mapped.

Note

• Depending on the setup of your environment, it may become necessary to define new geometrics and geometric relations to provide SmartPlant Reference Data with all information needed in the SmartPlant Isometrics catalogs.

For each SKEY, it is possible to define one set of attributes within the product group and one set within each project. When exporting, the attribute set will preferably be taken from the project the user is logged in. If none is available in the project, the set defined in the product group will be used.



Additional Attributes On this tab page, additional attribute sets can be defined which will be used when exporting the SmartPlant Isometrics Master catalog and CIF file. In the Master CIF, these attribute sets are used to export user-defined ident attributes like outer diameter and wall thickness.

It is possible to export up to eight values from Geometric Attributes and up to four values derived from table details. Which attribute to put in which field can be freely defined by users. But, this order should be the same for all SKEYs. Otherwise, it could happen that in the exported file, the column for an attribute is filled with values of different meaning.

Again, the attributes can be filled by using pick lists. The example shows the mapping to attributes to get outer diameter, schedule thickness, weight, and material.



Mapping Bolts This step prepares a specification for export to the SmartPlant Isometrics catalog by adding bolting information. Use the S.50.06 Specification Management screen to locate the specification and to go to specification items by double-clicking the Spec Code.

If a bolting file is going be created, the parts to be bolted must be edited and have a bolt commodity code assigned. So, first locate a part to be bolted.



Go to the Bolt Commodity Code field, and select a bolt commodity code from the S.30.01 Commodity Codes pick list.



Note

• The pick list for Bolt Commodity Codes is restricted to show commodity codes that are mapped to SKEYs marked as Bolting Material on I-Sketch 10.02 SKEY Mappings.



Proceed this way until the bolted parts have the appropriate bolt commodity codes attached.

The next step is to check if all commodity codes belonging to the specification have been mapped to an SKEY properly.



Check SKEY Mappings On the pop-up menu on the Short Code item, the I-Sketch SKEY Mappings entry opens the I-Sketch 10.03 Commodity Code SKEYs screen.

All commodity codes belonging to the selected specification are displayed on the screen together with the mapped SKEYs.

By default, all SKEY sets are used to find an existing SKEY mapping. When selecting a preferred SKEY set from this dropdown list in the Preferred SKEY Set field, SKEYs will be looked up in SKEY Sets according to the SKEY Set configurations stored on the I-Sketch 10.01 Master Data screen. This is to simulate the same SKEY selection rules that would apply when selecting an SKEY set for an export job on I-Sketch 20.05 Export Jobs.

Commodity Codes may be already mapped correctly, mapped more than once, or not mapped at all. Missing or incorrect mappings are indicated by an empty SKEY field. The reason why an SKEY cannot be identified is displayed in the SKey Description field.

If an SKEY is defined ambiguously, you will be informed by information displayed in the SKEY Description field accordingly. To correct this situation, select one SKEY from the complete list of values or from a restricted list showing all SKEYs the commodity code is mapped to. The complete list and the restricted list can be displayed by using the context menu in the SKEY field.



For commodity codes with missing SKEYs, the mapping can be done on this screen for each commodity code separately. By using this functionality, the mappings are done by direct mapping to the commodity code and so apply to this commodity code only. Other commodity codes belonging to the same commodity group and part are not affected. To complete the mapping, it is recommended to return to the I-Sketch 10.02 SKEY Mappings screen and complete the mapping in the group/part level rather than mapping on the commodity code level.

To complete the mapping on this screen, the SKEY pick list can be used either by pressing the F9 key or by using the pop-up menu.

Once the SKEY Mapping is completed in either way, the specification is ready to be exported.

If a mapping to an SKEY can be identified, the mapped attributes and mapped additional attributes are also displayed on the tab pages at the bottom accordingly.

File Configuration The I-Sketch 20.01 Export Config screen allows you to define necessary export parameters to be used to create the files for SmartPlant Isometrics specifications.

Templates Export parameters are organized in export templates. An export template is a set of specified files and their configurations to determine the format of the files to be exported.

An export template can be attached to an export job. The export job will derive the necessary file configurations from this template.

There are already two standard export templates provided by SmartPlant Reference Data. Both templates may not be edited by users but can be copied to adjust values according to users’ needs if necessary. Both templates have been proofed to work with the SmartPlant Reference Data database SDB (Standard Database). Therefore, it may not be necessary to create own templates at all but instead use the available templates.



Template STANDARD must be used for standard specification export.

File Types File types belonging to the standard template are:

• BOLTING-FILE

• CATALOGUE-FILE

• COMPONENT-INFORMATION-FILE

• CONNECTION-FILE

• DEFAULT-CHOICE-FILE

• FUNCTION-DEFINITION-FILE

• SPECIFICATION-FILE



File types belonging to the standard master template are:

• BOLTING-FILE

• CATALOGUE-FILE

• COMPONENT-INFORMATION-FILE

• FUNCTION-DEFINITION-FILE

Important

• Prior to changing an approved export template, you should be completely familiar with the file formats required by SmartPlant Isometrics. The explanations given in Appendix A - Export File Configuration must be followed carefully.

File Extension Though not checked by the system, the extension should match the file extensions that SmartPlant Isometrics expects.

Check the Active indicator to make sure this file type will be created when processing an I-Sketch catalog export. Clear this checkbox to avoid creation of the file type temporarily.

File Configurations This block is to specify the structure of each file type’s header rows and data columns.

According to the setup of SmartPlant Reference Data, you might need to set field length other than the values that come with the standard template. But, it is recommended to try an export with the available file configurations first. Because the file configuration can become quite complex, the full capabilities are explained in Appendix A - Export File Configuration.

The explanations in this chapter just provide some basic understanding of the file configuration.

Depending on the Content Type (HEADER, DATA COLUMN, or FIXED COLUMN), the unique order sequence is used to determine the order of the header rows or data columns in the output files.

For records of type HEADER, the content of the Name field will be written to the files.

For data columns, set the Name according to column identifiers known from SmartPlant Isometrics. The Value column is filled with either a fixed value or a variable representing the SmartPlant Reference Data pendant of the SmartPlant Isometrics column. If no value can be found, the value in the Default column may be used.



For HEADER records, Col Start sets the length of the output string. Values may be truncated if Col Start is not set correctly. Shorter values will be filled with blanks.

For Data Columns and Fixed columns, the position in the ASCII file is determined by both Col Start and End. But it determines the length of the string, NOT the absolute position in the line. One string will directly be concatenated to the other.

Comment Some entries require an additional comment to be exported to the file; for example, Component-Information-File data column ITEM-CODE-IDENTIFIER needs the comment !ITEM-CODE-IDENTIFIER.

Do not change these entries. Otherwise, SmartPlant Isometrics will not work properly with the exported data.


Workflow: Exporting Catalog Data using the Standard Template


The I-Sketch 20.05 Export Jobs screen allows you to set up and execute export jobs to export to the SmartPlant Isometrics ASCII catalog format. This chapter describes the necessary steps of a typical workflow using a standard template.

The standard export requires that at least one specification is attached to the job. For each attached specification, a set of files will be created.

The export of master catalog data is possible by choosing a master template with an export job. There are two ways to determine the amount of data exported. One is to attach a certain number of specifications. This action will collect all data belonging to at least one of the specs and export into one set of files.

The other way is to attach no specification at all. In this case, all commodity codes mapped to any SKEY will be exported. This way produces the largest amount of data and can be a very time consuming process.

More information on the configuration of both export types can be found in Appendix A of this document.



Job Creation In the following example, a new export job is created with job code DEMO. The run number is set by the system and cannot be changed by the user.

When entering the Template Code field, the value is applied automatically with the template marked as Default on I-Sketch 20.01 Export Config. A different template can be selected by using a pick list.



When entering the SKEY Set field, the value is applied automatically with the SKEY set marked as Standard on I-Sketch 10.01 Master Data. A different SKEY set can be selected using the LOV.



The selected SKEY set determines which set should apply to export processing. After choosing an SKEY set, the assigned values for bore unit and dim unit will also be copied from the SKEY set definition to the export job.

Depending on the settings of each SKEY set on the I-Sketch 10.01 Master Data screen, the assignment of SKEYs to a specification item follows certain rules:

1. The SKEY set assigned to the export job will be searched first. If an SKEY is found, other sets won't be searched. Otherwise, processing continues with step 2.

2. The Lookup Others? option of the selected SKEY set must be checked to continue the search. If this is the case, continue with step 3.

3. The SKEY set that has the Allow Use By Others? option checked and has the lowest value in the Order field will be searched next. This step will be processed until an SKEY is found or no more SKEY sets are available.

The value for Export Path can be applied by double-clicking. This action will fill in the value stored with project default ZI_ISK_DIR.



To attach a specification to the export job, double-click the Spec Type item in the Export Job Specs block. This will open the following window showing Specification Types and Specification Headers.

Select a specification by checking the Select checkbox, and click Fill In to copy over the selected specs. When the selection is finished, close the specification window and return to the export job window.

Note

• An export job may contain more than one specification. For each specification, a set of files will be created. The files will be offered as a download of a corresponding archive file.



Note

• It is also possible to create a new export job from an already existing one. Clicking New Run will create a new export job from the job currently displayed and increment the Run Number.



Job Execution The export job is now ready to run. Click Start Online to start the job. A warning message will ask for confirmation of the job execution. Click OK to proceed.

Job execution parameters will be set accordingly after starting the job.

When the file creation is finished, a dialog box will offer the files for download to the client machine. By confirming this dialog box with Yes, a file dialog box will open, allowing you to set the destination of the files in the client file system.

If the created files are zipped into an archive file, the name of the file will be created according to the following rule:

ISK_ & Job Code & _ & Run Number & .ZIP

An example is ISK_DEMO_1.ZIP.

The specification files are named by the specification name and the corresponding suffix.



Click OK to confirm the upcoming status message.

On the Export Job Files tab page, the path and name of the created files on the application server are displayed. If the files have not been zipped in an archive, it is possible to open and view a file by double-clicking the file name.



Note

• If your web browser has a pop-up blocker installed, the download and the displaying feature described above will not work.

The progress tab page may contain some important messages if some errors occurred during export processing. This information will not be saved in the database. It may become necessary to copy this information to a separate text file.


Appendix A – Export File Configuration

Appendix A – Export File Configuration Depending on your needs, it may become necessary to adjust the settings of the export templates. In the following section, the possibilities of tweaking export files are described for each template and each file type separately.



Standard Template The standard template is used to export a set of files for each attached specification. The following file types belong to a standard template:

• Specification File

• Component Information File

• Function Definition File

• Catalogue File

• Connection File

• Default Choice File

• Bolting File

For each file type, the standard configuration will be explained by examples.



Specification File (.SPN)

Header

ORDER NAME VALUE COL START

END DEFAULT COMMENT

10 ! 2 20 ! 2 30 [HEADER] 17 40 ! 2 50 Specification SPEC_CODE 17 60 Catalogue CATALOG_FILENAME 17 ANSI.CAT 70 Boreunits UNITS_BORE 17 75 MaxBores MAXBORES 17 80 Lengunits UNITS_LENGTH 17 90 ItemCode 17 ITEM-CODE-IDENTIFIER

100 Choice CHOICE_FILENAME 17 110 ImpliedMaterial IMPLIED_FILENAME 17 120 Connection CONNECTION_FILENA

ME 17

130 Bolts BOLTS_FILENAME 17 140 FullBoltCodes 17 FALSE 150 PulledBend TRUE 17 160 MinTube 17 42 170 ! 2 180 [SPECIFICATION] 17 190 ! 2 195 PULLEDBEND 51 346 # BENDS PULLED FROM TUBE

All information of content type HEADER determines the data output in rows.



Example output: ! ! ! SmartPlant Reference Data ! I-Sketch Interface - Specification ASCII Export ! Production Release 2007 (6.2.4) SP 9 ! Copyright 1988 - 2007, Intergraph Corporation ! All Rights Reserved ! License Number: 1031F893D37567BD ! ! Export started at 08-FEB-2008 12:23:32 ! ! ! ! [HEADER] ! Specification SDB_1CS150 Catalogue SDB_1CS150.CAT Boreunits Inch MaxBores 48 Lengunits Inch ItemCode ITEM-CODE-IDENTIFIER Choice SDB_1CS150.CHO ImpliedMaterial SDB_1CS150.IML Connection SDB_1CS150.CON Bolts SDB_1CS150.BLT FullBoltCodes FALSE PulledBend TRUE MinTube 42 ! [SPECIFICATION] ! PULLEDBEND 0.5 48 # BENDS PULLED FROM TUBE PPPABQPEACRAAG 0.5 1.5 # Pipe , B36.10M , PE , A 106 Gr. B , SMLS PPPABQBEADLAAB 2 24 # Pipe , B36.10M , BE , A 53 Gr. B , Welded PPPABQBEAEEAAH 26 30 # Pipe , B36.10M , B



The following twelve lines are fixed and will be written to each file of type SPN. ! ! ! SmartPlant Reference Data ! I-Sketch Interface - Specification ASCII Export ! Production Release 2007 (6.2.4) SP 9 ! Copyright 1988 - 2007, Intergraph Corporation ! All Rights Reserved ! License Number: xxxxxxxxxxxxxx ! ! Export started at 08-JAN-2008 12:23:32 ! !

The following lines match the configuration lines ORDER SEQ 10, 20, 30, 40 and 170, 180, 190.

Exclamation marks are used to indicate a comment line in SmartPlant Isometrics catalog files. It is possible to add some user information text to such fields. In this case, the value of COL START determines the length of the string here.

The entries [HEADER] and [SPECIFICATION] are needed at those positions and should not be changed. ! ! [HEADER] ! .. ! [SPECIFICATION] !



Lines 50, 60, 100, 110, 120, and 130 are all interpreted in the same way. The value in column NAME will be written to the file and padded with blanks up to the value specified in COL START. The value in column VALUE is a variable and interpreted during run time. Mainly this is the created file name of the appropriate file. If the value column is not set, the value of column DEFAULT will be applied.

Specification SDB_1CS150 Catalogue SDB_1CS150.CAT .. Choice SDB_1CS150.CHO ImpliedMaterial SDB_1CS150.IML Connection SDB_1CS150.CON Bolts SDB_1CS150.BLT

Lines 70, 75, and 80 are to be interpreted similarly but will be derived from the data collected during processing of the specification.

Boreunits Inch MaxBores 48 Lengunits Inch

Lines 90, 140, and 160 have no value in column VALUE. Therefore, the value of column DEFAULT will be used. This is a value required by SmartPlant Isometrics.

ItemCode ITEM-CODE-IDENTIFIER FullBoltCodes FALSE MinTube 42

Line 150 is used to determine whether to add the PULLEDBEND entry to the specification or not. In column VALUE, only values TRUE or FALSE should be set. If set to TRUE, the minimum and maximum bore are calculated and a corresponding line will be added as a first line of specification data. The value in column COL START sets the position for the string of column DEFAULT accordingly.

PulledBend TRUE

Example output:

PULLEDBEND 0.5 48 # BENDS PULLED FROM TUBE



DATA columns and fixed columns


END DEFAULT COMMENT

200 ITEM-CODE-IDENTIFIER

COMMODITY_CODE 1 32

210 FROM_SIZE FROM_SIZE1 33 41 220 TO_SIZE TO_SIZE1 42 50 230 Hash # 51 52 240 DESCRIPTION CC_DESCRIPTION 53 346

The information of content type DATA COLUMN or FIXED COLUMN determines the data output in columns.

The placing of the values in the file is determined by COL START and END. But, this is not the absolute position in the file; rather, it is the length of the entries. In the standard template, the commodity code takes the first 32 characters. The FROM_SIZE takes the next nine characters (41 – 33 + 1 = 9). If the configuration is changed for the commodity code – for example, column END set to 30 – the column FROM_SIZE will still be 9 characters long but start at position 31.

Line 200, 210, 220, and 240 all have a variable in the VALUE column. The columns will be filled with data according to the variable values derived from the database. For line 230, the ‘#’ is interpreted as a string and will be spooled out as thus.

Line 240 contains the variable CC_DESCRIPTION. The output of this variable can be influenced by changing the database package M_PCK_ISKETCH_CUSTOM. The function GET_CC_DESCRIPTION can be changed according to your needs. By default, this is the commodity code short description.

PPPABQPEACRAAG 0.5 1.5 # Pipe , B36.10M , PE , A 106 Gr. B , SMLS PPPABQBEADLAAB 2 24 # Pipe , B36.10M , BE , A 53 Gr. B , Welded PPPABQBEAEEAAH 26 30 # Pipe , B36.10M , B



Component Information File (.CIF) The configuration of the Component Information File only consists of entries of content type Data Column.

DATA columns


END DEFAULT COMMENT

10 INDEX INDEX_NUMBER 1 8 !INDEX 20 ITEM-CODE-IDENTIFIER COMMODITY_CODE 9 40 !ITEM-CODE-IDENTIFIER

30 ITEM-CODE-IDENTIFIER IDENT_CODE 41 55 !OPTIONAL-CODE 40 N.S. BORE_A 56 63 0 !N.S. 50 N.S.SEC BORE_B 64 71 0 !N.S.SEC 60 N.S.THIRD BORE_C 72 79 0 !N.S.THIRD 70 DESCRIPTION IDENT_DESCRIPTION 80 325 !DESCRIPTION

Example output: 000001 PPPABQPEACRAAG I0128494 0.5 0 0 Pipe , B36.10M , PE , A … 000002 PPPABQPEACRAAG I0128505 0.75 0 0 Pipe , B36.10M , PE , A … 000003 PPPABQPEACRAAG I0128516 1 0 0 Pipe , B36.10M , PE , A … 000004 PPPABQPEACRAAG I0128538 1.5 0 0 Pipe , B36.10M , PE , A …

The configuration of the Component Information File is also written to the Function Definition File. For an example, refer to the section above.

To fill the Component Information File, all lines are processed by interpreting the variables specified in column VALUE. Lines 10 to 60 use variables that extract fixed specification data. Except for the length of the columns specified by COL START and END, it is not necessary for further manipulations by the user.

Line 70 contains the variable IDENT_DESCRIPTION. The output of this variable can be influenced by changing the database package M_PCK_ISKETCH_CUSTOM. The function GET_IDENT_DESCRIPTION can be changed according to your needs. By default, this is a concatenation of the commodity code short description and ident short description.



Function Definition File (.FDF) The configuration of the Function Definition File consists only of the following header entries. Note that the information of content type HEADER determines the data output in rows.

ORDER NAME VALUE COL START END DEFAULT

10 FUNCTION-DEFINITION-FILE 26 20 UNITS-DEFINITION 18 30 UNITS-BORE UNITS_BORE 11 40 UNITS-LENGTH UNITS_LENGTH 13 50 UNITS-WEIGHT 13 LBS 60 COMPONENT-INFORMATION-FILE 27 70 COMPONENT-INFORMATION-SELECTION 32 80 ITEM-CODE-INPUT 35 9 90 ITEM-CODE-OUTPUT 35 41

100 DESCRIPTION 35 80

Example output: FUNCTION-DEFINITION-FILE UNITS-DEFINITION UNITS-BORE Inch UNITS-LENGTH Inch UNITS-WEIGHT LBS COMPONENT-INFORMATION-FILE INDEX 1 8 !INDEX ITEM-CODE-IDENTIFIER 9 40 !ITEM-CODE-IDENTIFIER ITEM-CODE-IDENTIFIER 41 55 !OPTIONAL-CODE N.S. 56 63 !N.S. N.S.SEC 64 71 !N.S.SEC N.S.THIRD 72 79 !N.S.THIRD DESCRIPTION 80 325 !DESCRIPTION COMPONENT-INFORMATION-SELECTION ITEM-CODE-INPUT 9 ITEM-CODE-OUTPUT 41 DESCRIPTION 80



Lines 10, 20, 60, and 70 are written to the file as they are without any further logic. FUNCTION-DEFINITION-FILE UNITS-DEFINITION .. COMPONENT-INFORMATION-FILE .. COMPONENT-INFORMATION-SELECTION

Lines 30 and 40 are processed by interpreting the variables specified in column NAME and the variable in column VALUE.

UNITS-BORE Inch UNITS-LENGTH Inch

Line 50 results in the output of the text string specified in column NAME and the value of column DEFAULT.

UNITS-WEIGHT LBS

The following lines are copied from the configuration of the Component-Information-File.

INDEX 1 8 !INDEX ITEM-CODE-IDENTIFIER 9 40 !ITEM-CODE-IDENTIFIER ITEM-CODE-IDENTIFIER 41 55 !OPTIONAL-CODE N.S. 56 63 !N.S. N.S.SEC 64 71 !N.S.SEC N.S.THIRD 72 79 !N.S.THIRD DESCRIPTION 80 325 !DESCRIPTION

For lines 80, 90, and 100, the value of column NAME is written to the file, but the values of column DEFAULT must match the values of COL START of the entries for ITEM-CODE-IDENTIFIER, OPTIONAL-CODE, and DESCRIPTION in the Component-Information-File exactly. This is not done automatically.

ITEM-CODE-INPUT 9 ITEM-CODE-OUTPUT 41 DESCRIPTION 80



Catalogue File (.CAT)

Header

ORDER NAME VALUE COL START END

10 [CAT Units] 11 20 Length UNITS_LENGTH 7 30 [CAT Records] 14

The information of content type HEADER determines the data output in rows.

Example output: [CAT Units] Length Inch [CAT Records] 000001 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 000002 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 000003 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 000004 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 ..

Lines 10 and 30 are just string output as specified in column NAME. Line 20 will be additionally filled with the value determined by the variable UNITS_LENGTH.

[CAT Units] Length Inch [CAT Records]




ORDER NAME VALUE COL START END 40 INDEX INDEX_NUMBER 1 8 50 SKEY SKEY 9 13 60 Dim A DIM_A 14 21 70 Dim B DIM_B 25 32 80 Dim C DIM_C 31 38 90 Dim D DIM_D 39 46

100 Item Config Number CONFIG_NUMBER 47 52 110 Item Group Code GROUP_NUMBER 53 58 120 PCF Component Type PCF_NUMBER 59 64 130 Flow Depency Code FLOW_CODE 65 65

The information of content type DATA COLUMN or FIXED COLUMN determines data output in columns.

This configuration creates a valid output format. It should not be necessary to change the format. .. 000001 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 000002 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 000003 PIPE 0.00 0.00 0.00 0.00 208 101 437 0 ..

Connection File (.CON) The configuration of the Connection File directly reflects the lines to be written to the file. There is no further processing logic. The content may be changed according to your needs. For meaningful settings, refer to SmartPlant Isometrics documentation.


10 ! 1 20 ! Connection List 17 30 01HG PIPE 5 40 **FL GASK 5 50 FL** PIPE 5 55 FL** GASK 5 60 FLWN **BW 5 65 **BW PIPE 5



70 **SC PIPE 5 75 **SW PIPE 5 80 **CP PIPE 5 85 BE** PIPE 5 90 BU** PIPE 5 95 CR** PIPE 5

100 PIPE OPEN 5 105 **BW **BW 5 110 DR GASK 3 115 SP GASK 3 120 SR GASK 3 125 SB GASK 3 130 OP GASK 3 135 PB PIPE 3 140 PL **SC 3 145 PR GASK 3 150 TB PIPE 3 155 TB** PIPE 5 160 TE** PIPE 5 165 W* PIPE 3 170 W** PIPE 4 175 W*** PIPE 5 180 PIPE PIPE 5 182 RP GASK 3 185 RD GASK 3 190 PF GASK 3 195 PV GASK 3 200 **BW **WN 5 205 W* **BW 3 210 W* W* 3 215 ! 1 220 ! Exclusion List 16 225 EXCLUDE 7 230 BOLT 4 235 AMAT 4 240 FLOW 4



245 FLOR 4 250 GAP 3 255 IBAL 4 260 ! 1 265 ! End of Connection Table 25

Example output: ! ! Connection List 01HG PIPE **FL GASK FL** PIPE FL** GASK ..

Default Choice File (.CHO)

ORDER NAME VALUE COL START END 10 ! Default Choice Table 22 20 ! 1 50 group GROUP_NUMBER 1 10 60 configuration CONFIG_NUMBER 11 26 70 minBore FROM_SIZE1 27 36 80 maxBore TO_SIZE1 37 46 90 item_code COMMODITY_CODE 47 80

Example output: ! Default Choice Table ! 102 200 0.5 1.5 OE45AB2SSWACGZZZ 102 200 0.5 1.5 OE90AB2SSWACGZZZ 102 200 2 48 BE4LABMBEACKZZZ 102 200 2 48 BE9LABMBEACKZZZ ..

Lines 10 and 20 of content type HEADER are string output. The lengths are determined by values specified in COL START.



Lines 50 to 90 are needed to call the processing of specification lines that should be selected as the default choice. To apply the default choice logic, the parts must have option code = 1 set as specification items.

Bolting File (.BLT)

ORDER NAME VALUE COL START END 10 ! Material Characters 21 20 MATERIAL 18 10

30 ! 2 40 ! Assignment List 17 50 ITEM-CODE_IDENTIFIER COMMODITY_CODE 1 32 60 N.S. BORE_A 33 42 70 N.S.SEC BORE_B 43 52 80 N.S.THIRD BORE_C 53 62 90 BOLT-QTY BOLT_QUANTITY 63 72

100 BOLT-ITEM-CODE BOLT_COMMODITY_CODE 73 105

Example output:

! Material Characters MATERIAL 18 ! ! Assignment List FBLABLIRFACGZZZ 15 0 0 4 LMBDAZDBZAZZ00012x50 FBLABLIRFACGZZZ 20 0 0 4 LMBDAZDBZAZZ00012x50 FBLABLIRFACGZZZ 25 0 0 4 LMBDAZDBZAZZ00012x50 ..

Lines 10, 30, and 40 are just string output as specified in column NAME.



But the value set for line 20 is special. This value is a key value telling SP Isometrics how to interpret the bolt commodity codes regarding the position of the bolt length. When exporting a specification, the bolt commodity codes written to the bolting file are built from a concatenation of the original SP Reference Data commodity code with the bolt diameter, an ‘x’ character. Determined by the value applied for MATERIAL – 18 in the example – the resulting string will be exactly 18 characters long. The bolt commodity codes may be padded with ‘0’ characters or truncated as necessary. Additionally, the bolt length will be concatenated to the found string.

Lines 50 to 100 determine the placing of output columns. Lines 50 to 80 are filled with data belonging to the part to be bolted. Line 90 defines the quantity of the required bolts.

Note that to derive the necessary bolt diameter and bolt length, appropriate geometrics must be available in SP Reference Data.

Line 100 specifies the variable for the bolt commodity code. This value will be filled only if the mapping of bolts for the specification items has been done on S.50.06 Specification Management.

Standard Master Template The standard master template is used to export a set of files to build a master catalog. The following file types belong to a master template:

• Function Definition File

• Catalogue File

• Component Information File

• Bolting File

Bolting File The bolting file will not be created by the master export, but the entry of variable MATERIAL must be placed somewhere. It serves the same purpose as for the standard export.



Component Information File (.CIF) The configuration of the Component Information File consists of entries of content type Data Column only.

DATA columns


END DEFAULT COMMENT

10 INDEX INDEX_NUMBER 1 8 !INDEX 20 ITEM-CODE-IDENTIFIER COMMODITY_CODE 9 40 !ITEM-CODE-

IDENTIFIER 30 ITEM-CODE-IDENTIFIER IDENT_CODE 41 70 !OPTIONAL-CODE 50 N.S. BORE_A 71 78 0 !N.S. 60 N.S.SEC BORE_B 79 88 0 !N.S.SEC 70 N.S.THIRD BORE_C 89 96 0 !N.S.THIRD 80 MATERIAL-ATTRIBUTE1 ATTRIBUTE1 97 106 - !OutsideDiam-1 90 MATERIAL-ATTRIBUTE2 ATTRIBUTE2 107 116 - !Wall-Thickness-1

100 MATERIAL-ATTRIBUTE3 ATTRIBUTE3 117 126 - !OutsideDiam-2 110 MATERIAL-ATTRIBUTE4 ATTRIBUTE4 127 136 - !Wall-Thickness-2 120 MATERIAL-ATTRIBUTE5 ATTRIBUTE5 137 146 - !Weight 130 MATERIAL-ATTRIBUTE6 ATTRIBUTE8 147 156 - !OutsideDiam-1 155 MATERIAL-ATTRIBUTE7 TAB1_VALUE 157 166 - !Pressure Rating 160 MATERIAL-ATTRIBUTE8 TAB2_VALUE 167 176 - !Material 170 DESCRIPTION IDENT_DESCRIPTION 177 450 !Description



Example output:

Because the length of the output strings exceeds the displaying capabilities of a document, a typical output line is displayed as a table showing the Order, Name, and the used variable of column VALUE as the first three columns and the corresponding output in a third column.

ORDER NAME VALUE Output Example

10 INDEX INDEX_NUMBER 004824 20 ITEM-CODE-IDENTIFIER COMMODITY_CODE FWNDAZ4XCDAZAZZ 30 ITEM-CODE-IDENTIFIER IDENT_CODE I3447148 50 N.S. BORE_A 0 60 N.S.SEC BORE_B 0 70 N.S.THIRD BORE_C 0 80 MATERIAL-ATTRIBUTE1 ATTRIBUTE1 1016 90 MATERIAL-ATTRIBUTE2 ATTRIBUTE2 36

100 MATERIAL-ATTRIBUTE3 ATTRIBUTE3 - 110 MATERIAL-ATTRIBUTE4 ATTRIBUTE4 - 120 MATERIAL-ATTRIBUTE5 ATTRIBUTE5 870 130 MATERIAL-ATTRIBUTE6 ATTRIBUTE8 - 155 MATERIAL-ATTRIBUTE7 TAB1_VALUE 40 160 MATERIAL-ATTRIBUTE8 TAB2_VALUE AZ 170 DESCRIPTION IDENT_DESCRIPTION WN Flg. PAS 1057, welding neck flange (Type11) -

PN25 PN40 , Small Tounge Face PAS 1057 - P245GH , 125 - 250 Ra Finish

MATERIAL-ATTRIBUTE1 to 8 are each set in column VALUE to the corresponding value from the mapping of Additional Attributes. Variables for these columns (ATTRIBUTE1 to ATTRIBUTE8 and TAB1_VALUE to TAB4_VALUE) can be used in a user-defined order.

Other lines are to be used as explained in the corresponding section of the standard template.



Function Definition File (.FDF) The configuration of the Function Definition File is the same as for the standard template, and it consists of the following header entries. Note that the information of content type HEADER determines the data output in rows. For explanations of the lines, refer to the Function-Definition-File section of the standard template.


END DEFAULT

10 FUNCTION-DEFINITION-FILE 24 20 UNITS-DEFINITION 16 30 UNITS-BORE UNITS_BORE 11 40 UNITS-LENGTH UNITS_LENGTH 13 50 UNITS-WEIGHT 13 LBS 60 COMPONENT-INFORMATION-FILE 26

200 COMPONENT-INFORMATION-SELECTION 31 210 ITEM-CODE-INPUT 35 9 220 ITEM-CODE-OUTPUT 35 41 230 DESCRIPTION 35 177

Example output: FUNCTION-DEFINITION-FILE UNITS-DEFINITION UNITS-BORE MM UNITS-LENGTH MM UNITS-WEIGHT LBS COMPONENT-INFORMATION-FILE INDEX 1 8 !INDEX ITEM-CODE-IDENTIFIER 9 40 !ITEM-CODE-IDENTIFIER ITEM-CODE-IDENTIFIER 41 70 !OPTIONAL-CODE N.S. 71 78 !N.S. N.S.SEC 79 88 !N.S.SEC N.S.THIRD 89 96 !N.S.THIRD MATERIAL-ATTRIBUTE1 97 106 !OutsideDiam-1 MATERIAL-ATTRIBUTE2 107 116 !Wall-Thickness-1 MATERIAL-ATTRIBUTE3 117 126 !OutsideDiam-2 MATERIAL-ATTRIBUTE4 127 136 !Wall-Thickness-2 MATERIAL-ATTRIBUTE5 137 146 !Weight MATERIAL-ATTRIBUTE6 147 156 !OutsideDiam-1 MATERIAL-ATTRIBUTE7 157 166 !Pressure Rating MATERIAL-ATTRIBUTE8 167 176 !Material DESCRIPTION 177 450 !Description



COMPONENT-INFORMATION-SELECTION ITEM-CODE-INPUT 9 ITEM-CODE-OUTPUT 41 DESCRIPTION 177

The following lines are copied from the configuration of the Component-Information-File.

INDEX 1 8 !INDEX ITEM-CODE-IDENTIFIER 9 40 !ITEM-CODE-IDENTIFIER ITEM-CODE-IDENTIFIER 41 70 !OPTIONAL-CODE N.S. 71 78 !N.S. N.S.SEC 79 88 !N.S.SEC N.S.THIRD 89 96 !N.S.THIRD MATERIAL-ATTRIBUTE1 97 106 !OutsideDiam-1 MATERIAL-ATTRIBUTE2 107 116 !Wall-Thickness-1 MATERIAL-ATTRIBUTE3 117 126 !OutsideDiam-2 MATERIAL-ATTRIBUTE4 127 136 !Wall-Thickness-2 MATERIAL-ATTRIBUTE5 137 146 !Weight MATERIAL-ATTRIBUTE6 147 156 !OutsideDiam-1 MATERIAL-ATTRIBUTE7 157 166 !Pressure Rating MATERIAL-ATTRIBUTE8 167 176 !Material DESCRIPTION 177 450 !Description

Catalogue File (.CAT)

Header


END DEFAULT COMMENT

10 [CAT Units] 11 20 Length UNITS_LENGTH 7 30 [CAT Records] 14

The information of content type HEADER determines the data output in rows.




40 INDEX INDEX_NUMBER 1 8 50 SKEY SKEY 9 13 60 Dim A DIM_A 14 21 70 Dim B DIM_B 25 32 80 Dim C DIM_C 31 38 90 Dim D DIM_D 39 46

100 Item Config Number CONFIG_NUMBER 47 52 110 Item Group Code GROUP_NUMBER 53 58 120 PCF Component Type PCF_NUMBER 59 64 130 Flow Depency Code FLOW_CODE 65 65

The information of content type DATA COLUMN or FIXED COLUMN determines the data output in columns. Please refer to the corresponding section of this file type as described above for the standard template.

Example output: [CAT Units] Length MM [CAT Records] .. 004823 FLWN 155.00 0.00 0.00 0.00 205 103 442 0 004824 FLWN 155.00 0.00 0.00 0.00 205 103 442 0 004825 FLWN 155.00 0.00 0.00 0.00 205 103 442 0 ..


smartplant reference data smartplant isometrics...

Documents