Use a D365 F&SCM document to read data from or write data to D365 F&SCM.


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Documents tab.
3. Click New.
4. Define a meaningful name for the document.
Example: If the document is used for a sales integration, you can use names like 'Sales - Order' or 'Sales - Invoice'.
  In the Document field, type a value.
 

Note: Best practice: In the document name, do not use the:
- Application: Use the Application field to define the applicable application.
- Document type: Use the Document type field to define the applicable document type.

5. In the Project field, enter or select a value.
6. Define the applicable application for the document. For a D365 F&SCM document, for example, select a 'D365 F&SCM' 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.

7. In the Document types field, select '0'.
8. Sub-task: Set properties.
  8.1 Expand the Properties section.
  8.2 To improve performance when processing a lot of records, you can use paging. For paging, the records are split over several threads which run these records in parallel batch tasks.
Define the number of records to be processed by one batch task.
  In the Query page size field, enter a number.
 

Note: You can use this calculation to define the number to be entered: Query page size = Total number of records / Number of available threads.

  8.3 On export, if you start the message run manually, you can have the standard D365 F&SCM query page shown before the message is run. You can use this query page to define more-detailed ranges.
  Select Yes in the Prompt field.
 

Note: If the message is run in batch, the standard D365 F&SCM query page is not shown and an error is logged.

  8.4 On import to D365 F&SCM, time validations can be applicable.
By default, the time validation is applied. Which means, this field is set to No. As a result, each import of an instance to which time validation applies, results in a new instance.
If this field is set to Yes, no time validation is applied, and the existing instance is updated.
For example, on import of addresses, the effective period is validated.
  Select Yes in the Disable time validation field.
9. Sub-task: Set (custom) handler.
  9.1 Expand the Custom section.
  9.2 For a D365 F&SCM document, several standard handler classes are available.
You can use a customized handler class. To do so, extend a standard handler class.
  In the Handler field, enter or select the desired handler class.
10. Sub-task: Set advanced features.
  10.1 Expand the Advanced section.
  10.2

Select the desired query type:

  • Standard: To select the data, only one D365 F&SCM query is created for the document.
  • Custom: To select the data, a separate query is created for each document record.

The Custom query feature offers an alternative approach to data retrieval. Unlike the standard query, with the Custom query, you can:

  • Join data across different companies.
  • Control queries more precisely with the Group by function.
  • Limit the selection to the first record only for complex queries.
  • Use fields from ancestor records in record relations.
  In the Query type field, select an option.
 

Note: Try to use the standard query unless the standard query does not give the desired results. So, only use the custom query if required to get a specific query result.

11. Close the page.
Related to Notes

Set up D365 F&SCM document

 

See also

Provide feedback