You are on page 1of 22

SPI Data Take-On

Unique Identifier: Revision: Page:

0 1

Procedure

Title:

SPI Data Take-On

Unique identifier: Area of applicability: Documentation type: Revision: Total pages: Next review date: Procedure 1

Disclosure classification:

SPI Data Take-On

Unique Identifier: Revision: Page:

0 2

CONTENT PAGE

CONTENT PAGE ........................................................................................................................ 2 INTRODUCTION ......................................................................................................................... 3 1.1 PURPOSE............................................................................................................................. 3 2. INFORMATIVE REFERENCES ............................................................................................. 3

Acrobat Document
.................................................................................................................. 3 3. DEFINITIONS........................................................................................................................ 4 4. ABBREVIATIONS ................................................................................................................. 4 5. PROCEDURE: Contracts using Tools other than SPI ............................................................. 5 5.1 Prerequisites for Contractor ................................................................................................... 5 5.2 Receiving data from suppliers ................................................................................................ 5 5.3 SPI Import Procedure ............................................................................................................ 6 5.4 Data templates used for data import to SPI ............................................................................ 6 Units of Measure UoM ............................................................... Error! Bookmark not defined. 4. AUTHORISATION.................................................................. Error! Bookmark not defined. 5. REVISIONS............................................................................ Error! Bookmark not defined. 6. DEVELOPMENT TEAM ......................................................... Error! Bookmark not defined. APPENDIX A. APPENDIX B. UPDATE FORMATTING SCHEME ................................................................. 17 SUPPORTING TABLES FOR PROCEDURE 4 ............................................... 17

SPI Data Take-On

Unique Identifier: Revision: Page:

0 3

INTRODUCTION
1.1 PURPOSE
The purpose of the document is to supply the requirements with regard to submissions for Smartplant Instrumentation. This Procedure defines the requirements and formatting of data to be imported and utilised in SmartPlant Instrumentation tools to perform design reviews and to create instrumentation designs. This document will describe the basic procedure for using SmartPlant instrumentation Import manager to create the basic design components

2.

INFORMATIVE REFERENCES

SmartPlant 2009 Import and Merger Utilities Users Guide

Acrobat Document

SPI Data Take-On

Unique Identifier: Revision: Page:

0 4

3.

DEFINITIONS
Description Can refer either to an entire Worksheet of an Excel Workbook or may refer to a defined, named subset of a Worksheet. A row of a Spreadsheet. A data tag and all data corresponding to that tag.

Definition Spreadsheet

Spreadsheet Entry

Data Field

A specific field or column in the spreadsheet. A field represents a specific property or design element. A Panel is an entity in SPI to which houses wiring items. Panels could be Junction Boxes, Marshalling Racks, DCS Cubicles etc. A wiring item that pertains to different types of multi-purpose I/O devices. These devices accept wires and signals, for example, barriers, opto-couplers, relays, repeaters, isolators, and so forth. A simple wiring item, with 2 sets of connectors Left and Right. The terminals on a strip can be labeled in recurring patterns for easy labeling and identification A collection of wires. The wires in a cable can be labeled in repeating patterns for easy labeling and identification.

Panel

Apparatus

Terminal Strip

Cable

4.

ABBREVIATIONS
Abbreviation Description SmartPlant Instrumentation Control and Instrumentation External Contractor Kraftwerk-Kennzeichensystem Input/Output Piping and Instrumentation Diagram File Transfer Protocol Quality Assurance High Availability To Be Defined Unit of Measure

SPI C&I EC KKS IO P&ID FTP QA HA TBD UOM

SPI Data Take-On

Unique Identifier: Revision: Page:

0 5

5.

PROCEDURE: Contracts using Tools other than SPI

While it is possible for contractors to use tools other than SPI for performing field designs and then import the data into SPI via the SPI Import Tool, it is not recommended. The potential for error becomes very large when importing data in this way. New contracts should make every effort to stipulate that contractors not use systems other than SPI for design work. In the event that the use of a non SPI tool is used, this procedure as documented here offers an insight into how data take-on can be handled. This procedure is not complete, in the event that this method of design is utilized, the Contractor shall consult a SPI specialist and a specialist for the tool they will be using to confirm the best way to handle data transfer.

5.1 Prerequisites for Contractor


