PBS mappings - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language

English

Product

HxGN SDx

Search by Category

Administration & Configuration

SmartPlant Foundation / SDx Version

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

For more information on how to create the PBS, see Create the PBS using the Load Manager.
Use the CFIHOS format mappings if you are using the cross-plant interaction hierarchy, even if your site is not CFIHOS-compliant. For more information, see Plant breakdown structure (PBS).
Examples of PBS mapping CSV files in CFIHOS or non-CFIHOS format are available on Smart Community. For more information, see Find sample data on Smart Community.

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.
Measurement system code	Relation to new object	Relation	SI	Yes	measurement system (object or Enum)	The default measurement system that is used by a site.

Plant

This mapping is intended to create an HxGN SDx plant under a site.

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

Use the Load Plants method to create the plants under a site.

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
name	HxGN SDx Plant - Name	String	CEX	Yes		This is the code name of the HxGN SDx plant.
description	HxGN SDx Plant - Description	String	Onshore processing facility	No		This is the description or name of the HxGN SDx plant.
status	HxGN SDx Plant - status	Enumlist - Active/Created	Active	Yes	value is "active" or "created"	Indicates if the plant is ready for use or is created for later use in the system.
site code	Relationship to the site	Relation		Yes	Site must exist in the database	Specifies which site the HxGN SDx plant is a part of.

Area (HxGN SDx)

This mapping is intended to create a functional area within an HxGN SDx plant. Areas can only be loaded into one plant at a time.

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

Use the Load Areas (HxGN SDx) method to create the functional areas in an HxGN SDx plant.

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
func area name	Area - Name	String	T	Yes		This is the code name of the functional area.
func area descr	Area - Description	String	Transmission	No		This is the description or name of the functional area.

Unit (HxGN SDx)

This mapping is intended to create a functional unit within a functional area. Units can only be loaded into one HxGN 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 areas to which the units belong.

Use the Load Units (HxGN SDx) method to create units within a functional area.

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
unit name	Unit - Name	String	CT	Yes		This is the code name of the unit.
unit descr	Unit - Description	String	Crude Transmission	No		This is the description or name of the unit.
func area name	Relationship to the functional area	Relation	T	Yes	Functional areas must exist in the database	Specifies which functional area the unit is a part of.

Area (CFIHOS)

This mapping is intended to create a area. Areas can only be loaded into one plant at a time.

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

Use the Load Areas (CFIHOS) method to create the functional areas in an HxGN SDx plant.

In the cross-plant structure, for successfully relating the tags and PBS items, we recommend that you must set the plant code property on the area to the corresponding plant.

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	Relationship to the area	Relation	6000	Yes	<=40 characters	A code that uniquely identifies the plant.
plant name	Area - Description	String	Onshore Processing Facility (OPF)	Yes	<=40 characters	The full name of the Plant.
site code	Area - Site	Relation	PRN	Yes	<=40 characters	Identifies the Site at which the Plant is geographically located.
ISO language	Area - PlantLanguageCode	Enum	EN	No	ISO language or (object or Enum)	The language that should be used by default for all exchange of information related to that plant
Measurement system code	Area- Measurementsystemcode	Enum	SI	No	Measurement system (object or Enum)	The default measurement system that is used by a site

Unit (CFIHOS)

This mapping is intended to create a unit. Units can only be loaded into one plant at a time.

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

Use the Load Units (CFIHOS) method to create units within a functional area.

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	Area - Name	Relation	6000	Yes	Must exist as or within the selected Create scope <=40 characters	A Plant is decomposed in process units. A process unit is part of one Plant.
process unit code	Unit - Name	String	36	Yes	<=40 characters	A code used to identify uniquely the Process_Unit within a plant.
process unit name	Unit - Description	String	Crude Transmission	Yes	<=100 characters	The full name of the Process_Unit.

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Area - Name

Relation

6000

Yes

Must exist as or within the selected Create scope

<=40 characters

A Plant is decomposed in process units. A process unit is part of one Plant.

process unit code

Unit - Name

String

Yes

<=40 characters

A code used to identify uniquely the Process_Unit within a plant.

process unit name

Unit - Description

String

Crude Transmission

Yes

<=100 characters

The full name of the Process_Unit.

Systems

This mapping is intended to create a system within an SDx plant. Multiple 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 system belongs.

Use the Load Systems method to create the systems.

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	SDx plant code or plant code	String	PlantA	Yes	Must exist as or within the selected Create scope <=40 characters	The SDx plant or plant code to which the system and sub system belong.
system code	System - Name	String	System10	Yes	<=10 characters	The name of the system.
system name	System - Description	String	System 10		<=50 characters	The description of the system.

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

