MDR deliverable create mappings - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This functionality was modified in an update. For more information, see MDR deliverable create mappings (modified in an update).

The deliverable submittal requires each document to have a revision, issue date, file, and issue purpose. For each submittal, a new revision must be supplied with the revision and issue date, or the same revision must be supplied with a different issue purpose. For more information on what can be done with a submittal, see Deliverable submittal.

The below table gives you a better understanding of the mappings delivered in the system.

Name

VTLImportDefHeaderOrder

Column header text

Column type

Constant value

Maps to

Notes

Document Number

1

Document Number

Physical

FDWDocumentMaster/Name

UID=FDWM, ConfigLevel, Document Number

DocRevision

2

Computed

FDWDocumentRevision/Name

UID=COMP_CurrentConfigLevel, Document Number, MAJORREVISION, MINORREVISION

Revision

3

Revision

Physical

SPFExternalRevision

Gets the revision from the Revision column.

Issue Date

4

Issue Date

Physical

A collaboration rule checks that this is populated.

COMP_CURRENTTIME

5

Computed

Gets the current time.

COMP_IssueDateAppendTime

6

Computed

Appends the current time to the issue date.

COMP_CURRCONFIGLEVELNAME

7

Computed

Gets the current configuration level.

COMP_CurrentConfigLevel

8

Computed

Gets the current configuration level and replaces any space with an underscore character.

REVISION_SCHEME

9

Constant

Rev01A

SPFDocRevisionRevisionScheme relationship

The SPFRevisionScheme object must exist.

Uses the fixed revision scheme.

MAJORREVISION

10

Computed

SPFMajorRevision

Gets the major revision from the Revision column.

MINORREVISION

11

Computed

SPFMinorRevision

Gets the minor revision from the Revision column.

COMP_DocRevisionUID

12

Computed

Builds UID for the revision.

COMP_ExistingRevisionIssueDate

13

Computed

Gets SPFRevIssueDate from the revision UID above in the system if it already exists.

Issue_Date_Conv

14

Computed

SPFRevIssueDate

Uses the existing issue date if it already exists; otherwise, uses COMP_IssueDateAppentTime value.

Document Title

15

Document Title

Physical

A collaboration rule checks that this is populated.

Classification

16

Classification

Physical

SPFPrimaryClassification relationship

Must be populated with the short code of the CFIHOS classification, otherwise use the name.

UID = SDC, Classification

WBSCode

17

WBSCode

Physical

SDADocWBSWorkPackage relationship

The SDAWorkPackage object must exist.

FEEDCode

18

FEEDCode

Physical

SDADocFEEDWorkPackage relationship

The SDAWorkPackage object must exist.

Vendor Package

19

Vendor Package

Physical

SDADocVendorWorkPackage relationship

The SDAWorkPackage object must exist and be classified as a vendor work package.

Vendor Package Classification

20

Constant

Vendor

SPFPrimaryClassification

Set to Vendor Package Classification to ensure the above package is a vendor package.

Alternate Document Number

21

Alternate Document Number

Physical

Gets the alternate document number from the csv.

Alternate Revision Number

22

Alternate Revision Number

Physical

Gets the alternate revision number from the csv.

Discipline

23

Discipline

Physical

SDADocMasterDiscipline relationship

The SDADiscipline object must exist and be available in the project - see processing below to validate this.

Area

24

Area

Physical

SDADocRevArea relationship

The SDAArea object must exist.

UID= FBA, ConfigLevel, Area

Unit

25

Unit

Physical

SDADocRevUnit relationship

The SDAUnit object must exist.

UID=FBU, ConfigLevel, COMP_PlantCodeValue, Unit

Status

26

Status

Physical

NOT USED

NOT USED

Issue Purpose

27

Issue Purpose

Physical

SDADocRevIssuePurposes relationship

The SDAPrgIssuePurpose object(s) must exist and be available in the project - see processing below to validate this.

UID = PIP, Issue Purpose

SubmissionsShareDIrectory

28

Computed

Gets the upload file location from the server manager - for internal use.

SDASubFolder_GUID

29

Computed

Gets the subfolder GUID - for internal use.

File Name

30

File Name

Physical

SPFFileComposition relationship

Creates the SPFDesignFile object if the file is found in the file folder.

File

31

Computed

Computes the local filename for the file.

COMP_Config1

32

Computed

Computes the local filename for the file.

ConfigLevel

33

Computed

Replaces any space with an underscore character in the configuration string.

