Instruments Configuration Category

The Instruments Configuration Category is divided into five sub-categories:

Settings Sub-Category

This application pane is used to set up the configuration properties of instruments.

The application pane is divided into the following sections.

Number of TAG fields Section

If four tag fields are to be used for project instruments (Prefix, Type, Number, Suffix), select the 4 Tag Fields option.

If six tag fields are to be used for project instruments (Block, Function, Prefix, Type, Number, Suffix), select the 6 Tag Fields option.

Values to Remember from Last Instrument Edit Section

This section contains a number of checkboxes - Block, Function, Prefix, Type, Number, Suffix, Descriptor, Pattern Reference, Alarm 1, Alarm 2, Alarm 3, Alarm 4, Alarm 5, Alarm 6, Size and Specification.

Note: The Block and Function checkboxes are only active if the 6 Tag Fields option in the Number of Tag fields section is selected.

A project can be configured so that a value entered in a field in a Properties dialog is "remembered" by the same field when that Properties dialog is accessed again when labelling another, previously unlabelled, item of that type.

If, for example, the functionality is switched on for the instrument Prefix field, and an instrument is labelled with a value of "20". The next time an instrument is labelled for the first time, when the Properties dialog for this item is opened, the Prefix field will automatically be completed with the value "20". This can be replaced by another value if required. This new value will then be the "remembered" value for the instrument Prefix field.

This functionality is switched on and off for individual Properties dialog fields by checking and unchecking the checkboxes in this section.

Instrument Panel Dialog Labels Section

This section contains four fields, which are used to specify the boilerplate text to replace the defaults of Prefix, Tag, Number and Suffix in the Instrument Panel Reference Properties dialog and other dialogs.

Instrument Dialog Labels and List of Values Section

If a list of values is to be used for instrument alarm labels, check the Enable Alarms LOV checkbox.

The Alarms field specifies which list of values is used for instrument alarm labels. The list of values is selected using the drop down list.

Lists of values for instrument alarm labels are defined using the List of Values Configuration Category of the Administration program. The default list of values for alarm labels is USERLOV_Alarms, custom lists of values for alarm labels can be created. The placement position of instrument alarm labels is defined using the Instrument Alarm Positions section of the Instrument- Labels Sub-Category.

This section contains four or six active fields, depending on the setting in the Number of Tag fields section.

They are used to specify the boilerplate text to replace the defaults of Block, Function, Prefix, Tag, Number and Suffix in the Label Instrument Properties dialog and other dialogs, and assign lists of values to them.

A sub-section of this section is used to perform these actions for the Descriptor field.

The first two fields are not active if the 4 Tag Fields option in the Number of Tag fields section is selected, for example:

In the Delimiter After Field 1, 2, 3, 4 and 5 fields, enter the delimiters used to separate the fields.

Note: These delimiters are not displayed on P&IDs or in the Engineering Explorer. They are used to make sure tag format consistency when exporting to PDMS via the ISO15926/P&ID Manager interface.

If required, from the drop-down lists next to each field, select the list of values against which entries in a tag field are to be validated: Area Code, Block Code, Function Code or Instrument Type.

• Area Code

• Block Code

• Equipment Type

• Function Code

• Imperial Size

• Instrument Type Letter

• Insulation Table

• Insulation Condition

• Insulation Index

• Metric Size

• Paint Code

• Service/Fluid Code

• Specification Code

• Valve Code

• Valve Closure

A list cannot be selected more than once. Lists of values are set up in the List of Values Configuration Category of the Administration program.

In the Descriptor sub-section, if required specify boilerplate text and select a list of values as described above.

Note: List of values validation takes priority over both pipe label inheritance and sheet attribute inheritance.

Propagation Rules from Pipes/Instrument/Equipment Section

This section contains the following settings:

• If item labels are to be inherited from owner pipes, equipment or associated instruments, the fields to be inherited from for each label are specified in the Instrument Prefix, Type, Number and Suffix fields, plus the Block and Function fields if the 6 Tag Fields option in the Number of Tag fields section is selected.

  Note: If an instrument label field is set to be validated against a list of values its Fields from Pipes field will not be accessible. List of values validation takes priority over pipe label inheritance. However, pipe label inheritance takes priority over sheet attribute inheritance.

