Version control in Subversion

The SVN integration mechanism is turned off when file system development mode is turned on. You can only install or update packages from the SVN repository using the out-of-the-box tools. We recommend creating a package using the out-of-the-box tools and binding it to the repository using third-party tools such as TortoiseSVN.

Before you bind a package to an SVN repository when the file system development mode is turned on, make sure Creatio is configured to access the SVN repository.

1. Create a package 

To create a custom package:

1. Click to open the System Designer.
2. Click Advanced settings in the Admin area block.
3. Click in the package workspace.

4. Fill out the package properties:

   • Set Name to "sdkTestPackage."

   • Set Version control system repository to "SDKPackages."

     If you fill out the Version control system repository field, the package will be bound to the repository. When file system development mode is turned on, manually add a directory whose name matches the package name to the repository.

     If you leave the Version control system repository field empty, the package will not be bound to the repository. Connect the package from the file system manually to version the package.

   • Set Version to "7.18.0."
   

   Attention. The repository name in the package properties only indicates that third-party tools will create the directory for the package in the repository. This lets you update the package from the Configuration section.

5. Click Create and add dependencies and set the package dependencies.

2. Export the package to the file system 

To export the package to the file system:

1. Configure Creatio to work in the file system. Learn more in a separate article: External IDEs.
2. Select Download packages to file system in the File system development mode group of the action menu.
   

As a result, the packages will be downloaded along the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg path to the directory whose name matches the package name.

3. Create directories for the package in the SVN repository 

To create directories for the package in the SVN repository, use an SVN client, for example, TortoiseSvn.

To create directories for a package in the SVN repository:

1. Open the repository listed in the package properties.
2. Create a directory whose name matches the Creatio package name in the repository. In this example, this is sdkTestPackage.
   
3. Create branches and tags subdirectories in the directory.
4. Create a directory whose name matches the 7.18.0 package version number in the branches directory.
   

4. Create a working copy of the versioned package branch 

To create a working copy of the versioned package branch:

1. Export (the SVN Checkout... command) the directory created on the previous step from the repository to the package directory in the file system. In this example, this is the 7.18.0 directory.
   
2. Confirm the export to the existing directory.
   

As a result, the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkTestPackage package director in the file system will be bound to the 7.18.0 version branch of the package in the repository.

5. Commit the package to the repository 

To commit the package to the repository:

1. Add (the SVN Commit command) the contents of the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkTestPackage directory to the repository.
   
2. Commit the directory to the repository.
   

The package contains the functionality of an editable list detail.

Creatio lets you install an existing package from SVN in the file system development mode both automatically and manually.

To install the package manually:

1. Install the package into the file system.
2. Install the package into Creatio.
3. Generate source codes.
4. Compile the changes.
5. Update the database structure.
6. Install SQL scripts and bound data (optional).

To install the package automatically:

1. Ensure Creatio applies changes automatically.
2. Install the package into the file system.
3. Install the package into Creatio.

Manually install the package from SVN in file system development mode 

1. Install the package into the file system 

To install the package into the file system:

1. In the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory, create a directory with the same name as the package.
2. Export (the SVN Checkout... command) the directory created on the previous step from the repository to the package directory in the file system.
3. Specify the address of the repository that stores the package contents and the directory to export the package contents.
   

The directory name to export the package contents must match the package name.

After the export, the package working copy will be created in the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory.

2. Install the package into Creatio 

To install the package into Creatio:

1. Click to open the System Designer.
2. Click Advanced settings in the Admin area block.
3. Select Update packages from file system in the File system development mode group of the action menu.
   

As a result, the package will be added to Creatio.

Info dialog that displays the package upload status

Package in the package workspace

If the repository name is missing from the package name, you can commit the changes to the repository only from the file system.

3. Generate source codes 

To generate source codes:

1. Select Generate where it is needed in the Source code group of the action menu.
   

4. Compile the changes 

To compile the changes, click Compile on the toolbar.

You can check whether you need to update the database structure or install SQL scripts and bound data in the Status column of the Configuration section workspace.

5. Update the database structure 

To update the database structure, click Update DB structure where it is needed in the Actualize items group of the action menu.

6. Install SQL scripts and bound data (optional) 

If the package contains bound SQL scripts or data, take the corresponding steps to execute them or install it.

After the installation, the implemented package functionality will be available in Creatio. In this example, this is the functionality of an editable list detail.

