1. To-Increase Dynamics 365 for Finance & Operations
  2. Connectivity studio
  3. Design
  4. Set up documents
  5. Set up external documents - File based

Validate connectivity setup

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.


Application Consultant Application Consultant Start Start Check setup Check setup If you have finished the setup, you can run a test to check for errors in the setup. You can do so for:   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.     If an error is found, in the message bar, a message is shown indicating the error.   If for an entity, an error exists or the setup is incomplete, an error icon   is shown. You can click the icon to show the related error in the message bar.    In this activity, as an example, the steps explain how to check a document. Where applicable, notes are added to explain how to check the other types.   Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. Note: To check a: Project, click Projects. (Opens your current project.) Message, message mapping, or data synchronization setup, stay on the Messages tab. Document record, click the Documents tab. Connector, click the Connectors tab. 3. In the list, find and select the desired record. Note: This step is not applicable for projects. 4. Click Edit. Note: This step is not applicable for projects. 5. On the ActionPane, on the Deploy tab, in the Configuration group, click Check. Note: To check a: Project, message, or connector, on the ActionPane, on the Deploy tab, in the Configuration group, click Check. Document record, in the Record section, select a record, and click Check. Message - Data synchronization setup, on the Header view, on the Setup for data sync tab, select a record and click Check. Message mapping, on the Lines view, in the Mapping section, select a mapping, and click Check. Notes You can re-run the automated error check if you have run the Auto-fix function. This to check if there are still errors in the setup that are not fixed automatically. Error found? Error found? Auto fix errors Auto fix errors If errors are found by the automated error check, you can first try to have these errors fixed automatically. For example, an error that can be fixed automatically: The field length of an internal document record field does not match the field length in the related table. In this case, the document record field length is changed to the table field length.You can auto-fix errors for: ProjectsDocumentsDocument recordsMessagesMessage - Data synchronization setupMessage mappingConnectorsWeb servicesWeb service - Data synchronization setupIn this activity, as an example, the steps explain how to auto-fix a document. Where applicable, notes are added to explain how to auto-fix the other types. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. Note: To automatically fix a: Project, click Projects. (Opens your current project.) Message, message mapping, or data synchronization setup, stay on the Messages tab. Document record, click the Documents tab. Connector, click the Connectors tab. 3. In the list, find and select the desired record. Note: This step is not applicable for projects. 4. Click Edit. Note: This step is not applicable for projects. 5. Click Auto fix. Note: To automatically fix a: Project, message, or connector, on the ActionPane, on the Deploy tab, in the Configuration group, click Auto fix. Document record, in the Record section, select a record, and click Auto fix. Message - Data synchronization setup, on the Header view, on the Setup for data sync tab, select a record and click Auto fix. Message mapping, in the Mapping section, select a mapping, and click Auto fix. 6. Close the page. Still errors found? Still errors found? Check setup Check setup If you have finished the setup, you can run a test to check for errors in the setup. You can do so for:   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.     If an error is found, in the message bar, a message is shown indicating the error.   If for an entity, an error exists or the setup is incomplete, an error icon   is shown. You can click the icon to show the related error in the message bar.    In this activity, as an example, the steps explain how to check a document. Where applicable, notes are added to explain how to check the other types.   Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. Note: To check a: Project, click Projects. (Opens your current project.) Message, message mapping, or data synchronization setup, stay on the Messages tab. Document record, click the Documents tab. Connector, click the Connectors tab. 3. In the list, find and select the desired record. Note: This step is not applicable for projects. 4. Click Edit. Note: This step is not applicable for projects. 5. On the ActionPane, on the Deploy tab, in the Configuration group, click Check. Note: To check a: Project, message, or connector, on the ActionPane, on the Deploy tab, in the Configuration group, click Check. Document record, in the Record section, select a record, and click Check. Message - Data synchronization setup, on the Header view, on the Setup for data sync tab, select a record and click Check. Message mapping, on the Lines view, in the Mapping section, select a mapping, and click Check. Notes You can re-run the automated error check if you have run the Auto-fix function. This to check if there are still errors in the setup that are not fixed automatically. Manually fix errors Manually fix errors If you have re-run the automated error check, and still errors exist in the setup that are not fixed automatically, manually fix these errors. End End Yes No Yes No

Activities

Name Responsible Description

Check setup

Application Consultant

If you have finished the setup, you can run a test to check for errors in the setup. You can do so for:

 

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.

 

 

If an error is found, in the message bar, a message is shown indicating the error.

 

If for an entity, an error exists or the setup is incomplete, an error icon   is shown. You can click the icon to show the related error in the message bar. 

 

In this activity, as an example, the steps explain how to check a document. Where applicable, notes are added to explain how to check the other types.

 

Auto fix errors

Application Consultant

 		If errors are found by the automated error check, you can first try to have these errors fixed automatically. For example, an error that can be fixed automatically: The field length of an internal document record field does not match the field length in the related table. In this case, the document record field length is changed to the table field length.
You can auto-fix errors for:
  • Projects
  • Documents
  • Document records
  • Messages
  • Message - Data synchronization setup
  • Message mapping
  • Connectors
  • Web services
  • Web service - Data synchronization setup
In this activity, as an example, the steps explain how to auto-fix a document. Where applicable, notes are added to explain how to auto-fix the other types.

Check setup

Application Consultant

If you have finished the setup, you can run a test to check for errors in the setup. You can do so for:

 

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.

 

 

If an error is found, in the message bar, a message is shown indicating the error.

 

If for an entity, an error exists or the setup is incomplete, an error icon   is shown. You can click the icon to show the related error in the message bar. 

 

In this activity, as an example, the steps explain how to check a document. Where applicable, notes are added to explain how to check the other types.

 

Manually fix errors

Application Consultant

 		If you have re-run the automated error check, and still errors exist in the setup that are not fixed automatically, manually fix these errors.

Provide feedback