Configuring Item Tag Formats - Intergraph Smart P&ID - 10 - Help

The Item Tag Validation functionality is saved as ItemTag.dll and performs calculations and validations in the current plant for unique tag checking, automatic tag generation, and tag reformatting. ItemTag Validation can generate unique Item Tag values and maintains consistency between the Item Tag value and the properties used in its calculation. Validation, in addition to checking for existing item tags, also checks for duplicate item tags according to the scope specified by the particular version of the ItemTag.dll file.

Also, for properties included in the item tag, any leading or trailing spaces are removed during validation.

You can configure item tag formats without the need to make code changes and recompile the ItemTag.dll file. To do so, you must install the Configure Item Tag Utility, which is made up of the following components:

• Executable file: ConfigureItemTagFormat.exe

• An appropriate customized version of the ItemTag.dll file

After activating the customized ItemTag.dll file (for details, see below), you run the executable file and specify the item tag configuration for each required item type. You also have to update values for the Validation ID in Data Dictionary Manager of the properties you have chosen to include in the item tag configuration. For details, see step 11 of the topic Configure an item tag's format.

Details of the configurations are stored in the ItemTagFormat.xml file, which is read by the customized ItemTag.dll file. Data in the ItemTagFormat.xml file is then used to implement item tag validation. If the item tag for an item type has not been configured using the utility, the custom ItemTag.dll uses the default item tag configuration for that item type. For tables showing the default item tag configurations of supported item types for the installed product, see Default Item Tag Configurations.

• The ItemTag.dll file validates item tag uniqueness for the following item types: equipment (other equipment, exchangers, mechanical equipment, and vessels), equipment components, instrument loops, instruments, pipe runs, duct runs, signal runs with a plant item type pipe run (hydraulic, connect to process, and so forth), rooms, and nozzles. All other item types are disregarded.

• In addition to the default ItemTag.dll file, versions of the file for use with a Project / As-Built configuration are delivered with the utility. For details, see Item Tag Validation.

Activate the custom ItemTag.dll file

1. Unregister the delivered ItemTag.dll file:

   1. Open a command prompt with admin privileges.

      To do this, right-click the command prompt icon and on the shortcut menu, click Run as administrator.

   2. At the command prompt, type the following command with the appropriate path to the file, for example:

      regsvr32 /u "c:\Program Files (x86)\SmartPlant\P&ID Workstation\bin\Itemtag.dll"

2. Rename the delivered ItemTag.dll file located in the above folder path.

3. From the ..\Programmer's Guide\Sample Source Code\Item Tag Validation folder on the Smart P&ID product media, copy the custom ItemTag.dll file to this folder path.

4. Register the custom ItemTag.dll file:

   1. Open a command prompt with admin privileges.

   2. At the command prompt, type the following command with the appropriate path to the file, for example:

      regsvr32 "c:\Program Files (x86)\SmartPlant\P&ID Workstation\bin\Itemtag.dll"

After running the ConfigureItemTagFormat.exe file for the first time, the ItemTagFormat.xml file is created in the location of the plant reference data rules file.

• All client machines using the plant must unregister the old ItemTag.dll file and register the new ItemTag.dll file in order to use the new tagging configuration.

• Any user can open and run the utility; that is, the user's access rights for the Configure Item Tag Utility are not validated against the roles set via Smart Engineering Manager.

• If a property included in an item tag’s definition is already associated with a validation program in Data Dictionary Manager, the existing value of that property's Validation ID must be copied to the Configure Item Tag Utility's ProgID field in order to be triggered, in addition to entering the value ItemTag.ItemTagFunc in the Validation ID field. For example, the existing Validation ID for the Nominal Diameter property of a pipe run is "ValidateNomDiam.ForeignCalc".

• The utility cannot verify or detect a plant's Workshare or project environment.