Skip to content
AutomatedOn Help Centre

Create an OData dataset

A Dataset is one query against an OData data source: which entity set to read, which records to include, and which fields to keep. Processes and rules read records through datasets.

Before you start

Create and publish the OData Data Source first. The dataset must be created underneath it, because the entity set and field lists are loaded from that data source.

Steps

  1. Create the dataset

    In the back office, open the menu on your data source and create a Dataset. Give it a name that describes the records, such as Active learners.

  2. Pick the Entity Set

    Choose from the Entity Set list, which is loaded from the API. If the list can't be loaded, you'll see the reason above a box where you can type the entity set name yourself.

  3. Add filters

    In Filters, add one OData filter condition per row, for example:

    • Status eq 'Active'
    • Amount gt 1000
    • contains(Email, '@example.com')
    • Region eq 'UK' or Region eq 'IE'

    All rows must be true for a record to be included; they're joined with and. To pick records by date, or by a value supplied when the process runs, use tokens.

  4. Choose the fields

    In Select, add a row for each field you need. Pick the field in Select, and optionally type a friendly name in As. That name is what you'll use elsewhere, for example as $$FirstName$$ in an email. If you leave As empty, the field's own name is used. You need at least one field.

  5. Save, publish and preview

    Save and publish. Then open the dataset on the AutomatedOn site and use the Preview tab to check the records look right.

More detail

Tips

  • Text values in filters need single quotes, such as Status eq 'Active'. The same applies when you use a token: Status eq '{aoParam:Status}'.
  • Fields can be nested with a slash, such as Address/City.
  • Field and entity set lists are remembered while the editor is open. If the API has changed, reload the page in your browser to fetch them again.
  • If a field list shows Select an Entity Set (OData Dataset) or enter a Resource Path (REST Dataset) before choosing a field., pick the entity set first.
  • AutomatedOn fetches every matching record, following the API's next-page links.

Was this guide helpful?