HeaderTemplates, HeaderTemplate

The <HeaderTemplates> element of the XML configuration contains a list of all the defined header templates. A header template contains a list of positions, the commands associated with each position, and all actions associated with each command. Additionally, commands can also be defined at the header template level. These commands can be referenced by commands at the position level.

To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.

Example

<WellTestConfiguration>

<HeaderTemplates>

<HeaderTemplate name="MbSim" type="Host" queueUdc="QUEUE" hasSubHeaders="false">

<Positions>

<Position …>

</Position>

</Positions>

<Commands>

<Command …>

<Actions>

</Actions>

</Command>

</Commands>

</HeaderTemplate>

</HeaderTemplates>

 

</WellTestConfiguration>

HeaderTemplates

The <HeaderTemplates> element has one type of child element, <HeaderTemplate>, and has no attributes.

HeaderTemplate

Each <HeaderTemplate> element contains a list of header templates associated with this header.

HeaderTemplate Properties

The <HeaderTemplate> element has the following properties:

Property Description

Case Sensitive

Yes

Required

Yes

Number of Instances Allowed

Unlimited

Parent Element

<HeaderTemplates>

Child Elements

Attributes

hasSubHeaders

name

queueUdc

type

HeaderTemplate Attributes

A <HeaderTemplate> element has the following attributes:

Attribute Required Description

hasSubHeaders

No

Indicates whether the template supports sub-headers, which are the cross-reference between the unique position of the header template to the sub-header and sub-header position where the well is connected. Options include True or False.

See Positions, Headers, and Sub-Headers for more information.

name

Yes

Specifies the name of the header template. This name is used in the Header configuration.

queueUdc

Yes

Specifies the UDC to use for the header queue. This is an override value that can be used if a different UDC is needed for whatever reason. E.g., QUEUE.

type

Yes

Two supported template types are supported:

  • Host-based — in this mode, the host is responsible for the sequencing of commands to the device
  • Device-based — in this mode, the device is responsible for the sequencing of commands to the device and the host is monitoring that process

Note: Device-based templates do not have Positions.

Back to top