InterformNG2 - Microsoft Dynamics 365FO Package - Implementation Guide
General Prerequisites
- MS Dynamics 365 FO
- InterFormNG2 Version 4.0.2
- InterFormNG2 D365 Solution Package (Export)
- Dynamics Integration Package (Connector)
- Connector License
D365 Connector Setup
Installing the Connector
InterForm Report Override Parameters
Connection Group
Report Override
Report Override – Users and Companies
Related Tables
Table field Reduction
Document History
Custom Reports
Installing the Connector
You can obtain the connector either by contacting InterForm through App Source or directly.
You will receive the model file for the connector, which you can import into your development environment and move to test, UAT, and production when applicable.
Once the connector is installed, the InterForm setup forms can be accessed through System Administration / Setup / InterForm Report Override.
In the
following, we will go through each of these forms.
Interform Report Override Parameters
In the general tab of the Interform Report Override Parameters, you can define the basic setup/configuration.
In the first fast tab, named Company specific profile, you can setup parameters for each individual company. By default, there is a blank record in the grid. The blank record indicates this setup is cross-company.
If you want to make a setup that uses other parameters for a different company, e.g. a specific company needs to use another tenant, you can click the “Company Override” button above the grid, and a record for that specific company is made.
In the InterForm Connector Setting the following fields are available:
Email Setup:
These are the parameters pertaining email overriding in the module. The module uses the standard print management to send out the report to the email set up for the specific report and customer. You can override the receiver, sender, and cc mail addresses from here.
If each field is left empty, the system will use the standard emails provided by the print management system.
For all fields, you can write the relative following relative replacement keys:
- %MAILSENDER% = The email of the user creating the report will be added instead.
- %MAILRECEIVER% = The email that is supposed to receive the report.
- %MAILCC% = The cc mail setup from the print management for the report.
You can enter a standard email in each field as well.
- Receiver: Here, you can override who will be the recipient of the mail sent from the system. This is handy in a test environment, where you don’t want any emails reaching customers. In that case, the mail can be set to a fixed email address, or the %MAILSENDER% keyword can be used to send the mail to the user.
- Sender: Here, you override the sender address. If left empty, it will use the user, that is, the printing email address. This, e.g., can be set to a no-reply company email.
- CC: Here, you override the cc email address.
Watermark
Here, you can enter a text that you want as a watermark on all reports from the current environment. This is useful in test environments to ensure that all reports that are output have a watermark saying this is a test print.
Short Value/label tags
This is a setting you can set, that reduces the xml output for the value and label tags. This is useful when dealing with large documents.
Disable logging
Here you can disable the logging of the communications between Finance and Operation and the InterForm server.
Connection Group
- Base URL
This is the base URL for the Interform service/server - TenantID
TenantID is "home" or in our current setup "Dynamics Test" - Username
The service username provided to you by Interform. - Password
The service password provided to you by Interform.
Report Override
This is where you can set up which reports should be overridden for output through Interform. You enter the report's name and its design. Both fields have lookups to improve the user experience.
When you open it for the first time, it is populated with the reports that come with the Interform package as standard; they are just not activated.
The template name column is where you connect your data to a template on the InterForm server. This field has a lookup, so the templates are correctly formatted.
The Internet address is the "path" of the Interform webservice/workflow. This is only use if you want the report to be sent through a specific workflow, otherwise the template name is the standard way of connecting the data to the design.
Report Override – Users and Companies
You will also need to define the Users and companies who are "allowed" to use the Interform Reports:
Here you can setup the report to only output through InterForm for certain named users. This is handy if you want to only have certain users see the InterForm reports for a certain period before opening it up companywide.
Related Tables
From the Report Override form, it is possible to navigate to the Related Tables form, to setup if you want extra data in the output.
In this case, we are looking at a Sales Invoice report. When we process the SalesInvoiceHeaderFooterTmp table, we will also include the related SalesTable in the XML output.
If the “Use Table Relations” field is checked, the system will use the existing relation set up in Dynamics 365 to find the table to add. In the above example no system table relation exists between the two tables.
The Include Fields column is related to the Fields tab on the Form. When checked the output to the xml only includes the fields setup on that tab and doesn’t export all data anymore.
In the field Node name, you can setup the name of the XML-node of the table you are adding to the output.
Relations Tab
If no table
relation exists in the system, you can set it up yourself in the relations tab.
In the above example, the relation is the field SalesID present in both
tables.
Table field Reduction
From the
Report Override form, it is possible to navigate to the Tabel Field Reduction
form, to set up if you want more control of how the data is stored in the XML.
First, you
add the table you want to reduce or change the field names for.
In the example below, the field in the field name column has been set up to have its name changed in the XML output to SpecInvDate. The only once column, can be checked, if the field should only be added to the XML output the first time it is processed. This is useful for data providers repeating header fields on all the line fields.
Document History
In the document history you can see all reports that have been printed via integration. You can either reprocess or download the xml.
In this screen you can see all documents that have been processed using the InterForm Report Override, and what was sent to the InterForm service. It is also possible to reprocess the document, so it will be sent to the InterForm Service once again.
If the user wants to use a different version of the reports, they can do so through the document management system in Microsoft Dynamics FO, if another version of the document exists. See the picture below.
Custom Reports
This feature lets you design your reports from the ground up with the data sources you choose and the fields you want.
In the Name column you name your Custom Report, in the table name, you choose which table should be the data source. The group Id is in order to group Reports together, which will be described later.
The template name column acts the same way as the template column on the report override form.
On the fields tab there is a grid to setup the fields that should be on the report.
The Name column is for the XML output. You can define the name here. If left blank, it just uses the field or method name.
The reference table name is defaulted to the table set for the report on the overview tab. But you can pick a related table as well here, as long as a relation exists between the two tables in the dynamics data model.
In the above example the salesLine table is the main table for the report, but one of the lines use the inventtable, which is possible because such a relation exists naturally in the data model.
Reference field name is the field to take the data to the output from.
If the needed data is provided with a display method, the method name column can reference that instead.
On the Parameter tab you can set up parameters the user should be prompted for, when executing the report.
The Name is the parameter name, and how it will figure in the XML output to Interform.
The datatype is the basic datatype the parameter has.
In extended data type you can reference existing Extended data types, and if there are relations on the data type, the parameter dialog will provide a lookup option for the parameter.
You can set the default value of the parameter, as well as the labe, as it should look to the user in the label.
On the Attach to form you can add your report to any form in the entire system.
In the above example, the report has been attached to two different forms, you need to choose which data source on the form to use for the report, it of course has to be a compatible data source, to the table you added as the main table for the report itself. In this case it is the SalesTable, which is the same used on the report.
On control name you choose which button group on the chosen form to attach the report to, as a new menu item on the form, and the label column defines what the report menu item is caleld to the user on the attached form.
In this case we will look at the sales table list page, and see the report is now there:
And if we click it, it opens a dialog:
And as seen the parameter is present, and can look up in related data. Clicking ok, executes the report generation, and it is presented to the user:
Back on the
custom reports screen the next tab is the printers tab:
In this, you simply set up which printers should be available for the specific report.
On the output tab, you can see an example XML output of the current setup of your report:
What is
important to notice here is that under the salesTable, there are lines, even
though the report has only been set up for one data source. That brings us to
the final setup part of the custom reports.
You can
embed reports within each other in the embedded reports button in the top of
the form.
In this case, the Sales Header report is active, and when we click the Embedded reports button you can choose which reports should be embedded in the dataset as well.
In this case, the salesLine report has been set to be an embedded report for the salesTable report. The table picked in the table name, is the table that holds the relation between the two tables set for each report, thereby tying them together.
The Run report button does the same, as when you ran the report on an attached form, this just provides the user the possibility to test the report genration, without having to attach the report to a form until the output is ready.
InterFormNG2 Setup
General access
Firewalls and ports
Mail server, SMTP, and mail relay
Printers
Examples and tests
General access
Internet connection from the InterformNG2 servers to request license, also connection between D365 and the InterForm server.
The provided model should be installed by a Dynamics consultant in the system before a connection between the two systems is possible.
For installations we need access to the InterformNG2 server.
Firewalls and ports
The following ports should be open:
Other ports could be needed depending on the use of FTP, ODBC, REST, different printing protocols, etc.
Mail server, SMTP and mail relay
The Customer must provide information on mail server, authentication and ensure that the mail relay is setup to allow InterFormNG2 to send mails from both test and production server.
Printers
Printers to be used in dynamic printer control from D365 must be shared on a windows share and is not part of the InterFormNG2 installation or the standard D365 package configuration.
Examples and tests
We need examples of documents, orders, invoices etc. that we are allowed to use for testing the base solution. The customer is responsible to provide test cases that are sufficient to do a base test of the documents.
Installation and basic configuration of InterformNG2
Install InterformNG2
Request a test license
InterformNG2 user management
Email server configuration
Add printers
Setup Sharepoint integration
Setup logging
Install InterformNG2
Install the latest Windows version of InterformNG2 from https://interform400.com/download-product/
Follow the “click next” installation process on both the test and production servers. It is preferred to install using the HTTPS protocol.
Note: InterformNG2 automatically installs JAVA 17.
Request a test license
Login to InterformNG2: https://myip_or_dnsname:8086/
- User: admin
- Password: password
Follow up on the guide described in the "The license code" article.
InterformNG2 user management
- Create a new Administrator user
Create a new user and add the Administrator role. Please note that the password you enter is a first-time password only.
For more information on user management, look at the "Users of InterformNG2" article. - Change Admin password
Change the Admin password.
Email server configuration
Email information needs to be added to the InterformNG2 settings.
- The customer is responsible for informing us of the correct information to set up the email integration.
- The customer is also responsible for ensuring that the mail relay allows the InterformNG2 to send through the SMTP gateway.
For information on setting up the email servers in InterformNG2, please use the article "Tenant email server".
Note: Remember to set up a valid from email address in InterformNG2
Difference between system and Tenant mail servers:
- System Admin is a global email server in order to be able to send system emails from InterformNG2.
- Tenant email server is for emailing documents from companies A , B, etc.
You can add multiple email servers.
When you are signed in as user admin and have selected System Admin create the email settings for InterformNG2 to be used for system e-mails. You can name the server with a unique name if you have separate email servers.
Now sign out of InterformNG2, and sign in using your own profile and select Tenant “Home”.
And create the email settings for the Tenant “home”.
Add printers
The standard M3 workflow is set to use dynamic printers based on the M3 settings in CRS290 and MNS205/CRS949. No additional printer settings are needed to run the default M3 printouts based on the standard workflow.
For more information on possibilities and setup of named printers in InterformNG2, please see the "Printers" articles.
Setup Sharepoint integration
In order to use the SharePoint workflow component and other SharePoint functionality, Office 365 connection parameters have to be configured in tenant settings.
However, you first need to create an app registration in Azure Active Directory Admin Center: https://aad.portal.azure.com
- From the left side menu, navigate to Azure Active Directory -> App registrations -> Register an application (or New registration).
- On this screen, enter a suitable name for the app, for instance "InterForm" and select "Accounts in this organizational directory only (XXX.XXX only - Single tenant)". Leave "redirect URI" undefined.
- An Application (client) ID and Directory (tenant) ID have been generated for you. Now click the link by "Client credentials".
- Under "Client Secrets" use the "New client secret" button to create a secret. Select any expiry time that you like, but note that you have to create a new secret when it expires.
- Now that you have created a secret, immediately make a copy of the value in the "Value" column, as you will not be able to see this again later.
- From the left side menu, select API Permissions -> Add a permission -> Microsoft Graph -> Application Permissions. In the list, expand "Sites" and select "Sites.ReadWrite.All". Finally, press the "add permissions" button.
- The permissions must now be approved by a user with one of the roles Global Administrator, Application Administrator or Cloud Application Administrator.
You can read more about this app registration process on: https://learn.microsoft.com/en-us/graph/auth-register-app-v2
In InterformNG2 tenant settings from the top navigation bar and scroll down to the section "Office 365":
As SharePoint tenant name, you need the tenant name for your SharePoint online account. If you access SharePoint with https://mytenant.sharepoint.com then your tenant name is "mytenant".
For the other three settings values, use the values that were created in the app registration process above.
You can use the "test connection" button to check if a connection can be established with these settings.
Setup logging
- Go to the InterformNG2 settings and the log section.
- Enable the email log and setup the Error report email.
- Remember to click SAVE
For more information on the IDM integration read the "Logging" article.
Deployment of D365 package to InterformNG2
The InterformNG2 D365 package is a content package specifically developed for Microsoft Dynamics 365 FO ERP system. The package contains standard workflows and templates to handle printouts from Dynamics365FO.
Import the InterFormNG2 D365FO package
Import the InterFormNG2 D365FO package
The InterformNG2 D365FO package is available from Interform partner.
Go to the InterFormNG2 settings and IMPORT TENANT.
Choose the downloaded file and click IMPORT, and confirm by clicking OK in the next window.
Configuration Options for the customer
Some adjustments can be made independently (without Interform). However, this is only recommended if you feel confident doing so. It should be noted that an incorrect configuration can lead to outputs being created incorrectly or not at all.
How to configure mail templates
How to create and change logos on existing templates
How to change sharepoint structure
Transferring resources between PROD and TEST
How to configure mail templates
If the user needs to change the mail templates, select the library, then select templates. Next, choose the folder D365FO.
And lastly choose the folder named MailTemplates.
You will now see all the available email templates.
You can then change the logo on the template to your own company logo. If you need to change the text of the email template, then you should go to the translations section on the left menu or include the text in the xml node EmailBody.
In the
translation section, select the folder D365FO. Here you see all the translation files used to change the text in the email template. Choose the appropriate email file, and then you can modify the email text.
How to create and change logos on existing templates
To create a new template, go to the template section and the D365FO folder and press New Template.
If you
would like to change the logos on the template, then you can choose any of the
existing templates and click on the logo on the template.
You will then on the
left section see elements which are expanded, and you will notice a component
and a ‘’Select’’ element. In the select element replace the image with your
company logo image. One of the benefits of our designer is that when we assign
a component to a template and make changes to it all other templates will be
affected as well. Therefore, you will only need to change the image in one template,
and the logo will be updated on all the other templates as well.
How to change sharepoint structure
To change the structure of the output pdf file and the folder structure the user can make changes to the maked section of Output filename and Folder. If the columns naming and data needs to be then it is possible on the marked area in column names and column values.
Transferring resources between PROD and TEST
You can use the following options to transfer resources between the environments:
Manually exporting specific templates – From the designer or the library you select export with dependencies. It will create a zip-file, which you can then import on the other system.
2. Full tenant export – You can also export and import the whole tenant via the settings. This secures that all changes are mirrored between the environments.
Change requests and support
In the case of the following change requests, the Client should contact InterForm:
- Additional forms/labels are needed
- Change in optics, contents of the forms/labels
- Change of logic (processes, e-mailing, etc. desired)
- Change of storage paths, file names, content XML, etc.
Change requests and support cases can be reported via our helpdesk: https://helpcenter.InterForm400.com/portal/en/newticket
If you do not yet have access to the portal, you can send a one-time e-mail to support@Interform400.com
Related Articles
InterformNG2 - Microsoft Dynamics 365FO Package - Overview
Introduction Microsoft Dynamics 365 for Finance and Operations (Dynamics 365FO) is an enterprise resource planning (ERP) system from Microsoft, designed for large and medium-sized organizations to manage core business processes such as: Finance ...Solution Documentation - Interform Infor M3 Package
Introduction The InterformNG2 - Infor M3 package is a standardized solution that enables Infor M3 customers to manage and streamline their document output through the InterformNG2 platform. It delivers preconfigured content, document templates, and ...Solution Documentation - Interform Automotive Solution
Interform Automotive Package Interform Automotive Solution is an output management solution developed specifically for the automotive industry. It extends the core functionality of InterformNG2 with a comprehensive collection of industry-compliant ...Integration between SAP S/4 HANA and InterFormNG2
Foreword / Background This documentation outlines the process and requirements for integrating SAP S/4 HANA with InterFormNG2, a solution for managing digital forms and output. It is essential to note that there are multiple approaches and methods ...