• The Browse button adjacent to pipes fields is used to select the fields to be inherited from. On selection of the button, the following dialog box is displayed:

  

  The fields required are selected using the drop down lists. Following selection, press OK. The selected fields will then be displayed in the Instrument Prefix, Type, Number and Suffix fields, plus the Block and Function fields if the 6 Tag Fields option in the Number of Tag fields section is selected.

• The Browse button adjacent to instrument and equipment fields is used to select the fields to be inherited from. On selection of the button, the following dialog box is displayed:

  

  The fields required are selected using the drop down lists.

  As required, enter a delimiter character in the field adjacent to each field selection list.

  Following selection, press OK. The selected fields will then be displayed in the Instrument Prefix, Type, Number and Suffix fields, plus the Block and Function fields if the 6 Tag Fields option in the Number of Tag fields section is selected.

• The values of instrument labels may be inherited from the sheet attributes entered on the Advanced Drawing Properties sheet. The values entered for these sheet attributes may be values that are common to many items on the drawing, for example, the design area. The inheritance facility enables all items to inherit these common values. The labels of items that do not share these common values may subsequently be edited manually using their properties sheets.

  The Fields from Sheet Attribute fields are used to select which instrument label fields are to inherit values from which sheet attributes. As required, select for each instrument label field the sheet attribute field from which values are to be inherited.

  Note: If an instrument label field is already set to inherit from the owning pipe, or is set to be validated against a list of values (see above), its Fields from Sheet Attribute field will not be accessible. Both list of values validation and Pipe label inheritance take priority over sheet attribute inheritance.

  Note: The attributes of the INSTRUMENT_TAG DataSet (see User Defined Attributes -DataSet Sub-Category) are be available for selection, in addition to the sheet attributes.

  Sheet attribute field names are set up using the Drawing Information - Settings Sub-Category.

• Instrument label fields that inherit values from sheet attributes can be hidden, for example, though they are part of instrument labels and will be included in any exports of P&ID data, they are not displayed on P&IDs. To hide an inherited instrument label field, check the checkbox next to the field in question.

  Note: Changing these settings will not change the appearance existing item labels. Only the appearance of labels subsequently added to a drawing will be affected.

Label Validation Across P&IDs Section

The project may be set to check that all instrument/instrument loop labels in all P&IDs in a project are unique.

• Select Prevent if users are to be prevented from entering project duplicate instrument labels. If this is attempted, an error message is displayed and the duplicate label may not be placed on the P&ID.

• Select Warn if users are to be warned if they enter project duplicate instrument labels. The entry of duplicate labels is permitted in this case, but an error message will be displayed on the P&ID, and will accompany the instrument label data when exported.

• If no uniqueness validation of instrument labels across P&IDs is required, select Ignore.

Instrument Loop Tag Section

This section is used to define which fields are used to identify instrument loops, and which of these fields are inherited by instruments in loops.

This section contains four or six pairs of checkboxes, depending on the setting in the Number of Tag fields section.

• As required, check the Block, Function, Prefix, Type and/or Suffix checkboxes to define which fields are to be used to identify instrument loops.

• The Number checkbox is checked automatically and cannot be unchecked. Number is minimum field required to identify instrument loops.

• If instruments within a loop are to inherit values from the loop they are in, check the appropriate Inherit Field to Instrument checkbox. For example, if instruments in a loop are to inherit the function of the loop, check the Inherit Function to Instrument checkbox.

• If an Inherit Field to Instrument checkbox is checked, the adjacent loop field checkbox is checked automatically. for example, if the Inherit Function to Instrument checkbox is checked, the Function checkbox is checked automatically.

• The Inherit Number to Instrument checkbox is checked automatically and cannot be changed. The instrument number is always inherited.

