smartplant materials how to receive model information from...

SmartPlant Materials How to Receive Model Information from PDS

Version 2008.4 (6.3.5) July 2009 DMAR1-PE-200075B

2

2

Copyright Copyright © 2004-2009 Intergraph Corporation. All Rights Reserved.

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

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.

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, SmartSketch, FrameWorks, INtools, MARIAN, ISOGEN, and IntelliShip 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.

0BPreface

Table of Contents

Preface ........................................................................................................................... 5

Principles of Import ..................................................................................................... 6

Idents or Commodity Codes ...................................................................................... 6

Steps Required to Configure and Import PDS Material .......................................... 9

Establish the Work Breakdown Structure (WBS) ..................................................... 9 B 20.01 Edit BOM ................................................................................................. 9

Establish the PDS Output Format ............................................................................ 11 Example 1 ............................................................................................................ 11 Example 2 ............................................................................................................ 13

Configure SmartPlant Materials Import Format ...................................................... 13 Confirm/Create position attributes in SmartPlant Materials .................................... 15

A.50.01 Attributes ................................................................................................ 16 A.20.06.11 Attribute Security .............................................................................. 16 B.10.04 Position Attributes .................................................................................. 17 B.20.01 Edit BOM ............................................................................................... 18

Save/Create required node attributes ....................................................................... 19 B 10.03 Node Types ............................................................................................ 19

Establish import Options.......................................................................................... 20 Job Information ........................................................................................................ 20

Job Code............................................................................................................... 20 Data Source .......................................................................................................... 21 Job Status ............................................................................................................. 21 Import Path........................................................................................................... 21 Import File ........................................................................................................... 21 User Comment ..................................................................................................... 21

Advanced Options .................................................................................................... 21 Import Fab Spools ................................................................................................ 21 Importing 3rd Party Commodity Codes/ Idents ................................................... 21 Restart .................................................................................................................. 22 PDS ...................................................................................................................... 22 PDS/SmartPlant Instrumentation ......................................................................... 22 Runtime Options .................................................................................................. 22 Job Execution Statistics ....................................................................................... 23 Job Control ........................................................................................................... 23

Execute and Import .................................................................................................. 24 Check error logs ....................................................................................................... 24

Attachments ................................................................................................................ 25

Attachment 1 – PDS report format and example output .......................................... 25 Attachment 2 – Isogen .b file format file and example output ................................ 25 Attachment 3 – Configuration Format ..................................................................... 25

Item ...................................................................................................................... 25 Values .................................................................................................................. 25 Digit from / Seq ................................................................................................... 30

SmartPlant Materials How to Receive Model Information from PDS 3

0BPreface

Digit to / Length ................................................................................................... 30 Comment .............................................................................................................. 30 Since Release 5.4.2 .............................................................................................. 30

4 SmartPlant Materials How to Receive Model Information from PDS

0BPreface

Preface This document provides a recommended workflow for receiving model information from PDS for use in SmartPlant Materials.

Send documentation comments or suggestions to [email protected].


mailto:[email protected]?subject=Documentation%20Comments

1BPrinciples of Import

Principles of Import To deliver model data to SmartPlant Materials, PDS generates an ASCII file output. The values in the ASCII file are mapped to attributes within SmartPlant Materials using the “Configure BOM Import” screen. If more than one ASCII file is generated, an interface must be configured for each format. Once the interface is configured, data is imported with various options for revision level, Work Breakdown Structure (WBS) position, and material validation.

This import method is a simplified interface for the use of Open Material Interface (OMI). OMI requires a specific format file and allows more flexibility for importing material. Refer to the Best Practice document titled How to Import Design Data.

Idents or Commodity Codes An ident is an explicit code for a specific material. For example:

I3437580 Flg WN ASME B16.5 Class 150 FFFE ASTM 181 Gr I or II As per NFPA Requirements 1/2" S-10S (Size: 15 mm Thk: 2.11 mm)

A commodity code is a less explicit code for material and typically does not contain attributes for nominal size or pipe schedule. Some companies do include the schedule in the commodity code, resulting in more commodity codes. For example:

PFWN51FA11AD Flg WN ASME B16.5 Class 150 FFFE ASTM 181 Gr I or II As per NFPA Requirements

It is recommended for PDS applications that idents are used in preference to commodity codes for pipe material classes, material reporting, isometric MTOs, etc., because it is an explicit identifier. If a commodity code is used, then it must always be qualified with the size and schedule, which is arduous when multiple sizes are considered (e.g. reducers). It is possible to use both ident and commodity code for presentation purposes if desired.

