Container ID naming convention - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

ContainerIDs are made up of:

Layer.Container

where

Layer = directory

Container = prefix_filename

(prefix = Admin, Schema, or Domain)

Examples of containerIDs are:

  • Auth

  • Bootstrap

  • Common

  • Common.Documents

  • Common.Transmittals

Core

  • Core.Forms

  • Core.Reports

  • Core.Workflow

The system must not have the same ContainerID used in two different files.

There is a direct relationship between the ContainerID and the location of the file in the directory structure.

Example

<Container CompSchema="SPFAdminComponent" IObject_ContainerID="Core.AdminReports">

FilePath = ..\Models\SPF\Core\ADMIN_AdminReports.xml

The part of the ContainerID that precedes the dot refers to the 'Layer' or Folder in which the model file should reside; in this case, it is 'Core'.

The part of the ContainerID that comes after the dot refers to the second part of the file name (the part after the underscore); in this case, it is AdminReports.

Lastly, the first part of the file name is either 'SCHEMA', 'ADMIN', or 'DATA', which is determined by the CompSchema of the file content; in this case, it is SPFAdminComponent so ADMIN is used.

If it is MetaSchema, then use SCHEMA; in all other cases, use DATA.