OWNING_GROUP

34

Constant

ENGINEER

SPFItemOwningGroup relationship

The SPFDataAccessGroup (ENGINEER) object must exist.

SECURITYCODE

35

Constant

Unclassified

SDAItemSecurityCode relationship

The SDASecurityCode (Unclassified) object must exist.

Submittal

36

Computed

SCLBSubmittalDocumentVersions interface

The SCLBSubmittal object must exist.

Builds relationships to the submittal object.

ContractNo

37

Computed

SDADocContract relationship

The SPFContract is read off the submittal object and a collaboration rule checks an existing document is not related to a different contract.

FromOrg

38

Computed

SDADocOriginatingOrg and SDADocRevOriginatingOrg relationships

The SDAOrganization is read off the submittal object.

IssuePurpose_Pattern

39

Computed

Creates a regex expression from the csv input issue purpose.

Resolve_IssuePurposes

40

Computed

Gets the names of all the project issue purposes from the environment variable.

Validate_IssuePurposes

41

Computed

Internal SDVIssuePurpose property for error checking

If the Issue purpose entered in the csv is available in the project it sets SDVIssuePurpose = True. (compares the regex expression with Resolve_IssuePurposes). This property is tested by the Validate IssuePurposes For Config collaboration rule.

SubmittalMDRDoc

42

Computed

Gets the classification of the document from the system, for the document specified as MDR in the csv. This column is used in IsMDRValid computed column.

SubmittalMDRDocName

43

Computed

Gets the name of the document related to the contract from the system, for the document specified as MDR in the csv. This column is used in IsMDRValid computed column.

IsMDRValid

44

Computed

Internal IsMDRValid property for error checking

Error code processed by a collaboration rule that prevents the creation of two MDR documents for the same contract.

IsDocHasContract

45

Computed

Internal IsDocHasContract property for error checking

Error code processed by a collaboration rule that checks if the document in the csv has a contract other than that specified in the submittal.

COMP_ALLDISCIPLINESFORCREATECONFIG

46

Computed

Gets the UIDs of all the project disciplines from the environment variable.

Comp_Config_Discipline

47

Computed

Gets the UIDs of all the project disciplines from the environment variable and removes the DC_ prefix.

Comp_Discipline_Regex_Pattern

48

Computed

Creates a regex expression from the csv input discipline.

Comp_Discipline_Valid

49

Computed

Internal SDAConfigDiscipline property for error checking

If the discipline entered in the csv is available in the project, it sets SDAConfigDiscipline = True. (compares the regex expression with Comp_Config_Discipline). This property is tested by the ValidateDiscipline collaboration rule.

COMP_PlantCode

50

Computed

Builds plant code from config level and Area.

COMP_PlantCodeValue

51

Computed

Gets plant code object from system - used in the UID of the Unit.

IsMDRRevisionValid

52

Computed

Error code processed by a collaboration rule that checks if the MDR has an actual revision. Only an MDR with actual revision will be considered for loading.

COMP_MasterDocTitle

53

Computed

Description

Sets the description property on the master document.

COMP_IsMDRDocRevisionValid

54

Computed

Internal SDAConfigDiscipline property for error checking

Error code processed by a collaboration rule that checks if the MDR has an actual revision. Only an MDR with actual revision will be considered for loading.

Resolve_Classifications

55

Computed

Gets the names of the document or tag classifications related to the current create configuration.

Comp_Classification

56

Computed

Replaces the empty spaces in names with an underscore (_) and appends a hyphen (-) at the beginning and the end of the string.

Classification_Pattern

57

Computed

Creates a regular expression pattern for the classification column.

Classification_AppendWildcards

58

Computed

Constructs a classification pattern for the resolve classification column.

For example, if the Resolve_classifications returns AB,A C,and AD, then it constructs a pattern, such as -AB-,-A_C-, and -AD-.

Validate_Classification

59

Computed

HEXSDxSource

Sets the SDXSource property to true if the classification entered in csv is available in the current create configuration. Otherwise, sets the property to null.

This property is validated using the "HEX Check property HEXFDWDocumentMaster-masterref-HEXSDxSource Is Not blank" rule.

COMP_MDRDoc_VersionNumber

61

Computed

HEXSPFDocVersion

Returns the latest version number of the document revision, using the computed API function: func.GetVersionNumberForRevision("#FDWDocumentRevision,.Name=[Document Number],.SPFExternalRevision=[Comp_ExtRevisionDoc]", "true")