If the design quantities are delivered from a system that only has the ability to use commodity codes, you can combine the code, piping material class, size, and schedule so that SmartPlant Materials can import the material and simultaneously validate the material against pipe classes stored in SmartPlant Materials.



Ident Commodity Code

Qty Size 1

Size 2

Size X

Sch 1

Sch 2

Sch x

Pipe Spec

PDS Option

Note

X X RECOMMENDED

X X X X X X X Pipe Spec in SmartPlant Materials

Matching PDS

X X X X X X X X No Pipe Spec in SmartPlant Materials

Several sources for material data exist which use the ident or commodity code. The following table is a simple Risk Assessment based on the source of a material code:

The Relative Merits of Using SmartPlant Materials as a Source for Material Codes

Material Identification &

Source Typical Case Risk

Level Risk During Import

SmartPlant Materials Commodity Code and Pipe Spec

SmartPlant Materials users are the design house 2

OK but needs more data transfer (spec, size, option) to validate against SmartPlant Materials ident.

SmartPlant Materials Ident and Pipe Spec

SmartPlant Materials users are the design house 1

BEST - only risk is design house has modified PDS configuration but import validation will catch this.

SmartPlant Materials Commodity Codes only (no spec downloaded)

SmartPlant Materials user not design house but agrees to use SmartPlant Materials commodity codes 5

Risk -- commodity codes not registered in SmartPlant Materials before import = delay in loading (caused by poor adherence to work practices).

Risk -- source system inconsistent.

Risk -- source system is not able to deliver reliable size, pipe spec, option info.

Risk (possible show stopper) -- SmartPlant Materials needs pipe spec configured to validate ident. Post processing of ISOGEN output required.

SmartPlant Materials Idents only (no spec downloaded)

SmartPlant Materials user are not the design house but agree to use SmartPlant Materials idents 3

Risk -- ident codes are not registered in SmartPlant Materials before import = delay in loading (caused by poor adhesion to work practices).





The Relative Merits of Using SmartPlant Materials as a Source for Material Codes

Material Identification &

Source Typical Case Risk

Level Risk During Import

3rd Party Commodity Codes

Design subcontractor has no agreement to use SmartPlant Materials commodity codes 6

Risk -- commodity codes are not mapped in SmartPlant Materials before import = delay in loading.


Risk -- source system is not able to deliver reliable size, pipe spec, option info.

Risk (possible show stopper) -- SmartPlant Materials needs pipe spec configured to validate ident.

Risk -- 3rd Party is low-end technology since idents (or equivalent) are used by majority of “SmartPlant Materials-like” systems.

3rd Party Idents

Design subcontractor has no agreement to use SmartPlant Materials idents 4

Risk -- ident codes are not mapped in SmartPlant Materials before import = delay in loading.


2BSteps Required to Configure and Import PDS Material

Steps Required to Configure and Import PDS Material

• Establish the Work Breakdown Structure (WBS). • Establish PDS output format. • Configure SmartPlant Materials import format. • Save/create required position attributes in SmartPlant

Materials. • Save/create required node attributes in SmartPlant Materials. • Establish import options. • Execute and import. • Check error logs. • Validate import.

Establish the Work Breakdown Structure (WBS)

This is a typical requirement for any project. If possible, the WBS in SmartPlant Materials should duplicate exactly that issued by the project to enable easy synchronization of budgets, account codes, design areas, etc. You can change the WBS after its creation. However, for obvious reasons, this should be avoided. (Refer to B-040-10-A-A-2-2-5 for detailed instruction on creation of WBS.)

Typically, the WBS for piping will be similar to the following:

Discipline > Unit > Area > Sub Area > Line ID

If the WBS does not exist prior to import, create it in SmartPlant Materials -- provided the necessary configuration is complete. The following is an overview of defining a WBS.

B 20.01 Edit BOM • In screen B 20.05, create a new MASTER node by scrolling

beyond the last entry to highlight a new field. • Select “Create New Node” icon.



• Enter the master node details and select OK. By creating the

discipline as the master node, the correct material is easily identified if multiple disciplines are referenced.

• To create sub nodes, highlight the master node. • Select “Create New node” icon. Continue the above steps until

the structure is complete.



You can copy, move, and delete a node from the current discipline as well as other disciplines, with or without the associated material. You can create node attributes now and/or later. (Refer to the section on node attributes.)

