Flow | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Analyze projects |
You can use these tools to analyze a project:
|
||||||||||||||||||||||
Compare content packages |
Use the Environment comparison studio to get the most relevant data from different environments or companies. In the Environment comparison studio, you compare the desired data using content packages. The comparison results show all the differences between two content packages. When you create a comparison, it is saved. You can also save intermediate results of the comparison. You can view the comparisons on the Compare history page. When you process your comparison results, for each table, a separate XML file is created. In the XML files, you can change the values that you want to synchronize manually. |
||||||||||||||||||||||
Create content package |
In the Environment comparison studio, you can compare data files using content packages. You can compare the data of:
A content package must contain all data for one side of the environment comparison. It can also contain data from several XML files and tables. Use a content package as a stable point of reference for the tables you want to compare. |
||||||||||||||||||||||
Define data migration project |
Use a project as the basis for each data migration. Most connectivity elements are linked to a project, for example, documents, connectors, and tasks. Because these elements are related to a project, use a project to deploy a data migration. For each data migration project, at least define the:
|
||||||||||||||||||||||
Define field options |
For each field mapping, you can set additional field options. Each field option has specific properties. If you select a field option, also fill in the related properties. |
||||||||||||||||||||||
Define project |
Use a project as the basis for each integration. Most connectivity elements are linked to a project, for example, documents, connectors, and tasks. Because these elements are related to a project, you can also use a project to deploy connectivity setup and do version management. For each project, you can also define the:
|
||||||||||||||||||||||
Define transformation |
You can use a transformation to change a source value into another value. |
||||||||||||||||||||||
Define type conversion |
You can use a type conversion to convert the data to match the format as required in the target. With a type conversion, you can convert values from any type to string or from string to any type. Usually, the string value is the external value. Note: Type conversions from any type to any type are not supported. For example, a conversion of type integer to type date is not possible. You can use these conversion types:
|
||||||||||||||||||||||
Design data migration |
To design a data migration from AX2012 to D365 FO, you can use the ODBC mapping generator. Using a Database connector with an ODBC connection to the AX2012 database, you can easily map the desired AX2012 tables to the related D365 FO tables. |
||||||||||||||||||||||
Inbound web service process |
The inbound web service process is used to receive a request from and send a response to an external application, via an inbound web service. The inbound web service can be an IIS application or Azure Logic Apps. This inbound web service receives the HTTP requests from the external application. Depending on the execution mode, the inbound web service process runs directly or asynchronously. When triggered, the inbound web service action runs the defined messages.This flow shows a general overview of the inbound web service process when run directly (Run asynchronous = 'No'). When the web service action is triggered, the request message is run. Depending on the result and setup, also a response message or error message is run. |
||||||||||||||||||||||
Inbound web service process - Asynchronous |
The inbound web service process is used to receive a request from and send a response to an external application, via an inbound web service. The inbound web service can be an IIS application or Azure Logic Apps. This inbound web service receives the HTTP requests from the external application.
Depending on the execution mode, the inbound web service process runs directly or asynchronously. When triggered, the inbound web service action runs the defined messages.
This flow shows a general overview of the asynchronous inbound web service process. How an asynchronous inbound web service is processed, depends on the execution mode. These asynchronous execution modes are supported:
|
||||||||||||||||||||||
Manage Connectivity studio parameters when copying database |
In some cases, it can be required that you copy a database to another environment. For example, you have a test environment and a production environment. An issue occurs in the production environment. So, testing is required to find the cause of the issue. However, you do not want to mess up the production environment with testing data. You can copy the full production database to the test environment. If you copy a database to another environment, the Connectivity studio parameters are overwritten with the parameter settings of the copied database. However, usually, you want to keep the original and unique parameter settings for an environment.
You have two options to make sure the Connectivity studio parameters are unique for the environment:
Prerequisites:
Before you copy a database:
|
||||||||||||||||||||||
Manage document record field setup - Internal documents |
You have several options to manage the document record field setup for internal documents. You can:
|
||||||||||||||||||||||
Manage document record setup - EDI documents |
You have several options to manage the document record setup for EDI documents. You can:
|
||||||||||||||||||||||
Manage document record setup - External documents |
You have several options to manage the document record setup for external file-based documents. You can:
|
||||||||||||||||||||||
Manage document record setup - Internal documents |
You have several options to manage the document record setup for internal documents. You can:
|
||||||||||||||||||||||
Manage document record setup - ODBC documents |
You have several options to manage the document record setup for ODBC documents. You can:
|
||||||||||||||||||||||
Manage project versions |
With project version management, you can manage changes on your Connectivity studio projects and all related components. This includes all project details and components, like messages, web service actions, documents, connectors, type conversion, or transformations. Changes to project details and related components are stored by project version. Each project version is stored as a file in the file storage folder as defined in the Connectivity studio parameters. You can use project version management to synchronize projects between several D365 FO environments. For version management, to work properly, the file storage folder, as defined in the Connectivity studio parameters, must be the same for all environments between which project versions must be synchronized. So, the version files are stored centrally and can be accessed by all applicable environments.
In Connectivity studio, if version management is active, you:
This picture shows an example of a typical environment setup. For each environment, project version management is active, using the same Azure Storage Account and folder to store project version files. In this case, the project is checked out on the Development environment, changes are made, and the project is checked in. Because the changes are required in the Acceptance environment, Get latest is done here.
You can use project version management, for example, for these scenarios:
|
||||||||||||||||||||||
Manage project versions - Advanced |
Project version management offers several advanced options. For example, to solve issues related to project versions. | ||||||||||||||||||||||
Message process |
This flow shows a typical example of a message process.ExampleImport customers from a webshop to D365 FO. In this case, the webshop is the source and D365 FO the target. For both the source (webshop) and the target (D365 FO) a connector and a document are required. Also, a message is required to map the source and target data. |
||||||||||||||||||||||
Monitor and troubleshoot Service Bus dead letter data |
If you use Azure Service Bus queues or topics to export data, you can monitor and troubleshoot the Service Bus dead letter data information on several specific pages. |
||||||||||||||||||||||
Monitor and troubleshoot Service Bus import |
If you use Azure Service Bus queues or topics to import data, you can monitor and troubleshoot the data import information on several specific pages. |
||||||||||||||||||||||
Monitor data synchronization log |
For messages and web service actions, you can use table events to track data changes. You can define, for each table, which table events are logged. The table events are logged in the Data synchronization log. If table events are not logged in the Data synchronization log as expected, you can check the data synchronization setup for your message or outbound web service action. If logged events in the data synchronization log are not processed to the outbound queue, you can:
If processing the data synchronization log does not run at all, the batch server can be down. |
||||||||||||||||||||||
Monitor EDI Delfor journal |
Use the EDI Delfor journal to monitor the received EDI sales orders (Delfor). The 'Sales (Delfor) - XML to EDI Delfor journal' message imports the received sales orders (Delfor) into the EDI Delfor journal.
These EDI Delfor journals are validated according to the applicable journal validation setup. If the applicable validation rules are:
|
||||||||||||||||||||||
Monitor EDI inventory order journal |
Use the EDI inventory order staging journal to monitor the EDI inventory orders. If you use EDI inventory order staging, custom messages are required. You can, for example, use staging in your EDI process for picking list registrations or product receipts. You can use these messages to import the received information into the EDI inventory order journal:
The EDI inventory orders are validated according to the applicable journal validation setup. If the applicable validation rules are:
|
||||||||||||||||||||||
Monitor EDI purchase order confirmation journal |
Use the EDI purchase order staging journal to monitor the EDI purchase order confirmations. You always use staging in your EDI process for purchase order confirmation. The 'Purchase - XML to EDI confirmation' message is used to import the received purchase order confirmations into the EDI purchase order journal.
These EDI purchase order confirmations are validated according to the applicable journal validation setup. If the applicable validation rules are:
|
||||||||||||||||||||||
Monitor EDI sales order journal |
Use the EDI sales order staging journal to monitor the EDI sales orders. If you use staging in your EDI process for sales orders, the 'Sales - XML to EDI order' message imports the received sales orders into the EDI sales order journal.
These EDI sales orders are validated according to the applicable journal validation setup. If the applicable validation rules are:
|
||||||||||||||||||||||
Monitor file history |
You can review and analyze the file history of message runs for messages with an Azure file storage connector. All actions that are done to the related file, are registered in the file history.
Registered file actions are the:
You can monitor the file history from the Connectivity studio Integration operations workspace.
|
||||||||||||||||||||||
Monitor inbound web service history |
Depending on how you run an inbound web service integration, you can monitor the integration on these levels:
To monitor an inbound web service integration, use the Connectivity studio Integration operations workspace.
|
||||||||||||||||||||||
Monitor message history |
You can review and analyze the history of message runs that have run with errors. You can investigate these errors and take the appropriate actions to solve the errors. If the errors are solved, you can re-run the message run. To monitor the message history, use the Connectivity studio integration operations workspace.
|
||||||||||||||||||||||
Monitor outbound queue |
For messages and web service actions, you can use table events to track data changes. You can define, for each table, which table events are logged. The table events are logged in the data synchronization log. On processing the data synchronization log, based on the logged events, records are added to the outbound queue. On processing the outbound queue, for each record, the related message or web service action is run to export the applicable data. When the outbound queue is processed, errors can occur. You can reset the outbound queue record status to New. For example, when running a web service action, the external web service can be down. As a consequence, running the related outbound queue records fails and these get the status Error. When the issue is solved, you can reset the status to New, And the next time the outbound queue is processed, these records are processed again.
This flow explains how to:
To monitor the outbound queue, use the Connectivity studio Integration operations workspace.
If the outbound queue does not run at all, the batch server can be down.
|
||||||||||||||||||||||
Monitor Service Bus data |
If you use Azure Service Bus queues or topics to exchange data, you can monitor the data exchange information on several specific pages. | ||||||||||||||||||||||
Monitor staging journal |
In Connectivity studio, you can use the staging concept to validate data in an intermediate area before it is further processed. This is usually used to import data into D365 FO from another system. In this way, you can validate the data before it is written into the D365 FO database. Use the staging journal to monitor the data validation. One predefined generic staging journal table is available for Connectivity studio: 'BisStagingBufferOrderJournal'. Usually, you only use this generic table if you have a limited number of simple integrations. So, integrations that integrate one smaller table. If you want to use staging for integrations with multiple tables or bigger tables, you are advised to develop a customized staging journal table instead of using the generic staging journal table. This flow explains how to monitor staging journals using the generic staging journal table. You can monitoring a customized staging journal table in a similar way. If the validations are not met, errors or warnings are reported in the staging journal. Usually, issues as shown in the staging journal are data related. If it appears that issues are not data related, extend your issue investigation to the messages that import data to or export data from the the staging journal. |
||||||||||||||||||||||
Outbound web service process |
The outbound web service process is used to request data from an external application and to process the response in D365 FO, via an external web service. Only D365 FO can trigger an outbound web service action. When triggered, the outbound web service action automatically runs the defined messages.
This flow shows a general overview of the outbound web service process that is started when an outbound web service action is triggered.
|
||||||||||||||||||||||
Process data synchronization log process |
When you process the data synchronization log, automatically several actions are done, and several decisions are made based on the applicable setup. This flow shows the automatically executed actions and decisions when the data synchronization log is processed. | ||||||||||||||||||||||
Release project |
You can release a project and export it as a data file to import and publish it in another environment. | ||||||||||||||||||||||
Run integration |
You can run an integration on these levels:
|
||||||||||||||||||||||
Run message from a button |
You can use button on a form to run a message. You can add a button to a form in these ways:
|
||||||||||||||||||||||
Run outbound web service |
An outbound web service action can only be triggered by D365 FO. When triggered, the outbound web service action automatically runs the defined messages. You can run an outbound web service action on these levels:
|
||||||||||||||||||||||
Run web service action from a button |
You can use button on a form to run an outbound web service action. You can add a button to a form in these ways:
|
||||||||||||||||||||||
Set Connectivity studio parameters |
Before you start using Connectivity studio, set up the Connectivity studio parameters. |
||||||||||||||||||||||
Set up Azure file storage connector |
Set up a connector of type Azure file storage. Use this type to exchange data files between your D365 FO environment (on-cloud or on-premises) and another environment, for example an on-premises environment. With the Azure file storage type connector, you can exchange these external file-based documents: EDI, Fixed text, Microsoft Word, Microsoft Excel, Text, XML, JSON. You can exchange data files using:
|
||||||||||||||||||||||
Set up Azure Service Bus for ODBC connection |
You can connect D365 FO to an external on-premises database. If you connect to an external on-premises database, you must connect through firewalls. With Connectivity studio, you can connect to an external on-premises database using an Azure Service Bus.
To establish a connection between an external on-premises database and D365 FO with Connectivity studio, these elements must be in place:
This picture gives an architectural overview of the Azure Service Bus solution in Connectivity studio with the required elements. (Note: The numbers in the picture correspond with the before-mentioned element numbers.): Prerequisites to establish this connection:
|
||||||||||||||||||||||
Set up Azure Storage for Azure file storage connector |
You can use an Azure Storage Account to exchange data files between your D365 FO environment ( |
||||||||||||||||||||||
Set up Azure Storage for general files |
You can use an Azure Storage Account to exchange data files between your D365 FO environment ( |
||||||||||||||||||||||
Set up Blob storage connector |
Set up a connector of type Blob storage to exchange data files between your D365 FO environment and another environment, using Azure Blob storage. Azure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data. With the Blob storage type connector, you can exchange these external file-based documents: EDI, Fixed text, Microsoft Word, Microsoft Excel, Text, XML, JSON. |
||||||||||||||||||||||
Set up business event for message |
You can set up a business event that is triggered by a message. Business events provide a mechanism that lets external systems receive notifications from D365 FO. In this way, the external systems can perform business actions in response to the business events.
For more information on business events, refer to Business events overview .
Note:
|
||||||||||||||||||||||
Set up D365 FO document |
Use a D365 FO document to read data from or write data to D365 FO. |
||||||||||||||||||||||
Set up data synchronization for message |
On export of data, the data synchronization setup defines which records are processed.
|
||||||||||||||||||||||
Set up data synchronization for outbound web service action |
On export of data with an outbound web service action, the data synchronization setup defines which records are processed. Note: The request message also can have data synchronization set up. This setup is overruled by the outbound web service data synchronization setup. You can use these types of data synchronization:
|
||||||||||||||||||||||
Set up Database connector |
Set up a connector of type Database. Use this type to directly connect to an external database. This external database can be an on-premises database or a cloud database.
You can also directly connect to an Azure SQL database. |
||||||||||||||||||||||
Set up EDI document |
Use an EDI document to read data from or write data to a file if you use EDIFACT or ANSI X12 for your EDI. The data in the file is structured in line with these standards. You can use an EDI type to indicate which EDI standard is used for the EDI document. For example, EDIFACT or ANSI X12. For each EDI type, you can set up qualifiers for an EDI segment. |
||||||||||||||||||||||
Set up EDI type and qualifiers |
You can use an EDI type to indicate which EDI standard is used. For example, EDIFACT or ANSI X12. This is used for informational purposes only. For each EDI type, you can set up qualifiers for an EDI segment. |
||||||||||||||||||||||
Set up EDI validations |
If you use staging in your EDI process, the received messages are stored in a staging journal. On insert of the message into the staging journal, the applicable journal validations are done.
To define these validations, you set up:
|
||||||||||||||||||||||
Set up Environment comparison studio |
Define the basic settings for the Environment Comparison Studio. |
||||||||||||||||||||||
Set up external documents - File based |
Use an external file-based document to define the data model of the external source or target with which you want to exchange data.
The available file-based external document types are:
|
||||||||||||||||||||||
Set up external documents - ODBC |
Use an ODBC document to define the data model of the external source or target with which you want to exchange data. You can exchange data with an external database via ODBC or with an external Azure SQL database. |
||||||||||||||||||||||
Set up field mapping |
The message is the carrier for all the information that is needed for the integration. On the field mapping you define which target document record fields are mapped to which source document record fields. The resulting field mapping is used to get the right data from the source and get it in the right format to the right place in the target.
|
||||||||||||||||||||||
Set up field mapping - Advanced |
For each field mapping, you can define several advanced settings. You can set up:
Note: A field mapping without any advanced settings gives a better performance. So, the more advanced settings, the more time it takes to execute the field mapping. |
||||||||||||||||||||||
Set up file action - Email |
You can use the Email file action to exchange files with email. If the direction is:
These email options are available:
|
||||||||||||||||||||||
Set up file actions for Azure file storage connector |
With a Azure file storage connector, you exchange files between your D365 FO environment and another environment via an Azure file share or a local folder. If the other environment has no access to the Azure file share or local folder, you can use file actions to transfer the files to a location where the other environment can access the files. Each file action has one direction. The file action direction defines when the action is applicable. If the direction is:
The file actions are done in the sequence as shown in the grid. To put the file actions in the correct sequence, use Move up and Move down.
|
||||||||||||||||||||||
Set up Fixed text document |
Use a Fixed text document to read data from or write data to a file with defined start positions and lengths for fields. |
||||||||||||||||||||||
Set up inbound web service - Azure App Service |
If you want to run the inbound web service application in the cloud, use an Azure App Service. |
||||||||||||||||||||||
Set up inbound web service - Azure Logic Apps |
Instead of an Azure App service, you can use other applications to run an inbound web service in the cloud. An often-used alternative is an Azure Logic App. This topic explains globally how to set up the web service using Azure Logic App. For more information on Azure Logic Apps, refer to Azure Logic Apps documentation. |
||||||||||||||||||||||
Set up inbound web service - IIS application |
If you want to run the inbound web service application on premise, use the predefined IIS application.
You can use the IIS application to route external HTTP requests to the applicable inbound web service actions in D365 FO. Prerequisites:
Before you set up the IIS application, make sure:
|
||||||||||||||||||||||
Set up inbound web services |
You can use the inbound web service process to receive a request from and send a response to an external application, via an inbound web service. To manage the inbound web service process, set up an inbound web service action. |
||||||||||||||||||||||
Set up internal documents |
Use an internal document to define the data model of the internal D365 FO source to read data from or D365 FO target to write data to.
The available internal document types are:
|
||||||||||||||||||||||
Set up journal documents |
Use the journal documents to write journal data to D365 FO journals. | ||||||||||||||||||||||
Set up JSON document |
Use a JSON document to exchange data with an application that uses data-object notation. With a document of type JSON, you can read data from or write data to a JSON file. |
||||||||||||||||||||||
Set up message |
Use messages as the carriers that transport data from a source to a target, based on the mapping as defined on the message. On a message you define:
|
||||||||||||||||||||||
Set up messages |
Use messages as the carriers that transport data from a source to a target, based on the mapping as defined on the message. On a message you define:
|
||||||||||||||||||||||
Set up Microsoft Excel document |
Use a Microsoft Excel document to read data from or write data to a Microsoft Excel file (XLSX). |
||||||||||||||||||||||
Set up Microsoft Word document |
In Connectivity studio, use a Microsoft Word document to write data to a Microsoft Word document (DOCX) using a Microsoft Word template (DOTX). With a Microsoft Word document, you can, for example, add data to text, include contract text, support multi-language output, or include product attributes or specifications. In this way, you can, for example, generate invoices or contracts with the style texts as defined in the template. |
||||||||||||||||||||||
Set up ODBC document |
Use an ODBC document to define the data model of the external source or target with which you want to exchange data. You can exchange data with an external database via ODBC or with an external Azure SQL database.
|
||||||||||||||||||||||
Set up outbound web service - Azure Logic Apps |
Instead of an external web service managed by an external application, you can use other applications as outbound web service in the cloud. An alternative application is an Azure Logic App. This topic explains globally how to set up the web service using Azure Logic App. For more information on Azure Logic Apps, refer to Azure Logic Apps documentation. |
||||||||||||||||||||||
Set up outbound web services |
You can use the outbound web service process to request data from an external application and to process the response in D365 FO, via an external web service. To manage the outbound web service process, set up an outbound web service action. |
||||||||||||||||||||||
Set up record mapping |
The message is the carrier for all the information that is needed for the integration. On the message record mapping, you define for each target document record the mapped source document record. | ||||||||||||||||||||||
Set up secret references |
You can create secret references to store secrets at a central place in Connectivity studio. Wherever you need a secret in Connectivity studio, you can use a secret reference. Benefits of using secret references are:
You can use secret references for:
Note: You can only use secret references if the the Display secret field of the Connectivity studio parameters is set to 'Secret reference' or 'Both'. |
||||||||||||||||||||||
Set up Service Bus queue connector |
Set up a connector of type 'Service Bus queue' to exchange information via an Azure Service bus queue or topic. The 'Service Bus queue' connector supports these Service Bus entities:
For more information, refer to Service Bus queues, topics, and subscriptions. |
||||||||||||||||||||||
Set up SharePoint connector |
Set up a connector of type SharePoint to exchange data files between your D365 FO environment and another environment, using SharePoint. SharePoint is a solution to share and manage content, knowledge, and applications to empower teamwork, quickly find information, and seamlessly collaborate across the organization. With the SharePoint type connector, you can exchange these external file-based documents: EDI, Fixed text, Microsoft Word, Microsoft Excel, Text, XML, JSON. |
||||||||||||||||||||||
Set up Staging document |
Use a Staging document to read data from or write data to the staging table. |
||||||||||||||||||||||
Set up tasks |
You can use tasks to set up the execution of:
You can use task dependencies to run tasks sequentially or in parallel. If you run tasks in parallel, the performance increases. You can run tasks:
|
||||||||||||||||||||||
Set up Text document |
Use a Text document to read data from or write data to a file with field and line separators. For example, a CSV file. |
||||||||||||||||||||||
Set up XML document |
Use an XML document to exchange data in XML format without the need to code. With a document of type XML, you can read data from or write data to an XML file. |
||||||||||||||||||||||
Troubleshooting connectors |
When a message does not run successfully, you can troubleshoot the related source connector and target connector. You have several options to troubleshoot a connector. You can, for example:
|
||||||||||||||||||||||
Troubleshooting documents |
When a message does not run successfully, you can troubleshoot the related source document and target document. When a document is used in a message run, based on the document setup, a query is created that reads the data. You have several options to troubleshoot a document. You can, for example:
|
||||||||||||||||||||||
Troubleshooting messages |
When a message doesn't run successfully, you can troubleshoot the message.
You have several options to troubleshoot a message. You can, for example:
Common issues on the message are:
|
||||||||||||||||||||||
Troubleshooting web services |
When a web service action doesn't run successfully, you can troubleshoot the web service action. You have several options to troubleshoot a web service action. You can, for example:
|
||||||||||||||||||||||
Use Environment comparison studio |
Use the Environment comparison studio to get the most relevant data from different environments or companies. In the Environment comparison studio, you compare the desired data using content packages. |
||||||||||||||||||||||
Use form mapping |
For a message, you can generate the record mapping and field mapping based on an external document and a recording of the applicable forms and fields in D365 FO. The form mapping recording also records the data structure of the mapped D365 FO fields.
You can use this, for example, as a starting point for the message record mapping and field mapping.
|
||||||||||||||||||||||
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:
In this flow, in the activity steps, as an example, the validation is done for documents.
|