---
title: "Set up Connectivity studio parameters"
slug: "set-up-connectivity-studio-parameters"
description: "Set up Connectivity Studio parameters for environments, file storage, version management, and data synchronization to optimize your D365 F&SCM integration."
tags: ["Connectivity Studio", "CS", "Task"]
status: "update"
updated: 2026-09-22T13:18:59Z
published: 2026-09-22T13:18:59Z
canonical: "docs.staedean.com/set-up-connectivity-studio-parameters"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.staedean.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up 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.
- Several specific Connectivity studio features.

### Steps

1. Click **Connectivity studio - Integration Design**.
2. Click **Connectivity studio parameters**.
3. Sub-task: Set environment parameters.
  1. Set the environment parameters on the **General** tab:

The environment type only applies to connectors of type:

You can export connectivity setup and import it in another D365 F&SCM 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]
> **Note**
> 
> For example, if the **Environment type** parameter is set to **Development**, the connector properties, as defined for entity type **Development** are applicable.
    - **Environment types**
    - **Description**
    - **Database**
    - **Azure file storage**
    - **Blob storage**
    - **SharePoint**
    - **Service Bus queue**
  2. Enter a descriptive name of the current environment. Usually, the environment name is used.

This description is used on check in/out. So, in project version management, a descriptive name is shown instead of the GUID that is shown in the **Environment ID** field.

In the **Description** field, type a value.
4. Sub-task: Set file storage parameters.
  1. Set the file storage parameters on the **General** tab:

Enter the UNC path to the applicable Azure file share or Windows folder.

In the **Windows share** field, type a value.

> [!NOTE]
> **Note**
> 
> You can only use a Windows folder if it has access control with a user and password defined.
    - **Windows share**
    - **Operator name**
    - **Password**
  2. Enter the user name to be used to access the Azure file share or Windows folder.

To access an Azure file share, the user name is the name of the applicable Azure Storage Account.

In the **Operator name** field, type a value.
  3. You can define how to manage secrets in Connectivity Studio, for example, related to the Azure storage setup in the Connectivity studio parameters.

Select one of these options:

In the **Display secret** field, select an option.
    - **Secret**: Only the **Password** field is shown.
    - **Secret** reference: Only the 'secret reference' field is shown. The secret reference refers to a centrally stored secret which makes updating secrets easier. See also: [Set up secret references](/data-management/docs/set-up-secret-references).
    - **Both**, you can fill in either the 'secret' field or the 'secret reference' field. Only use this option during a transition phase from using a secret to using a secret reference.
  4. 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:

> [!NOTE]
> **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.
    - **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.
  5. If you have set the file storage parameters, you can test the connection to the file storage.

Click **Test connection**.
5. Sub-task: Set import and export parameters.
  1. Click the **Import and Export** tab.
  2. You can export project configurations from Connectivity Studio. To define which settings are included in the export, you can choose from these options:

In the **Export options** field, select an option.

> [!NOTE]
> **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**'.
    - **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.
  3. You can set or change the encryption key.

The encryption key is used to:

Click **Change encryption key**.

> [!NOTE]
> **Note**
> 
> This encryption key is not used to encrypt the secrets of the secret references when you export or import secret references.
    - 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.
  4. In the **Encryption key** field, type a value.
  5. Click **OK**.
  6. On setting or changing the encryption, all secrets of the secret references are:

Click **Yes**.
    - Decrypted with the previous encryption key.
    - Encrypted with the new encryption key.
    - Stored encrypted in the secret references.
  7. You can show the encryption key in the message bar.

Click **Show encryption key**.
6. Sub-task: Set version management parameters.
  1. Click the **Version management** tab.
  2. You can activate version management for projects. If active, you can add projects to version management. So, version management is only applicable for the projects that you added to version management.

Select **Yes** in the **Active** field.
  3. 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]
> **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.
  4. 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]
> **Note** Before you define the **Microsoft Word template**, download the [Connectivity studio Documentation Template.dotx](https://cdn.document360.io/da662430-6a41-47b1-8c7e-7e4ac37a9756/Images/Documentation/BIS%20Documentation%20Template.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.
7. Sub-task: Set history reporting parameters.
  1. Click the **Error handling** tab**.**
  2. You can have a report created in Microsoft Excel format that contains the errors that occurred during a message run. You can, for example, use this to inform the sender of data on the errors. The report is created when the message run is finished. You can indicate this on the message header, in the **Create history report in Microsoft Excel** field.

Define the folder in which the reports 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 **History report path** field, type a value.
  3. The name of the history report is composed in this way: Message [message name]_[number sequence].

Define the number sequence that is used for the history report name.

In the **Report number sequence** field, enter or select a value.
  4. You can set up alerts to notify the responsible persons when errors occurred during message runs or web service action runs.

For an environment, you can block alerts from being sent.

Select **Yes** in the **Skip alerts** field.
8. Sub-task: Set finance-related parameters.
  1. Click the **Finance** tab.
  2. You can indicate whether and how financial dimensions are validated when the mapping is applied during a message run.

In the **Connectivity studio financial dimension validation** field, select an option.

> [!NOTE]
> **Note**
> 
> The financial dimension validation, as done for options '**Custom**' and '**Standard**':
> 
> - Is time consuming.
> - Only applies to record mappings for the **LedgerJournalTrans** table.
    - **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.
9. Sub-task: Set synchronization parameters.
  1. Click the **Synchronization** tab.
  2. This field shows the latest date and time on which the data synchronization log is processed. Each time the data synchronization log is processed, this date/time is updated automatically.

You can change the date/time, to reprocess the data synchronization log from the changed date/time.

In the **Last run** field, enter a date and time.
  3. When processing the data synchronization log, you can make sure that only logged events are processed for which editing of the related record is fully finished. To do so, you can define the number of minutes back for which logged events are not processed. Only the events are processed that are logged before the current processing date/time minus the defined number of minutes.

Example:

Current processing date/time: 3/1/2022 11:05:07 AM

Synchronization delay: 10 minutes

Only the events that are logged before 3/1/2022 10:55:07 AM are processed.

In the **Synchronization delay (minutes)** field, enter a number.
  4. 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]