• The Display Label Format Fields field is used to select the types of data displayed in instrument loop labels, and the order in which they are displayed. Fields may appear in a different order from those of the "actual" label, and fields that are in the "actual" label may be left out, though additional fields may not be included.

  The Browse button adjacent to the field is used to select the format. On selection of the button, the Display Label Format dialog box is displayed:

  

  Use the lists of values to select which fields are to be displayed, and the order that they are to be displayed in. For example, if Type is to appear first, select Type from the list of values in the Field 1 field.

  A field will not be available for selection unless its checkbox has been checked to specify that it will be part of instrument loop tags, as described above. The number of active fields in the dialog depends on the number of checkboxes checked.

  As required, enter a delimiter character in the field adjacent to each field selection list. For example, if the Type part of an instrument loop display label is to be separated from the next field in the label by a "-", enter that symbol in the field next to the field in which Type is selected.

  Following selection, press OK. The selected Display Label Format will then be shown in the Display Label Format Fields field, e.g. 1,-,2.

Leader Line Settings Section

If multi-vertex leader lines may be used to label balloons with instrument valves and flow elements, check the Use Multi Vertex Leader Line checkbox.

An example of an instrument valve and label balloon connected by a multi-vertex leader line (PSV-001) is shown:

Labels Sub-Category

The fields in this application pane are used to set up the label configuration properties of instruments.

The application pane is divided into the following sections:

Label Options Section

This section contains the following settings:

• If instrument prefixes are required for the project, make sure that the Prefix Label Required checkbox is checked.

• If instrument labels are to be rotated when the symbol they are associated with is rotated, make sure that the Rotate Labels with Symbol checkbox is checked.

Label Balloon Section

This section contains the following settings:

• In the Label Balloon Symbol field, select the symbol name of the Instrument Label Balloon symbol from the drop down list.

• If all link lines between instruments and their balloons are to be switched off, then make sure that the Label Balloon Link Lines Off checkbox is checked. This setting will not update existing instruments when the drawing is reloaded.

Instrument Label Positions Section

The fields in this section govern the positions of the different elements that make up an instrument label, relative to the insert point of the labelled instrument. In the fields provided, enter the X and Y coordinates for the instrument labels components.

The number of fields in which positions can be entered depends on the option selected in the Number of Tag fields section of the Settings pane. If the 4 Tag fields option is selected, the first two fields (Block and Function) will not be active.

If different label positions are needed for different types of instrument balloons, the default positioning can be overridden by selecting the Instrument Label Positional data option in the List of Values Configuration Category.

Note: If the USER_RESETANNPOS user-defined directive on the Miscellaneous – Settings Sub-Category of the AVEVA P&ID Project Administration program is set to 'Yes', instrument label settings are updated on the drawing when Refresh Settings is executed in the P&ID application. If the setting is set to ‘No’ (the default value), instrument label settings are not updated on the drawing when Refresh Settings is executed in the P&ID application.

Instrument Label Format Section

The Instrument Label Format fields are used to specify the display format of instrument labels, for example, the order in which instrument label fields are displayed.

At least one display label format must be set up.

Multiple display label formats may be set up, one of which will be set as the default. When labelling instruments, the label will default to this format, but another format may be selected if required.

The Browse button adjacent to the field is used to select the format. On selection of the button, the Select a Tag Format dialog box is displayed:

The dialog lists the existing display formats.

To set a format as the default, select if from the list and click Set as Default. The current default format is indicated by the word "True" in the IsDefault column.

The Remarks field contains two options available for selection, “Default Display Tag" and “Default Positional Data”

If Default Positional Data is selected and the symbol position is declared in the Instrument Label Positional Data option in the List of Values Configuration Category, the label is inserted at that position.

If Default Display Tag is selected, the label is inserted at the position declared in the Instrument Label Positions.

To edit a format, select it and then click Edit. The Tag Format Editor dialog is then displayed.

To delete a format, select it and then click Delete.

To create a new format, click New. The Tag Format Editor dialog is then displayed.

Unique Tags Section

The Unique Validation field is used to specify which combination of fields in instrument labels are to be checked for uniqueness.

The Browse button adjacent to the field is used to select the values. On selection of the button, the Select Label Identifier(s) dialog box is displayed:

The fields can be selected by using the drop down lists. A field cannot be selected twice.