5.1.1 Contractor Data Deliverables Definition
In order to do design work and then import all design data accurately from a tool which does not have a database which is directly compatible with that of SPI, the Contractor will need to be careful when setting up their systems and when delivering data. Contractors shall set up their softwares configuration to accurately reflect the configuration of the Local SPI plant at the time of design so that design data can be retrieved into the PBS configuration on SPI. Contractors shall confirm with experts on SPI and the design tool being used as to what data is needed to accurately reconstruct the design on the Local Database. A guideline of the types of data required will be given in this document, but these should not be considered complete and accurate.

5.2 Receiving data from suppliers


5.2.1 SPI Data Supply Format
All data which is to be imported into SPI from Contractors using tools other than SPI shall be provided in either Microsoft Excel (Office 2003 .xls or Office 2007 .xlsx) spreadsheet format or preferably Microsoft Access Database (.mdb) Separate Tables must be supplied for the various different information sets which are required in order to build the SPI database. The Excel spreadsheets shall be populated in line with standard templates which have been confirmed as accurate with a SPI expert corresponding to the type of data to be imported. o Instrument Data shall be populated in accordance with an Instrument Data Template. o Field Design Data shall be populated in accordance with the various Field Design Templates. The layout and ordering of the data templates shall not be edited or modified in any way once they have been confirmed. If Excel is used, Named tables shall be defined each spreadsheet containing all of the data which needs to be imported. Any data which is not needed by SPI on a worksheet can be ignored by not including it in the scope of the defined table. The tables shall be named in such a way as to reflect the data which is contained in the table. The naming convention employed shall be consistent across all data sets delivered. Data populated in the various fields shall have correct, relevant formatting so as to be suitable with the corresponding data type to which the data will be imported.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 6

5.3 SPI Import Procedure


Data received from a Contractor shall be imported into the SPI database using the SPI Import Utility or the SmartPlant Instrumentation tool itself. To verify the accuracy of the supplied data, the data should initially be imported into the QA instance of SPI. Once the data has been validated there, it can be copied to the Production instance as the official configuration. To import data using the SPI Import Utility, all data fields supplied in the Excel spreadsheets or in an Access Database shall be mapped to relevant fields of the relevant tables in the SPI database. This mapping must be accurate and should be done by an SPI database expert. The essential fields which need to be populated will be explained in the relevant sections. If MS Excel spreadsheets are provided, it is recommended to migrate these into an MS Access database as the importing of data is faster and more stable between an Access database and the SPI database than from spreadsheets. The importing of data through the import utility is very slow and requires many steps. Great care must be taken when using the import tool. For certain functions it is far simpler and quicker to simply use the SmartPlant Instrumentation tool itself to recreate the database.

5.4 Data templates used for data import to SPI


As mentioned, the contractor supplying data shall confirm all data which is to be supplied at the onset of a project.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 7

5.4.1 SPI Instrument Data Template


In order to capture the minimum required instrument data required for the development of a complete database and accurate Configuration Management data; the fields in Table 3 must be filled in for each instrument. There are additional fields which may or may not be populated depending on the nature of the instrument or piece of equipment. These fields are defined in

SPI Data Take-On

Unique Identifier: Revision: Page:

0 8

Table 4 these should be populated as is appropriate to the instrument or item of equipment as necessary. The
instrument types which may be used will be confirmed between contractor at the beginning of a project, this ensures data can be accurately imported.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 9

5.4.2 SPI Wiring Equipment Import


In order to import wiring equipment into the SPI database, it is necessary to follow the following process to create all of the wiring equipment including DCS Cabinets, Junction Boxes, Cables and the connections of the cables to the relevant equipment. The following sections will briefly give an introduction into data imports. The mappings which are explained are the minimum mappings required in order to create basic equipment and connections. The mappings explained here do not necessarily conform to the standards used by the source provider and appropriate modifications may be necessary. The procedures detailed here do not show any metadata properties which may be appropriate for specific equipment. If this data is available, it can be included. 5.4.2.1 Importing DCS Panels The order of items which need to be imported will differ depending on the actual configuration of the system. The process that will be described below will show a typical process using a Siemens T3000 type system with ET200 panels with Marshalled Terminal Assemblies (MTA) as the basis. Figure 1 shows a typical Siemens ET Panel with internal Marshalling. In the example, there are two racks AC, BC and a Marshalling Terminal Assembly. The MTA is an array of 320x8 pins for connecting the field wiring to the relevant I/O Cards located in the racks. Importing the entire set of terminal strips can take a long time since each terminal needs to have a line written into the database and the import utility takes approximately 1.5s per line, so for say 10 DCS cubicles, the import operation may take in excess of 10 hours, but if the cubicles were created directly in SPI, it would only take a few minutes to create all of the cubicles with their associated terminal strips.