NOTE: A GENERATED NAME APPEARS TO THE RIGHT OF THE NODE NAME. THE GENERATED NAME COMPRISES THE SHORT DESCRIPTION OF THE NODE.

Establish the PDS Output Format This will depend on the project requirements. In this session, we illustrate two examples below:

Example 1 Import of following information from an ASCII file:

Line ID commodity code Design standard Piping material class Fluid code Line sequence no Insulation purpose Insulation thickness Unit number Unit code Module number Package sys number Quantity

Isometric sheet no



Piece mark no Hold status Approval status Fabrication category

These attributes may be changed according to the projects needs. ASCII transfer limits the line length to 255 characters. You can perform multiple imports if a very large amount of information is to be transferred. (Refer to Attachment 1 for complete example output.)

380105-MC5 FAAABAWAAA 1C0031 MC5 0105 N 0' 0" 38 6 - NA SSSF 380105-MC5 FAAABAWAAA 1C0031 MC5 0105 HF 2" 38 2 - NA SSSF 380105-MC5 FAABBAWAAA 1C0031 MC5 0105 N 0' 0" 38 2 - NA SSSF 380105-MC5 POCAAAOAAE 1C0031 MC5 0105 N 0' 0" 38 6 - NA CSFF 380105-MC5 SCAQZZZAAA 1C0031 MC5 0105 N 0' 0" 38 3 - NA CSFF 380105-MC5 VAABAHCCAA 1C0031 MC5 0105 N 0' 0" 38 3 - NA CSFF 380105-MC5 VAUSAHGAAA 1C0031 MC5 0105 N 0' 0" 38 3 - NA CSFF 380105-MC5 VBABAHCFAA 1C0031 MC5 0105 HF 2" 38 1 - NA CSFF 380105-MC5 WAAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 5 - NA SSSF 380105-MC5 WAAAAAWAAA 1C0031 MC5 0105 HF 2" 38 1 - NA SSSF 380105-MC5 WOAAAAWAFA 1C0031 MC5 0105 N 0' 0" 38 1 - NA SSSF 380105-MC5 WRAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 2 - NA SSSF 380105-MC5 WRBAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 2 - NA SSSF 380105-MC5 WTAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 2 - NA SSSF 380105-MC5 PAAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 8758 - NA SSSF 380105-MC5 PAAAAAWAAA 1C0031 MC5 0105 HF 2" 38 10033 - NA SSSF 380105-MC5 PAAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 10034 - NA SSSF 380105-MC5 PAAAAAWAAA 1C0031 MC5 0105 HF 2" 38 10035 - NA SSSF 380105-MC5 PAAAAAWAAA 1C0031 MC5 0105 N 0' 0" 38 13873 - NA SSSF 380111-MC5 FAAABAWAAA 1C0031 MC5 0111 N 0' 0" 38 2 - NA SSSF 380111-MC5 WAAAAAWAAA 1C0031 MC5 0111 N 0' 0" 38 4 - NA SSSF 380111-MC5 PAAAAAWAAA 1C0031 MC5 0111 N 0' 0" 38 14385 - NA SSSF

The export of data from PDS depends largely on what information is available in PDS and the current progress of design. In the above example, there are no spool numbers because they have not been assigned in the PDS model.

SmartPlant Materials imports the material data into the WBS. The WBS typically comprises Plant Unit, Area, and Sub-area. If this information is available in PDS, SmartPlant Materials will automatically allocate the material to the correct position in the WBS. In our example, we have the Unit Number U01, Area A01 and Sub-area 38.

Another requirement of the requisition process is to define the delivery destination of the material. In PDS, this destination can initially be defined using the Fabrication Category. In our example, we import the Fabrication Category to assist the split between field and shop material.

Some key points about the PDS ASCII file include:

• All material for an isometric MUST be grouped together. IF the material for an isometric is not grouped together, the import function will only import the last group -- subsequently losing some of the material.

• Any idents or commodity codes (or other codes) not registered in SmartPlant Materials before the import is started will cause an error.

• Quantities must have a consistent unit of measure (e.g. all pipe must be either ‘m’ or ‘ft’, not a mixture).



• The ASCII file can be delimited rather than constant width (refer to TYPE in the detail Configuration Format – Attachment 3).

Example 2 Import from the standard PDS piping report “piping_g”:

