Set up a connector of type Web service. Use this type to exchange data via a web service using a stream.

If you:

  • Import data, the web service adds its data to a stream. From this stream, the data is imported into D365 FO.
  • Export data, the data is exported from D365 FO and added to a stream. The web service takes the data from this stream and processes it.

The related document defines which data is added to or taken from a stream and in which format and structure. So, the document does not result in a file.

With the Web service type connector, you can use these external file-based documents: EDI, Fixed text, Text, XML, JSON. You can only use this connector in combination with a document for which the version 3 (V3) handler class is selected.

 


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Connectors tab.
3. Click New.
4. In the Connector field, type a value.
 

Note: You are advised to not include, in the connector name, the name of the application to which you connect. Use the Application field to define the applicable application for the connector.

5. In the Project field, enter or select a value.
6. Define the applicable application for the connector. For a web service connector, for example, select a 'Web service' application.
  In the Application field, enter or select a value.
 

Note:
- You can only select an application that is defined for the applicable project. You can define project applications on the Projects page.
- You can type any existing application name, whether it is defined as project application or not. If the typed application is not defined as project application, it is automatically added to the project applications.

7. In the Connector type field, select 'Web service'.
8. Sub-task: Select custom handler.
  8.1 Expand the Custom section.
  8.2 For a Web service type connector, the standard handler class is BisConnectorStreamWebservice. This handler class imports data from a stream or exports data to a stream. You can use a customized handler class. To do so, extend the standard handler class.
  In the Handler field, you can enter or select a custom handler class.
9. Sub-task: Set advanced options.
  9.1 A document can have a query for which cross-company is enabled. If a user, with access to a restricted set of companies, runs a message that uses the document, the cross-company option does not work. If you have this scenario, make sure the cross-company option is enabled for the used connector. Otherwise, you can disable the cross-company option.
  Expand the Advanced options section.
  9.2 Select Yes in the Cross company disabled field.
10. Close the page.

Notes

  • You can test the connection. To do so, on the Connectors page, in the Action Pane, on the Development tab, click Test connection.
  • If you use a Web service connector as source or target connector on a message, make sure the related source or target document uses the 'V3' handler version.
  • The environment type does not apply to a Web service connector.

See also

Provide feedback