You might need to clear the browser cache and refresh the page to apply the changes.

Automatically install the package from SVN in file system development mode 

1. Ensure Creatio applies changes automatically 

To ensure Creatio applies changes automatically, check whether the <appSettings> element keys in the ..\Terrasoft.WebApp\Web.config file are set to true:

• AutoUpdateOnCommit key enables the package update from the SVN repository on package commitment. If you set the key to false and modify the package schemas, then try to commit the package to the repository, Creatio warns you that an update is required.
• AutoUpdateDBStructure key enables the database structure update.
• AutoInstallSqlScript key enables the SQL scenario installation.
• AutoInstallSqlScript key enables the installation of bound data.

<appSettings>
    ...
    <add key="AutoUpdateOnCommit" value="true" />
    <add key="AutoUpdateDBStructure" value="true" />
    <add key="AutoInstallSqlScript" value="true" />
    <add key="AutoInstallPackageData" value="true" />
</appSettings>

Repeat steps 2–5 of the procedure to manually install the package from SVN in file system development mode.

Configure interaction with the SVN repository (optional) 

Creatio lets you configure interaction with the SVN repository both from the Configuration section and file system.

To configure interaction with the SVN repository:

1. Click to open the System Designer.
2. Click Advanced settings in the Admin area block.
3. Install the package from the SVN repository. Learn more in a separate article: Version control in Creatio IDE.
4. Download the package to the file system. Learn more in a separate article: Set up Creatio to work with the file system.

Repeat steps 3–6 of the procedure to manually install the package from SVN in file system development mode.

You can bind a package from the file system to the repository only in Creatio on-site. After binding a package to SVN, you can install the package into the file system using the out-of-the-box Creatio tools.

1. Download the package to the file system 

To download the package to the file system:

1. Configure Creatio to work in the file system. Learn more in a separate article: External IDEs.
2. Select Download packages to file system in the File system development mode group of the action menu.
   

As a result, all packages will be downloaded along the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg path to the directory whose name matches the package name.

2. Create directories for the package in the SVN repository 

To create directories for the package in the SVN repository, use an SVN client, for example, TortoiseSvn.

To create directories for the package in the SVN repository:

1. Open the repository specified in the package properties.
2. Create a directory whose name matches the package name in Creatio in the repository. In this example, this is sdkUnboundPackage.
   
3. Create branches and tags subdirectories in the created directory.
4. Create a directory whose name matches the package version number (7.18.0) in the branches directory.
   

3. Create a working copy of the versioned package branch 

To create a working copy of the versioned package branch:

1. Export (the SVN Checkout... command) the directory created on the previous step from the repository to the package directory in the file system. In this example, this is the 7.18.0 directory.
   
2. Confirm the export to an existing directory.
   

As a result, the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkUnboundPackage package directory in the file system will be bound to the branch of the 7.18.0 package version in the repository.

4. Commit the package directory to the repository 

To commit the package directory to the repository:

1. Add the contents of the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkTestPackage directory to the repository.
   
2. Commit the directory to the repository.
   

1. Connect the SVN repository to Creatio 

If the SVN repository is connected to Creatio, proceed to the next step.

To connect the SVN repository to Creatio:

1. Click to open the System Designer.
2. Click Advanced settings in the Admin area block.
3. Select Open list of repositories in the SVN repositories group of the action menu.
   
4. Click Add and add a repository. In this example, the repository is .../SDKPackages.
   
5. Click Authenticate.

2. Bind the repository to the package 

To bind the repository to the package:

1. Open the Creatio database.
2. Run an SQL query in the database.
   Example of an SQL query

   UPDATE SysPackage 
   SET 
       [SysRepositoryId] = 
       (
           select top 1 Id from SysRepository
           where Name = 'SDKPackages'-- Repository name. 
       )
   where [Name]='sdkUnboundPackage'-- Name of the custom package.  
   

   This query executes the following actions:

   • Gets the ID of the record that contains the SVN repository location from the [SysRepository] table.
   • Adds the ID to the [SysPackage] database table’s record whose [SysRepositoryId] column contains the name of the package not bound to the SVN repository.

Log out from Creatio and log back in to apply the changes.

3. Download the package to the file system 

To download the package to the file system:

