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:
  • Manage versions on project level only, including all project components and settings.
  • Must check out a project to make changes to the project or its components.
  • Must check in a project to make changes generally available for other environments.
  • Can restore a project version or get the latest project version.
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:
  • Project changes: A change to a project component in an environment can be easily applied to other environments.
  • Issue resolution: During testing, you can find and solve an issue in a project component in one environment. The solution to the issue can be easily applied to other environments.
  • Updates in the test environment: In a test environment, project components are often changed. Using project versions, you make sure that changes are saved, and you can always restore a previous project version.

Application Consultant Application Consultant Start Start Is the project added  to version management? Is the project added  to version management? Add project to version management Add project to version management If version management is activated in the Connectivity studio parameters, you can add projects to version management. So, version management is only applicable to the projects that you added to version management. If you add a project to version management, it is automatically checked out to make changes. To add the current project setup to version management as the first project version, check in the project. As a result, a version file is created and added to the folder as defined in the Business integration parameters. Procedure 1. Click Connectivity studio Integration Design. 2. In the Project field, enter or select the project that you want to add to version management. 3. Click Projects. 4. On the Action Pane, click Deploy. 5. In the Version management group, click Add to. 6. Click Check in. 7. In the Note field, type a value and press Tab. 8. Click OK. 9. Close the page. Check out a project Check out a project If version management is active, you must check out a project to make changes to the project or its components.You check out a project in an environment. Each user in this environment can make changes to the checked-out project. If a project is checked out, it cannot be checked out in another environment.You can only check out the latest project version. If you check out a project and the active version is not the latest version, you can choose to first get the latest version. If you do not get the latest version, the project is not checked out. Procedure 1. Go to Connectivity studio > Common > Projects. 2. In the list, find and select the desired project. 3. On the Action Pane, click Deploy. 4. Click Check out. 5. Select Yes in the Run in background field. 6. Click OK. 7. Click Yes. 8. Close the page. Change project or related components Change project or related components If a project is checked out, you can make the required changes to the project or to the related components. Save changes? Save changes? Check in a project Check in a project If version management is active and a project is checked out to make changes, check in the project to make the changes generally available for other environments. As a result, the changes to the project details and related components are stored as a new project version. The project version is stored as a file in the file storage folder as defined in the Connectivity studio parameters. Procedure 1. Go to Connectivity studio > Common > Projects. 2. In the list, find and select the desired project. 3. On the Action Pane, click Deploy. 4. Click Check in. 5. Select Yes in the Run in background field. 6. In the Note field, type a value. 7. Press Tab and click OK. 8. Close the page. Undo changes Undo changes If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone. Procedure 1. Go to Connectivity studio > Common > Projects. 2. In the list, find and select the desired project. 3. On the Action Pane, click Deploy. 4. Click Get latest. 5. Select Yes in the Run in background field. 6. Click OK. 7. Click Yes. 8. Close the page. Get latest project version Get latest project version If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone. Procedure 1. Go to Connectivity studio > Common > Projects. 2. In the list, find and select the desired project. 3. On the Action Pane, click Deploy. 4. Click Get latest. 5. Select Yes in the Run in background field. 6. Click OK. 7. Click Yes. 8. Close the page. Manage project versions - Advanced

Manage project versions - Advanced

Project version management offers several advanced options. For example, to solve issues related to project versions.

End End No Yes Yes No

Activities

Name Responsible Description

Add project to version management

Application Consultant

If version management is activated in the Connectivity studio parameters, you can add projects to version management. So, version management is only applicable to the projects that you added to version management.

If you add a project to version management, it is automatically checked out to make changes. To add the current project setup to version management as the first project version, check in the project. As a result, a version file is created and added to the folder as defined in the Business integration parameters.

Check out a project

Application Consultant

If version management is active, you must check out a project to make changes to the project or its components.
You check out a project in an environment. Each user in this environment can make changes to the checked-out project. If a project is checked out, it cannot be checked out in another environment.
You can only check out the latest project version. If you check out a project and the active version is not the latest version, you can choose to first get the latest version. If you do not get the latest version, the project is not checked out.

Change project or related components

Application Consultant

If a project is checked out, you can make the required changes to the project or to the related components.

Check in a project

Application Consultant

If version management is active and a project is checked out to make changes, check in the project to make the changes generally available for other environments.

As a result, the changes to the project details and related components are stored as a new project version. The project version is stored as a file in the file storage folder as defined in the Connectivity studio parameters.

Get latest project version

Application Consultant

If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.
If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone.

Get latest project version

Application Consultant

If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.
If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone.

Manage project versions - Advanced

Application Consultant

Project version management offers several advanced options. For example, to solve issues related to project versions.

Activities

Name Responsible Description

Add project to version management

Application Consultant

If version management is activated in the Connectivity studio parameters, you can add projects to version management. So, version management is only applicable to the projects that you added to version management.

If you add a project to version management, it is automatically checked out to make changes. To add the current project setup to version management as the first project version, check in the project. As a result, a version file is created and added to the folder as defined in the Business integration parameters.

Check out a project

Application Consultant

If version management is active, you must check out a project to make changes to the project or its components.
You check out a project in an environment. Each user in this environment can make changes to the checked-out project. If a project is checked out, it cannot be checked out in another environment.
You can only check out the latest project version. If you check out a project and the active version is not the latest version, you can choose to first get the latest version. If you do not get the latest version, the project is not checked out.

Change project or related components

Application Consultant

If a project is checked out, you can make the required changes to the project or to the related components.

Check in a project

Application Consultant

If version management is active and a project is checked out to make changes, check in the project to make the changes generally available for other environments.

As a result, the changes to the project details and related components are stored as a new project version. The project version is stored as a file in the file storage folder as defined in the Connectivity studio parameters.

Get latest project version

Application Consultant

If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.
If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone.

Get latest project version

Application Consultant

If in an environment, the current project version is not the latest project version, you can get the latest project version. As a result, the current project version is replaced with the latest project version.
If you have checked out a project and made changes in the current environment, you can undo these changes by doing Get latest. In this case, also the check out of the project is undone.

Manage project versions - Advanced

Application Consultant

Project version management offers several advanced options. For example, to solve issues related to project versions.

Provide feedback