In this article
Overview
The Exact Online Create Snap is a Write-type Snap that allows you to create data objects in the Exact Online instance.
Prerequisites
A valid OAuth 2.0 account that supports Exact Online instance, with the appropriate access permissions. See Exact Online OAuth 2.0 Account.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
None
Snap Views
View Type | View Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
Input | Document |
|
| Each input document contains data that must be created and written into the Exact Online instance. |
Output | Document |
|
| Each document contains the response to the creation of new records in the Exact Online instance. |
Error | Document |
| N/A | The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline. |
Snap Settings
Field Name | Field Type | Description |
|---|---|---|
Label* | String | Specify the 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 |
Version* | String | Specify the version of the Exact Online API. Default Value: v1 |
Division* | String/Expression/Suggestion | Specify the unique ID of the Exact Online Division (can be retrieved with a REST call https://start.exactonline.nl/api/v1/current/Me?). Default Value: N/A |
API object* | String/Expression/Suggestion | Choose the API that you want to access in the Exact Online instance. This dropdown list contains supported services available for the Exact Online instance. Default Value: N/A |
Endpoint* | String/Expression/Suggestion | Select an Exact Online Endpoints to be specified and connected for each of the API objects. Default Value: N/A |
Connection details | Use this field set to configure the connection parameters. This field set contains the following fields:
| |
Connection timeout* | 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 Retry Interval before attempting to reconnect. Default Value: 300 |
Maximum request attempts* | 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 |
Retry Interval* | 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 |
Snap Execution | Dropdown list | Indicates how the Snap must be executed. Available options are:
Default Value: Execute only |
Troubleshooting
Error | Reason | Resolution |
API object is not existing. | The entered API object is not found for the Exact Online API. | Please search and select an API object from the dropdown list. |
The endpoint is not existing. | The entered Endpoint is not found for the selected API object in the server. | Please search and select the Endpoint from the dropdown list. |
Additional Information
Here is some information to assist you while using the Exact online Create Snap.
Snap General Behavior
The Exact online Create Snap supports the following:
POST operation to create new data in the Exact online instance.
Display of only the create-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 POST queries (create operations).
And then, select an entity to view and specify values for only create-compatible parameters related to this entity, in the input schema.
Input schema
The input schema for Exact Online Create Snap:
Use the Payload schema for the Exact Online Create 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 |
Examples
Creating New Accounts in Exact Online Instance CRM Service
This Pipeline example demonstrates how to create a new Account in the Exact Online instance CRM Service. This example assumes you have a valid Exact Online Account. See Configuring Exact Online Accounts.
We configure the Exact Online Create Snap with the following settings to add customer material data from the Exact Online instance CRM Service it accesses.
API object: CRM
Endpoint: Account
After successfully validating the Pipeline, the Snap displays the query results in the output preview as follows.
Subsequently, we connect the JSON Formatter Snap to the upstream Snap to read and format the output data into standard JSON format.
Next, we connect the File Writer Snap to the JSON Formatter Snap to write the JSON data into a file.
To view the output JSON file, you must SSH to the target directory and open the newly-created JSON file. The preview of the output JSON file can be seen as shown below.
Downloads
Important Steps to Successfully Reuse Pipelines
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
