1. To-Increase Dynamics 365 for Finance & Operations
  2. Connectivity studio
  3. Activities

Set up document - Trade agreement journal
Application task

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


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 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.
  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 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.
  8.4 On import to D365 FO, 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.
  Select Yes in the Disable time validation field.
  8.5 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.
9. Sub-task: Set custom handler.
  9.1 Expand the Custom section.
  9.2 For a Trade agreement journal document, the standard handler class is BisDocumentPriceDiscJournal'. This handler class imports trade-agreement-related data into trade agreement journals. For example: discount adjustments or price adjustments. 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.
10. Close the page.
Related to Notes

Set up journal document

 		 

See also

Provide feedback