> **Note**
> 
> This parameter applies to all records in the data synchronization log.
10. Sub-task: Set service bus parameters.
  1. Click the **Service Bus** tab.
  2. 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]
> **Note**
> 
> The maximum timeout you can set is 230 seconds.
11. Sub-task: Set web services parameter.
  1. Click the **Web Services** tab.
  2. You can define the maximum number of retries that is allowed when processing a web service action outbound queue record fails.

If an outbound queue record for a web service action has run with errors, the maximum number of retries is checked. If the maximum number of retries is:

In the **Max. automatic retries of web services** field, enter a number.
    - Not reached, the outbound queue record gets the status New. The next time the outbound queue is processed, the record is processed again.
    - Reached, the outbound queue gets the status Error.
12. Sub-task: Set up Data quality studio integration.
  1. You can apply data quality policy rules on import of data into D365 F&SCM 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]
> **Note**
> 
> The **Data quality studio integration setup** in Connectivity Studio is only available if Data Quality Studio is installed on the same D365 F&SCM environment as Connectivity Studio.
  2. To apply data quality policy rules on import of data with Connectivity Studio, select **Yes** in the **Enable Data quality integration** field.

> [!NOTE]
> **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.
13. Sub-task: Activate specific Connectivity Studio features.
  1. Click the **Features** tab.
  2. If you use staging in your data import processes, you are advised to enable storing the staging history.

Select **Yes** in the **Enable Staging history** field.
  3. You can activate a **Connectivity studio** feature called '**Split message run**'. This feature:

Select **Yes** in the **Split message run** field.
    - Manages message run batch jobs that are not ended properly due to an AOS or batch crash or stop.
    - Enables limiting the number of threads (batch tasks) if **Parallel processing** is applied. In this case, on the **Message** page, on the **Header** view, in the **Performance** section, the **Threads number** field is available.
  4. You can activate a Connectivity Studio feature called '**Shared staging validations**'. By default, staging validations only apply to the company in which these are set up. Disadvantages of this are:

You can switch to a staging validation setup that by default applies to all companies.

Select **Yes** in the **Shared staging validation** field.

> [!NOTE]
> **Note**
> 
> If you have an existing Connectivity Studio installation, before you can activate the '**Shared staging validations**' feature, upgrade the existing staging validation setup. To do so, go to **Connectivity studio** > **Periodic** > **Upgrade** > **Upgrade staging validations**.
> 
> The upgrade moves the staging validation setup data from the old unshared tables to the new shared tables.
    - If a validation is required for all companies in your Connectivity Studio environment, you must set up the validation for each of these companies.
    - On project import or export, only the validation setup is included of the current company.
  5. On a dynamic action, you can use the **Run as** option. You can select a user account whose security permissions are used to run the dynamic action. See also: [Run message or web service action from dynamic button](/data-management/docs/run-message-or-web-service-action-from-dynamic-button).

To track the dynamic actions triggered this way, you can activate an **Audit log**. When activated, the **Audit log** records who triggered each action, which user context was used, when it was executed, and what message or web service was involved. In the **Dynamic action audit trail** field, select **Yes**.

> [!NOTE]
> **Note**
> 
> To clean up the **Audit log**, refer to [Clean up history tables](/data-management/docs/clean-up-history-tables).
  6. For an outbound web service action, you can set up attributes. By default, these attributes are generic and apply to each environment type. You can enable setting up different web service action attributes for each environment type. See also: [Set up web service action - Outbound](/data-management/docs/set-up-web-service-action-outbound). In the **Web service attributes per environment type** field, select **Yes**.

> [!NOTE]
> Note
> 
> If set to **No**, these environment-type-related elements are not available on the **Web service action** page:
> 
> - **Environment types** field (at the right-top of the **Web service action** page).
> - **Environment types** field (in the **Attributes** section).
> - **Copy attributes** button.
14. Close the page.

## Related

- [Financial dimensions validation](/financial-dimensions-validation.md)
- [Set up staging validations](/set-up-staging-validations.md)
- [Run message or web service action from dynamic button](/run-message-or-web-service-action-from-dynamic-button.md)
- [Set up secret references](/set-up-secret-references.md)

## Attachments

- [Connectivity Studio Documentation Template.dotx](https://cdn.document360.io/da662430-6a41-47b1-8c7e-7e4ac37a9756/Images/Documentation/BIS%20Documentation%20Template.dotx)