1. Data Management
  2. Connectivity Studio
  3. Design
  4. Testing and troubleshooting
  5. Troubleshooting

Troubleshooting web services

When a web service action doesn't run successfully, you can troubleshoot the web service action.

You have several options to troubleshoot a web service action. You can, for example:

  • Validate the web service action setup.
  • Test an outbound web service action.
  • Test an inbound web service action.


Application Consultant Application Consultant Start Start Validate web service action setup

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.

 Test outbound web service action Test outbound web service action You can test an outbound web service action without sending a request to the external web service. So, you only test the outbound web service action setup and not the full process with connection to the external web service. When testing, the outbound web service action does run the request message and response message. So, data can be impacted. Therefore, you are advised to only test an outbound web service action in a Development or Test environment. For the result of an outbound web service action test, view the message history of the related request message and response message. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Web service tab. 3. In the list, click the link of the desired outbound web service action 4. On the Action Pane, click Development. 5. Click Test. 6. In the StatusCode field, enter a number. 7. Indicate whether you want to use the request data or the mockup response data as test response data. In the Use request as response field, select the desired option. Note: If you select No, make sure to enter the test response data in the Response section, in the Mockup response field. 8. In the Table name field, enter or select a value. 9. You can test using a specific record. To do so, you need the RecId of the desired record. In the Record-ID field, enter a number. Note: If you do not define a specific record, you are advised to fill in the Test quantity field. 10. Select Yes in the Delta run field. 11. In the Test quantity field, enter a number. 12. In the Mockup response field, type a value. 13. Click Run. 14. Close the page. Test inbound web service action Test inbound web service action You can test an inbound web service action without receiving an HTTP request from the external application. So, you only test the inbound web service action setup and not the full process with connection to the external application. When testing, the inbound web service action does run the request message and response message. So, data can be impacted. Therefore, you are advised to only test an inbound web service action in a Development or Test environment. For the result of an inbound web service action test, view the Result section on the test page. You can also view the message history of the related request message and response message. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Web service tab. 3. In the list, click the link of the desired inbound web service action. 4. On the Action Pane, click Development. 5. Click Test. 6. In the Web service users field, enter or select a value. 7. In the Resource field, type a value. 8. In the Data field, type a value. 9. Click Run. 10. Expand the Result section. 11. Close the page. Monitor web service action history Monitor web service action history When a web service action is run, you can view the web service history. The web service history shows, for example, the:Status of the web service action run.Related web service requests.Related message runs.Possible issues can occur, for example, in the:Message run.Connection with the web service. Procedure 1. Click Connectivity studio Integration operations. 2. Review the web service action runs for which errors occurred. Click the Webservice errors tab. Note: You can also click the Web service tab, which shows all web service action runs. 3. In the list, find and select the desired web service action run. 4. Click Web service history. 5. You can view history that is related to the web service action run history. The Web requests tab shows all web requests that are sent during the web service action run. Expand the Details section. Note: You can view detailed information about a web request: - If a web request has an error, select it, and, on the Error tab review the details of the reported error. - For outbound web service actions, you can view the web request header in JSON format. Authorization information is excluded from the header. - For inbound and outbound web service actions, you can view the transferred data in the format as defined by the applicable message. 6. The Message history tab shows all messages that are run for the web service action run. Click the Message history tab. Note: If a message has an error, review the details of the message run. To do so, on the Action pane, on the History tab, click Message history. 7. Close the page. End End

Activities

Name Responsible Description

Validate web service action 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 outbound web service action

Application Consultant

You can test an outbound web service action without sending a request to the external web service. So, you only test the outbound web service action setup and not the full process with connection to the external web service.

When testing, the outbound web service action does run the request message and response message. So, data can be impacted. Therefore, you are advised to only test an outbound web service action in a Development or Test environment.

For the result of an outbound web service action test, view the message history of the related request message and response message.

Test inbound web service action

Application Consultant

You can test an inbound web service action without receiving an HTTP request from the external application. So, you only test the inbound web service action setup and not the full process with connection to the external application.

When testing, the inbound web service action does run the request message and response message. So, data can be impacted. Therefore, you are advised to only test an inbound web service action in a Development or Test environment.

For the result of an inbound web service action test, view the Result section on the test page. You can also view the message history of the related request message and response message.

Monitor web service action history

Application Consultant

 		When a web service action is run, you can view the web service history. The web service history shows, for example, the:
  • Status of the web service action run.
  • Related web service requests.
  • Related message runs.
Possible issues can occur, for example, in the:
  • Message run.
  • Connection with the web service.

Provide feedback