SDx plant code or plant code

String

PlantA

Yes

Must exist as or within the selected Create scope

<=40 characters

The SDx plant or plant code to which the system and sub system belong.

system code

System - Name

String

System10

Yes

<=10 characters

The name of the system.

system name

System - Description

String

System 10

<=50 characters

The description of the system.

Sub Systems

This mapping is intended to create a sub system within an SDx plant. Multiple sub 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 sub system belongs.

Use the Load Sub Systems method to create the sub systems.

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	SDx plant or plant code	String	PlantA	Yes	Must exist as or within the selected Create scope <=40 characters	The SDx plant or plant code to which the system and sub system belong.
system code	System - Name	String	System10	Yes	<=10 characters	The system to which the sub system belongs.
sub system code	Sub System - Name	String	SubSys101	Yes	<=10 characters	The name of the sub system.
sub system name	Sub System - Description	String	SubSystem 101		<=50 characters	The description of the sub system.

Tag-Sub System Relations

This mapping is intended to create a relationship between a tag and a system or sub system within an SDx plant.

This mapping can be used only when the Create and Query scopes are set to the plant or project to which the system or sub system belongs.

Use the Load Tag-Sub System Relations method to create the tag to system and sub system relationships.

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	The SDx plant or plant code related to the system or sub system	String	PlantA	Yes	Must exist as or within the selected Create scope <=40 characters	The SDx plant or plant code to which the system and sub system belongs.
tag name	Tag - Name	String	AH-001	Yes	Must exist, tag must exist in the selected Create scope	The name of the tag used to reference the system or sub system.
system code	System - Name	String	System10	Yes	Must exist <=10 characters	The name of the system that is referenced by the tag.
sub system code	Sub system - Name	String	SubSystem101	Yes	<=10 characters	The name of the sub system referenced by the tag.

Doc-Sub System References

This mapping is intended to create a reference between a document and a system or sub system within an SDx plant.

This mapping can be used only when the Create and Query scopes are set to the plant or project to which the system or sub system belongs.

Use the Load Doc-Sub System References method to create the doc-sub system references.

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
document number	Document - Name	String	Doc-001	Yes	Must exist, the revision number must exist in the configuration set as the Create scope	The document number used in the reference.
revision code	Document - External Revision	String	01A	Yes	A specific revision for the document number must exist <=3 characters	The revision number used in the reference.
plant code	The SDx plant or plant code referenced by the system or sub system	String	PlantA	Yes	Must exist as or within the selected Create scope <=40 characters	The SDx plant or plant code to which the system and sub system belong.
system code	System - Name	String	System10	Yes	Must exist <=10 characters	The name of the system referenced by the document revision.
sub system code	Sub System - Name	String	SubSys101	Yes	<=10 characters	The name of the sub system referenced by the document revision.

Location

This mapping is intended to create a location. Locations can only be loaded into one HxGN 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 HxGN SDx Plant/Plant code	Relation	3000	Yes	Must exist as or within the configuration set as the Create scope? <=40 characters	A Plant is decomposed in geographical Areas. An Area belongs to one Plant.
area code	Location - Name	String	3000-LD3	Yes	<=10 characters	A code used to identify uniquely the Area within a plant.
area name	Location - Description	String	Standby Generator Room North	Yes	<=100 characters	The full name of the Area

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relation to HxGN SDx Plant/Plant code

Relation

3000

Yes

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

<=40 characters

A Plant is decomposed in geographical Areas. An Area belongs to one Plant.

area code

Location - Name

String

3000-LD3

Yes

<=10 characters

A code used to identify uniquely the Area within a plant.

area name

Location - Description

String

Standby Generator Room North

Yes

<=100 characters

The full name of the Area

Maintenance unit

This mapping is intended to create a maintenance unit within an HxGN SDx plant. Maintenance units can only be loaded into one HxGN 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 HxGN SDx Plant or Plant code	Relation	3000	Yes	Must exist as or within the configuration selected as the Create scope <=40 characters	A Plant is decomposed in maintenance units. A maintenance unit is part of one Plant.
maintenance unit code	Maintenance Unit - Name	String	KZ.KAS.H01.B02	Yes	<=10 characters	A code used to identify the Maintenance_Unit.
maintenance unit name	Maintenance unit - Description	String	Gas Processing and Compression	Yes	<=100 characters	The full name of the Maintenance_Unit

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relationship to the HxGN SDx Plant or Plant code

Relation

3000

Yes

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

<=40 characters

A Plant is decomposed in maintenance units. A maintenance unit is part of one Plant.

maintenance unit code

Maintenance Unit - Name

String

