Data Model pane

The Data Model pane displays the result of all the preparations and extractions of the extraction workflow. The pane displays the content of a single record within the record set at a time.
Data is displayed as a tree view, with the root level being the record table. On the level below that are detail tables, and a detail table inside a detail table is called a nested table.
The Data Model is also used as a navigation tool between records and in all detail tables.

For more information see The Data Model.

Filter

To find a certain table, group or field in a large Data Model, start typing characters in the Filter box. This immediately narrows down the list of displayed items to all tables, groups and fields whose name contains the characters that were typed. Note that the filtering is case-insensitive.

Data Model toolbar buttons

  • Import Data Model : Click to browse to a file that contains a Data Model. This may be:
    • A Data Model file (*.OL-datamodel).
    • A JSON file (*.json; see the note below).
    • A Connect template (*.OL-template), data mapping configuration (*.OL-datamapper) or 'typed' JSON file (*.json; see the note below).

    The file's data model structure will be displayed in the Data Model pane without data.

  • Export Data Model : Click to browse to a location to save the Data Model file. The available file types are:
    • A Data Model file (*.OL-datamodel).
    • A JSON file (*.json): A JSON object or an array of JSON objects representing records.
    • A 'typed' JSON file (*.json).
    Typed JSON follows the structure of a JSON Record Data List (see the REST API Cookbook). Data field types are determined by the schema object in the JSON.
    When a Data Model is exported to a JSON file or typed JSON file, detail tables are exported, but groups are not.
  • Synchronize Fields and Structure : Click to synchronize the Data Model fields and structure in the currently loaded template and data mapping configuration. If you click this button when working on the data mapping configuration, the Data Model gets updated to the one in the template. If you click it when working on the template, the Data Model gets updated to the one in the data mapping configuration.
  • Show the ExtraData field : Note that this field is not meant to be filled via an extraction. It is meant to be used in a Workflow configuration to add data to the Data Model; see Adding fields and data via Workflow.
  • Collapse All: Collapse all fields on the record level, in all detail tables and in all groups.
  • Minimize/Maximize: Click to minimize or maximize the pane. See Moving and Merging Panes.

Data Model contextual menu

The Data Model is generally constructed by extracting data; see Extracting data.
It is however possible to modify the Data Model, even if no data is present in the pane. To do this, open the contextual menu within the pane itself by right-clicking on something in the Data Model pane. Depending on where you've clicked, it can contain the following options.

Note: Moving and grouping fields in the Data Model has no impact on the order in which data are extracted, or on the final records in the OL Connect database. They only help you organize the Data Model visually.
To learn how to change the order in which data are extracted, see Renaming and reordering fields in an extraction step.

  • Add Field: Click to add a new field at the current level (record or detail table). Enter the field name in the dialog; if you want you can change the field's data type and set a default value. Then click OK to add it to the Data Model.

  • Add Table: Click to add a new detail table at the current level (record or existing detail table). Enter the table name in the dialog and click OK to add it.

  • Add Group: Click to create a new group at the current level (record or existing group). Enter the group name in the dialog and click OK to add it. Any selected fields will be added to the group. (See also: Ordering and grouping fields in the Data Model.)

Note: Rename, Delete and Set Type are only available for Data Model fields or detail tables that are not filled via an extraction.
Fields and detail tables that are filled via an Extract step are to be changed (renamed, deleted etc.) via the properties of that Extract step; see: Editing fields and Renaming a detail table.

  • Rename: Click to rename the selected table, field or group. Enter the new name and click OK to rename.

  • Required: Click to indicate that the field should be retained, even if there is no Extract step that references it. The DataMapper immediately discards non-required fields that are not referenced by any Extract step.

  • Delete: Click to delete the selected table or field.

  • Set Type: Use the list to select the field type (see Data types).

  • Ungroup: Delete the selected group. The fields in the group will be moved up one level in the Data Model.

  • Default Value: Click to set the default value for a field. This value is used if no extraction is present, or if an extraction attached to this field returns no value.

  • Move: Click to move the selected field within the current level or group in the Data Model. (See: Ordering and grouping fields in the Data Model.)

    • Top: Move the field to the first place.

    • Up: Move the field one step up.

    • Down: Move the field one step down.

    • Bottom: Move the field to the last place.

  • Collapse All: Collapse the fields on the record level, in all detail tables and in all groups.

  • Expand All: Expand the fields on the record level, in all detail tables and in all groups.

  • Copy: Copy the field's contents to the clipboard.

Field display

Fields in the Data Model pane are displayed in specific ways to simplify comprehension of the display data:

  • The column on the left displays the name of the field.

  • The column on the right displays the current value of the extracted field based on the record shown in the Data Viewer, if an Extract step has an extraction for this field (see Extracting data).

  • The icon to the left of the name indicates the data type of the field (see Data types).

  • A field name with an asterisk to the right indicates that this field is required. All imported data model fields are initially marked as required to prevent them from being removed, since the DataMapper immediately discards non-required fields that are not referenced by any Extract step.

  • A field with a grey background indicates this Data Model field does not have any attached extracted data.

  • A field with a white background indicates that the field has attached extracted data but the step extracting the data is not currently selected.

  • A field with a blue background indicates that the field has attached extracted data and the step extracting the data is currently selected.

  • A field or table with red text indicates a difference between the data model in the data mapping configuration and template.

Record navigation

Records can be navigated via the Data Model pane. The default record level navigates between records both in the Data Model pane and the Data Viewer, while each detail table has a similar navigation that influences that table and each detail table under it.

  • Expand/Contract: Click to hide or show any fields or tables under the current table level or in the current group (see Grouping fields).

  • Table Name: Displays the name of the table as well as the number of records at that level (in [brackets]). At the record level this is the number of records. In other levels it represents the number of entries in a detail table.

  • Number of Records: The number of available records in the active data sample. This is affected by the Boundary settings (see Record boundaries and Settings pane) and the Preprocessor step (Preprocessor step).

  • First Record: Go to the first record in the data sample. This button is disabled if the first record is already shown.

  • Previous Record: Go to the previous record in the data sample. This button is disabled if the first record is shown.

  • Current Record: Displays the current record or table entry. Type a record number and press the Enter key to display that record. The number has to be within the number of available records in the data sample.

  • Next Record: Go to the next record in the data sample. This button is disabled if the last record is shown.

  • Last Record: Go to the last record in the data sample. This button is disabled if the last record is already shown. If a record limit is set in the Settings pane (Settings pane) the last record will be within that limit.