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

Set Connectivity studio parameters

Before you start using Connectivity studio, set up the Connectivity studio parameters.


Application Consultant Application Consultant Set up Azure Storage for general files

Set up Azure Storage for general files

You can use an Azure Storage Account to exchange data files between your D365 FO environment (on-cloud or on-premises) and another environment, for example an on-premises environment.

 Set up local Windows folders for general files Set up local Windows folders for general files If you use Connectivity studio on a D365 FO (on-premises) environment, you can choose to use local Windows folders to exchange data files. In the local Windows folders, create the required folders. Create folders that relate to the paths in these sections of the Connectivity studio parameters: Version management section: Shared path History section: History report path Set Connectivity studio parameters Set Connectivity studio parameters Before you start using Connectivity studio, set up the Connectivity studio parameters. Define parameters for the: Applicable environment. File storage that is used for the environment. Version management of Connectivity studio projects. Connectivity studio history reporting. Data synchronization log processing. ODBC Service bus. Outbound web services queue. Procedure 1. Click Connectivity studio Integration Design. 2. Click Connectivity studio parameters. 3. Sub-task: Set environment parameters. 4. Set the environment parameters on the General tab: - Environment types - Description The environment type only applies to connectors of type: - Database - Azure file storage - Blob storage - SharePoint - Service Bus queue You can export connectivity setup and import it in another D365 FO environment. For example, you first set up and test the connectivity setup in a development environment. When finished, you deploy the setup in your production environment. To strictly distinguish between different environments, you can define unique connector properties for each of your environment types. Which properties are applicable to the current environment is defined in the Environment type parameter In the Environment types field, select an option. Note: For example, if the Environment type parameter is set to Development, the connector properties, as defined for entity type Development are applicable. 5. In the Description field, type a value. 6. Sub-task: Set file storage parameters. 7. Set the file storage parameters on the General tab: - Windows share - Operator name - Password Enter the UNC path to the applicable Azure file share or Windows folder. In the Windows share field, type a value. Note: You can only use a Windows folder if it has access control with a user and password defined. 8. In the Operator name field, type a value. 9. Define the password or the password reference to access the Azure file share or Windows folder. Whether the password or password reference applies is defined by the Display secret field in the Connectivity studio parameters. If the Display secret parameter is set to: - Secret, fill in the Password field with the desired password or access key. The password or access key is specific for the current connector. - Secret reference, fill in the Password reference field with the desired secret reference. The password reference refers to a centrally stored password or access key which makes updating secrets easier. - Both, fill in either the Password field or the Password reference field. In the Password hash field, or in the Password reference field, type a value. Note: To access an Azure file share, the password is the key, or the password reference refers to the key of the applicable Azure Storage Account. 10. In the Display secret field, select an option. 11. Click Test connection. 12. Sub-task: Set import and export parameters. 13. Click the Import and Export tab. 14. You can export project configurations from Connectivity studio. To define which settings are included in the export, you can choose from these options: - All: The full project configuration is exported, including the not encrypted secrets. - Encrypt environment secrets: The full project configuration is exported, but the secrets are encrypted. To encrypt the secrets, you must define an encryption key in the Connectivity studio parameters. - Skip environment properties: The project configuration is exported except for the environment-specific properties of connectors and webservice actions. On import, the environment-specific properties are not overwritten. In the Export options field, select an option. Note: With regards to the export of secrets, only the locally stored secrets are exported. So, this only applies if the Display secret parameter is set to 'Secret' or 'Both'. 15. You can set or change the encryption key. The encryption key is used to: - Encrypt the locally stored secrets on export of a project configuration. This is only applied if the Export option parameter is set to 'Encrypt environment secrets'. - Encrypt the secrets of the secret references. This is only applied if the Display secret parameter is set to 'Secret reference' or 'Both'. If no encryption key is defined, the secrets of the secret references are not encrypted. Click Change encryption key. Note: This encryption key is not used to encrypt the secrets of the secret references when you export or import secret references. 16. In the Encryption key field, type a value. 17. Click OK. 18. Click Yes. 19. Click Show encryption key. 20. Sub-task: Set version management parameters. 21. Click the Version management tab. 22. Select Yes in the Active field. 23. If version management is active, define the folder where the version files are stored. This is a folder in the file share as defined in the Windows share field. Make sure, the folder exists in the file share. In the Shared path field, type a value. Note: For version management, to work properly, the file share and Shared path must be the same for all environments between which project versions must be synchronized. 24. To analyze a project, you can create a Microsoft Word document based on the project. A summary of the project setup and related components setup is added to the document. You can use the document to review the setup. Define the applicable Microsoft Word template. In the Microsoft Word template field, enter or select a value. Note: Before you define the Microsoft Word template, download the Connectivity studio Documentation Template.dotx template. Move the downloaded template to the path as defined in the Connectivity studio parameters, in the Version management section, in the Shared path field. 25. Sub-task: Set history reporting parameters. 26. Click the Error handling tab. 27. In the History report path field, type a value. 28. In the Report number sequence field, enter or select a value. 29. Select Yes in the Skip alerts field. 30. Sub-task: Set finance-related parameters. 31. Click the Finance tab. 32. You can indicate whether and how financial dimensions are validated when the mapping is applied during a message run. Ignore: The financial dimensions are not validated Custom: The financial dimensions, account structures, and advanced rules are validated. When an error is found, validation continues. The validation stops when all financial dimensions, account structures, and advanced rules are validated, or when further validation doesn't make sense. The found errors are logged in the message run history. Standard: The financial dimensions, account structures, and advanced rules are validated. When the first error is found, the validation stops. The error is logged in the message run history. In the Connectivity studio Financial dimension validation field, select an option. Note: The financial dimension validation, as done for options 'Custom' and 'Standard': Is time consuming. Only applies to record mappings for the LedgerJournalTrans table. 33. Sub-task: Set synchronization parameters. 34. Click the Synchronization tab. 35. In the Last run field, enter a date and time. 36. In the Synchronization delay (minutes) field, enter a number. 37. For testing purposes, you can limit the number of records that are added to the outbound queue, when triggered by one change. For example, when a customer group is changed, all related customers are marked as changed as well. To prevent from all customers being added to the outbound queue as changed, you can define a maximum number of allowed changes. When the maximum number is reached, no further customers are added to the outbound queue. In the Max changes allowed field, enter a number. Note: This parameter applies to all records in the data synchronization log. 38. Sub-task: Set service bus parameters. 39. Click the Service Bus tab. 40. For the ODBC service bus, you can set a timeout time. If, on export or import, the service bus takes more than the specified time, the service bus is stopped, and you get a timeout error message. The timeout time is expressed in seconds. In the Timeout field, enter a number. Note: The maximum timeout you can set is 230 seconds. 41. Sub-task: Set web services parameter. 42. Click the Web Services tab. 43. In the Max. automatic retries of web services field, enter a number. 44. Sub-task: Set up Data quality studio integration. 45. You can apply data quality policy rules on import of data into D365 FO with a Connectivity studio message. For more information, refer to Apply data quality rules on data import with Connectivity studio. Click the Data quality studio tab. Note: The Data quality studio integration setup in Connectivity studio is only available if Data quality studio is installed on the same D365 FO environment as Connectivity studio. 46. To apply data quality policy rules on import of data with Connectivity studio, select Yes in the Enable Data quality integration field. Note: To apply data quality policy rules on data import, also indicate which rule types must be applied. To do so, on the data import message, on the Header view, in the Data quality studio section, select the desired rule types. 47. Close the page. Start Start Use template company? Use template company? Set up template company in Connectivity studio parameters Set up template company in Connectivity studio parameters You can use a template company as source company. If you run a message, the data is exported from the template company and imported in the target company. In a template company, you can, for example, define generally applicable master data. You can use this to set up the master data for a new company. To be able to use a template company, in the Connectivity studio parameters, define the template company for each target company. You can define several template companies. For example, with country-specific or industry-specific data. On connectors of type D365FO, use the Template company field to indicate if a template company is used. Dimension numbering If you use several companies, for each company, you can use different financial dimensions. In the Connectivity studio parameters, for each template company, you can assign company-specific numbers to financial dimensions. To make a message company-independent, you can use these numbers to identify the applicable dimensions. So, instead of the dimension name, in the message, you use a number as set up in the Connectivity studio parameters. If the message is run, based on the number, the applicable dimension name is found for the company. Based on the RecId and this dimension name, the dimension value is read or written. Example: For company A, number 1 refers to dimension Department. For company B, number 1 refers to dimension Customer. For the message, dimension numbering is active. On import with this message in company: A, the field mapping sets the value of the Department dimension. B, the field mapping set the value of the Customer dimension. Procedure 1. Click Connectivity studio Integration Design. 2. Click Connectivity studio parameters. 3. Click the Company tab. 4. In the upper section, click New. 5. In the Target company field, enter or select a value. 6. In the Template chart of accounts field, enter or select a value. 7. In the Template company field, enter or select a value. 8. Sub-task: Set up dimension numbering. 9. In the Dimension numbering section, click New. 10. In the Dimension field, enter or select a value. 11. You can change the sequence of the dimensions. The dimension numbering is changed accordingly. To move a selected dimension down, click Move down. Note: You can also manually assign dimension numbers in the Number field. 12. To move a selected dimension up, click Move up. 13. Close the page. End End What file system to  use to store files? What file system to  use to store files? Yes No Azure file share (for D365 FO on cloud  and on-premises) Local Windows folders (for D365 FO on-premises only)