Date/Time : 27-Nov-02 PDS MTO REPORT Page: 1 Corporate Headquarters SmartPlant Explorer shoals Intergraph Corporation 0001 Huntsville, Alabama 35894-0001 Intergraph (205)730-2000 Huntsville Commodity Code Qty/Length 1st Size 2nd Size Material Description ______________ __________ ________ ________ ____________________ LINE NUMBER: A380311-3"-2C0032-HF _________________________________ FAABBAWAAA 2 3" 3" Flange, CL300, RFFE/BE, ASTM-A105, ANSI-B16.5, WN, S-STD bore VABBAHCAAA 1 3" 3" Gate valve, CL300, RFFE, BB, OS&Y, ASTM-A216-WCB, trim 8, Crane 33 PAAAAAWAAA 1' 1 3/8" 3" Pipe, S-STD, BE, ASTM-A53-B Type S LINE NUMBER: A380311-3"-2C0032-N ________________________________ FAABBAWAAA 2 3" 3" Flange, CL300, RFFE/BE, ASTM-A105, ANSI-B16.5, WN, S-STD bore 38LV-565 1 3" 3" *

The second example illustrates some of the specific functionality of the PDS import.

Configure SmartPlant Materials Import Format The main difference between these two imports is that the second example uses the “Line_Num” parameter to identify the word “LINE NUMBER”, and hence identify the line number in the PDS report. In the first example, the line ID is used and simply identified as a BOM node by parameter “POS_LEV3T”. The interface screens are shown in the following figure.



Interface Screen 1:

WBS Node to import

WBS node level and type

Each position attribute is identified by POS_ATTR plus the attribute name.

Interface Screen 2:

LINE_NUM defines that the line number to be imported is prefixed with LINE NUMBER and begins in column 68.



There are many input parameters. Refer to Attachment 3 for a detailed description of the parameters (this is a copy of the online help page). Simply explained:

1st column is the input parameter.

2nd column is to qualify the parameter where necessary.

3rd column is the data type.

4th column is the column position for the attribute in the ASCII file.

5th column is the end column position for the attribute in the ASCII file.

6th column is for a comment.

By comparing the interface screen to the input file, the explanation is clarified.

NOTE: THE QUANTITY VALUES THAT HAVE NO DECIMAL POINT ARE NOT INTERPRETED AS LENGTHS (I.E. ARE COMPONENTS NOT PIPE).

Confirm/Create position attributes in SmartPlant Materials

All entries in the interface screen with the import parameter “POS_ATTR” are SmartPlant Materials position attributes that are defined in the BOM module. It is possible to import ANY attribute from PDS as a SmartPlant Materials position attribute provided the attribute has been created in SmartPlant Materials.

The choice of attributes is flexible; it depends totally on your company-specific configuration for SmartPlant Materials (e.g. you may decide to store the pressure and temperature of a line (or not!)). Typical attributes that aid the use of SmartPlant Materials are:

• Required on Site Date (usually not from PDS) • Line Attributes (Pipe Class, line no, fluid code etc) • Shop Field Indicator (or destination) • Module Number • Approval Status • Hold Comment Creation of BOM attributes is detailed in B-040-10-A-A-2-2-5. The following is a brief summary:



A.50.01 Attributes • Create and define the attribute (SmartPlant Materials must

know about the data).

A.20.06.11 Attribute Security Views can be assigned to allow only specific users to see an attribute and its value (perhaps it is cost sensitive). By default, all attributes are added to the default view. If security is required, a specific view will be created.

• Add the attribute to the default view so all users can see it after it is assigned to a BOM.



B.10.04 Position Attributes Specify where the attribute is to be used in the BOM. In this case, the attributes are defined for piping discipline (not others), and they are all defined in the top block “Assigned Attributes”. This means the attributes occur independently for each material item. You can apply the attributes at the group or part level rather than each individual item. Apply at the group level allows the attribute to be applied consistently over all parts and items in the group. Attributes are not mandatory because they will not always have a value at the beginning of a project. Mandatory will require an input we don’t have.



B.20.01 Edit BOM The attributes are now seen in the BOM. On the left of the screen are Position Attributes that require input or load by users. On the right are Standard Attributes that are referenced from SmartPlant Reference Data for the given material.



Save/Create required node attributes Node attributes are similar to position attributes except that they appear at the node level. The value of a node attribute is propagated to each lower position attribute. However, if a position attribute is entered for a specific item, this will take precedence over the node attribute. Subsequent node attribute updates will not override the position attributes.

