Data definitions

Wiki
1

Data definitions are very similar to export definitions. Data definitions can be used to generate data in JSON/ XML format or as a tuple list. The main advantages for using a data definition when generating JSON are:

  • Performance gain by caching.
  • Integration with REST endpoints. Novulo REST endpoints only support data definition or process action definitions for providing data. Export definitions are not supported.
  • Nesting functionality to customize JSON easily.

How to create a data definition.

  1. Go to general settings → data definitions and add a new record.

  2. Set the status to draft. When the status is set to active you will not be able to add new fields.

  3. Fill in a description, record type and filter expression.

    image
    image938×325 6.46 KB

  4. Add a new field and select the required field type

  • Field: This option allows you to retrieve 1 value from a field or path from the data definition record type.
  • Single object: This option allows you to link another data definition which can only return a single object. For this option you will need to create a new data definition first, after which you’ll have to create an expression resulting in one single record. For example sub-dataset with recordtype contacts. the expression could be something like. contacts:first({contacts,this,this.is_active.equals(yesno:load(1)),this.id.desc})
  • List of objects: This option allows you to link another data definition just like the single object but allows you to get all of the records or a select range. A filter expression is required for further filtering the linked data definition but may be set to true. This filter expression combines with the filter of the data definition itself.

In the below example 3 fields are used, the identifier is used in the result:

image
image752×177 10.8 KB

    {
        "this_is_a_field": null,
        "this_is_a_single_object": {
            "status": "Started",
            "description": "Example for e-mail"
        },
        "this_is_a_list_of_objects": [
            {
                "status": "Started",
                "description": "Test"
            },
            {
                "status": "Started",
                "description": "Test CB"
            },
            {
                "status": "Started",
                "description": "Example for e-mail"
            }
        ]
    }
]
  1. After or during creating all fields and sub-data definitions you can test the outcome by clicking on the “Run data definition to JSON” button found on the “Test data” panel.
  2. When you are content with the output make sure to change the status from draft to active.