Exporting Records from Workbooks

This task will export data from your Workbooks system based on the settings provided. The task settings are explained in detail below.

The data returned will always be in XML format. An example of this format is provided below.

Connection

Required
The Workbooks connection to use when running this task.

Output File

Required
The file to save results from the task. The results are returned as an array of fields as detailed in the example below.

Export Settings

Columns

Optional
Optionally filter the columns returned from the Workbooks API. For API reference, login to Workbooks and navigate to Configuration -> Automation -> API Reference

Endpoint

Required
The name of the endpoint you would like to retrieve data from. For example, 'crm/organisations', to get Workbooks organisations.

Limit

Optional
Limit the number of records returned per page. This defaults to 100.

Filter Settings

Created Since

Optional
When the 'Export Type' option is set to 'New', filter out records created before this date.

Export Type

Required
Optionally export new, modified or all records from Workbooks.

Filters

Optional
Optionally filter the records returned from the Workbooks API.

A filter contains the following properties:

• Field The name of the field to base your filter on
• Comparison The operator to use against the given value, e.g 'Equals' or 'Greater Than'
• Value The value to run the filter against

Updated Since

Optional
When the 'Export Type' is set to 'Modified', filter out records updated before this date.