1. Data Management
  2. Connectivity Studio
  3. Design
  4. Set up documents
  5. Set up internal documents

Set up journal document

Use the journal documents to write journal data to D365 FO journals.


Application Consultant Application Consultant Start Start Set up document - Inventory journal Set up document - Inventory journal Use an Inventory journal document to import data into the inventory journals.Compared to the D365 FO document, the Inventory journal document focuses only on the inventory journals. It has journal-specific properties and behavior.Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:No records are required for the journal header. Also, no mapping is required in the related message.Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name. For example, the InventJournalTrans table in combination with the InventDim table.The journal name, as defined in the document header properties, defined which inventory journal is applicable. Examples of supported inventory journals are:Movement journalInventory BOM journalCounting journalTransfer journalProject item journal 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 an Inventory journal 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 'Inventory journal'. 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. Enter the journal name that defines the desired journal type. Based on the document type and journal name, the journal header is created. In the Name field, enter or select a value. Note: You can only select journal names that are related to the inventory journal. 14. You can automatically post the journal when the import is finished. Select Yes in the Post journals field. Note: When testing the document and message, you are advised to set this field to No. So, you can review the imported data before the journal is posted. 15. Sub-task: Set custom handler. 16. Expand the Custom section. 17. In the Handler field, enter or select the desired handler class. 18. Close the page. Set up document - Ledger journal Set up document - Ledger journal Use a Ledger journal document to import data into the ledger journals.Compared to the D365 FO document, the Ledger journal document focuses only on the ledger journals. It has ledger-journal-specific properties and behavior.Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:No records are required for the journal header. Also, no mapping is required in the related message.Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name. For example, the LedgerJournalTrans table.The journal name, as defined in the document header properties, defines which ledger journal is applicable. Examples of supported ledger journals are:General journalInvoice journalOn journal creation, the voucher settings of the journal name are considered. If a transaction date is available, the voucher is set. 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 Ledger journal 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 '0'. 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. You can define the applicable journal name for each company in the ledger journal mapping. However, if no ledger journal mapping exists for a company, the default ledger journal name is applied. Enter the default ledger journal name that defines the desired journal type for the companies without a ledger journal mapping. Based on the document type and journal name, the journal header is created. In the Default ledger journal field, enter or select a value. Note: You can only select journal names that are related to the ledger journal. If a ledger journal mapping exists for the current company, the applicable ledger journal name is shown in the Ledger journal field. 14. You can automatically post the journal when the import is finished. Select Yes in the Post journals field. Note: When testing the document and message, you are advised to set this field to No. So, you can review the imported data before the journal is posted. 15. Sub-task: Set custom handler. 16. Expand the Custom section. 17. For a Ledger journal document, the standard handler class is 'BisDocumentLedgerJournal'. This handler class imports ledger-related data into ledger journals. For example: ledger allocations or customer payments. It creates the journal header and links the lines to the created header. You can use a customized handler class. To do so, extend a standard handler class. In the Handler field, enter or select a value. Note: If you use EDI, you can also use this handler class: BisEdiDocumentLedgerJournalChangeCompany. This handler class imports data into the ledger journals. On import, it switches to the company as defined in the EDI history and imports the ledger data into that company. 18. Sub-task: Set up ledger journal mapping. 19. On the Action Pane, click Design. 20. Several companies can exist in your D365 FO environment. Ledger journal names are defined per company and can be different per company. You can define the applicable ledger journal name for each company in the ledger journal mapping. Click Ledger journal mapping. Note: If no ledger journal mapping exists for a company, the default ledger journal name is applied. You can define the default ledger journal name on the document header. 21. Click New. 22. In the Company accounts ID field, enter or select a value. 23. Enter the ledger journal name that defines the desired journal type for the company. Based on the document type and journal name, the journal header is created. In the Ledger journal field, enter or select a value. Note: You can only select journal names that are related to the ledger journal. 24. Close the page. 25. Close the page. Notes For vendor invoices, you can import the details as well in the VendInvoiceInfo table. You can add this table to the document records. Set up document - Trade agreement journal Set up document - Trade agreement journal Use a Trade agreement journal document to import data into the trade agreement journals.Compared to the D365 FO document, the Trade agreement journal document focuses only on the trade agreement journals. It has trade-agreement-journal-specific properties and behavior.Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:No records are required for the journal header. Also, no mapping is required in the related message.Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name.The journal name, as defined in the document header properties, defined which trade agreement journal is applicable. Examples of supported trade agreement journals are:Discount journalsPrice adjustment 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 Trade agreement journal 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 'Trade agreement journal table'. 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. Enter the journal name that defines the desired journal type. Based on the document type and journal name, the journal header is created. In the Name field, enter or select a value. Note: You can only select journal names that are related to the trade agreement journal. 14. Sub-task: Set custom handler. 15. Expand the Custom section. 16. In the Handler field, enter or select a value. 17. Close the page. Set up document - Other journals Set up document - Other journals Connectivity studio provides you with several other journal-related document types: WMS journal Use a WMS journal document to import data into a WMS journal. You can for example import or post a packing slip for a purchase order or an item arrival. Report as finished journal Use a Report as finished journal document to import data into the Report as finished journal to report production orders as finished. Production picking list Use a Production picking list document to create a production order picking list and post it. Project journal Use a Project journal document to import project data into the project journals. You can, for example, import hours or expenses. 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 journal 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 an option. 8. Sub-task: Set properties. 9. Expand the Properties section. 10. Enter the journal name that defines the desired journal type. Based on the document type and journal name, the journal header is created. In the Name field, enter or select a value. Note: You can only select journal names that are related to the selected document type. 11. You can automatically post the journal when the import is finished. Select Yes in the Post journals field. Note: When testing the document and message, you are advised to set this field to No. So, you can review the imported data before the journal is posted. 12. Sub-task: Set custom handler. 13. Expand the Custom section. 14. In the Handler field, enter or select the desired handler class. 15. Close the page. Add document records - Internal document Add document records - Internal document 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 - Inventory journal

