Set up data synchronization for outbound web service action

On export of data with an outbound web service action, the data synchronization setup defines which records are processed.
Data synchronization only applies to the request message of the outbound web service action.

Note: The request message also can have data synchronization set up. This setup is overruled by the outbound web service data synchronization setup.

You can use these types of data synchronization:

Type	Description
All	This is the standard data synchronization. All records that are found, based on the source document setup, are exported. No data synchronization setup is required for this.
Table events	You can use table events to log data changes. You can define, for each record, which table events are logged. The table events are logged in the Data synchronization log. From here, the logged entries must be processed further to the Outbound message queue. Process the outbound message queue to run the messages to export the records.
Date range	You can use a date range to export only the records that are changed or added since the latest outbound web service action run.

Activities

Name

Responsible

Description

Set up data synchronization - Table events - Outbound web service action

Application Consultant

For outbound web service actions, you can use the data synchronization setup to define which records are processed.

Web service data synchronization only applies to outbound web service actions for which data synchronization is set up. If no data synchronization is set up, the web service action must be run in another way.
This topic explains how to use table events to track data changes. You can define, for each record, which table events are logged. The table events are logged in the Data synchronization log. From here, the logged entries must be processed further to the Outbound message queue. Process the outbound message queue to run the web service actions to export the records.

Set up data synchronization - Date range - Web service

Application Consultant

For outbound web service actions, you can use the data synchronization setup to define which records are processed.

Web service data synchronization only applies to outbound web service actions for which data synchronization is set up. If no data synchronization is set up, the web service action must be run in another way.
This topic explains how to use a date range to export only the records that are changed or added since the latest web service action run.
Make sure, the root record of the source document of the request message has a date/time field that indicates when the record is last changed, for example a 'modifiedDateTime' field. If you run the outbound web service action, all records that are found, based on the source document setup, are considered. For each found root record, the date/time is compared with the Latest run date/time of the outbound web service action. Only the records are exported with a date/time that is later than the latest run date/time of the outbound web service action.

Validate connectivity setup

Application Consultant

If you open a form or save (changes to) the setup of a key element in Connectivity studio, the setup is validated automatically. If errors are found in the setup, an error icon is shown. You can click the icon to show the related error messages.

You can also manually start an automated test to check for errors in the setup. As a result, the found errors are shown. Also, the error icons are shown where applicable.

When errors are found, you can try to fix these errors automatically.

You can check and auto-fix errors for these key elements in Connectivity studio:

Key element	Check
Projects	When automatically checked, only the project setup is checked, and not the related setup like messages and connectors. When started manually, the full project setup is checked.
Documents	The document setup is checked, including the document records setup.
Document records	Only the document records setup is checked.
Messages	The message setup is checked, including the data synchronization setup and message mapping.
Message - Data synchronization setup	Only the data synchronization setup is checked.
Message mapping	Only the message mapping is checked.
Message business events	A check is done if a business event is created for the message business event. Also, a check is done if the target fields and source fields match with the related document setup.
Connectors	Only the connector setup is checked.
Web services	The web service setup is checked, including the data synchronization setup.
Web service - Data synchronization setup	Only the data synchronization setup is checked.

In this flow, in the activity steps, as an example, the validation is done for documents.

Activities

Name

Responsible

Description

Set up data synchronization - Table events - Outbound web service action

Application Consultant

For outbound web service actions, you can use the data synchronization setup to define which records are processed.

Web service data synchronization only applies to outbound web service actions for which data synchronization is set up. If no data synchronization is set up, the web service action must be run in another way.
This topic explains how to use table events to track data changes. You can define, for each record, which table events are logged. The table events are logged in the Data synchronization log. From here, the logged entries must be processed further to the Outbound message queue. Process the outbound message queue to run the web service actions to export the records.

Set up data synchronization - Date range - Web service

Application Consultant

For outbound web service actions, you can use the data synchronization setup to define which records are processed.

Web service data synchronization only applies to outbound web service actions for which data synchronization is set up. If no data synchronization is set up, the web service action must be run in another way.
This topic explains how to use a date range to export only the records that are changed or added since the latest web service action run.
Make sure, the root record of the source document of the request message has a date/time field that indicates when the record is last changed, for example a 'modifiedDateTime' field. If you run the outbound web service action, all records that are found, based on the source document setup, are considered. For each found root record, the date/time is compared with the Latest run date/time of the outbound web service action. Only the records are exported with a date/time that is later than the latest run date/time of the outbound web service action.

Validate connectivity setup

Application Consultant

You can also manually start an automated test to check for errors in the setup. As a result, the found errors are shown. Also, the error icons are shown where applicable.

When errors are found, you can try to fix these errors automatically.

You can check and auto-fix errors for these key elements in Connectivity studio:

Key element	Check
Projects	When automatically checked, only the project setup is checked, and not the related setup like messages and connectors. When started manually, the full project setup is checked.
Documents	The document setup is checked, including the document records setup.
Document records	Only the document records setup is checked.
Messages	The message setup is checked, including the data synchronization setup and message mapping.
Message - Data synchronization setup	Only the data synchronization setup is checked.
Message mapping	Only the message mapping is checked.
Message business events	A check is done if a business event is created for the message business event. Also, a check is done if the target fields and source fields match with the related document setup.
Connectors	Only the connector setup is checked.
Web services	The web service setup is checked, including the data synchronization setup.
Web service - Data synchronization setup	Only the data synchronization setup is checked.

In this flow, in the activity steps, as an example, the validation is done for documents.