Spec Driven Configuration Category
- Last UpdatedMar 14, 2024
- 19 minute read
The Spec Driven Configuration Category is used to control which symbols can be inserted into pipes and which pipe styles pipes may be set to based on the specification of those pipes.
It is also used to set up lists of values for valve codes associated with sets of pipe and valve properties. When labelling a valve, only valve codes in the list of values associated with the set of pipe properties matching the properties of the owning pipe and the valve may be selected.
Note: When a project is upgraded, in order for Spec Driven data and functionality to be available, the database schema must be updated by selecting the Upgrade Specdriven Database Schema - Upgrade button in the Project Database Configuration Category.
The Spec Driven Configuration Category is divided into the following sub-categories:
Symbols Sub-Category
Note: If the user does not specify a piping specification code for a particular size, and if an entity is placed on a pipe of that size then the entity will be in spec. If the user needs to make the entity so that it is out of spec (or restrict placing of the entity on pipes) then a new rule must be specified for the required size.
The Symbols sub-category is used to specify valid pipe specifications for individual symbols. The Add/Edit and Assign Specs sub-categories are used to specify valid pipe specifications to groups of symbols.
For example, it may be specified that Ball Valve symbols may only be inserted into pipes with a specification of AAA3, and an inlet bore size of 20 and an outlet bore size of 20.
Multiple combinations of pipe specs and sizes may be specified as compatible with the insertion of a symbol. If no specs or sizes are specified for a symbol, insertion of this symbol is unrestricted.
Spec/size insertion restrictions may be set up for Valves, Instrument Valves and Reducers.
Currently, only restrictions for 2-way symbols may be specified, but not symbols inserted at pipe junctions such as 3-way and 4-way valves.
Note: Changes to drawings resulting from changes to Spec Driven settings are not automatically implemented when project drawings are loaded. The user must trigger these changes "manually" in each drawing after it has loaded. Refer to Update Spec Driven Data.
Specify the Valid Specs and Pipe Sizes for Insertion of a Symbol
Note: Valid specification and size data can be imported from an AVEVA PDMS project.
To specify the specs and sizes of pipes that a symbol may be inserted into:
-
From the list of values at the top of the application pane, select the symbol.
-
From the list of values below this, select the symbol.
The selected symbol is displayed next to the list.
Note: Symbols are set up using the Symbols Configuration Category.
-
From the bore sizes grid, select the inlet and outlet size by clicking on the cell at the intersection of these values. The vertical axis displays the inlet size, the horizontal axis displays the outlet size. The selected cell is displayed with a blue background.
Note: that only light grey cells can be selected.
In the case of Valves and Instrument Valves, only those cells at the intersection of identical bore size values can be selected, as valves have the same inlet and outlet sizes.
In the case of Reducers, only those cells at the intersection of different bore size values can be selected, as reducers must have different inlet and outlet sizes.
Note: The list of sizes is set up using the List of Values Configuration Category.
-
From the list of pipe spec codes, select the code or codes. To select a code from the list, click on it. The spec code is then highlighted with a blue background. Multiple codes can be selected.
To de-select a spec code, click on it again. The code will no longer be highlighted in the list, and will be removed from the cell in the table.
Spec codes can be copied and pasted from one cell to another. To copy the contents of a cell, right-click and select the Copy option from the menu that is then displayed.
To paste into a cell, right-click on the cell and select the Paste option from the menu.
Note: The list of pipe spec codes is set up using the List of Values Configuration Category.
-
Repeat steps 3 and 4 for each valid combination of spec and bore sizes for the symbol.
-
To populate all cells with every code from the list of spec codes, select Set as Default. Individual codes may then be de-selected if required for each cell, as described above.
-
To clear every cell in the grid of codes, select Clear.
Insertion Options
These settings control what happens when symbols are inserted into pipes with specs and/or sizes that the symbols are not valid for. These settings are applicable to all symbols that are subject to this functionality, not just the one selected at the top of the application pane.
-
Select Prevent if users are to be prevented from inserting a symbol into a pipe with a spec and/or size that the symbol is not valid for. If this is attempted, an error message is displayed and the symbol is not placed on the P&ID.
-
Select Warn if users are to be warned if they insert an invalid symbol. The insertion of the symbol is permitted in this case, but an error message will be displayed on the P&ID, and will accompany the symbol when exported. Invalid symbols are displayed on the P&ID in a specific colour.
-
If the specs and sizes of pipes are to be ignored when inserting symbols, select Ignore.
The Out of Spec Symbol Warning Colour at P&ID field is used to specify the colour of symbols that are not valid for the spec and/or size of the pipe that they are inserted into (see the Warn option above).
To select a colour, press the green button next to the field. On selection of the button, the colour selection dialog box is displayed:
The Colour Code can be selected using the following methods:
-
Selection of one of the colours shown in the palette
-
By double-clicking on the Assume By Layer hyperlink. Items will automatically assume the colours of the layers they are inserted into, as set in the Layers Sub-Category the Drawing Configuration Category.
-
By manually entering the Colour Code field
Following selection, press OK. The selected colour code will then be displayed in the field.
PDMS Cats and Specs Import
Valid specs and sizes can be imported from a PDMS project.
In the Paragon Module of PDMS, a report must be run on the specifications in question.
The contents of this report can then be imported into the project settings of an AVEVA P&ID project.
-
Press the green button next to the Spec Report Location field, and browse for the PDMS report. By default, the report will be called spco.report and will be located in the c:/temp folder.
-
Check the Use Report to Populate Specification List of Values checkbox.
-
Press Import Spec Report to Database.
-
The import then takes place. The grid in the Symbols pane is then automatically populated with valid symbol spec and size data from the PDMS project. Existing settings are replaced.
Spec Driven Data Import from PDMS - PML Function and Report
A PML function can be adapted by a customer to filter the Specification data. The order in which the data is listed must as described below as the code to import the data into P&ID relies on this. The correct order is:
Specification Name, Symbol Name, Catalogue Reference, Bore 1, gtype, bore2
These must be delimited by a one space character. The PML for this is:
!temp = !spec & ' ' & !name & ' ' & !catref & ' ' & !bore & ' ' &!gtype & ' ' & !bore2
Where ‘!temp’ is a temporary string.
AVEVA P&ID will display the report correctly only if the names from the report (from PDMS) correspond to the symbol names configured at the P&ID Project Administrator. Verify that the report is correctly imported by revising the P&ID project database at the Project Projmet folder, e.g.:
C:\AVEVA\P&ID\Project\IPE\Autocad\Projmet\IPE.mdb
Below is a sample PML function report:
/A1A /A1A/RE500x400:500_400 /AARE2001Y 500 REDU 400
/A1A /A1A/XER:500_400 /XAARE2001Y 500 REDU 400
/A1A /A1A/RC500x450:500_450 /AARC2001Z 500 REDU 450
/A1A /A1A/RE500x450:500_450 /AARE2001Z 500 REDU 450
/A1A /A1A/XER:500_450 /XAARE2001Z 500 REDU 450
/A1A /A1A/RC600x400:600_400 /AARC2003Y 600 REDU 400
/A1A /A1A/RE600x400:600_400 /AARE2003Y 600 REDU 400
/A1A /A1A/XER:600_400 /XAARE2003Y 600 REDU 400
/A1A /A1A/RC600x450:600_450 /AARC2003Z 600 REDU 450
/A1A /A1A/RE600x450:600_450 /AARE2003Z 600 REDU 450
/A1A /A1A/XER:600_450 /XAARE2003Z 600 REDU 450
/A1A /A1A/RC600x500:600_500 /AARC20031 600 REDU 500
/A1A /A1A/RE600x500:600_500 /AARE20031 600 REDU 500
/A1A /A1A/XER:600_500 /XAARE20031 600 REDU 500
/A1A /A1A/RE600x550:600_550 /AARE20032 600 REDU 550
/A1A /A1A/XER:600_550 /XAARE20032 600 REDU 550
/A1A /A1A/KT15 /A0KD330D0 15 CAP 0
/A1A /A1A/KD15 /A0KD530D0 15 CAP 0
/A1A /A1A/KT20 /A0KD330E0 20 CAP 0
/A1A /A1A/KD20 /A0KD530E0 20 CAP 0
/A1A /A1A/KC65 /AAKC200K0 65 CAP 51
/A1A /A1A/KC80 /AAKC200L0 80 CAP 64
/A1A /A1A/KC100 /AAKC200N0 100 CAP 76
/A1A /A1A/KC150 /AAKC200R0 150 CAP 102
/A1A /A1A/KC200 /AAKC200T0 200 CAP 127
/A1A /A1A/KC250 /AAKC200V0 250 CAP 152
/A1A /A1A/KC300 /AAKC200W0 300 CAP 178
/A1A /A1A/KD25 /A0KD330F0 25 CAP 0
/A1A /A1A/KD40 /A0KD330H0 40 CAP 0
/A1A /A1A/KD50 /A0KD330J0 50 CAP 0
/A1A /A1A/KM15 /ABKM600D0 15 PCOM 0
/A1A /A1A/KM20 /ABKM600E0 20 PCOM 0
/A1A /A1A/VG15 /A0VG3X0DD 15 VALV 45
/A1A /A1A/VH15 /A0VH3X0DD 15 VALV 33
/A1A /A1A/VC15 /A0VC3X0DD 15 VALV 60
/A1A /A1A/GA-1117:15 /VGVG5XRDD 15 VALV 21
/A1A /A1A/GL-1132:15 /VGVH5XRDD 15 VALV 28
/A1A /A1A/CK-1429:15 /A0VJ5X0DD 15 VALV 26
/A1A /A1A/VG20 /A0VG3X0EE 20 VALV 56
/A1A /A1A/VH20 /A0VH3X0EE 20 VALV 38
/A1A /A1A/VC20 /A0VC3X0EE 20 VALV 64
The report can have several lines with the same symbol name (each a catalogue reference with specific geometry). For example, the source project has an Eccentric Reducer symbol, named, "RE", that has multiple bore diameters, so instead of having something like in the Report:
/A1A /A1A/RE500x400:500_400 /AARE2001Y 500 REDU 400
/A1A /A1A/RE500x450:500_450 /AARE2001Z 500 REDU 450
/A1A /A1A/RE600x400:600_400 /AARE2003Y 600 REDU 400
/A1A /A1A/RE600x450:600_450 /AARE2003Z 600 REDU 450
...the user may edit the report so that instead it has:
/A1A RE /AARE2001Y 500 REDU 400
/A1A RE /AARE2001Z 500 REDU 450
/A1A RE /AARE2003Y 600 REDU 400
/A1A RE /AARE2003Z 600 REDU 450
This means only one symbol is required in the AVEVA P&ID Project Administrator Program, "RE", instead of having several of them as follows:
/A1A/RE500x400:500_400
/A1A/RE500x450:500_450
/A1A/RE600x400:600_400
/A1A/RE600x450:600_450
Editing the report in such a way before importing into AVEVA P&ID may save considerable time and effort.
Finally, in the generated report care must be taken to remove (if applicable) the preceding "/" from the symbol names. The names must correspond to the P&ID Project Administrator symbol names.
Note: these values can be also changed at project SQL database.
Note: Spec Driven data can, if necessary, be edit directly in the SQL database after it has been imported. For example:
Add/Edit Specs Sub-Category
The Add/Edit Specs sub-category is used to create specifications which are groups of piping specification codes links to an item type or an item group (Instrument Valves, Reducers or Valves).
Specific symbols within the item type or item group can then be assigned to the specification using the Assign Specs Sub-Category.
To create a specification:
-
Select Create Specification Template. The Add Specifications dialog is then displayed:
-
If the specification is to be for an item type, select Item Type. If it is to be for an item group, select Item Group.
-
Enter the name of the specification in the Spec Name field.
-
From the list in Item Type field, select the item type of item group that the specification is for.
-
Click OK to save the spec.
-
The dialog remains open so that further specs can be created if required, as described in steps 2 to 5. Click Done to close the dialog.
-
From the bore sizes grid, select the inlet and outlet size by clicking on the cell at the intersection of these values. Then, from list of pipe spec codes, select the code or codes. See the description of the Symbols Sub-Category for details.
-
Select Save to save the specification. Specific symbols can now be assigned to the specification using the Assign Specs Sub-Category.
To edit an existing specification, select the specification from the list available from the Select Specifications field and then edit the bore sizes/pipe spec codes as required.
To delete a specification, open it as described above, then select Delete.
Assign Specs Sub-Category
The Assign Specs sub-category is used to assign symbols to specifications created using the Add/Edit Specs sub-category.
To edit an existing specification, select the specification from the list available from the Select Specification Template field and then edit the bore sizes/pipe spec codes as required.
The grid beneath the Spec Name field then displays the valid bore size/pipe specification associations set using the Add/Edit Specs sub-category. They cannot be edited here.
Assign Symbols to Specifications
The grid beneath the bore size/pipe specification associations grid displays all the symbols of the item type or item group of the specification. The name and description of each symbol is listed. To assign a symbol to the spec, check its Select checkbox.
To assign all the listed symbols, check the Select All Symbols checkbox. The Select checkbox for every symbol is then checked.
When all the required symbols have been selected, select Assign to complete the procedure.
Insertion Options
The Spec Driven Symbols and Out of Spec Symbol Warning Colour at P&ID controls are used to control what happens when symbols are inserted into pipes with specs and/or sizes that the symbols is not valid for. These settings are applicable to all symbols that are subject to this functionality.
Code Rule Sub-Category
The Code Rule sub-category is used to set up lists of values for valve codes associated with sets of pipe and valve properties. When labelling a valve, only valve codes in the list of values associated with the set of pipe properties matching the properties of the owning pipe and the valve may be selected. The association of a valve code with a set of pipe and valve properties is known as a code rule.
Note: While the Code Rule sub-category is used to set up code rules that are IN of spec, the Out of Spec Sub-Category is used to set up code rules that are OUT of spec.In case of a clash between these two sets of rules, the Out of Spec list of rules will take priority.
Note: If code rules are to be used on a project both the Use Valve code and the Add Valve Code Label checkboxes on the Valves - Settings Sub-Category must be checked.
Code rules can be entered manually in the grid at the bottom of the pane, or loaded from an Excel spreadsheet. A default set of rules supplied with the project can also be loaded.
The application pane is divided into the following sections.
Code Rule Settings Section
If code rules are to be used in a project, check the Enable Code Rule checkbox. Code rules can still be specified if the checkbox is not checked but they will not be applied.
The applicability of code rules to valves can be determined by considering the GTypes and SCSTypes instead of the specifications, inlet sizes and outlet sizes. If this is required, check the Determine Code Using GType and SCSType checkbox.
Note: If the Determine Code Using GType and SCSType checkbox is not checked then the code rules will be applied based on the combination
of Size, Specification and Item Description.
If it is checked then the code rules will be applied based the combination of Size,
Specification and GTYPE/SCSTYPE values.
Note: If the SCSTYPE value is blank in the Code Rule grid then the corresponding valve code will be available for all the valves which have the same GTYPE value and a blank SCSTYPE value in the Symbol grid (refer to the Symbols Configuration Category).
Note: If the SCSTYPE value is blank in the Symbol grid then the corresponding valve code will be available for all the valves which have the same GTYPE value irrespective of the SCSTYPE value set in Code Rule grid.
If the code rule functionality is to be applied to instrument valves, make sure that the Include Instrument Valves in the Code Rule checkbox is checked.
Load Default Code Rules
A default set of code rules are available with the product which can be used by a project if required. To load the default rules, click Load Default Rules.
Loading the default rules will overwrite all existing code rules specified for the project. A warning will be displayed to inform the user of this.
Click Yes to continue. The default rules will then be loaded. A progress bar is displayed:
Once the process is complete, the default rules will be added to the grid in the bottom section of the pane. They may then be edited as required. Any rules that were already defined in the grid are deleted.
Delete All Code Rules
To delete all code rules and clear the code rules grid, press Clear All Rules.
A message will be displayed requesting that the deletion be confirmed. Click Yes to continue.
Import/Export Code Rules Section
Code rules can be imported from an Excel spreadsheet.
Note: Importing rules will overwrite all existing code rules specified for the project.
The procedure is as follows:
-
Click the Export Code Rules to Excel link. The following message is displayed:
-
Click Yes. The export then takes place and the following message is displayed:
-
Press OK. The schema has now been imported to an Excel spreadsheet, which will consist of all the required headings and columns required by the import.
-
The user must now open the Excel spreadsheet and enter details of the rules to be imported. Click Open Excel File. The spreadsheet is then opened:
-
Enter the required details and then save and close the spreadsheet.
-
Finally, load the contents of the spreadsheet by clicking Import Code Rules From Excel.
-
Messages are then displayed requesting that the import be confirmed and warning that all existing rules will be overwritten. Click Yes to continue.
-
The import then takes place and the following message is displayed:
-
The imported code rules are then added to the grid in the bottom section of the pane. They may then be edited as required. Any rules that were already defined in the grid are deleted.
Code Description Section
When a valve code is selected when labelling a valve in the Valve Properties dialog, details of the applicable valve code rule can be displayed in a dropdown. This dropdown may display either the relevant item description or the relevant part description.
The description displayed is specified in this section. Select either Item Description or Part No Description as required.
Error/Warning Colour Settings Section
The Out of Spec Symbol Warning Colour at P&ID field is used to specify the colour of valves that are not valid for the associated valve and pipe properties in accordance with the code rules.
To select a colour, press the green button next to the field. On selection of the button, the colour selection dialog box is displayed:
The Colour Code can be selected using the following methods:
-
Selection of one of the colours shown in the palette
-
By double-clicking on the Assume By Layer hyperlink. Items will automatically assume the colours of the layers they are inserted into, as set in the Layers Sub-Category the Drawing Configuration Category.
-
By manually entering the Colour Code field
Following selection, press OK. The selected colour code will then be displayed in the field.
Code Rules Grid Section
Code rules are displayed in this grid. Facilities in the grid enable users to add new code rules and edit existing code rules.
Note: As well as the default code rule properties such as Inlet Size, Specification etc, any Project definable fields that have been added to the Pipe Label Format (refer to the Pipes Configuration Category for details) will also be available in grid, and can therefore be included in code rules.
Add Code Rules
Select 
. The Insert Code Rule dialog is then displayed:
Select the required code rule values from the dropdown lists and enter the name of the valve code in the Valve Code field (the AVEVA Plant and Marine GType field is read-only - it is automatically completed from the symbol list as defined in the Symbols Configuration Category).
Press OK. The new code rule is then added to the grid.
Edit Code Rules
To edit a code rule, type in the required details in the grid fields or select them from list of values as appropriate. For example:
Code Rule Data from a Compare/Update Service
Users can now import data from the Paragon module (Plant/Marine Catalogue data) into AVEVA P&ID through an Integration service.
In order to do this, the user must transfer the data into the Integration service by specifying the AVEVA Catalogue source type. This procedure is described in the AVEVA P&ID Reports Guide, in "Appendix - Middle Tier Service Settings".
Using the Compare Update facility, the data which has been added to Integration service can then be added to Code Rule section in the AVEVA P&ID Administrator.
The user must create a mapping in Compare Update (Report Application), selecting AVEVA Catalogue as data source. After creating the configuration with required attribute mappings, the user can load the data into database. This will be reflected in the Code Rule grid (see above).
Out of Spec Sub-Category
The Out of Spec sub-category is used to set up lists of values for valve codes associated with sets of pipe and valve properties. These codes rules as these associations are are known, are set as "out of spec".
When labelling a valve, valve codes and pipe and valve properties should not be associated in such a way as to be out of spec, for example, in such as way as it breaks one of the code rules set in the Out of Spec sub-category. Items that are out of spec will be displayed in the Out of Spec Symbol Warning Colour at P&ID field in the Code Rule Sub-Category.
Note: While the Out of Spec sub-category is used to set up codes rules that are OUT of spec, the Code Rule Sub-Category is used to set up code rules that are IN spec.In case of a clash between these two sets of rules, the Out of Spec list of rules will take priority.
Code rules are displayed in the grid. Facilities in the grid enable users to add new code rules and edit existing code rules.
Note: As well as the default code rule properties such as Inlet Size, Specification etc, any Project definable fields that have been added to the Pipe Label Format (refer to the Pipes Configuration Category for details) will also be available in grid, and can therefore be included in code rules.
Add Code Rules
Select . The Insert Code Rule dialog is then displayed:
Select the required code rule values from the dropdown lists and enter the name of the valve code in the Valve Code field (the AVEVA Plant and Marine GType field is read-only - it is automatically completed from the symbol list as defined in the Symbols Configuration Category).
Press OK. The new code rule is then added to the grid.
Note on Actuators
As can be seen in the screen example above, rules may include types of actuators, or NONE.
Such settings should be taken into consideration when assigning actuators to valves in the Symbols Configuration Category, as actuators could be selected for valves symbols in such a way that these symbols will always break the out of spec rules.
Edit Code Rules
To edit a code rule, type in the required details in the grid fields or select them from list of values as appropriate. For example:
Pipe Styles Sub-Category
The pipe styles that pipes can be set to can be filtered based on their specification. In other words, the list of pipe styles available for a pipe will be based on that pipe’s specification. Pipe styles are associated with specifications using the Pipe Styles sub-category.
To turn on this functionality for the project, check the Pipe Style Filter checkbox.
Select a specification from the Specification field.
Under Available Pipe Styles is then listed all the pipe styles in the project not already assigned to the specification.
The Selected Pipe Styles list displays all the pipe styles currently assigned to the specification, if any.
To assigned a pipe style to a specification, select it from the Available Pipe Styles list and press >. The style is then moved from the Available Pipe Styles list to the Selected Pipe Styles list.
To assign all pipe styles to a specification, select >>.
To unassign a pipe style, select it from the Selected Pipe Styles list and press < to move it back to the Available Pipe Styles list.
Use << to unassign all pipe styles.
When all required pipe styles have been assigned to the specification, select Save.
Select a different specification from the Specification field to assign pipe styles to it.