Input 

Document

• Min: 0

• Max: 1

• Mapper Snap

• Copy Snap

• JSON Parser

A document with data that indicates the entities to be filtered and retrieved from an Exact Online instance. 

Output

Document

• Min: 1

• Max: 1

• Mapper Snap

• Copy Snap

• JSON Formatter

A document containing the entity data retrieved from an Exact Online instance.

Error

Document

• Min: 1

• Max: 1

N/A

The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline.

Label*

String

Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default Value: N/A
Example: Exact Online Read

Version*

Dropdown list

Choose or specify the version of the Exact Online API.

Default Value: v1
Example: v1

Division*

String/Expression/Suggestion

Specify a unique ID of the Exact Online Division (you can retrieve this ID using a REST call, https://start.exactonline.nl/api/v1/current/Me?). Alternatively, click the Suggestion  icon to fetch the list of supported divisions and select a division. 

Default Value: N/A
Example: 1234567

API object*

String/Expression/Suggestion

Specify the API that you want to access in the Exact Online instance. This dropdown list contains supported services available for the Exact Online instance. Alternatively, click the Suggestion  icon to fetch the list of API objects and select an object. 

Default Value: N/A
Example: CRM

Endpoint*

String/Expression/Suggestion

Specify an Exact Online Endpoint to be connected for each of the API objects.

Default Value: N/A
Example: Accounts

Filter records

Use this field set to define the filter criteria for the response result based on the specified parameters. Click to add a new row to define the filter criteria. You can enter only one filter criteria in each row. This field set comprises the following fields:

• Field name

• Operation

• Field value

• Condition

String

Specify the system parameter ($filter) field for filtering the records in the output.

String

Choose the comparison operator for the $filter field specified above from this drop-down list. Available options are: 

• Equals

• Not Equals

• Greater than or Equal

• Greater than

• Less than or Equal

• Less than

• Starts with

• Ends with

String

Specify the value with which the above $filter field must be compared. The data types: String, Integer, Boolean, or any other data type depends on the $filter field that you specified for the filter criterion.

String

Choose a value from this drop-down list to set the correlation between this filter criterion (row) and the next one (row), if being defined at all, to apply the filters for generating the final output. Available options are: 

• Or: To retrieve records that match either the current criterion or the next criterion.

• And: To retrieve only records that match both the current criterion and the next criterion.

• None: To specify that the current and the next criteria can be evaluated independently of each other in retrieving the records.

Output field selection

This field set enables you to select the fields to include in the output. Click to add a new row to define the output field. You can enter only one output field in each row. 

String

Specify the fields from the result dataset to be populated in the output.

Default Value: N/A
Example: ID, name1, name2

Order by

Use this field set to define the sort order for the records in the output. Click   to define the sort order criteria. Multiple criteria is applied in the same sequence as they are defined. This field set comprises the following fields:

• Element

• Order by type

String

Specify the field in the expected output by which the records in the output must be ordered.

Default Value: N/A
Example: name1

String

Depending on the field selected above, define whether the rows must be sorted in the ascending order or descending order. Available options are:

• Ascending

• Descending

Default Value: Descending
Example: Descending

Function parameter

This field set enables you to define the sort order for the records in the output. 
Only one column name can be specified in each row. Click   to add a new row and define the value accordingly. Multiple parameters are applied in the same sequence as they are defined. This field set comprises the following fields:

• Field name

• Field value

String

Specify the name of functional properties.

Default Value: N/A
Example: searchText

String

Specify the values of specified functional fields.

Default Value: N/A
Example: test_text

Output fields advanced options

Use this section of Snap Settings to customize the output set: the number of output entries and the index of the starting entry. Available options are:

• Output entry limit

• Output entry offset

• Automatic pagination

• Inline count

• Allow empty result

Integer

Specify the maximum number of entries that Exact Online on-premise instance must return in the output.

Default Value: N/A
Example: 10

Integer

Specify the record index starting from which the Exact Online on-premise instance must return records in the output. Use this property along with the Output entry limit to retrieve a specific set of entries in the output.

Default Value: N/A
Example: 10

Checkbox

Select this checkbox to return the records of all the pages retrieved in the API response. By default, the Exact Online API returns a maximum of 60 records per page. But for the bulk endpoint, a maximum of 1000 records can be returned per page.  If you select this checkbox, all matching records are automatically returned.

Default Value: Selected

Checkbox

Select this checkbox to return the total number of records retrieved in the API response. The count number will be added to each document record with a property name of "__count".

Default Value: Deselected

Checkbox

Select this checkbox to allow empty results on the output views. If you deselect this checkbox, an error is thrown when the output has no records.

Default Value: Selected

Connection details

Use this field set to specify the connectivity parameters: timeout, retry count, and retry interval. This field set contains the following fields:

• Connection timeout

• Maximum request attempts

• Retry Interval

Integer

Enter, in seconds, the duration for which Snap must try to establish a connection with the Exact Online instance. If the connection cannot be established within this duration, the Snap times out, writes the event to the log, and waits until the specified RetryInterval before attempting to reconnect.

Default Value: 300
Example: 120

Integer

Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

Default Value: 3
Example: 5

Integer

Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts until the number of retries is reached.

Default Value: 1
Example: 10

Snap Execution

String

Select one of the three modes in which the Snap executes. Available options are:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.

Default Value: Validate & Execute
Example: Execute Only

API object is not existing.

The API object is not found for the Exact Online API.

Search and select an API object from the dropdown list.

The endpoint is not existing.

The Endpoint that you have entered is not found for the selected API object in the server.

Search and select the Endpoint from the dropdown list.

Output entry limit: 50

• Retrieves the first 50 API responses from the server (if more than 50 records are present in the API response).

• Retrieves all the available API response records from the server (if 50 or fewer records are present in the API response).

Output entry offset: 50

• Retrieves API responses starting from index 51 from the server (if more than 50 records are present in the API response).

• Returns empty result (if 50 or fewer records are present in the the API response).

Output entry offset: 50, and  Output entry limit: 50

• Skips the first 50 records and collects the 51 - 100 records in the API response from the server.