Exact Online Update

In this article

Overview

You can use this Snap to update a data object in the Exact Online instance.

Exact Online Update_Overview.png

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

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Parser

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

Output

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Formatter

Each document contains the response of the update operation.

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.

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

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
Example: Exact Online Update

Version*

String

Specify the version of the Exact Online API.

Default Value: v1
Example: v1

Division*

String/Expression/Suggestion

Specify an unique ID of the Exact Online Division. The Exact Online REST API resource URIs require a Division parameter. This parameter identifies the division that is accessed. The specific division can be found by calling /api/v1/current/Me. For example: /api/v1/current/Me?$select=CurrentDivision

Default Value: N/A
Example: 1234567

API object*

String/Expression/Suggestion

Select the API that you want to access in the Exact Online instance. This drop-down list contains supported services available for the Exact Online instance.

Default Value: N/A
Example: CRM

Endpoint*

String/Expression/Suggestion

Select an Exact Online Endpoints to be specified and connected for each of the API objects.

Default Value: N/A
Example: Accounts

ID

String/Expression/Suggestion

Specify a unique Exact Online identifier (GUID) of the record to be updated.

Default Value: N/A
Example: a8ecb3d6-6632-11eb-ae93-0242ac130002

Connection details

Use this section of Snap Settings to specify the connectivity parameters: timeout, retry count and retry interval.  This field set comprises the following fields:

  • Connection timeout

  • Maximum request attempts

  • Retry Interval

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
Example: 120

Maximum request attempts*

Integer

Specify the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

Default Value: 0
Example: 5

Retry Interval*

Integer

Specify the duration for which the Snap must wait between two reconnection attempts until the number of retries is reached.

Default Value: 0
Example:10

Snap Execution

Dropdown list

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: Execute only
Example: Validate & Execute 

Troubleshooting

Error

Reason

Resolution

API object is not existing.

The entered 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 entered Endpoint is not found for the selected API object in the server.

Search and select the Endpoint from the dropdown list.

Additional Information

Here is some information to assist you while using the Exact Online Update Snap.

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

Example

Updating account details from Exact Online Instance CRM service

This Pipeline example demonstrates how to update account details in the Exact Online instance CRM service. This example assumes that you have configured and authorized a valid Exact Online Account. See Configuring Exact Online Account.