Custom settings files for custom server projects - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

If any custom values, interfaces, or settings are required when you create a new server project or module, you must create a custom version of the applicable XML files as follows:

  • SpecializationValues.xml - Identifies any custom interface definitions with code.

  • DynamicValues.xml - Identifies any custom dynamic values.

  • Settings.xml - Identifies any custom server settings.

These unique XML files ensure that the original core server XML files are not overwritten or deleted during any upgrades. This also allows easier segregation of the content of the new custom server project or module.

The contents of each unique XML file are loaded by the server configuration service into the cache at log on. The custom settings, dynamic values, and interface definitions are then available in SmartPlant Foundation.

The customized files must not duplicate the content from the original files. They must only contain the new dynamic values, extensions, and interface definitions for the new custom server project or module.

To create a unique custom version of each of the XML files:

  1. Make a copy of each of the original XML files.

    For example, the SpecializationValues and DynamicValues XML files are located in the folder <SiteName>\SPFServer\SPFConfigService\SPFSharedSettings. The Settings XML file is located in the folder <SiteName>\SPFServer.

  2. Remove the existing product content from the container blocks in the copied XML files.

    The container block must be empty so you can add the new custom settings, dynamic values and interface definitions.

  3. Add the custom settings, dynamic values, or interface definition content to the empty container blocks in each XML file using the same format as the original.

  4. Save each new XML file to the same location as the original. Each file must have a unique name that begins with the same name as the original file, but includes additional characters that are specific to the new server project or module. For example:

    • SpecializationValuesMTR.xml

    • DynamicValuesMTR.xml

    • SettingsMTR.xml

Every new interface definition in the SpecializationValues.xml file in a new server project must be listed with a unique number. For more information on their format, see Editing the SpecializationValues.xml file.