1. Configure Creatio to work in the file system. Learn more in a separate article: External IDEs.
2. Select Download packages to file system in the File system development mode group of the action menu.
   

As a result, Creatio will download the packages along the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg path to the directory that has the corresponding package name.

1. Update the package from the SVN repository 

To get the latest package revision, use an SVN client, for example, TortoiseSvn.

To update the package from the SVN repository:

1. Select the needed package in the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory. In this example, this is sdkPackageInFileSystem.
2. Update the package (the SVN Update command).

   As a result, the package edit date in the descriptor.json package descriptor file and UsrGreetingService schema source code of the Source code type will be updated.

   UsrGreetingService schema

   namespace Terrasoft.Configuration
   {
       using System.ServiceModel;
       using System.ServiceModel.Activation;
       using System.ServiceModel.Web;
       [ServiceContract]
       [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
       public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
       {
           [OperationContract]
           [WebInvoke(Method = "GET", UriTemplate = "Hello")]
           public string TestHello()
           {
               return "Hello!";
           }
       }
   }    
   

3. Click to open the System Designer.
4. Click Advanced settings in the Admin area block.
5. Select Update packages from file system in the File system development mode group of the action menu.
   
6. If object schemas or source code schemas were changed, take steps 3–6 in the Install an SVN package in the file system development mode article as well.

2. Modify the package contents 

To modify the package contents, add the TestHelloWorld() method to the UsrGreetingService schema of the Source code type.

namespace Terrasoft.Configuration
{
    using System.ServiceModel;
    using System.ServiceModel.Activation;
    using System.ServiceModel.Web;
    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
    {
        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "Hello")]
        public string TestHello()
        {
            return "Hello!";
        }

        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "HelloWorld")]
        public string TestHelloWorld()
        {
            return "Hello world!";
        }
    }
}

3. Commit the package to the repository 

To commit the package to the repository:

1. Select the needed package in the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory. In this example, this is sdkPackageInFileSystem.
2. Commit (the SVN Commit command) the directory to the repository.
   

The example requires understanding of the difference between development modes.

General recommendations:

• Work with the SVN repository only using the file system in the file system development mode.
• Work with the SVN repository only using the Configuration section tools in the development mode that uses out-of-the-box tools.

1. Add the directory path for working copies of packages 

In the file system development mode, the Download packages to file system action downloads the custom packages to the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory. However, the contents of the custom package downloaded to the file system are not bound to the SVN repository even if you bind the package to the repository in the Configuration section.

If you fill out the Version control system repository field using the out-of-the-box tools when creating a package, the package is bound to the SVN repository. This also creates a working copy of the package in the file system. Set the path to the directory where to create the working copies of packages in the defPackagesWorkingCopyPath attribute of the ConnectionStrings.config configuration file. If you set the path to the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory in the defPackagesWorkingCopyPath attribute, the package is bound to the SVN repository automatically after you download the package to the file system.

To set the path to the directory for working copies of packages, set the full path to the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory in the defPackagesWorkingCopyPath setting of the ConnectionStrings.config file.

<?xml version="1.0" encoding="utf-8"?>
<connectionStrings>
  ...
  <add name="defPackagesWorkingCopyPath" connectionString="C:\creatio\Terrasoft.WebApp\Terrasoft.Configuration\Pkg"/>
  ...
</connectionStrings>

This change lets you merge the directory that contains working copies of custom packages and directory where packages are downloaded in the file system development mode.

2. Create a package 

To create a custom package:

1. Click to open the System Designer.
2. Click Advanced settings in the Admin area block.
3. Click in the package workspace.

4. Fill out the package properties:

   • Set Name to "sdkPackageForFileSystem."
   • Set Version control system repository to "SDKPackages."
   • Set Version to "7.18.0."
   
5. Click Create and add dependencies and install the package dependencies.

As a result, the package will be committed to SVN automatically, and a working copy of the package will be created in the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg directory.

3. Download the package to the file system 

To download the package to the file system:

1. Configure Creatio to work in the file system. Learn more in a separate article: External IDEs.
2. Select Download packages to file system in the File system development mode group of the action menu.
   

As a result, the packages will be downloaded along the ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg path to the directory whose name matches the package name.

4. Commit the package to the repository 

To commit the package to the repository:

1. Add (the SVN Commit command) the contents of the ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkPackageForFileSystem directory to the repository.
   
2. Commit the directory to the repository.