Creation of BOM attributes is detailed in B-040-10-A-A-2-2-5. The following is a brief summary.

B 10.03 Node Types • Select the node (e.g. isometric) in this screen with which to

associate the attribute. In the next block titled “Assigned Attributes” enter the details.

• Order Seq -- indicates the order in which the attribute will be displayed.

• Attributes -- must exist in the List of Values to be selected.

• Mandatory -- should be unchecked unless there is a specific reason to require the data. Otherwise, the system will insist on an input each time.

Once an attribute has been created against the node, it is not easily deleted, thus avoiding corruption of data.

Node attributes may be populated manually. This exercise describes attributes populated during the PDS import.



Establish import Options Once the configuration has been established for a project, the import variables should be minimized.

For example, the difference between loading a preliminary PDS report and a final ISOGEN report could be as simple as follows:

1. Job Code Reference

2. Import File Name

3. Configuration File

4. Issue Status

5. List Status

Once these are established, the import is simple.

Job Information

Job Code Often a job is run several times to achieve 100% import. For this reason, establish a consistent naming convention. Once a job code has been used, it may not be used again unless it is deleted. Deleting the job code will not delete the import, only the reference to it. The job code and its parameters may be copied making it easy to perform exactly the same import task after first changing the code (e.g. change mto01 job code to mto02).



Data Source For PDS import, we always use “From PDS ASCII File”.

Job Status The job status denotes changes as the job is executing. Status “Ready” means the job has completed but there may be errors and warnings.

Import Path Press button “Default Path” to set the default or enter another path.

Import File The import file name without extension. The file MUST have an .rpt extension (OMI assumes .dat)

User Comment This is an optional field.

Advanced Options

Import Fab Spools This option is to import spool tags. It is not considered part of PDS importing.

Importing 3rd Party Commodity Codes/ Idents There are two configuration options:

1. PDS 10.01 plus PDS 30.01

2. B 40.01 plus PDS 30.01 (optional)

If the company mapping is specified in PDS, use PDS10.01 to convert commodity codes to the company specified when exporting to PDS specs AND when importing Bills of Material. When importing the parameter, specify POS_CC_MAP in PDS 30.01.

If the company mapping is specified interactively during BOM import in B 40.01, POS_CC_MAP need not be used. If mapping exists in PDS 10.01, it will be ignored.

In PDS 30.01, specify the priority of mapping (CIM = company dependent, interface specific, SmartPlant Materials). This could be altered to IMC, CMI, and others, for example.



Restart This is an automatic feature that allows you to restart an import job aborted by the system. (Refer to online documentation.)

PDS BOM Config – The configuration file to be used in the import.

PDS/SmartPlant Instrumentation Start Node – the node at which the import will start populating the materials (e.g. if you have all the sub-nodes specified in the import file, you may use the top MASTER node as the start node). If none of the nodes are included in the import file, you will need to specify the exact node under which the material should appear.

Runtime Options Issue Status – This attribute is used in conjunction with List Status. Typically, Issue Status refers to the PHASE of a project, e.g. Preliminary, For Design, For Construction, or As Built. It may also be used to show the revision level depending on the company’s philosophy. The Issue Status represents a set of historical data stored.

A simple example may be Issue Status:

A, B, C, D = Preliminary 0, 1, 2, 3, 4 = For construction 0a, 0b, 1a, 1b, 1, etc = Internal revision once the information has reached As Built Status The coding in SmartPlant Materials may be modified to reflect the phase as well as the status. For example:

Preliminary PRE_x (where X is the revision letter/number) Approved For Design AFD_x Approved For Construction AFC_x As Built ASB_x

List Status – This status is used in conjunction with the Issue Status. Typically the List status is used to monitor the completeness of each revision if desired. The list status can also be defined as an identifier of the data quality, for example, it may be beneficial to:

0 – Working

A– Design Service conditions complete

B – Operating Service Conditions complete

C – Insulation requirements complete



D …………

E – Checked for Issue

Z – Issued

Transfer – If this box is checked, the import job will update the records in SmartPlant Materials. If not checked, it will perform a simulation only. This allows testing to be done without modification to the database.

Find Ident – When importing material using the commodity code, you can request SmartPlant Materials to find the associated ident. The prerequisites are that there must be sufficient information for SmartPlant Materials to determine the ident that is tabulated in “Idents or Commodity Codes”. If this option is not checked, it will be necessary to run a separate verification job in B20.01.