Figure 1: Example of Siemens DCS Panel with Internal Marshalling


To create this structure through the use of the Import Utility, there are 5 steps that need to be followed. 1. Create the DCS Panels 2. Create the Racks 3. Create the MTA Terminal Strip 4. Create Channels on the MTA Terminal Strip 5. Create the Terminals on the MTA TS 6. Create slots on the DCS Racks See Table 5 See Table 6 See Table 7 See Table 8 See Table 9

SPI Data Take-On

Unique Identifier: Revision: Page:

0 10

7. Assign Cards to the slots To import the DCS Panels, it is necessary to create a link in the Import utility using a single Table PANEL The Table definition must be left as the default table definition. The following fields need to be populated as a minimum.

Table 1: Panel Definitions to create a DCS Cabinet


Property Panel_Name Remark This is the name of the panel, the source table must contain a column which has the KKS names of the DCS Cabinets To create a DCS Cabinet, this value can be a static value of 5 in the link definition To create a DCS Cabinet, this value can be a static value of 510 in the link definition This can be a static N in the link definition.

Panel_Category_ID

Panel_Sub_Category_ID

Def_Flg

An example of how the source data would look is shown in Figure 2.

Figure 2: Example of DCS Panel Source Data


Each of the other steps can be followed in a similar manner. The corresponding tables Table 5 to Table 9 in Appendix B show which fields must be populated and what data those fields must be populated with.. For certain Items which are to be imported, it is necessary to use a table definition other than the default definition. To illustrate, when importing a terminal strip directly into a panel and when importing a terminal strip onto an apparatus such as an I/O Card on a Rack within a panel. Both terminal strips will be created on the Table Panel_Strip, but because the two strips are located at different levels, they will reference different types of parent items. The Terminal strip located directly in the panel will reference the parent item Panel_Name only, whereas the terminal strip on an I/O card will reference Panel_Name, Rack_Name and Apparatus_Name. To make the link in the import module work correctly, the correct table definition must be selected. For the example illustrated above where a Terminal Strip was located directly in the panel, (this would be the case for a junction box as well) Select the link properties -> select Table Definition -> Select Definition -> Select Panel-Strip as shown in Figure 3 > Apply the changes and select yes when asked if you wish to change from the default table definition. To validate that the Table Definition has changed, see the Definition column as shown in Figure 4.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 11

Figure 3: Table Definition Selection

Figure 4: Validate the Table Definition

SPI Data Take-On

Unique Identifier: Revision: Page:

0 12

5.4.2.2 Importing Junction Boxes The process for importing Junction boxes is very similar to the process for importing DCS Panels. A typical junction box structure is shown in Figure 5.

Figure 5: Typical Junction Box Structure


Three steps are needed to create the Junction boxes. 1. 2. 3. Create the Panels Create the Terminal Strips on the panels Create the Terminals on the Terminal Strips See Table 5 See Table 7 See Table 9

The same tables are referenced as for the creation of the DCS Panels; the major differences which need to be noted are that the Panel Category ID and Panel Sub Categories are different. The codes which are required are detailed in the details column of the tables.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 13

5.4.2.3 Importing Cables To import cables three steps need to be followed. 1. The Cable Needs to be created 2. Each cable set within the cable needs to be created 3. Each wire within each cable set needs to be created Table 10 Table 11 Table 12

Figure 6 below illustrates the cable structure. The Cable name is 4 0HAD 4001 UH, there is only one cable set with name 1 and there are 4 wires numbered 1-4.

Figure 6: Cable Structure


Similarly to the previous section of this document, the tables and fields which must be populated in order to create the cable structures are shown in Table 10 to Table 12 of Appendix B.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 14

5.4.2.4 Importing of Instrument Device Panels Each instrument that has wiring attached to it will need an associated device panel. Creating an instrument as specified previously simply creates a tag for the instrument without any associated wiring equipment. Creating a device panel allows a terminal strip to which wires can be connected to be created for an instrument. To create a device panel and associate it to an instrument, 4 steps need to be followed. 1. Create the device panel 2. Create the terminal strip for the device panel 3. Create the terminals on the terminal strip 4. Link the device panel to the instrument. Table 5 Table 7 Table 9 Table 13

