PBS mappings (modified in an update) - HxGN SDx - HxGN SDx - Reference - Hexagon

HxGN SDx Modified and Retired Functionality

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the CFIHOS mappings prior to Version 1.4. For the latest information, see PBS mappings.

Site

This mapping is intended to create a site, which is the highest level in the PBS.

This mapping can be used only when the Create and Query scopes are not selected.

  • Use the Load Sites method to create the sites.

The following table explains the input formats required for the mapping, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

site code

Site - Name

String

KAS

Yes

<40 characters

A code used to uniquely identify the Site.

site name

Site - Description

String

Kashagan Field

Yes

<100 characters

A unique name to identify a geographical location.

This mapping can be used only when the Create and Query scopes are not selected.

Location

This mapping is intended to create a location. Locations can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the locations belong.

  • Use the Load Locations method to create the locations.

The following table explains the input formats required for the mapping, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relation to SDx Plant/Plant code

Relation

CEX

Yes

Must exist as or within the configuration set as the Create scope

Specifies which SDx plant or plant code the location is a part of.

area code

Location - Name

String

CT

Yes

<10 characters

This is the code name of the location.

area name

Location - Description

String

Crude Transmission

No

<40 characters

This is the description or name of the unit.

Maintenance unit

This mapping is intended to create a maintenance unit within an SDx plant. Maintenance units can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the maintenance units belong.

  • Use the Load Maintenance Units method to create the maintenance units.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must exist as or within the configuration selected as the Create scope

Specifies which SDx plant or plant code the maintenance unit is a part of.

maintenance unit code

Maintenance Unit - Name

String

H01.B02

Yes

<10 characters

This is the code name of the maintenance unit.

maintenance unit name

Maintenance unit - Description

String

Gas Processing and Compression

Yes

<50 characters

This is the description or name of the unit.

Maintenance system

This mapping is intended to create a maintenance system within a maintenance unit. Maintenance systems can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant that contains the maintenance units to which the maintenance systems belong.

  • Use the Load Maintenance Systems method to create the maintenance systems.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must exist as or within the selected Create scope

Specifies which SDx plant or plant code the maintenance system and its parent maintenance unit are a part of.

maintenance unit code

Relation to maintenance Unit

Relation

H01.B02

Yes

Maintenance unit must exist

Specifies the maintenance unit to which the maintenance system belongs.

maintenance system code

Maintenance unit - Name

String

H01.B02.01

Yes

<10 characters

This is the code name of the maintenance system.

maintenance system name

Maintenance unit - Description

String

Gas Processing and Compression

Yes

<50 characters

This is the description or name of the maintenance system.

maintenance system start up date

Maintenance unit - Start up date

dd-mm-yyyy

04-03-2018

No

Must be a valid date and in dd-mm-yyyy format

The date on which the maintenance system started for the first time.

Commissioning unit

This mapping is intended to create a commissioning unit. Commissioning units can only be loaded into one SDx plant at a time.

This mapping can be used only if the Create and Query scope is set to the plant to which the commissioning units belong.

  • Use the Load Commissioning Units method to create the commissioning units.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must exist as or within the selected Create scope

Specifies which SDx plant or plant code the commissioning unit is a part of.

commissioning unit code

Commissioning unit - Name

String

H2RG0300253

Yes

<10 characters

This is the code name of the commissioning unit.

commissioning unit name

Commissioning unit - Description

String

Site Commissioning Activity 53

Yes

<50 characters

This is the description or name of the commissioning unit.

Commissioning system

This mapping is intended to create a commissioning system. Commissioning systems can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the commissioning systems belong.

  • Use the Load Commissioning Systems method to create the commissioning systems.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must be the same as the SDx plant into which you are loading

Specifies which SDx plant or plant code the commissioning system is a part of.

commissioning unit code

Commissioning unit - Name

Relation

H2RG0300253

Yes

Must exist within the SDx plant or plant code

This is the code or name of the commissioning unit which the system is a part of.

commissioning system code

Commissioning system - Name

String

01

Yes

<10 characters

This is the code or name of the commissioning system.

commissioning system name

Commissioning system - Description

String

Site Commissioning Activity 53 on Flash gas compressor system 3, subsystem 2 on Hub 2

Yes

<50 characters

This is the description or name of the commissioning system.

Module

This mapping is intended to create a module, that is a construction module. Modules can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the modules belong.

  • Use the Load Modules method to create the modules.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must exist as, or within, the selected Create scope

Specifies which SDx plant or plant code the module is a part of.

module code

Module - Name

String

H01

Yes

<10 characters

This is the code name of the module.

module name

Module - Description

String

Gas Processing and Compression

Yes

<50 characters

This is the description or name of the module.

Module system

This mapping is intended to create a module system. Module systems can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the module systems belong.

  • Use the Load Module Systems method to create the module systems.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must be the same as the SDx plant into which you are loading

Specifies which SDx plant or plant code the module system is a part of.

module code

Module - Name

Relation

H01

Yes

Must exist within the SDx plant or plant code

This is the code name of the module which the system is a part of.

module system code

Module system - Name

String

A01

Yes

<10 characters

This is the code name of the module system.

module system name

Module system - Description

String

Gas Processing and Compression pipelines

Yes

<50 characters

This is the description or name of the module system.

Corrosion loop

This mapping is intended to create a corrosion loop. Corrosion loops can only be loaded into one SDx plant at a time.

This mapping can be used only when the Create and Query scopes are set to the plant to which the corrosion loops belong.

  • Use the Load Corrosion Loops method to create the corrosion loops.

The following table explains the input formats required, including an example and explanation of each column's purpose:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the SDx Plant or Plant code

Relation

CEX

Yes

Must be the same as the SDx plant into which you are loading

Specifies which SDx plant or plant code the corrosion loop is a part of.

corrosion loop code

Corrosion Loop - Name

String

CL1101

Yes

<40 characters

This is the code name of the corrosion loop.

corrosion loop name

Corrosion Loop - Description

String

Corrosion for Steel Pipe

Yes

<255 characters

This is the description or name of the corrosion loop.

corrosion loop description

Corrosion Loop - Long Description

String

Gas Processing and Compression System

No

<255 characters

This is the long description of the corrosion loop.

corrosion loop type code

Corrosion Loop - Corrosion loop type

Enumlist

[Type X]

No

Provided value must be one of the types defined in your corrosion types Enumlist

If you have corrosion loop types defined in the system, this is the typing that is given to the corrosion loop.

process description

Corrosion Loop - Process description

String

gas transport

No

<255 characters

Description of the process performed by the elements of the corrosion loop.

corrosion type description

Corrosion Loop - Corrosion Type description

String

corrosion due to H2S in gas

No

<255 characters

Identifies the type of expected corrosion.