Recognize Rev +1 – In earlier versions of SmartPlant Materials, material in the Bill of Material could be locked as a form of revision control. This is no longer recommended; thus, the Rev+1 option should not be checked. (Basically, it allowed the import to continue even when a BOM had been locked for issue on site).

Job Execution Statistics General information about the job.

Job Control

Useful Buttons: Start Online -- Select this once all parameters have been set and saved.

Delete Job -- Good to clear unwanted test loads (production loads should be kept live for a time period).

View SQL Loader Log File -- Shows Oracle log file – useful if import fails.

View Job Log File -- Shows OMI parameters and summary import information.

View Import Protocol -- Shows step-by-step import of material, gives warnings where material was imported but there is some potential problem with it (e.g. idents were not found for the imported commodity code).

Less Useful Buttons Start Batch -- Available only if batch module has been installed.

Restart Job -- Available under special circumstances. (See online help.)



Clear Import Data -- Import data is stored in a temporary interface table, this clears the table and removes some log information from the Import Protocol.

Clear Info Panel -- Just clears the info panel at the bottom of screen.

JCS Monitor -- For Batch processing.

Execute and Import The import file must have an .rpt extension for PDS import. Importing material for a specific ISO at the same issue status deletes the existing data and overwrites it with the new data. No revision history is kept.

Check error logs • Check the info screen at the bottom of B40.01 to see if there are

any failure messages. • Check the SQL Loader Log file. See if the number of read lines

matches the import file (e.g. total logical records read: 67). • View Job Log file. Check the Section entitled “Import Data

Error Summary.” • View the import Protocol. Look for Errors and Warnings. In the

top right corner, you can set SmartPlant Materials to only show Errors. This is a quick way to find problems.


3BAttachments

Attachments Attachment 1 – PDS report format and example output Attachment 2 – Isogen .b file format file and example output Attachment 3 – Configuration Format

Item This field holds the name of the configuration item you want to supply with parameters. The available items can be selected from the List of Values (LOV). The LOV automatically fills other fields with defaults, so you can easily achieve a default configuration.

Values LINE_NUM (optional)

Defines the horizontal location of the line number. In the field “Value,” enter a line number title that differs from the literal 'LINE NUMBER'. This information identifies a physical line in the report as line number information. If you don't use this configuration item, the standard PDS defaults are entered.

When the system sees this text (specified in VALUE) it knows the line identifier appears on this line at the specified column. LINE_TYPE

The area line_type defines which node type the line will have in SmartPlant Materials BOM. Choose from the available node types from the LOV in the field “Value.” The node type code is stored, but no internal id is created. The node type for every project can be the same. This config item is required and must be defined. There is no default set by the system.

The BOM node type for the line LINE_ATTR

You can have the interface interpret the line number and create its node attributes. Specify the name of the attribute in the field “Value” and enter the location in the digit-fields. You can have more than one use of LINE_ATTR by selecting this item for more than one row in the block. If you don't use this config item, the line number is stored in the short desc, description of the node and no node_attributes are generated. The attr


3BAttachments

code is stored, and no internal id is created. The attr code for every project can be the same.

Node Attributes for the line node made from the line number LINE_SEP

If you choose to define relative locations, you can define the separator symbol within the line number. If you omit this config item, the dash is created as default. Refer to description of the field “Type” for further information on defining relative or fixed locations.

Choice of using the | symbol instead of the - symbol POS_ATTR

You can transfer an unlimited number of position attributes for each position. Enter the location of the position attribute in the digit-fields, and the name of the attribute in the value-field.

POS_CC

Enter the location of the Commodity Code in the digit-fields. Trailing and leading blanks are cut off automatically. If you omit this config item, the defaults from PDS piping_g are used.

POS_IDENT

Enter the location of the Ident Code in the digit-fields. Trailing and leading blanks are cut off automatically.

POS_LEVxN

The name of the node level x where the material is stored. You can create up to five levels from the start node defined in B.40.01. If the node does not exist in the BOM, it will be created.

POS_LEVxT

The type of the node level x where the material is stored. You can create up to five levels from the start node defined in B.40.01. The node type is required when new nodes are created within the BOM tree.

POS_OPTION

Enter the location of the option in the digit-fields. Trailing and leading blanks are cut off automatically.

POS_SHORT

