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

Set up D365 FO document

Use a D365 FO document to read data from or write data to D365 FO.


Application Consultant Application Consultant Start Start Set up document - D365 FO Set up document - D365 FO Use a D365 FO document to read data from or write data to D365 FO. 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 FO document, for example, select a 'D365 FO' 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 'D365 FO'. 8. Sub-task: Set properties. 9. Expand the Properties section. 10. 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. 11. On export, if you start the message run manually, you can have the standard D365 FO 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 FO query page is not shown and an error is logged. 12. Select Yes in the Disable time validation field. 13. Sub-task: Set (custom) handler. 14. Expand the Custom section. 15. For a D365 FO 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. Note: For a list and description of the standard D365 FO handler classes, refer to the Notes section of this topic. 16. Close the page. Notes For a D365 FO document, several standard handler classes are available: Handler class Description BisDocumentAxDatabase This handler class reads data from or writes data to D365 FO. BisDocumentAxDatabase_CompanyHeader If you use EDI, you can also use this handler class. This handler class imports data into D365 FO. On import, it switches to the company as defined in the EDI history and imports the data into that company. BisDocumentHistoryAxDatabase This handler class runs the message from the message history. It is automatically applied if you manually run a message from the message history. So, do not select it for a document. BisDocumentAxDB_SalesOrderPostInvoice This handler class creates sales orders and automatically reserves the sales quantities. If the quantities are reserved for a sales order, the sales order invoices are created and posted automatically. If the quantities cannot be reserved, the created sales order is deleted. BisDocumentAxDB_InventCounting This EDI-specific handler class creates inventory counting journals. BisDocumentAxPurchaseOrderAutoConfirm This EDI-specific handler class imports purchase order confirmations and automatically confirms the purchase orders. You can only use this handler class to import a purchase order confirmation from the BisEdiPurchaseJour staging table. BisDocumentAxDatabase_DataEntryWorkflow This handler class is specific for the Connectivity studio integration with Data entry workflow. Only use this handler class on a target document of a data import message. This handler class starts a data entry workflow. The imported data is imported in the data entry workflow staging table. The data entry workflow tasks are based on the imported data. You can, for example, use this to start a data entry workflow to complete and review the imported data before it is imported in the relevant D365 FO tables. If you select this handler class on the D365 FO document, a Data entry workflow section is added to the document header. Here you can select the desired data entry workflow template that is used to start the data entry workflow. BisDocumentLoyaltyCardPointAdj This handler class imports loyalty card reward point adjustments. Each adjustment is logged with a unique sequence number. BisDocumentPickingListRegistration This handler class imports and creates picking lists. When a picking list is created, the related picking route is updated. BisDocumentPickingListRegistrationCancelUnpicked This handler class imports and creates picking lists. When a picking list is created, the related picking route is updated. If, at least, one line is picked, all non picked (activated) lines are set to cancelled and the picklist is finished. BisDocumentPickingListRegistrationPostAll This handler class imports and creates picking lists. When a picking list is created, the related picking route is updated. Also the packing slip and the invoice of the linked sales order are posted. BisDocumentPickingListRegistrationPostAllCancelUnpicked This handler class imports and creates warehouse orders. When a warehouse order is created, the related picking routes is updated. Also, the packing slip and the invoice of the linked sales order are posted. BisDocumentPickingListRegistrationPostPackingSlip This handler class imports and creates the picking list, updates the route, and posts the packing slip.      BisDocumentAxDB_TransferOrderWave This handler class creates transfer orders. If a created transfer order is validated, it is automatically released. BisDocumentAxDB_CustVendTransOpen This handler class exports open customer transactions or vendor transactions, depending on document record setup. BisMdmDocumentAxDatabase This handler class exports data from D365 FO for Master data management (MDM). BisDocumentWsHistoryAxDatabase This handler class uses the web service request data to process the web service response, if no response data is received from the web service. Only use this handler class when you process one record at once. BisDocumentWsHistoryAxDatabaseV2 This handler class uses the web service request data to process the web service response, if no response data is received from the web service. You can use this handler class when you process several record at once. BisDocumentAxDatabase_DataEntryWorkflow This handler class starts a data entry workflow. Only use this handler class on a target document on a data import message. The imported data is imported in the data entry workflow staging table. The data entry workflow tasks are based on the imported data. BisEdiDocumentAxChangeCompany This handler class runs an EDI message to move data from the staging journal to D365 FO in the company/legal entity as defined in the BisEdiHistory table.   You can also select several other standard handler classes. These other handler classes also extend the BisDocumentAxDatabase class. However, these are related to the journal and staging document types that have specific properties related to these handler classes. Therefore, selecting these other handler classes for the D365 FO document type does not give an optimal result. Add document records - Internal documents Add document records - Internal documents To each document, add the data records to be exchanged. For internal documents, set up the records in line with how the data is structured and named in D365 FO.This topic explains how to add records to documents of these types: D365 FO, Journal, or Staging. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. 3. In the list, find and select the desired document of one of these types: D365 FO, a journal type, or Staging. 4. Click Edit. 5. In the Record section, click Add line. 6. In the Record field, type a value. 7. In the Record table field, enter or select a value. 8. In the Parent record field, enter or select a value. 9. Select Yes in the Combine with parent record field. 10. In the Join mode field, select an option. 11. Select Yes in the History field. Manage document record setup - Internal documents

