Select and Process Criteria for Publish and Retrieve Mapping - Intergraph Smart 3D - Administration

Intergraph Smart 3D Integration

PPMProductFamily
3D Design and Visualization
PPMProduct
Intergraph Smart 3D
PPMCategory
Administration
Version_S3D
10.1(2014R1)

As you customize the publish and retrieve mapping in Smart 3D, you might encounter select and process criteria. Process criteria, also known as "callbacks," assist during publish and retrieve operations when the information in the tool schema does not match the information in the SmartPlant schema. Select criteria, when used, are the arguments for the Process Criteria programs.

Publish Tool Map Schema

The publish tool map schema includes select and process criteria on map class definitions and property definitions.

Map Class Definitions

Process Criteria (ProgID)

Select Criteria

Class

Task

Description

EFPublishHelpers.PublishImpliedPartOcc

CImpliedPartOcc

CImpliedPartOcc

Common

Helps with publishing implied part occurrences: whether to publish them or not and whether to map the objects.

When a part occurrence is published, its implied part should also be published if the part occurrence is a piping component.

EquipPublishHelpers.IntfPublishHelper

CPCableNozzle

CPCableTrayNozzle

CPConduitNozzle

CPEqpFoundationPort

CPHvacNozzle

CPPipeNozzle

CPCableNozzle

CPCableTrayNozzle

CPConduitNozzle

CPEqpFoundationPort

CPHvacNozzle

CPPipeNozzle

Equipment

Helps with publishing equipment. This code publishes nozzles only if they are connected to an equipment or a component.

RtePublishHelpers.RelationHelper

N/A

CPPipeAlongLegPathFeat

CPPipeEndPathFeat

CPPipeTurnPathFeat

Route

Helps with publishing relations associated with piping objects. For example, this code helps decide which SameAs relation to publish, when there is more than one possible SameAs relation allowed by the SmartPlant schema.

In this case, the callbacks are on the relation mapping, not on the class mapping.

Here are the callbacks for the relations associated with the classes: OwnsDistributionConnection: When an occurrence of the relation OwnsDistributionConnection is to be published, if the owner is a LogicalDistribConn (LDC), then the PathRun parent of the LDC is retrieved and returned as the owner.

RelConnectionAndPartOcc: When an occurrence of the relation OwnsDistributionConnection is encountered, this callback checks to see if the connection object should be published.

PathGeneratedParts: If a feature supports correlation, then the PathGeneratedParts relation between it and its base part is published as a SameAs.

SameAs: Determines if the SameAs relation on a feature is of type Instrument or Pipe Component.

Map Property Definitions

Process Criteria (ProgID)

Select Criteria

Property

Task

Description

EFPublishHelpers.LocalCSHlpr

N/A

Position

XAxis

YAxis

ZAxis

Common

Provides special processing for local coordinate system properties during a publish operation.

EquipPublishHelpers.PropPublishHelper

N/A

DistribPortStatus

DistribPortType

EndStandard

FlowDirection

Ncd

NcdUnitType

Npd

NpdUnitType

PressureRating

ScheduleThickness

Tightness

Equipment

Helps with publishing various equipment properties, for example, properties on different types of nozzles.

EquipPublishHelpers.PropPublishHelper

EquipmentComponent

ProcessEqCompTypes1

ProcessEqCompTypes2

ProcessEqCompTypes3

ProcessEqCompTypes4

Equipment

Helps with publishing properties on equipment components.

For a list of the delivered equipment component types, see the AllCodeLists.xls workbook.

EquipPublishHelpers.PropPublishHelper

Equipment

ProcessEqTypes0

ProcessEqTypes1

ProcessEqTypes2

ProcessEqTypes3

ProcessEqTypes4

ProcessEqTypes5

ProcessEqTypes6

Equipment

Helps with publishing properties on equipment.

For a list of the delivered equipment types, see the AllCodeLists.xls workbook.

RtePublishHelpers.PartPublishHelper

N/A

CommodityClass

CommoditySubClass

CommodityType

Route

Helps with publishing Route parts.

These instrument properties are not published because the SmartPlant schema does not contain corresponding properties.

RtePublishHelpers.PropPublishHelper

N/A

NCD

NPD

OuterDiameter

SteamoutPressure

SteamoutRequirement

SteamoutTemperature

Thickness

Route

Helps with publishing properties on Route parts.

NPD and NCD: In Smart 3D, the value and units for these properties are stored as two separate properties. In the SmartPlant schema, they are stored as one property. This helper concatenates the value and its UOM so that it can be published as one property.

OuterDiameter: This property is not published for components because the model does not have data for this case.

Steamout properties: These properties are not published for conduit.

Thickness: The software publishes this value only if the value is greater than 0.

SP3DEFPropHelper.SystemPathPublisher

N/A

SystemPath

Common

Helps with publishing the SystemPath property on an object in the model. This code parses the select criteria to get the delimiter for constructing the system hierarchy path. The software uses the \ delimiter if none is specified.

SPSProcessTEFProp.MatGradeProp

N/A

MaterialGrade

Structure

Provides custom process criteria for the MaterialGrade property. The code converts the property string to a codelist value.

SPSProcessTEFProp.PartAxisProp

N/A

BetaAngle

Mirror

Structure

Provides custom process criteria for the mirror and beta angle properties in the SmartPlant schema. These properties are not published on the member system.

SystemPublishHelper.PropPublishHelper

N/A

FluidCode

FluidSystem

Systems & Specs

Provides special processing for the FluidCode and FluidSystem properties, which are properties on pipeline systems. The SystemPublishHelper.PropPublishHelper class is similar to the EquipPublishHelpers.PropPublishHelper class.

The code handles codelist values that use 1 as "Undefined". The SmartPlant schema supports -1 as "Undefined', so the values are converted to -1.

Retrieve Tool Map Schema

The retrieve tool map schema includes callbacks for document types, as well as a few other callbacks.

Document Type

ProgID

Task

Description

ProjectBrkDwn

EFWDocCallback.WBSCallback

Common

Processes WBS (Work Breakdown Structure) projects and items when the software retrieves project breakdown structure documents.

This class determines whether to correlate the WBS projects and items with 3D objects.

PBSDocument

EFSystemCallback.EFUnitSysCallback

Systems & Specs

Processes area systems and unit systems when the software retrieves PBS (Plant Breakdown Structure) documents created by SmartPlant Foundation. When an area or unit system is retrieved, the software checks to see if there is an existing Smart 3D object with the same name and type in the same location in the system hierarchy. If so, the software correlates to this object instead of creating a new object.

PIDDrawing

EFSystemCallback.EFPipelineCallback

Systems & Specs

Processes pipeline systems when the software retrieves P&ID documents created by SmartPlant P&ID. When a pipeline is retrieved, the software checks to see if there is an existing pipeline with the same name in the same location in the system hierarchy. If so, the software correlates to this pipeline instead of creating a new pipeline.

N/A

CmnAppPropHelpers.WBSProjMapHelper

Common

Compares the project name of the Smart 3D object with the project name of the corresponding design basis object during the Compare Design Basis command.

N/A

EquipPropConversion.InsulateConversion

Equipment & Furnishings

Provides property conversion for equipment insulation during the Compare Design Basis command.

N/A

RteMapPropHelpers.RunMapPropHelper

Route

Facilitates the mapping of data in the SmartPlant schema to Smart 3D pipe runs (for example, flow direction and slope) during the Compare Design Basis command.

See Also

Schema Mapping Rules