The following lists include rules that must be followed when using Smart Instrumentation in an integrated environment. Following these rules allows Smart Instrumentation data to be shared correctly with other integration tools.
The software retrieves instrument data at the lowest plant hierarchy level in the plant hierarchy item that you logged on to in Smart Instrumentation, for example a unit. The software retrieves wiring data, such as panels and cables, in the highest plant hierarchy level. Provided a plant is registered, you can publish and retrieve data in Smart Instrumentation, subject to the limitations indicated in the following sections.
General Integration Requirements
The following is a list of best practice scenarios for using Smart Instrumentation so data will migrate correctly to the other Smart software tools.
-
As Domain Administrator, perform the following tasks:
-
Assign the access right for SmartPlant Registration (under Domain Level) to Full (Add / Delete / Update).
-
Assign the access rights for Publish and Retrieve (under each registered plant) to Full (Add / Delete / Update).
-
-
If you have installed Smart Instrumentation on a SQL Server platform, open the Intools.ini file and under the [Database] section, make sure that the Lock parameter has the value:
Lock=RC
Naming Convention Requirements for Integration
Instruments, Loops, Control System Tags and other objects in Smart Instrumentation have a naming convention. The names of these objects are made of segments with predefined length and separators between the segments.
If working in an integrated environment, you cannot use a forward slash (/) as a
plant hierarchy separator.
The mapping between the segments of the name and properties in the SmartPlant schema is determined by the content of the NamingConventionMap.xml file. For details, see Naming Convention Mapping.
Instrument Retrieval
When you retrieve an instrument, the software populates the tag number segments from the retrieved instrument object properties according to the following mapping:
Segment |
Property |
---|---|
1 |
InstrTagPrefix |
2 |
MeasuredVariable+InstrFuncModifier |
3 |
InstrTagSequenceNo |
4 |
InstrTagSuffix |
Segment 1 is populated with the InstrTagPrefix
Segment 2 is populated with the concatenation of MeasuredVariable and InstrFuncModifier
Segment 3 is populated with the InstrTagSequenceNo
Segment 4 is populated with the InstrTagSuffix
The segments are then trimmed and put together according to the naming convention to create the tag number.
If the naming convention in other tools (for example, Smart P&ID) does not include a prefix, the first segment length needs to be set to 0.
Loop Retrieval
When you retrieve a loop, the software populates the loop name segments from the retrieved instrument object properties according to the following mapping:
Segment |
Property |
---|---|
1 |
LoopPrefix |
2 |
LoopIdentifier |
3 |
|
4 |
LoopSequenceNo |
5 |
LoopSuff |
Segment 1 is populated with the LoopPrefix
Segment 2 is populated with the LoopIdentifier
Segment 4 is populated with the LoopSequenceNo
Segment 5 is populated with the LoopSuff
Segment 3 is not populated and needs to be set to length 0
Instrument Publishing
When you publish an instrument, the software populates the published object properties by the naming convention segments as follows:
Property |
Segment |
Comment |
---|---|---|
InstrTagPrefix |
1 |
|
MeasuredVariable |
2 |
Left side of segment 2 |
InstrFuncModifier |
2 |
Right side of segment 2 |
InstrTagSequenceNo |
3 |
|
InstrTagSuffix |
4 |
The object name is populated by the tag number with all spaces removed. If the length of prefix is more than 0, the prefix will be part of the object name. Other applications that publish instruments (for example, Smart P&ID ) need to be configured to publish the instrument object name with the prefix.
The MeasuredVariable and InstrFuncModifier are both populated be the second segment. If the first two characters of segment 2 are included in the TwoLetterMeasuredVariable list that was defined in the Smart Instrumentation mapping file, then the MeasuredVariable gets these two letters; if not then the MeasuredVariable gets the first character of segment 2. In both cases, the InstrFuncModifier gets the rest of the characters of segment 2. This allows correct publishing of instruments such as PDT or DPT.
TwoLetterMeasuredVariable |
---|
DP |
PD |
FQ |
FF |
TD |
WD |
ZD |
FO |
Loop Publishing
When you publish a loop, the software populates the published object properties by the naming convention segments as follows:
Property |
Segment |
---|---|
LoopPrefix |
1 |
LoopIdentifier |
2+3 |
LoopSequenceNo |
4 |
LoopSuff |
5 |
The object name is populated by the loop name with all spaces removed. If the length of prefix is more than 0, the prefix will be part of the object name. Other applications that publish loops (for example, Smart P&ID) need to be configured to publish the loop object name with the prefix.
An example of an instrument naming convention:
An example of a loop naming convention:
Integration with Smart P&ID
General
-
Both Smart Instrumentation and Smart P&ID must have the same plant hierarchy structure, with a minimum of three levels.
-
The domain name in Smart Instrumentation must be different from the plant name in Smart P&ID.
-
You cannot change the plant hierarchy template or names of plant hierarchy levels after retrieving documents from Smart P&ID for the first time. You can, however, change the names of individual plant group items, if you require.
Working with Projects
-
You can edit items in the project where you are publishing or retrieving new objects, however, you CANNOT edit As-Built items unless you have claimed them to a project, other than for publishing data. In Options Manager, under General Settings, you can disable editing in As-Built using the Allow Full Access to As-Built option.
-
In Options Manager, under General Settings, you must set the Claim Mode option to Exclusive only. As a result, you cannot claim the same items for multiple projects.
-
You cannot perform a manual claim of any items belonging to the following item types that are shared between Smart Instrumentation and Smart P&ID: tag numbers, loops, lines, equipment, and control system tags. This requirement exists because Smart P&ID performs the scoping and Smart Instrumentation automatically claims scoped items when you retrieve data. You can manually claim any unshared items such as panels, strips, terminal, cables, cable sets, wires, and so forth.
-
In Smart Instrumentation, the software automatically claims control systems tags for pre-assigned instruments to the project whenever the instruments are claimed. However, for unassigned instruments, you must claim the control system tags separately to assign them to these instruments in the project.
-
You must merge all shared items at the same time; you cannot perform a partial merge of shared items.
Publishing Data
-
You are not allowed to publish data from As-Built. Doing so results in items appearing more than once (for As-Built and for each project where the item is claimed). Instead, you must open the specific project from which you want to publish the data.
Retrieving Process Function and Instrument Type Data
While there is no requirement to specify process function and instrument type values when publishing from Smart P&ID, you should be aware of the following:
-
Smart P&ID has a property, InstrumentComponentType, that sometimes, but not always, matches the instrument type in Smart Instrumentation. This property is part of the Smart P&ID symbol. Only by replacing the symbol can you change the value of the InstrumentComponentType property for in an instrument that was already placed on the drawing. If the symbol does not provide enough information to publish an instrument type that is recognized by Smart Instrumentation, on retrieving data in Smart Instrumentation, the software specifies the process function and instrument type based on the name of the instrument, where the instrument naming convention includes an Instrument Type segment. For example, if the name of the instrument is FT-100, the software assigns to it instrument type FT and process function Flow.
-
If Smart Instrumentation recognizes an instrument type that has more than one description, the software assigns to the instrument the instrument type description designated as the default.
-
If Smart P&ID cannot publish an instrument type, or if it publishes an instrument type that Smart Instrumentation is unable to recognize, then on retrieving the data, Smart Instrumentation does not assign an instrument type. You can then specify the instrument type manually in Smart Instrumentation.
-
If you have already specified an instrument type in Smart Instrumentation and you run an update task that has a null or unrecognized instrument type, the software does not overwrite the existing instrument type.
Integration with Smart Electrical
To have a successful data exchange between Smart Instrumentation and Smart Electrical, make sure that:
-
Both Smart Instrumentation and Smart Electrical have the same plant hierarchy structure, with a minimum of three levels.
-
In Smart Instrumentation, instruments and I/O signals are defined on the lowest plant hierarchy level.
-
In Smart Instrumentation, cabinets are defined on the highest plant hierarchy level.
-
In Smart Electrical, you defined a registered report for both the I/O lists and for Instruments requiring power supply.
You must also ensure that the following Smart Electrical select lists and Smart Instrumentation supporting tables contain identical values:
-
System I/0 type
-
Rated Voltage
-
Power Supply AC/DC Flag
-
Number of Phases
-
Operating Mode
-
Process Function
-
Frequency
Furthermore, in the Administration module, in the Domain Definition window, the System Administrator must clear the check box Allow claims for multiple projects (if working in an owner operator domain or EPC-Project Mode).
In the two tools, the units of measure of certain properties might be defined using a different precision accuracy. For example, 1.2 kW (one-digit accuracy of precision) in Smart Electrical corresponds to 1.23 kW (two-digit accuracy of precision) in Smart Instrumentation. This may result in inconsistencies and could be interpreted as an update when retrieving data.
These properties are:
-
Rated Active Power
-
Rated Reactive Power
-
Rated Apparent Power
-
Full Load Current
-
Operating Mode Coincidence Factors (X, Y, Z, ZZ)
-
Starting Current