Following selection, press OK, and the numbers of the selected Unique Validation fields will be shown in the Unique Validation field. e.g. 1, 2, 3, 4, 5, 6.

The numbers represent label fields are follows:

1. Block

2. Function

3. Prefix

4. Type

5. Number

6. Suffix

For example, if PREFIX, SUFFIX, NUMBER, TYPE was selected, the field would display: 3,6,5,4.

Note: If the 4 Tag fields option in the Number of Tag fields section of the Settings pane is selected, the first two lists will not be active.

Note: Although <NONE> can be selected from the drop down lists, all fields must be selected. If <NONE> is selected for any field, the format will reset to the default format of 1,2,3,4.

Instrument Panel Label Position Section

The fields in this section govern the positions of the different elements that make up a panel label, relative to the insert point of the instrument panel reference symbols. In the fields provided, enter the X and Y coordinates for the Prefix, Letters, Number and Suffix parts of the instrument panel labels.

Panel reference label positioning does not automatically update on reload of the drawing if these settings have been changed.

I/O Label Position Section

This section contains the following settings:

• If I/O labels are to be placed on the Non-plot layer, make sure that the Labels on Non-Plot Layer checkbox is checked.

• I/O labels must be automatically positioned in the same place for each I/O symbol and the X, Y offsets in the Offset from Symbol Origin fields control the automatic positioning of the I/O Address, Card Type, Signal/Area Code and Remarks.

• The four components of I/O Symbol labels may be individually rotated as they are placed. Check the appropriate Rotate with Symbol checkboxes to activate the rotation. Make sure the checkboxes are unchecked to have the labels placed at zero degrees to the symbol angle.

Instrument Alarm Positions Section

This section contains the following settings:

• The Insert at fix location checkbox is used to specify whether or not instrument alarm labels are to be placed at specified X and Y coordinates, relative to the instrument insertion point. Check the checkbox if instrument alarm label components are to be placed at specified X and Y coordinates. Uncheck the checkbox if instrument alarm label components are to be manually positioned on the drawing.

• The fields in this section govern the positions of the different elements that make up an instrument alarm label, relative to the instrument insertion point. In the fields provided, enter the X and Y coordinates for the instrument alarm label components.

A list of values can be assigned to instrument alarm labels, replacing the need to enter label values manually. Lists of values are defined using the List of Values Configuration Category of the Administration program. The default list of values for alarm labels is USERLOV_Alarms, custom lists of values for alarm labels can be created. Enabling the list of values for alarm labels is defined using the Instrument Dialog Labels and List of Values section of the Instrument- Settings Sub-Category.

Patterns Sub-Category

The Pattern application pane is used to edit the definitions of project instrument patterns.

The first section of the application pane is used to add, amend and delete pattern definitions.

Existing Patterns Section

The first section contains a list of existing patterns and three tools for managing patterns - Add Pattern, Delete Pattern and Rename Pattern.

Add a New Pattern

If a new pattern is to be created, select the Add Pattern… hyperlink. The following dialog box is then displayed:

Enter a unique value for the pattern name and click OK.

The dialog box will be closed and the new value is displayed in the Existing Patterns list

Delete a Pattern

If a pattern is to be deleted, select the Deleted Pattern… hyperlink. The following dialog box is then displayed:

To proceed with the deletion select Yes. If the value is not to be deleted select No.

If Yes is selected the dialog box will be closed and the pattern deleted from the Existing Patterns list. All associated pattern property data is deleted.

Rename a Pattern

If a pattern is to be renamed, select the Rename Pattern... hyperlink. The following dialog box is then displayed:

Enter a unique value for the pattern name and click OK.

The dialog box will be closed and the amended name is displayed in the Existing Patterns list.

Pattern Style Section

If the Substitute Master Instrument Tag checkbox is checked, if an instrument is made the master instrument for a pattern, when synchronized and exported to P&ID Reports its tag label is replaced by the tag label defined in the pattern assigned to it (it will remain unchanged on the drawing).

Edit the Patterns with Import from Excel Spreadsheets

The patterns can be efficiently edited by exporting them to an Excel spreadsheet, editing it in that spreadsheet, and then by importing the amended list back into AVEVA P&ID.