Enter the location of the Short Code in the digit-fields. Trailing and leading blanks are cut off automatically. If you don't have a Short Code in your file, the program will search for one within the Spec Code, Option Code and Commodity Code. If no Short Code is found, the program will receive an error. It is recommended to define a Short Code "ERROR" in S.10.08. The program then assigns this Short Code to the item where no Short Code was found, and the import will proceed. You will be informed which line was not imported because ERROR was not in the spec.


3BAttachments

POS_SPEC

Enter the location of the Specification Code in the digit-fields. Trailing and leading blanks are cut off automatically.

POS_RTYPE

Enter the location of the Record Type in the digit-fields. Trailing and leading blanks are cut off automatically. The Record Type influences the interpretation of the POS_QTY.

This would typically be used for interpretation of the Isogen.b file that used RTPYE of PIPE, COMP, BOLT, GASK, SUPP, INST. POS_QTY

Enter the location of the position quantity in the digit-fields. Trailing and leading blanks are cut off automatically. If the Record Type (as far as existing) is BOLT or PIPE, the quantity is set to zero if none are found on the line. If the Record Type is different, missing quantity is defaulted to 1. If there is no Record Type, missing quantities are left out. If you omit this config item (POS_QTY), the defaults from PDS piping_g are used.

POS_UNIT or POS_LUNIT

Enter the unit code of the position quantity. If the parameter POS_RTYPE is set, a quantity unit with a decimal point is interpreted to be a length unit and the unit is derived from POS_LUNIT. If there is no decimal point, the value in POS_UNIT is used. If the parameter POS_RTYPE is not set and the unit is a length unit, the program expects to find “MM” or “IN” following the quantity. If it is no length, the unit code from POS_UNIT is used. If you omit this config item, the unit is set to “EA” for “each.”

So, if RTYPE is used to identify PIPEs v COMPs then the decimal place will indicate a length of pipe, not a component. The unit (meters, feet, or each) is defined by POS_LUNIT for length and POS_UNIT for whole items.

POS_SIZE1

Enter the location of the first size in the digit-fields. Trailing and leading blanks are cut off automatically. If you omit this config item, the defaults from PDS piping_g are used.

POS_SIZE2

Enter the location of the second size in the digit-fields. Trailing and leading blanks are cut off automatically. If you omit this config item, the defaults from PDS piping_g are used.

POS_SIZE3

Enter the location of the third size in the digit-fields. Trailing and leading blanks are cut off automatically. You need this item to find idents for material that has more than one end and found by Commodity Code and sizes.


3BAttachments

POS_SIZE4

Enter the location of the fourth size in the digit-fields. Trailing and leading blanks are cut off automatically. You need this item to find idents for material that has more than one end and found by Commodity Code and sizes.

POS_SEP

To define relative locations, you can define the separator symbol within position line. If you omit this config item, a blank becomes the default. Refer to description of the field “Type” for further information on defining relative or fixed locations.

Value This field can hold different information depending on the field “Item.”

For LINE_NUM, the field stores the preceding identifier of the line number. Default is “LINE NUMBER.”

For LINE_ATTR, the field holds the name of the node attribute to be read from the line number. You can choose the attribute code from the LOV on A.50.01.

For LINE_TYPE. the field stores the node type name of the line nodes. You can choose the node type code from the LOV on B.10.03.

For LINE_SEP, the field contains the line separator symbol. Default is the dash.

For POS_ATTR, the field holds the name of the position attribute. You can choose the attribute code from the LOV on A.50.01.

For POS_SEP, the field contains the position separator symbol. Default is the blank.

For POS_UNIT, the field stores the quantity unit code to be used if there is no length unit (IN or MM) already contained in the ASCII file. Default is “EA.”

For POS_LUNIT, the field stores the length unit code to be used if there is no length unit already contained in the ASCII file.

Type The type can have three distinct values:

Column (C)

This value defines the horizontal position of the item in fixed column numbers. “Digit from” contains the first column to be read from the PDS file and “Digit to” contains the last column to be read. Both fields must be filled if you use this type for an item. Otherwise the program will cause a data jam. The fixed column numbers are read before the sequential order information. When you began to specify an item sequential (type “Sequence”), you cannot return to fixed column numbers.


3BAttachments

Sequence (S)

This value defines the horizontal position of the item in sequence with lowest first and highest last. The field “Seq” contains the sort order that defines when the specified item is expected in the PDS file. The step size of the sequence value can be different from 1, and the first sequence can be unequal to 1. You could even use negative values.