The device panel can be given the same name as the instrument. When the device panel is created by SPI itself, this is the convention used.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 15

5.4.2.5 Connecting Wires to Wiring Equipment At this point the import procedures for all of the basic equipment types have been explained. The next major step is to connect the wires in the cables to the associated wiring equipment. To import a connection only one basic step needs to be done. This basic step will need to be slightly altered and repeated for the different locations where connections can be made. 1. Connecting wires to device panels 2. Connecting wires to field side of junction box terminals 3. Connecting wires to the trunking side of the terminals 4. Connecting wires to the Marshalling terminals etc. Table 14 in Appendix B shows the fields which need to be populated in order to make a connection. Figure 7 is a typical example of how the import link would look when importing the wiring connections on instrument device panels to the instrument cables. In the example the cable number field is linked to instrument cable name. The cable set name field is linked to the static value 1 this is because all of the instrument cables were created with only one cable set. The panel name field is linked to the device panel, the device panels were named using the KKS code of the instrument appended with -DP for device panel. The set level field is linked to the wire number of the cable. The strip name field is linked to the static value TS this is because in this case all of the terminal strips on device panels were named TS The term seq field is linked to the wire number of the cable here because the device panel terminals were created using the wire numbers. To be more correct, this should be linked to a source field containing the corresponding terminal strip terminal number. The term side is set to R to connect to the Right side of the device panel terminal strip.

Figure 7: Example Mapping of Wiring Connection Link


Figure 8 shows the result of the connection of cable 4 0HAD 4001 UH to the device panel for 4 0HAD35 AA101.

SPI Data Take-On

Unique Identifier: Revision: Page:

0 16

Figure 8: Example Result of Wiring Connection on Device Panel

SPI Data Take-On

Unique Identifier: Revision: Page:

0 17 of 22

APPENDIX A.

UPDATE FORMATTING SCHEME

Table 2: Update Formatting Scheme When Using Excel Files Formatting Highlight Turquoise Highlight Yellow Highlight Through Red and Meaning New data since last Revision Data Has Changed Since Last Revision Strike Data is being removed or is now invalid Comment

APPENDIX B.

SUPPORTING TABLES FOR PROCEDURE 4

Table 3 : Essential Instrument Data Fields


Typical Source Field Name KKS Item tag SPI Target Field Description KKS Code of Load. Is the key field, must be specified and must be unique. The code must also be formatted correctly with spaces in the appropriate places. e.g. 6 0LAB10 CT001 This field is necessary for SPI to categorise the instrument type correctly. E.g Temperature, Flow etc. See SPI Import Manual for allowed types and corresponding mapping codes This field is a short code which classifies the instrument type. This code will be the KKS 3rd level code. E.g QB for a sensor/transducer This field disambiguates the instrument type within SPI so that different properties can be assigned to different instrument types which would have the same KKS 3rd level. For instance QB for a flow type instrument could represent an Orifice plate or Rota meter.

Process Function

Process Function Type

Instrument Type

Instrument Type

Instrument Type Description

Instrument Type Description

SPI Data Take-On

Unique Identifier: Revision: Page:

0 18 of 22

Table 4 : Configuration Management Data


Typical Field Long description TBD SPI Property Field Description Text Description of Load. This field is necessary for accurate Config Management This field is a shortened version of the long description. The P&ID drawing number on which the instrument appears. sheets/revisions? Name of supplier of the specific load. Reference to the C&I IO block diagram specific to that instrument Reference to the Limits of Scope and Supply to which the instrument belongs Operating Range of Instrument Operating Range of Instrument Operating Range of Instrument Designed Operating Pressure of instrument Designed Operating Temperature of instrument This will be expanded to several fields for alarm and set point values

Short Description PID no

TBD P&ID Drawing Number

Instrument supplier IO Function Block Ref

Contractor Name User Defined Fields TBD User Defined Fields TBD Instrument Range (max) ? Instrument Range (min) ? ? ?

LOSS Ref Engineering Values (max) Engineering Values (nor) Engineering Values (min) Designed Pressure Designed Temperature Alarm/Set Point Values

Purpose of measurement Notes/Remarks Etc.

User Defined Fields User Defined Fields

SPI Data Take-On

Unique Identifier: Revision: Page:

0 19 of 22

Table 5: Importing Panels