The procedure is as follows:

7. Select the pattern to be exported from the Exisiting Patterns list.

8. Select the Export to Excel link. A message is then displayed requesting that the user confirm that the export is to take place:

   

9. Click Yes. The selected pattern is then exported to a spreadsheet. When the export is complete, a message is displayed to inform the user of this, and giving the location of the exported file. For example:

   

10. The patterns can now be edited in Excel. Click the Open Excel link to open it.

    Note: The Open Excel and Import from Excel links are disabled until an export takes place, and disabled again once the changed patterns are imported back into AVEVA P&ID.

11. Add, edit and delete pattern as required, and then save the file.

12. To import the changed pattern back into AVEVA P&ID, select the Import from Excel link. A message is then displayed requesting that the user confirm that the import is to take place. Click Yes to continue.

13. The patterns list is then updated to reflect the changes made in the spreadsheet.

Patterns Components Section

The second section contains a grid, which is used to manage the components of a pattern.

Enter Instrument Pattern Labels

A pattern definition must consist of two types of items, a single substitute instrument (which is the item shown on the drawing), and the component instruments that it represents.

The substitute item can appear on any row; it does not have to be positioned first within the pattern listing.

Create a new row is created by selecting . The new row then is created at the bottom of the grid.

Pattern labels details are entered in the following fields:

Field 1: Sequence No

Normally the item handle forms the unique identifier for an instrument exported to AVEVA P&ID Reports. However, component pattern items do not posses such a handle.

To overcome this lack, the handle of the substitute item is used together with an asterisk and the sequence number of the component item, e.g., AB*1, where AB is the substitute instrument handle, and 1 is the sequence number of the component instrument.

If there are no sequence numbers in the file, an error will occur on output.

If pattern instrument data has been exported and the pattern is then changed on the P&ID, the existing sequence numbers should be maintained. For example, if the sequence was 1, 2, 3, and 2 was removed - the new sequence should be 1, 3, not 1, 2. This is to avoid inconsistencies which would occur if the pattern was re-exported into AVEVA P&ID Reports.

Sequence numbers are assigned automatically.

Field 2: Type Label

• Substitute Instrument: It is possible to label the substitute instrument with a concatenated label, e.g., FEIT to indicate that it consists of an FE (the substitute item), an FI and an FT. However, the substitute item must appear in the IPT file with its valid name, for example, FE.

• Component Instruments: The type part of the instrument label must be entered here for component items, e.g., FI, FE, FT.

Field 3: Suffix Label

• Substitute Instrument: If the substitute instrument has a suffix in its label, enter it here.

• Component Instruments: If two or more pattern items are to be labelled identically when the records are created on export, make sure that the suffices are entered in this column to prevent exact duplicates occurring.

Field 4: Symbol Name

• Substitute Instrument: This field has its data inherited from the P&ID, and must be left blank.

• Component Instruments: Enter the symbol names here for component items. Symbol names can be identified using the Symbols Configuration Category of the AVEVA P&ID Project Administration program or from the item Properties dialogs.

Field 5: P&ID Substitute Item

A pattern can consist of any number of component items, but only one inline substitute item is permitted.

The substitute item is denoted by ‘YES’. If an attempt is made to export with two or more asterisks in any one pattern listing, an error message will be received.

The substitute item can appear on any row; it does not have to be positioned first within the pattern listing.

Field 6: Instrument Alarms

• Substitute Instrument: This field has its data inherited from the P&ID, and must be left blank.

• Component Instruments: Enter any alarms here separating them with commas, e.g., H, HH. All other restrictions such as a maximum of six alarms still apply.

Field 7: Instrument Desc

• Substitute Instrument: This field has its data inherited from the P&ID, and must be left blank.

• Component Instruments: The descriptor is used within AVEVA P&ID Reports.

The instrument description can be selected from a drop-down list which is populated from the Instrument Type Letters list of values. By default, if the Instrument Desc field is modified, the Type field is updated.

Field 8: Process Links

• Substitute Instrument: The substitute item will either be inline or process connected. Place a 'YES' in this column if the substitute item is process connected. Otherwise select 'NO'.