The field “Length” contains the last column to be read. The length is counted from the beginning of the new item. Blank entries will be ignored. While the “Seq” value is mandatory, the “Length” can be omitted. If you omit the length, the program reads the item until it comes to the specified line/position separator symbol.

Other (O)

The config item has no fixed-column or sequential information.

POS_NUM

The position number can be submitted in the ASCII file. Enter the location of the position number in the digit-fields. To transfer position numbers, set the project default ZI_OMI_POS to DATA.

Value This field can hold different information depending on the field 'Item'.

For LINE_NUM, the field stores the preceding identifier of the line number. Default is “LINE NUMBER.”

For LINE_ATTR, the field holds the name of the node attribute to be read from the line number. You can choose the attribute code from the LOV on A.50.01.

For LINE_TYPE, the field stores the node type name of the line nodes. You can choose the node type code from the LOV on B.10.03.

For LINE_SEP, the field contains the line separator symbol. Default is the dash.

For POS_ATTR, the field holds the name of the position attribute. You can choose the attribute code from the LOV on A.50.01.

For POS_SEP, the field contains the position separator symbol. Default is the blank.

For POS_UNIT, the field stores the quantity unit code to be used if there is no length unit (IN or MM) already contained in the ASCII file. Default is “EA.”

For POS_LUNIT, the field stores the length unit code to be used if there is no length unit already contained in the ASCII file.

For POS_SUM_ID, if you want to summarize material which has the same ident within one node, set this item to the value Yes, Y, True, 1, or ON.


3BAttachments

For POS_CC_MAP, if you want to use interface or company mappings for your commodity code, enter I, M, C in the desired order. Refer to help on the item field for more information.

Digit from / Seq Use depends on the field “Type” and “Item.” Refer to those for detailed information.

Digit to / Length

Comment You can use this field to enter your own information.

Since Release 5.4.2 Number of possible BOM Levels increased to 10 (Level 0 to 9).

New config items in PDS 30.01:

POS_SUM_ID. If you want to summarize material which has the same ident within the same node/list status/issue status, set this item to the value Yes, Y, True, 1, or ON. If you don't want to sum materials, omit this config item. Summarizing will only take place for material that is characterized by the same parameters. For example, if one position has only the ident code while the other has no ident but contains spec, short code and size information, these materials cannot be added even if they refer to the same ident. They will remain as two separate positions. Summarizing will only supply the correct values if they are of the same unit. The unit of identical idents will not be converted to each other by the program. If you add 1 meter pipe to 3000 mm pipe, the result will be unpredictable.

POS_TAG_NU. Enter the location of the tag number in the digit-fields. If a tag number occurs without ident on one ASCII line, it is treated as an item rule TWM. One item type in A.10.15 with rule TWM has to be checked as default. You can submit CCL short/long to create CC. If a tag number occurs together with an ident, the item type will be considered to be SWT. One item type in A.10.15 with rule SWT has to be checked as default.

1 POS _TAG_SH. Enter the location of the tag number short layout in the digit-fields. This setting is only used if you are working with POS_TAG_NU and creating tags with item rule TWM. One item type in A.10.15 with rule TWM has to be checked as default.

2 POS _TAG_LO. Enter the location of the tag number long layout in the digit-fields. This setting is only used if you are


3BAttachments


working with POS_TAG_NU and creating tags with item rule TWM. One item type in A.10.15 with rule TWM has to be checked as default.

3 POS_CC_MAP. You can receive commodity codes in an interface- or company-specific translation. You have three characters to indicate what translation should be used: “M” for SmartPlant Materials, “I” for interface specific, “C” for company specific commodity codes. The order of these characters specifies the search order. The value “CIM” would first look for a commodity mapping; if none found, look for an interface mapping; and if none found, assume the normal commodity code from S.30.01. In this example, you could have omitted “M” because the normal commodity code is looked up per default if no other codes are found. You don't have to use all three characters: “C“ is also a valid example value for POS_CC_MAP. The interface code for interface mappings is “PDS.” The company code for company mappings is taken from PDS 10.01 PDS configuration screen.

POS_NATTR. Specify an arbitrary number of node attributes for each node of the SmartPlant Materials BOM structure. Enter the location of the position attribute in the digit-fields, and the name of the attribute in the value-field. To transfer the attributes correctly, the first position row which is on another (or on the very first) node has to contain the node attributes with their values. The node attribute information on all following position rows for the same node in the import file will be ignored.

The usage depends on the field “Type” and “Item.”Refer to those for detailed information.

smartplant materials how to receive model information from...

Documents