Application Consultant
Use an Inventory journal document to import data into the inventory journals.
Compared to the D365 FO document, the Inventory journal document focuses only on the inventory journals. It has journal-specific properties and behavior.
Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:
  • No records are required for the journal header. Also, no mapping is required in the related message.
  • Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name. For example, the InventJournalTrans table in combination with the InventDim table.
The journal name, as defined in the document header properties, defined which inventory journal is applicable. Examples of supported inventory journals are:
  • Movement journal
  • Inventory BOM journal
  • Counting journal
  • Transfer journal
  • Project item journal

Set up document - Ledger journal

Application Consultant

 		Use a Ledger journal document to import data into the ledger journals.
Compared to the D365 FO document, the Ledger journal document focuses only on the ledger journals. It has ledger-journal-specific properties and behavior.
Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:
  • No records are required for the journal header. Also, no mapping is required in the related message.
  • Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name. For example, the LedgerJournalTrans table.
The journal name, as defined in the document header properties, defines which ledger journal is applicable. Examples of supported ledger journals are:
  • General journal
  • Invoice journal
On journal creation, the voucher settings of the journal name are considered. If a transaction date is available, the voucher is set.

Set up document - Trade agreement journal

Application Consultant

 		Use a Trade agreement journal document to import data into the trade agreement journals.
Compared to the D365 FO document, the Trade agreement journal document focuses only on the trade agreement journals. It has trade-agreement-journal-specific properties and behavior.
Based on the document type and journal name, the journal header is created automatically when the message is started, and the document is opened. So, in the document:
  • No records are required for the journal header. Also, no mapping is required in the related message.
  • Only set up records for the journal line tables. All lines in the same import message run are added to the created header. For the records, use tables that are related to the defined journal name.
The journal name, as defined in the document header properties, defined which trade agreement journal is applicable. Examples of supported trade agreement journals are:
  • Discount journals
  • Price adjustment

Set up document - Other journals

Application Consultant
Connectivity studio provides you with several other journal-related document types:
  • WMS journal
    Use a WMS journal document to import data into a WMS journal. You can for example import or post a packing slip for a purchase order or an item arrival.
  • Report as finished journal
    Use a Report as finished journal document to import data into the Report as finished journal to report production orders as finished.
  • Production picking list
    Use a Production picking list document to create a production order picking list and post it.
  • Project journal
    Use a Project journal document to import project data into the project journals. You can, for example, import hours or expenses.

Add document records - Internal document

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