Output Management

This document provides an overview how to setup and use the Output Management solution.

Report setup

The report setup can be found via the module 9A Raptor DWH > Setup > Output management > Report setup.

  • Report setup Id: an unique identifier for one report setup.

  • Provider: SSRS, SmartFlows, Electronic reporting, dox42, XperiDo

  • Report name: this should be matched with the report name in the print management. Don’t forget to remove the suffix .report (std D365FO) or another custom suffix.

  • Format mapping: this is only if Electronic reporting is chosen as provider.

  • Company: fill it if you want to use this report setup for a specific company. If a specific company is not filled in, then it is searching for a report setup without company. So make sure you have a default report setup without company as fallback.

  • Primary table name: this is mandatory if you want to archive the report in 9A Raptor DWH. It only works with regular tables like journal tables and not with temporary tables.

  • Download XSD: this is only if SmartFlows, dox42 or XperiDo is chosen as provider.

  • Download XML: this is only if SmartFlows, dox42 or XperiDo is chosen as provider.

  • Document template: this is in combination with Raptor Document Warehouse. This is triggered if you choose Ex Arte Archive as print destination.

  • Email ID: choose an email template for email with your customers and vendors. If no company is selected then it’s important the Email ID exists in every used company. Also it is possible to use placeholders in your email templates.

  • Activate tracking: if no, mail is sent immediately to the customer or vendor. If yes, it will be tracked and the mail is sent via the email batch job (std D365FO).

  • Convert to PDF: this can be activated when you want to convert Excel or Word documents to PDF. Keep in mind: the Document Management integration should be activated

  • Output generation: has two statuses; 'Default' and 'Word'. This parameter only works with the dox42 provider and will convert your document to a word document. Once enabled, the 'Convert to PDF' parameter will be available to turn on. Because of this feature, we can make a pdf with tables that adjust in size by setting 'Output generation' to 'Word' and then ticking 'Convert to PDF'.

  • Trigger business event: trigger a business event with Information regarding your print generation (XML or attachments aren't Included!)

  • Print as EMF: by default enabled for dox42 as report provider. This checkbox can be enabled by report to report for validation. With this feature we can run the DRA client In a Windows service mode.

  • Output generation: possibility to choose in which format the document should be generated. For dox42, you can choose between PDF (default) or Word. For other report providers, it's always PDF as default value except Electronic Reporting.

  • Download XSD: this is only if SmartFlows, dox42 or XperiDo is chosen as provider.

  • Download XML: this is only if SmartFlows, dox42 or XperiDo is chosen as provider.

  • Document template: this is in combination with 9A Raptor DWH. This is triggered if you choose 9A Archive as print destination.

  • Email ID: choose an email template for email with your customers and vendors. If no company is selected then it’s important the Email ID exists in every used company. Also it is possible to use placeholders in your email templates.

  • Activate tracking: if no, mail is sent immediately to the customer or vendor. If yes, it will be tracked and the mail is sent via the email batch job (std D365FO).

  • Convert to PDF: this can be activated when you want to convert Excel or Word documents to PDF. Keep in mind: the Document Management integration should be activated

  • Output generation: has two statuses; 'Default' and 'Word'. This parameter only works with the dox42 provider and will convert your document to a word document. Once enabled, the 'Convert to PDF' parameter will be available to turn on. Because of this feature, we can make a pdf with tables that adjust in size by setting 'Output generation' to 'Word' and then ticking 'Convert to PDF'.

  • Trigger business event: trigger a business event with Information regarding your print generation (XML or attachments aren't Included!)

  • Print as EMF: by default enabled for dox42 as report provider. This checkbox can be enabled by report to report for validation. With this feature we can run the DRA client In a Windows service mode.

  • Output generation: possibility to choose in which format the document should be generated. For dox42, you can choose between PDF (default) or Word. For other report providers, it's always PDF as default value except Electronic Reporting.

  • Use only for E-Platform: only XML generation and without attachments

  • Rest endpoint URL: Let E-Platform know for which destination it is. This can be overruled on vendor/customer level.

  • Document template: this is in combination with the Document Management solution. With this feature the generated XML file is archived in 9A Raptor DWH.

This setup is available when the SmartFlows, dox42 or XperiDo integration is activated in tab Output management in the 9A Raptor DWH parameters.

It’s possible to set custom filenames so you can archive documents in 9A Raptor DWH with specific filenames. Also the filenames are used for attachments in emails. It’s possible to have a file name without language or overrule it for every specific language. It can be used in combination with placeholders.

This is only when 9A Email or 9A Email interactive are used as print destinations. Via this way we can add extra attachments for emails based upon tag setup. Also 9A Raptor DWH should be set already before start with this setup.

  • Tags: here you can fill one or more tags as conditions

  • Linked to record: include the record as tag condition like sales invoice journal, sales confirmation journal,… This is not mandatory but if you want to find a specific document with the linked record as tag. If the linked record Is not found as context In the 9A Raptor DWH, It will make all selected tags empty to avoid unwanted documents.

  • Linked to company: include the company as tag condition. This is not mandatory but useful if you have different sales conditions per company as example.

  • Linked to language: include the language from the linked record as tag condition. This is not mandatory but useful if you have sales conditions for a company in different languages and you want to pick up the correct sales conditions.

This is only when 9A Archive is used and starting from the release 10.2022.9.1. It is possible to add additional tags to an archived document in 9A Raptor DWH. This Is a fully generic solution and can be applied for every report without customizations and In combination with the primary table name.

Tag methods engine works based upon the primary table that you defined It In the report setup overview. Please consult a technical consultant to look which methods are available and which kind of return type should be used. Important to know Is that the entities behind returned records should be available In the entity configuration In 9A Raptor DWH.

  • Customer confirmations

    • Table CustConfirmJour

    • Methods

      • queryCustConfirmSalesLink

        • Purpose: to return multiple sales order numbers

        • Return type: Query - records of table CustConfirmSalesLink

        • Entity of table SalesTable should be configured In 9A Raptor DWH

        • Use relations In D365FO to create link between CustConfirmSalesLink and SalesTable

  • Customer packing slips

    • Table CustPackingSlipJour

    • Methods

      • queryCustPackingSlipSalesLink

        • Purpose: to return multiple sales order numbers

        • Return type: Query - records of table CustPackingSlipSalesLink

        • Entity of table SalesTable should be configured In 9A Raptor DWH

        • Use relations In D365FO to create link between CustPackingSlipSalesLink and SalesTable

  • Customer invoices

    • Table CustConfirmJour

    • Methods

      • queryCustInvoiceSalesLink

        • Purpose: to return multiple sales order numbers

        • Return type: Query - records of table CustInvoiceSalesLink

        • Entity of table SalesTable should be configured In 9A Raptor DWH

        • Use relations In D365FO to create link between CustInvoiceSalesLink and SalesTable

      • custTrans

        • Purpose: to return customer transaction voucher

        • Return type: Record - record of table CustTrans

        • Entity of table CustTrans should be configured In 9A Raptor DWH

  • Project Invoices

    • Table ProjInvoiceJour

    • Methods

      • exaQueryProjInvoiceLinesUnion

        • Purpose: to return multiple project numbers

        • Return type: Query - records of view ProjInvoiceLinesUnion

        • Entity of table ProjTable should be configured In Document Warehouse

        • Use relations In D365FO to create link between ProjInvoiceLinesUnion and ProjTable

  • Customer quotation journals

    • Table CustQuotationJour

    • Methods

      • queryCustQuotationSalesLink

        • Purpose: to return multiple sales quotation numbers

        • Return type: Query - records of table CustQuotationSalesLink

        • Entity of table SalesQuotationTable should be configured In Document Warehouse

        • Use relations In D365FO to create link between CustQuotationSalesLink and SalesQuotationTable

  • Project Invoices

    • Table ProjInvoiceJour

    • Methods

      • exaQueryProjInvoiceLinesUnion

        • Purpose: to return multiple project numbers

        • Return type: Query - records of view ProjInvoiceLinesUnion

        • Entity of table ProjTable should be configured In 9A Raptor DWH

        • Use relations In D365FO to create link between ProjInvoiceLinesUnion and ProjTable

  • Customer quotation journals

    • Table CustQuotationJour

    • Methods

      • queryCustQuotationSalesLink

        • Purpose: to return multiple sales quotation numbers

        • Return type: Query - records of table CustQuotationSalesLink

        • Entity of table SalesQuotationTable should be configured In 9A Raptor DWH

        • Use relations In D365FO to create link between CustQuotationSalesLink and SalesQuotationTable

  • All print destinations are supported with Electronic Reporting reports. Only the Ex Arte printer Is supported when the Word/Excel document Is converted to PDF.

  • Before starting with Electronic reporting as provider make sure the necessary electronic reporting templates are imported in D365FO.

  • In case of troubleshooting: verify or the document is generated properly via standard D365FO

  • The biggest difference with the std D365FO implementation is that you don’t need to set-up a format mapping in the general print management setup or in the print management setup for customers and vendors. Leave it standard and set-up the used format mapping in the report setup. Also you don’t need to define electronic reporting destinations (std D365FO).

  • All print destinations are supported with Electronic Reporting reports. Only the 9A printer Is supported when the Word/Excel document Is converted to PDF.

  • Before starting with Electronic reporting as provider make sure the necessary electronic reporting templates are imported in D365FO.

  • In case of troubleshooting: verify or the document is generated properly via standard D365FO

  • The biggest difference with the std D365FO implementation is that you don’t need to set-up a format mapping in the general print management setup or in the print management setup for customers and vendors. Leave it standard and set-up the used format mapping in the report setup. Also you don’t need to define electronic reporting destinations (std D365FO).

9A Archive

Archiving documents in 9A Raptor DWH. This print destination is only valid for non-proforma documents. Also it’s mandatory to define a primary table name in the report setup so 9A Raptor DWH knows which tag should be linked for a specific document.

9A Screen

9A Printer

If a user tries to print a non-PDF document with 9A printer, a warning is displayed.

9A Email

9A Email interactive

When you want to use 9A Email Interactive In combination with BCC Integration, It's necessary to select EML_Raptor as email provider In the Email parameters. The email parameters can be found via the System administration > Setup > Email > Email parameters .

9A E-Platform

Send a XML file in electronic format to the 9A E-Platform. Also the originally document will be included as attachment in base64 format in the XML file. The XML file will be archived in 9A Raptor DWH If the document template is defined In tab E-Platform.

This form can be found via 9A Raptor DWH > Setup > Output management > Placeholders.

It provides an event based framework Instead of document generation framework where e-mails can be sent Internal or external. Also, It's possible to Introduce new event types with customization and trigger e-mail distribution framework from different places In D365FO. The biggest advantages of this functionality are a built-In Integration with our 9A Raptor DWH and using placeholders for e-mails.

The next configuration can be completed via 9A Raptor DWH > Setup > Output management > Email distribution. Here you can create events, create event groups and link events with event groups. Event groups are useful to trigger different events that are added to one event group. Also, It Is possible to reuse same events In different event groups. Event groups can be used on customer or vendor level as example.

  • Tags: here you can fill one or more tags as conditions

  • Linked to record: include the record as tag condition

  • Linked to company: include the company as tag condition

  • Linked to language: include the language from the linked record as tag condition

  • Validation level

    • None: always send e-mail In case no documents found

    • No e-mail: don't send e-mail If no documents found

    • Block: throw error If no documents found

  • Document version mode

    • Newest: pick up newest document (expect one document)

    • Oldest: pick up oldest document (expect one document)

    • All: pick up all documents

  • Convert to PDF: convert documents to PDF If necessary

  • Document template PDF: archive converted in the 9A Raptor DWH. The record In backend should be exists as entity In the entity configuration.

This form can be found via 9A Raptor DWH > Inquiries and reports > Output management > Email distribution logging. The same form can be opened from an event where the logged e-mails are filtered automatically by the opened event Id. To avoid to log every e-mail, there Is a possibility to activate logging from event to event.

Print Destinations

  • 9A Archive: Archives documents in Document Warehouse. This print destination is valid for non-proforma documents only. The primary table name must be defined in the report setup to link tags.

  • 9A Screen: Displays documents on your portable device. The file extension determines which application is used (e.g., Excel for XLS, PDF viewer for PDFs).

  • 9A Printer: Only supports PDF documents if the Document Routing Agent is running in interactive mode. If Dox42 is the provider, EMF images can be generated.

  • 9A Email: Sends emails either immediately or in batch if tracking is enabled.

  • 9A Email Interactive: Sends interactive emails, allowing you to edit them before sending. If used with BCC Integration, select EML_Raptor as the email provider in the Email parameters (System administration > Setup > Email > Email parameters).

Report Setup

The report setup can be found through the following path: 9A Raptor DWH > Setup > Output Management > Report Setup

Currently, the module supports various providers:

  • SmartFlows

  • SSRS

  • Electronic Reporting

  • Dox42

  • Xperido

SmartFlows

  • All print destinations are supported with SmartFlows reports.

  • Before using SmartFlows as a provider, ensure that the 9A Kickstart templates are imported into SmartFlows.

SSRS

  • All print destinations are supported with SSRS reports.

  • Troubleshooting Tip: Verify whether the document is generated correctly via standard D365FO.

Electronic Reporting

  • All print destinations are supported with Electronic Reporting reports. However, only the 9A Printer is supported when Word/Excel documents are converted to PDF.

  • Before using Electronic Reporting as a provider, ensure that the necessary electronic reporting templates are imported into D365FO.

  • Troubleshooting Tip: Verify whether the document is generated correctly via standard D365FO.

  • Key Difference: With Electronic Reporting, you don’t need to set up format mapping in the general print management setup, or in the customer/vendor print management setup. Instead, leave it as standard and set up the required format mapping in the report setup. Additionally, you don’t need to define electronic reporting destinations (as in standard D365FO).

Dox42

  • All print destinations are supported with Dox42 reports.

  • Before using Dox42 as a provider, ensure that the 9A Kickstart templates are imported into a SharePoint environment.

XperiDo

  • This is for existing XperiDo customers.

  • Connection information can be found in the Ex Arte V5 Foundation.

  • All print destinations are supported with XperiDo reports.

Some setup options are only available for certain providers. For example, template development is only available when SmartFlows or Dox42 is selected as the provider. Format mapping is only available when Electronic Reporting is selected.

Settings

The mandatory settings are explained below, detailing how to use them for your reports.

  • Report Setup ID: A unique identifier for each report setup.

  • Provider: Options include SSRS, SmartFlows, Electronic Reporting, Dox42, Xperido.

  • Report Name: This should match the report name in Print Management. Be sure to remove the suffix .report (default in D365FO) or any custom suffix.

  • Format Mapping: This option is only available when Electronic Reporting is selected as the provider.

  • Company: Enter a company name if you want to use the report setup for a specific company. If not filled, the system will search for a default report setup without a company.

  • Primary Table Name: Required if you want to archive the report in Document Warehouse. It only works with regular tables (e.g., journal tables) and not with temporary tables.

General Settings

  • Download XSD: This option is available if SmartFlows, Dox42, or XperiDo is selected as the provider.

  • Download XML: Also available for SmartFlows, Dox42, or XperiDo as the provider.

  • Document Template: Works with the Raptor Document Warehouse. Triggered when Ex Arte Archive is selected as the print destination.

  • Email ID: Choose an email template for sending emails to customers and vendors. If no company is selected, ensure the Email ID exists in every company used. Email templates can also include placeholders.

  • Activate Tracking: Select "Yes" to track emails. If "No", emails are sent immediately. When tracking is activated, emails are sent via the email batch job (standard in D365FO).

  • Convert to PDF: Enable this option if you want to convert Excel or Word documents to PDF. Keep in mind that the Raptor Document Warehouse integration must be activated.

  • Output Generation: This has two options: 'Default' and 'Word'. It is only available with Dox42 as the provider and converts documents to Word. When this option is enabled, the "Convert to PDF" setting becomes available. This allows you to generate PDFs with adjustable tables.

  • Trigger Business Event: Use this to trigger a business event with information about the print generation (note: XML or attachments are not included).

  • Print as EMF: By default, this is enabled for Dox42 as the report provider. This option allows the DRA client to run in Windows Service mode.

  • Output Generation: Allows you to choose the format for the document (PDF or Word). For Dox42, you can select either PDF (default) or Word. For other providers, PDF is always the default.

E-Platform

This setup is available when the E-Platform integration is activated in the 9A Raptor DWH parameters.

  • Use Only for E-Platform: Supports XML generation only, without attachments.

  • REST Endpoint URL: Specify the destination for E-Platform. This can be overridden at the vendor or customer level.

  • Document Template: Works in conjunction with the Raptor Document Warehouse solution. The generated XML file will be archived in the Document Warehouse.

Flows

This setup is available when the SmartFlows, Dox42, or XperiDo integration is activated in the Output Management tab of the 9A Raptor DWH parameters.

  • Flow: Choose a flow from the dropdown when SmartFlows or XperiDo is selected as the report provider. For Dox42, manually input the SharePoint URL where the template is stored.

  • Language: Optional. Leave blank if the flow is for all languages. The language can be retrieved from the sales or purchase order.

Filenames

You can set custom filenames to archive documents in Document Warehouse or for email attachments. Filenames can be specified for different languages, and placeholders can be used.

  • Default Filename: If no specific filename is set for a report setup, a generic filename will be used for every generated document.

  • Electronic Reporting: When using Electronic Reporting as a provider, the filename defined in Electronic Reporting will be used if none is specified in the report setup.

Attachments

This is available only when 9A Email or 9A Email Interactive is selected as the print destination. Extra attachments can be added to emails based on tag setup. Document Warehouse must be set up before using this feature.

  • Tags: Enter one or more tags as conditions.

  • Linked to Record: Include the record as a tag condition (e.g., sales invoice journal, sales confirmation journal).

  • Linked to Company: Include the company as a tag condition.

  • Linked to Language: Include the language from the linked record as a tag condition.

Tag Methods

This feature is available when 9A Archive is used, starting from release 10.2022.9.1. It allows you to add additional tags to archived documents in Document Warehouse, without the need for customizations.

Tag methods start from the primary table configured in the Report setup, and retrieve additional data via a linked record or a query. This data is then translated into tags using the Entity Configurationand applied on the archived document.

  • Record: Returns one record as an object.

  • Query: Returns a query as an object.

Below is a list of existing primary tables with their corresponding table methods:

Customer Confirmations

  • Table: CustConfirmJour

  • Methods:

    • queryCustConfirmSalesLink

  • Purpose: To return multiple sales order numbers.

  • Return Type: Query – Records from the CustConfirmSalesLink table.

  • Entity Configuration: The entity behind the SalesTable should be configured in Document Warehouse.

  • D365FO Relations: Use relations in D365FO to link CustConfirmSalesLink and SalesTable in the Relation setup

Customer Packing Slips

  • Table: CustPackingSlipJour

  • Methods:

    • queryCustPackingSlipSalesLink

  • Purpose: To return multiple sales order numbers.

  • Return Type: Query – Records from the CustPackingSlipSalesLink table.

  • Entity Configuration: The entity behind the SalesTable should be configured in Document Warehouse.

  • D365FO Relations: Use relations in D365FO to link CustPackingSlipSalesLink and SalesTable in the Relation setup

Customer Invoices

  • Table: CustConfirmJour

  • Methods:

    • queryCustInvoiceSalesLink

  • Purpose: To return multiple sales order numbers.

  • Return Type: Query – Records from the CustInvoiceSalesLink table.

  • Entity Configuration: The entity behind the SalesTable should be configured in Document Warehouse.

  • D365FO Relations: Use relations in D365FO to link CustInvoiceSalesLink and SalesTable in the Relation setup

  • Table: CustTrans

  • Purpose: To return the customer transaction voucher.

  • Return Type: Record – Record from the CustTrans table.

  • Entity Configuration: The CustTrans entity should be configured in Document Warehouse.

Project Invoices

  • Table: ProjInvoiceJour

  • Methods:

    • exaQueryProjInvoiceLinesUnion

  • Purpose: To return multiple project numbers.

  • Return Type: Query – Records from the ProjInvoiceLinesUnion view.

  • Entity Configuration: The entity behind the ProjTable should be configured in Document Warehouse.

  • D365FO Relations: Use relations in D365FO to link ProjInvoiceLinesUnion and ProjTable in the Relation setup

Customer Quotation Journals

  • Table: CustQuotationJour

  • Methods:

    • queryCustQuotationSalesLink

  • Purpose: To return multiple sales quotation numbers.

  • Return Type: Query – Records from the CustQuotationSalesLink table.

  • Entity Configuration: The entity behind the SalesQuotationTable should be configured in Document Warehouse.

  • D365FO Relations: Use relations in D365FO to link CustQuotationSalesLink and SalesQuotationTable in the Relation setup

Placeholders

In the Placeholders section we can define placeholders and map them to a specific field or method from a particular table.

Placeholders can be used in filenames or email templates. Remember to enclose each placeholder with percent symbols (%) as both a prefix and suffix.

For example, the %customername% placeholder can be mapped to the DeliveryName field from the CustConfirmJour table (Sales Confirmations) or the InvoicingName field from the CustInvoiceJour table (Sales Invoices).

Another example is mapping the %DeliveryAddress% placeholder to the deliveryAddress method from the CustConfirmJour table.

Email Distribution Framework

The email distribution framework allows sending emails based on events, with integration into Document Warehouse. Ensure the 9A Document Management - Email Distribution Framework feature is enabled in Feature Management.

PreviousInput ManagementNextProcess Management

Last updated