Manage document record setup - Internal documents

You have several options to manage the document record setup for internal documents.

You can:
  • Change the sequence of the records.
  • View the D365 FO table relations.
  • View where a record is used.
  • Check or change the table relations.
  • Define the data querying order.
  • Define the range of data to be queried.
  • Validate the record setup.

 Select fields Select fields You can add a selection of table fields to a record. You can select fields from the D365 FO table that is defined in the Record table field.This is mainly applicable to internal documents. However, you can also use this to quickly set up fields for external file-based documents.When the field selection is added to the record, review and complete the properties of the added fields. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. 3. In the list, find and select the desired document. 4. Click Edit. 5. In the Records section, in the Record list, find and select the desired record. 6. Click Select fields. 7. Sub-task: Define filter. 8. In the Table name field, enter or select a value. 9. Select Yes in the Show system fields field. 10. Select No in the Show inherited fields field. 11. Usually, you add fields to an internal document record with the type as defined in the table setup. However, you can add all selected fields with the type set to String. Select Yes in the Create as string fields field. Note: This field is only available for internal documents. 12. Sub-task: Select fields. 13. Click Select the fields of a specific group to open the drop dialog. 14. In the Field group name field, enter or select a value. 15. Click OK. 16. Click Select all. 17. Click Deselect all fields. 18. Click Select mandatory. 19. Select the Selected check box for the desired fields. 20. Click OK. Copy fields Copy fields You can copy fields from a record of another document. You can use this, for example, to save setup time if you use a specific record in several documents.You can only copy fields:From a record with the Record table defined.To a record with no fields.As a result, the full field setup is copied from the selected record to the current record. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. 3. In the list, find and select the desired document. 4. Click Edit. 5. In the Record section, in the Record list, find and select the desired record. 6. Click Copy fields. 7. In the Record field, select the desired record from another document. Note: You can only select a record with the same Record table defined as the current record. 8. Click OK. 9. Close the page. Add document record fields - Internal documents Add document record fields - Internal documents To each document record, add the data fields which values must be exchanged. For internal documents, set up the fields in line with naming in D365 FO.For internal documents, make sure the fields have the same type as in D365 FO.This topic explains how to add records to documents of these types: D365 FO, Journal, or Staging.If fields are already selected for or copied to the record, you can review and complete the setup for these fields. To do so, skip step 6. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Documents tab. 3. In the list, find and select the desired document of one of these types: D365 FO, a journal type, or Staging. 4. Click Edit. 5. In the Records section, in the Record list, find and select the desired record. 6. On the Fields tab, click New. 7. In the Field name field, enter or select a value. 8. In the Record table field field, enter or select a value. 9. Select the Key field check box. 10. In the Mandatory field, select an option. 11. In the Length field, enter a number. Manage document record field setup

Manage document record field setup - Internal documents

You have several options to manage the document record field setup for internal documents.
You can:

  • Change the sequence of the fields.
  • View where a field is used.
  • Clean up unused fields.
  • Create a related record.

 Validate connectivity 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.

 End End

Activities

Name Responsible Description

Set up document - D365 FO

Application Consultant

 		Use a D365 FO document to read data from or write data to D365 FO.

Add document records - Internal documents

Application Consultant

To each document, add the data records to be exchanged. For internal documents, set up the records in line with how the data is structured and named in D365 FO.

This topic explains how to add records to documents of these types: D365 FO, Journal, or Staging.

Manage document record setup - Internal documents

Application Consultant

 		You have several options to manage the document record setup for internal documents.
You can:
  • Change the sequence of the records.
  • View the D365 FO table relations.
  • View where a record is used.
  • Check or change the table relations.
  • Define the data querying order.
  • Define the range of data to be queried.
  • Validate the record setup.

Select fields

Application Consultant

You can add a selection of table fields to a record. You can select fields from the D365 FO table that is defined in the Record table field.

This is mainly applicable to internal documents. However, you can also use this to quickly set up fields for external file-based documents.

When the field selection is added to the record, review and complete the properties of the added fields.

Copy fields

Application Consultant

 		You can copy fields from a record of another document. You can use this, for example, to save setup time if you use a specific record in several documents.
You can only copy fields:
  • From a record with the Record table defined.
  • To a record with no fields.
As a result, the full field setup is copied from the selected record to the current record.

Add document record fields - Internal documents

Application Consultant

 		To each document record, add the data fields which values must be exchanged. For internal documents, set up the fields in line with naming in D365 FO.
For internal documents, make sure the fields have the same type as in D365 FO.
This topic explains how to add records to documents of these types: D365 FO, Journal, or Staging.
If fields are already selected for or copied to the record, you can review and complete the setup for these fields. To do so, skip step 6.

Manage document record field setup

Application Consultant

 		You have several options to manage the document record field setup for internal documents.
You can:
  • Change the sequence of the fields.
  • View where a field is used.
  • Clean up unused fields.
  • Create a related record.

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.

Provide feedback