Troubleshooting documents

When a message does not run successfully, you can troubleshoot the related source document and target document.

When a document is used in a message run, based on the document setup, a query is created that reads the data.

You have several options to troubleshoot a document. You can, for example:

Validate the document setup.
Test a document.

Common issues on the document are:

No files are read from the Work folder: Check the read settings on the document header.
Missing data in export: Verify the setting of these fields on the record setup: 'Join mode' and 'Combine with parent record'. For more information, refer to this blog.
No records are processed: Verify the range as set up for document records.

Activities

Name

Responsible

Description

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.

Test document

Application Consultant

If you run into an issue with a message, you can separately test the source and target documents.

The document type defines what is tested:

External document - File based: Reads the data from a defined file and tests the document query.
External document - ODBC: Reads the data from an external database and tests the document query.
Internal document: Tests the document query.

As a result:

The records that are read from the file or from the external database, are shown on the Imported records page.
When you test a document, based on the document setup, a query is created that reads the data. The result of the query test is shown in the message bar. If the 'No data found' message is shown, the document is not set up properly. In the message bar, you can click 'Message details' to see more detailed information.

Note: Before you test an external document, make sure, the document process type is set to 'Query'. After testing the document, if the original process type was 'Direct', do not forget to change the process type back to 'Direct'.

Activities

Name

Responsible

Description

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.

Test document

Application Consultant

If you run into an issue with a message, you can separately test the source and target documents.

The document type defines what is tested:

External document - File based: Reads the data from a defined file and tests the document query.
External document - ODBC: Reads the data from an external database and tests the document query.
Internal document: Tests the document query.

As a result:

The records that are read from the file or from the external database, are shown on the Imported records page.
When you test a document, based on the document setup, a query is created that reads the data. The result of the query test is shown in the message bar. If the 'No data found' message is shown, the document is not set up properly. In the message bar, you can click 'Message details' to see more detailed information.