• Component Instruments: Select 'PROCESS OWNER' if the process owner (e.g. line or equipment tag) of the instrument that holds the pattern is to be exported/reported as the process owner for all instruments in the pattern.

• Otherwise put a 'YES' in this column if simply the pattern item is to appear as process connected in the export file. If neither of the above apply, select 'NO'.

  Note: If component instruments are both process and signal connected, the process connection takes precedence.

Field 9: Signal Lines

• Substitute Instrument: This field has its data inherited from the P&ID, and must be left blank.

• Component Instruments: Enter the number of signal lines here if the instrument is to be signal connected, for example, would have been attached to one or more signal lines if actually drawn on the P&ID.

  Note: If instruments are BOTH process and signal connected, the process connection takes precedence.

Field 10: No of Signal Line Types

• Substitute Instrument: This field has its data inherited from the P&ID, and must be left blank.

• Component Instruments: Enter the number of signal line types which are to be connected to the component instrument. On output the signal line types are checked for validity against the signal line validation file.

Field 11: InterLock

Select 'YES' in this column if the pattern item is to appear as an interlock in the export file. Otherwise, select 'NO'.

Field 12: Panel Prefix

If required, enter the default panel reference prefix value which will appear in the export file.

Field 13: Panel Type

If required, enter the default panel reference type value which will appear in the export file.

Field 13: Panel Loop

If required, enter the default panel reference loop value which will appear in the export file.

Field 13: Panel Suffix

If required, enter the default panel reference suffix value which will appear in the export file.

Validation Sub-Category

This pane is used to specify the permitted format of entries into selected instrument and panel reference label fields.

Note: If the 4 Tag fields option in the Number of Tag fields section of the Settings pane is selected, the first two fields in the Instrument Label Field Validation section (Block and Function) will not be active.

In the fields provided, enter the following characters as required:

For example, if AaN is entered for the Prefix Field field, when a user is completing this field in the Instruments labelling Properties dialog, the first character must be an uppercase letter, the second a lower case letter, and the third a number.

The Advanced Format Options dialog is available from the button adjacent to each field.

To test how the validation will work in practice, make an entry in the Test Data field of the Test tab, and click Test. A message will be displayed indicating whether or not the test data would be a valid entry.

To directly edit the regular expression that comprises the validation entry, select the Advanced tab. The expression is displayed in the Regular Expression field and may be amended as required. For help on editing Regular Expressions, click on the help link displayed on this tab.

Automatic Tag Format Sub-Category

If the number fields of instruments are to be completed automatically (refer to Automatic Tags), the format of this field is defined using this sub-category.

If automatic tagging is to be used for instruments, check the Enable AutoNaming checkbox.

By default, the automatically incremented numbers that are part of automatic instrument tag numbers will be from the range of numbers specified for the drawing and sheet in the Drawing - Drawing List Sub-Category.

If the automatically incremented numbers should instead be a simple count for the project overall, check the Apply Project based Auto Naming checkbox.

The format of automatic instrument tags is defined in the Tag Expression field. A preview of a tag using the current definition is displayed in the Sample Tag Value field.

14. In the Tag Expression field, enter any fixed values such as prefixes and delimiters.

15. If instrument tags are to include an automatically incrementing number, place the cursor in the expression where this number is to be located, and click Insert Counter.

    The counter is added to the expression like so: [Counter].

16. Select the length of the counter number from the list in the Format field. Enter the number that the counter is to be incremented by for each instrument in the Increment By field.

17. A separate count may be applied for each value of specified instrument properties. For example, a separate count for each instrument type.

    If this is required, check the Based on Counter Field checkbox, and select the button next to the Counter Reset Field field. The Select Fields dialog is then displayed:

    

    To specify that a separate count is to be applied to a property, select it from the Available Tag Properties list and click Insert Property. The property is then added to the Counter Reset Fields list.

    Click Clear to remove all properties from the Counter Reset Fields list.

    Click OK when all required fields have been selected.

    The selected fields are displayed in the Counter Reset Field field.

18. To clear the Tag Expression field, click Clear.

If a counter is in use, it may be reset to 0 for the project by selecting Reset Counter.