Developing OTDs for Communication Adapters

Editing an OTD’s Root Properties

The HL7 OTD copied to your Project can only be edited from the Root node. Each of the OTD’s segments are write protected. The OTD segments are visible from the Reference pane of the OTD Editor. This Reference pane contains internal and external templates for the OTD file. To edit specific segments of a Library OTD, see Adding and Editing OTD Segments. For more information regarding OTD properties, see OTD Properties.

Root Node Properties

The set of properties associated with Root nodes is shown in the following table.

Node Property Descriptions 

name 

Node display name. This can be a virtually-arbitrary string. 

javaName 

Property accessor basename. This is normally derived from the display name, modified to suit the restrictions on Java identifiers, and supplied automatically by the Sun Enterprise Service Bus. 

javaType 

Java type; automatically assigned, not editable. 

comment 

Free-form text (no run-time effect). 

delim 

Specified delimiter. See Specifying Delimiters.

nodeType 

Governs the marshal/unmarshal format. See Specifying the Node Type.

antecoding 

Specifies the input data coding (see Specifying Data Encoding on page 219). If this property is not specified, the value specified for the decoding property will be used for the input data. This property is displayed only when the top property is set to true.

decoding 

Specifies the unmarshal coding (see Specifying Data Encoding on page 219). (It is recommended to use UTF-8 for DBCS data, since the hex value of some ASCII delimiter may coincide with a hex value contained within a double-byte character.) This property is displayed only when the top property is set to true.

encoding 

Specifies the marshal coding (see Specifying Data Encoding on page 219). This property is displayed only when the top property is set to true. 

order 

Specifies the ordering of the Root node’s children: 

  • seq: Specifies that the child nodes must appear in sequence.

  • any: Specifies that the child nodes can appear in any order.

  • mix

postcoding 

Specifies the output data coding (see Specifying Data Encoding on page 219). If this property is not specified, the value specified for the encoding property will be used for the output data. This property is displayed only when the top property is set to true.

public 

Reserved for future development 

top 

Flag on Root node: support marshal/unmarshal (T/F). 

Properties edited from the Root node are applied inclusively to the OTD. For example, a level three delimiter, changed from the Root node, applies to all level three node delimiters. (The properties for specific segments can be exclusively edited, but to do this you must copy and paste the specific OTD that the segment refers to into your Project. For more information on editing specific segments, see Adding and Editing OTD Segments. .

ProcedureTo Edit an HL7 OTD’s Root Node Properties

  1. Copy and paste the OTD to your Project. The OTD is added to your Project in the Project Explorer tree.

  2. Double-click the OTD to open your Project in the OTD Editor.

  3. Select the Root node of the OTD from the editor’s Object Type Definition pane.

    The Root properties and displayed in the editor’s Properties pane.

  4. Click on any property field to edit the property from the Properties pane.