HeaderTemplates, HeaderTemplate

Well Test > Configuring CygNet Well Test > Configuring Well Test Using XML > Elements and Attributes > HeaderTemplates, HeaderTemplate

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

…

</Position>

</Positions>

…

</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	<Positions> <Commands>
Attributes	name queueUdc type

HeaderTemplate Attributes

A <HeaderTemplate> element has the following attributes:

Attribute	Required	Description
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 — in this mode, the host is responsible for the sequencing of commands to the device Device — in this mode, the device is responsible for the sequencing of commands to the device and the host is monitoring that process Note: Device type templates do not have Positions.

Attribute

Required

Description

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 — in this mode, the host is responsible for the sequencing of commands to the device
Device — in this mode, the device is responsible for the sequencing of commands to the device and the host is monitoring that process

Note: Device type templates do not have Positions.