Structure of the workbook - Intergraph Smart Construction - Hotfix 11 - Customization & Programming - Hexagon

Intergraph Smart Construction Customization

Language
English
Product
Intergraph Smart Construction
Search by Category
Customization & Programming
Smart Construction Version
8

The SPCRetrieveMappings.xlsm workbook contains separate tabs; each defines different properties and data required for retrieving documents into Smart Construction.

  • Column names are fixed and cannot be modified.

  • Columns can be moved to different locations on the same sheet.

  • Do not add new columns. Smart Construction does not read or handle any newly added columns.

Main tab

The Main tab is located on the first sheet of the workbook. It contains the Generate Retrieve Mapping button, which generates the XML file and saves it in the location specified when the file is checked out.

The Generate Retrieve Mapping button should not be renamed or removed because it contains a macro. The code behind the button should not be modified or removed.

Tool Specific tabs

Each tool-specific tab contains data and properties for tools that publish to SmartPlant Foundation and the mapping between those properties and Smart Construction.

Column Header

Explanation

DomainUID

Unique ID for the specific tool domain that is used by SmartPlant Foundation when doing schema mapping.

EFClassDef

Class definition of the object published into SmartPlant Foundation.

EFInterface

Interface definition of the object published into SmartPlant Foundation. It exposes the EFProperty defined on the same row. You can also use a view definition in this column.

EFProperty

Property definition of the object published into SmartPlant Foundation. If multiple values are available for a property of a published object, you can specify an identifier, such as MAX, MIN, or AVG, to get the maximum, minimum, or average value for the mapped property.

SPCInterface

Interface definition of the Smart Construction property into which the EFSchema property published maps to.

SPCProperty

Property definition of the Smart Construction property into which the EFSchema property published.

Formula

Formula definition of an object, either published into SmartPlant Foundation that is used by Smart Construction during schema mapping or a Smart Construction object. For mapped components, such as equipment, the formula can be "1."

FormulaUOM

Unit of measurement for the object, either published into SmartPlant Foundation that is used by Smart Construction during schema mapping or a Smart Construction object. For mapped components such as equipment, the FormulaUOM can be "each."

You can specify either an interface and property definition (EFInterface/EFProperty) or a formula definition (Formula/FormulaUOM) as the source for a SmartPlant Foundation property to be mapped to a Smart Construction property, but you cannot specify both.

OrderedValues tab

The OrderedValues tab lists table names and values used to specify enumerated properties for view definitions.

Column Header

Explanation

TableName

Name of a table referenced by the enumerated entry.

Name

Name of the enumerated entry.

Value

An order value for the enumerated entry.

ComponentCategories tab

The ComponentCategories tab maps component categories to class definitions for a particular tool. Data in the same row maps a particular category to a class definition and domain unique ID.

If your category mapping definition depends not only on the class definition but also on one or more property values, you can specify a SmartPlant Foundation condition statement in the Value column. The condition statement can restrict the assignment using one or more properties. For more information on how to build condition statements, see Condition syntax.

  • The component category must be spelled exactly the same as the component category in SmartPlant Foundation Desktop Client. For more information, see Manage Component Disciplines and Categories.

  • If a class definition is not assigned a component category, engineered published components related to the class definition are excluded from the Smart Construction retrieve.

  • When using a condition to assign component categories for an object, you must follow these guidelines:

    • You must include a generic (or "catch-all") row that assigns all members of the object class to a component category.

    • The row that contains the condition in the Value column must appear in the worksheet above this generic row.

    • When two or more conditions are required to split the category assignments for a class, the most restrictive condition should be listed first because the rows are processed by the system in order from top to bottom and will determine the assignment based on the first valid condition that is found.

      In the example below, a row is added above the generic mapping row for a condition with multiple properties to map P3DEquipment objects that meet the condition to the Civil component category instead of the Equipment category:

Column Header

Explanation

ComponentCategory

Category of a component within a discipline.

DomainUID

Unique ID for the specific tool domain that is used by SmartPlant Foundation when doing schema mapping.

EFClassDef

Class definition of the object published into SmartPlant Foundation.

EFInterface

Only used if not using conditions to define exceptions. See note below.

EFProperty

Only used if not using conditions to define exceptions. See note below.

Value

Enter a SmartPlant Foundation condition, if required, to define property values for assigning this class to a particular category that is different from the category that would be assigned to this class generally.

FabricationReplaceable

Select Y to signify that the class definition specified in the EFClassDef column is fabrication replaceable.

When a component is retrieved (or a component correlated to the component being retrieved) has a class definition marked as replaceable and a correlated equivalent component, it is replaced by that equivalent component.

If your category mapping depends only on a single property value, you can use an alternate syntax. In this case, in the EFInterface cell you would enter an interface definition of an object published to SmartPlant Foundation that exposes a property that would then be entered in the neighboring EFProperty cell on the same row. In the Value column, you would enter the value to compare the existing property value against. If multiple values need to be compared to a property of a published object, list the values in brackets, separated with a pipe. For example, {Value1 | Value2 | Value3}.

AssemblyDefinition tab

The AssemblyDefinition tab maps an EF interface definition to a Smart Construction class definition, either SPC_Spool or SPC_Assembly. Published components that are published to the interface definition are retrieved to the Smart Construction class definition. As a result, components can be grouped as spools or assembly definitions.

Column Header

Explanation

EFInterface

Interface definition of the object published into SmartPlant Foundation.

SPCClass

Smart Construction class definition of the object, either SPC_Spool or SPC_Assembly.

Grouping tab

The Grouping tab allows you to define a group. The group is represented as a single item in Smart Construction, and its geometry is the accumulation of each of the group elements. For example, you can define every graphic of a nozzle as part of the geometry of the equipment class definition. The nozzles would be highlighted in models and drawings together as a group and added to IWPs as a single component.

Column Header

Explanation

GroupRepresentative

EF class definition of the item which is going to be the representative of a group.

GroupRelationToExpand

EF relationship definition to expand to navigate from the group representative to the corresponding group elements.

GroupElements

EF class definition of the group elements.

SPCRepresentative

Corresponding representative in Smart Construction. The value is SPC_ComponentItem.