Activities

Name Responsible Description

Set up Azure Storage for general files

Application Consultant

 		You can use an Azure Storage Account to exchange data files between your D365 FO environment (on-cloud or on-premises) and another environment, for example an on-premises environment.

Set up local Windows folders for general files

Application Consultant

If you use Connectivity studio on a D365 FO (on-premises) environment, you can choose to use local Windows folders to exchange data files.

In the local Windows folders, create the required folders. Create folders that relate to the paths in these sections of the Connectivity studio parameters:
  • Version management section: Shared path
  • History section: History report path

Set Connectivity studio parameters

Application Consultant

Before you start using Connectivity studio, set up the Connectivity studio parameters.

Define parameters for the:

  • Applicable environment.
  • File storage that is used for the environment.
  • Version management of Connectivity studio projects.
  • Connectivity studio history reporting.
  • Data synchronization log processing.
  • ODBC Service bus.
  • Outbound web services queue.

Set up template company in Connectivity studio parameters

Application Consultant

You can use a template company as source company. If you run a message, the data is exported from the template company and imported in the target company.
In a template company, you can, for example, define generally applicable master data. You can use this to set up the master data for a new company.
To be able to use a template company, in the Connectivity studio parameters, define the template company for each target company. You can define several template companies. For example, with country-specific or industry-specific data.

On connectors of type D365FO, use the Template company field to indicate if a template company is used.
Dimension numbering
If you use several companies, for each company, you can use different financial dimensions. In the Connectivity studio parameters, for each template company, you can assign company-specific numbers to financial dimensions. To make a message company-independent, you can use these numbers to identify the applicable dimensions. So, instead of the dimension name, in the message, you use a number as set up in the Connectivity studio parameters. If the message is run, based on the number, the applicable dimension name is found for the company. Based on the RecId and this dimension name, the dimension value is read or written.
Example: For company A, number 1 refers to dimension Department. For company B, number 1 refers to dimension Customer. For the message, dimension numbering is active. On import with this message in company:
  • A, the field mapping sets the value of the Department dimension.
  • B, the field mapping set the value of the Customer dimension.

Set up Azure Storage for general files

Manage Connectivity studio parameters when copying database

See also

Provide feedback