Table = PANEL
TABLE DEFINITION = Default Property Panel_Name Description This is the name of the panel, the source table must contain a column which has the KKS names of the DCS Cabinets To create a DCS Cabinet, this value can be a static value of 5 in the link definition. To create a Junction box 1 should be used. To create a device panel 4 should be used. To create a DCS Cabinet, this value can be a static value of 510 in the link definition. To create a junction box 110 should be used. To create a device panel 410 should be used. This can be a static N in the link definition.

Panel_Category_ID

Panel_Sub_Category_ID

Def_Flg

Table 6: Importing Racks onto DCS Panel


Table = CABINET_RACK
Table Definition = Default Property Panel_Name Description This is the name of the panel that has already been created in which the racks will reside. This is the name that that the rack should be given This is the sequence number of the rack This is the number of slots that will be available on each rack This can be a static N in the link definition.

Cabinet_Rack_Name

Rack_Seq Slot_Count

Def_Flg

Table 7: Importing Panel Strips Directly Into the DCS Panel


Table = Panel_Strip Table Definition = Panel-Strip Property Panel_Name Description This is the name of the panel that has already been created in which the strip will reside. The name that the strip will be given Static 0

Strip_Name Strip_Category

SPI Data Take-On

Unique Identifier: Revision: Page:

0 20 of 22

Panel_Strip_Seq

The sequence number of the strip in the Panel. Will be a static 1 if there is only one strip Static N

Def_Flg

Table 8: Importing Channels onto the Terminal Strips


Table = Channel Table Definition = Strip-Channel
Property Panel_Name Description This is the name of the panel that has already been created in which the channel will reside. The name that of the existing strip The name that the channel will be given. The sequence number of the channel on the strip. Static 0 Static N

Strip_Name Channel_Name Channel_Seq

Channel_Type Def_Flg

Table 9: Importing Terminals onto the Channels of the Terminal Strip


Table = Panel_Strip_Term
Table Definition = Default Property Panel_Name Description This is the name of the panel that has already been created in which the channel will reside. The name that of the existing strip. The name of the existing Channel. If there are no channels given on the terminal strips, this can be omitted. The sequence number of the terminal in the terminal strip The name that the terminal will be given. This can be alph-numeric. Static N

Strip_Name Channel_Name

Term_Seq

Term_number

Def_Flg

SPI Data Take-On

Unique Identifier: Revision: Page:

0 21 of 22

Table 10 : Importing Cables


Table = CABLE
Table Definition = Default Property Cable Num Cable Category Description This will be the name of the cable to be created This specifies the type of cable, for regular cable a static value R can be used Static N

Def_Flg

Table 11: Importing Cable Sets


Table = CABLE_SET
Table Definition = Default Property Cable Num Description This will be a name reference to the cable in which the cable sets are created. This field is the name of the cable set. If the source data does not specify cable sets, it may be necessary to specify only one cable set. This will be the numeric sequence of the named cable set. Again if there is only one set a static value 1 can be used. Static N

Cable Set Name

Cable Set Sequence

Def_Flg

Table 12: Importing Wires into Cable Sets


Table = CABLE_SET
Table Definition = Default Property Cable Num Description This will be a name reference to the cable in which the cable sets are created. This will reference the cable set name that the wire being created belongs to This is the numeric sequence number of the wire within the cable set This is the name that will be displayed for the wire Static N

Cable Set Name

Set Level

Wire Tag

Def_Flg

SPI Data Take-On

Unique Identifier: Revision: Page:

0 22 of 22

Table 13: Linking Device Panels to Instrument Tags


Table = PANEL_COMPONENT
Table Definition = Default Property Panel Name Description This will be a name of the Device panel that was created for the Instrument This will reference the instrument tag to which the device panel should be associated

Tag number

Table 14: Import Connections of Wires to Terminals


Table = WIRE_TERMINAL
Table Definition = Default Property Cable Num Description This will reference the cable number of the wire to be connected This will reference the cable set name of the wire to be connected This references the numeric number of the wire in the cable set to be connected to the terminal strip This references the name of the panel in which the terminal to connect to resides This references the name of the terminal strip on the panel to which the wire will be connected This references the terminal number on the strip to which the wire is to be connected Will be either L or R for left and right side of the terminal strip. The appropriate end of the wire will be connected.

Cable Set Name

Set Level

Panel Name

Strip Name

Term Seq

Term Side