Exact Online Update

Overview

The Exact Online Update Snap updates a data object in the Exact Online instance.



Supported Accounts

Prerequisites

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one document input view.

Each input document contains data that must be updated and written into the Exact Online instance for the selected entity.
Output

This Snap has at most one document output view.

Each document contains the response of the update operation.
Learn more about Error handling.

Examples

  1. Updating account details from Exact Online Instance CRM service.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Exact Online Update
Version

String

Required. Specify the version of the Exact Online API.

Default value: v1

Example: v1
Division

String/Expression/ Suggestion

Required. Specify the unique ID of the Exact Online Division. You can retrieve this ID using a REST call to https://start.exactonline.nl/api/v1/current/Me. For example: /api/v1/current/Me?$select=CurrentDivision. 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

Required. 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

Required. Specify an Exact Online Endpoint to be connected for each of the API objects. Alternatively, click the Suggestion icon to fetch the list of endpoints and select one.

Default value: N/A

Example: Accounts
ID

String/Expression/ Suggestion

Optional. Specify a unique Exact Online identifier (GUID) of the record to be updated. If not specified, the Snap reads the ID from the input document.

Default value: N/A

Example: a8ecb3d6-6632-11eb-ae93-0242ac130002
Connection details

Use this field set to specify the connectivity parameters: timeout, retry count, and retry interval.
Connection timeout

Integer

Required. Enter, in seconds, the duration for which the 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 Retry Interval before attempting to reconnect.

Default value: 300

Example: 120
Maximum request attempts

Integer

Required. 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
Retry Interval

Integer

Required. 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

Dropdown list
Choose 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

Troubleshooting

Error Reason Resolution
API object does not exist.

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

Search and select an API object from the dropdown list.
The endpoint does not exist.

The specified Endpoint is not found for the selected API object in the server.

Search and select the Endpoint from the dropdown list.

Additional information

Snap General Behavior

The Exact Online Update Snap supports the following:

  • PUT operation to update data in the Exact Online instance.
  • Displays only the update-compatible input parameter set from the upstream input Snap.
  • Dynamic loading of API metadata with a Parent-child dependency structure. This means that you can:
    • Select an API object from the API Object field to view only entities that are related to the API object and support PUT queries (update operations).
    • And then, select an entity to view and specify values for only update-compatible parameters for input schema.

Input schema

The input schema for Exact Online Update Snap:

Use the Payload schema for Exact Online Update Snap to define the input payload for an API call. This dynamically loads and represents all the parameters that you need for creating the data object (payload).

  • If the upstream Snap can display the entire input schema like Mapper Snap, always select the Payload object in the schema to define your input payload in that Snap.
  • If your input payload is a JSON object, ensure that the text Payload is included as the key in the parent of your input.

Schema settings

Parameter Name Data Type Description Default Value Example
Payload Object Specify the input data parameters for the selected entities. N/A N/A