KZ.KAS.H01.B02

Yes

<=10 characters

A code used to identify the Maintenance_Unit.

maintenance unit name

Maintenance unit - Description

String

Gas Processing and Compression

Yes

<=100 characters

The full name of the Maintenance_Unit

Maintenance system

This mapping is intended to create a maintenance system within a maintenance unit. Maintenance systems can only be loaded into one HxGN 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 HxGN SDx Plant or Plant code	Relation	3000	Yes	Must exist as or within the selected Create scope <=40 characters	A Plant is decomposed in maintenance units. A maintenance unit is part of one Plant.
maintenance unit code	Relation to maintenance Unit	Relation	KZ.KAS.H01.B02	Yes	Maintenance unit must exist <=10 characters	Identify the Maintenance unit to which the Maintenance system belongs.
maintenance system code	Maintenance unit - Name	String	AA.KAS.H01.B02.11	Yes	<=10 characters	A code used to uniquely identify the Maintenance_System.
maintenance system name	Maintenance unit - Description	String	HP Flash Gas Compression Train 1	Yes	<=100 characters	A unique name of the Maintenance_System based on the Main Tag within the 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 at which the maintenance system has been started for the first time (on a continuous basis). This information is used by the maintenance discipline to develop maintenance plans, and particularly to determine when the first maintenance activities will have to happen.

Commissioning unit

This mapping is intended to create a commissioning unit. Commissioning units can only be loaded into one HxGN 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 HxGN SDx Plant or Plant code	Relation	3000	Yes	Must exist as or within the selected Create scope <=40 characters	A Plant is decomposed in commissioning units. A commissioning unit is part of one Plant.
commissioning unit code	Commissioning unit - Name	String	H2RG0300253	Yes	<=10 characters	A code used to identify the Commissioning_Unit.
commissioning unit name	Commissioning unit - Description	String	Site Commissioning Activity 53 on Flash gas compressor system 3, subsystem 2 on Hub 2	Yes	<=100 characters	The full name of the Commissioning_Unit
Parent commissioning unit code	Relationship to the parent commissioning unit	Relation	H2RG0300253	No	Commissioning unit must exist	This is the code name of the commissioning unit.

Construction Assembly

This mapping is intended to create a construction assembly. Construction assemblies can only be loaded into one HxGN 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 Construction Assemblies method to create the construction assemblies.

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 HxGN SDx Plant or Plant code	Relation	CEX	Yes	Must exist as or within the selected Create scope	The plant at which the construction assembly is constructed.
construction assembly code	Construction Assembly - Name	String	H01	Yes	<=10 characters	A code that uniquely identifies the construction assembly at a plant.
construction assembly name	Construction Assembly - Description	String	Gas Processing and Compression	Yes	<=100 characters	A name describing the purpose of a construction assembly.
parent construction assembly	Relationship to the parent construction assembly	Relation	CEX	No	construction assembly	A code that uniquely identifies the parent of a construction assembly at a plant.

Corrosion loop

This mapping is intended to create a corrosion loop. Corrosion loops can only be loaded into one HxGN 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 HxGN SDx Plant or Plant code	Relation	3000	Yes	Must be the same as the HxGN SDx plant into which you are loading <=40 characters	A Plant has many corrosion loops. A corrosion loop is part of one Plant.
corrosion loop code	Corrosion Loop - Name	String	CL1101	Yes	<=40 characters	A code used to uniquely identify the Corrosion_Loop.
corrosion loop name	Corrosion Loop - Description	String	Absorber circuit	Yes	<=255 characters	The full name of the Corrosion Loop.
corrosion loop description	Corrosion Loop - Long Description	String	V301 separator vessel below demister. Condensate liquid outlet piping to BL.	No	<=255 characters	Description of the Corrosion Loop.
corrosion loop type code	Corrosion Loop - Corrosion loop type	Enumlist		No	Provided value must be one of the types defined in your corrosion types Enumlist <=10 characters	Classifies the Corrosion_Loop with a Corrosion_Loop_Type.
process description	Corrosion Loop - Process description	String	V301 separates the 15 barg gas stream into dry saturated gas and condensate containing hydrocarbons, free sour water (CO2 and H2S) and inhibitor.	No	<=255 characters	Description of the process performed by the elements of the corrosion loop.
corrosion type description	Corrosion Loop - Corrosion Type description	String	Vessel is made of 15mm PWHT carbon steel including 3mm corrosion allowance. Normal operation Wet CO2 corrosion. Special operating conditions Un-inhibited the corrosion rate is 1.1mm/yr. Inhibiter injection should be monitored and alarmed.	No	<=255 characters	Identifies the type of expected corrosion.