Copybook Annotations

You can customize how the connector processes individual copybook items by inserting annotation comments in copybook text.

Annotations take the following form:

* @binary

01 T1 PIC X

Annotations are inserted before the item they apply to. In the above example, @binary applies to T1.

Annotations do not affect validity of the copybook from the COBOL standpoint. If you enter an annotation incorrectly, the connector displays a warning but ignores the issue if no action is taken.

Annotations offer these capabilities:

  • Designating a field as base64 binary
  • Turning on or off numeric interpretation
  • Setting a default redefine item, adding control values

Copybook Annotations

Annotation Applicability Effect
@binary Elementary items Makes the item a base64Binary string. Connector does not apply any validation or conversion to items with this annotation.
@defaultRedefine One of the items in a REDEFINE group Designates an item as default in a REDEFINE group.
@controlField:{item name} A redefined item Assigns a control field to an item in a REDEFINE group.
@controlValues One of the items in a REDEFINE group. Assigns a set of control values to an item in a REDEFINE group.
@parseNumeric A numeric edited item Turns on editing/de-editing of a numeric-edited item.