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

This topic explains how to add records to an ODBC document.


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Documents tab.
3. In the list, find and select the desired ODBC document.
4. Click Edit.
5. In the Record section, click Add line.
6. For the applicable project, you can define a default Database connector to an external database. If the Database connection is active, you can select a table from the external database. If no Database connection is active, enter a free-definable name. Usually, this is a table name as used in the external database.
  In the Record field, type a value.
7. Because in D365 FO the data is structured in records and fields, for each external document type, the data structure is translated in the same way. To do this, by default the table 'BisBuffertable' is used. The values are stored in a container field in this table. As a consequence, you can add or remove fields without coding to avoid deployment issues.
  In the Record table field, keep the default value 'BisBufferTable'.
8. Use the parent record to define a record structure with parent-child relations.
  In the Parent record field, enter or select a value.
9. By default, if you have a parent-child relation, the parent and child data is processed separately. You can process the parent and child data together.
  Select Yes in the Combine with parent record field.
10. This setting is only applicable to parent records.
- Inner join: To process the parent record, the child record must exist. Example: A sales order is only processed if it has a sales line. If no sales line exists, the sales order is not processed. If a sales line exists, both the sales order and the sales line are processed.
- Outer join: To process the parent record, it is not required that child a record exists. Example: A sales order with no sales lines is processed.
- Exists join: To process the parent record, a child record must exist. Example: If sales order has a sales line, only the sales order is processed. If the sales order does not have a sales line, the sales order is not processed.
- NoExistsJoin: Only parent records are processed that do no have child records. Example: A sales order is only processed if it does not have a sales line.
  In the Join mode field, select an option.
11. During an import or export you can have the need to update another table in D365 FO. Usually, this is an internal history table to trace what is imported or exported.
If you select Yes:
- The record is skipped by the query. And therefore, not exported to an external format.
- You can use the record in the message mapping.
- The record uses the validations as defined in D365 FO.
  Select Yes in the History field.
12. Sub-task: Set record details.
  12.1 In the Line details section, define the detailed settings for the record.
This field is related to the Field name field in the Company range section of the applicable connector. In this Field name field, you can define a company name that exists in the external database.
Several scenarios are possible. If the current field is set to:
- No, and a company is filled in the Field name field, only data is imported for the defined company.
- No, and no company is filled in the Field name field, data is imported from all companies in the external database.
- Yes, data is imported from all companies in the external database.
  Select Yes in the Exclude company where clause field.
  12.2 Tables in a database can have a different owner. If the owner differs, define the applicable schema. If no owner schema is defined, the default dbo schema is used (for example: dbo.salestable).
Examples of other user schemas are: guest and sys.
  In the SQL owner schema field, type a value.
  12.3 In a document, you can need to repeat an element in the records. However, you cannot give these records the same name. Use the External name to refer to the table name in the external database. Example: You have a header address and a line address. In the document, you create a HeaderAddress record and a LineAddress record. For both, the External name is 'Address'.
  In the External table field, enter or select a value.
13. Close the page.

Notes

Generic external document record details fields:

  • External reference: You can indicate which field of the record contains the unique ID of the record in the external database. In this way, you link the external ID to the D365 FO record ID. Note: Usually, you only use this for an ODBC connection with CRM or if you use web services.
  • Revision field: You can indicate which of the records fields contains the revision of the record in the external database. In this way, you find and link the latest revision to the record ID. Note: You can only use this field in combination with the External reference field.

Related to Notes

Set up ODBC document

 

See also

Provide feedback