Name, Start, End, and Key (Recordset Fields Tab)

Before you can define a field on a recordset, you need to add fields to your recordset.

Note: If the size of a record in a recordset is not consistently a fixed number of rows, you can create variable records in a recordset. Variable records enable you to dynamically access records that change in size throughout your host application. Using the Recordset Layout tab, configure a distinguishing characteristic of a record in a recordset and then, using the Recordset Fields tab, identify certain record fields in a recordset that are unique.

 

To add a field to a recordset:

  1. Select an area within the recordset on the terminal screen that contains specific data and click the New Field button.

    Note: By default, a name and the start and end offsets of the field are provided by the Design Tool. To change the name of the field, place your cursor in the Name text field and type a new name.

  2. To delete the field, place your cursor within the field definition in the Entity window and click the Delete button.

Use the following options to further define the field you just created:

Name
The name of the field.

Start
The start offset within a field. By default, the Design Tool provides the start coordinate of the field you have selected. Note: This is not a position on the terminal screen but rather a position within the record. Example: If a terminal screen is 80 columns wide and a record has two rows, the Start position on the second row will be 1 rather than 81.

End
The end offset within a field. By default, the Design Tool provides the end coordinate of the field.

Key
Select this check box if the name of this field returns one unique record. If you mark multiple fields as a key, the combination forms a key that appears in the exported documentation to aid the API developer in fetching specific pieces of data.

To create variable records in a recordset:

  1. Add a recordset to your model.
  2. On the Recordset Layout tab, select Variable under Record size.
  3. Select an option from the Delimit by box.

    For example, select <Any text> and then specify the start and end column of the text that appears in the first row of a recordset.

  4. Click the Advanced Delimiter Properties button to open the Advanced Recordset Delimiter Properties dialog box.

    If you have selected a delimiting property that is also data in the recordset, like the <Any text> option described above, configure the options in this dialog box.

  5. Click the Recordset Fields tab, and add fields to your recordset.
  6. On the last field of the recordset, delete the column number in the End box and type the letters eor, which notifies the Host Integrator that this is the end of the variable record that you've created.

Related Topics
Bullet How to add entities
Bullet Attribute tab
Bullet Recordset tab