Migrate files between database and external file storages

Level: advanced

FileMigrator is a utility that migrates Creatio files between database and external file storages. For example, S3 or Azure Blob file storage.

If you use Creatio in the cloud, contact Creatio support to migrate files.

Before you migrate files between file storages in Creatio on-site, set up a connection to the external storage. Out of the box, Creatio can be integrated with S3 and Azure Blob file storages. Instructions: Use external files storages.

View an example that migrates files from Creatio database to the S3 file storage below. To do this:

1. Install the WorkspaceConsole utility. Instructions: Set up the WorkspaceConsole utility (developer documentation). Skip this step if you already have the utility installed.

2. Receive the FileMigrator.dll file. To do this, contact Creatio support (support@creatio.com).

3. Copy the FileMigrator.dll file to the ..\Terrasoft.WebApp\DesktopBin\WorkspaceConsole directory.

4. Migrate files.

   For this example, migrate files from Creatio database to the S3 file storage. To do this:

   1. Open the ..\Terrasoft.WebApp\DesktopBin\WorkspaceConsole directory.

   2. Run the command that migrates files. Structure the command as follows:

      For .NET Framework

      [Path to WorkspaceConsole]\Terrasoft.Tools.WorkspaceConsole.exe -operation=ExecuteScript -fileName=FileMigrator.dll -typeName=FileMigrator.Executor -workspaceName=Default -confRuntimeParentDirectory="[Path to the directory that contains an installed Creatio instance]\Terrasoft.WebApp" -logPath=[Path to the directory that contains log files] -sourceStorage="[Storage name]" -targetStorage="[Storage name]" -excludeSchemaNames="[List of schemas to exclude from the operation]" -schemaNames="[List of schemas to include in the operation]" -numberOfFiles=[Number of files to migrate] -autoExit=true

      For .NET 6

      dotnet [Path to WorkspaceConsole]\Terrasoft.Tools.WorkspaceConsole.dll  -operation=ExecuteScript -fileName=FileMigrator.dll -typeName=FileMigrator.Executor -workspaceName=Default -confRuntimeParentDirectory="[Path to the directory that contains an installed Creatio instance]" -logPath=[Path to the directory that contains log files] -sourceStorage="[Storage name]" -targetStorage="[Storage name]" -excludeSchemaNames="[List of schemas to exclude from the operation]" -schemaNames="[List of schemas to include in the operation]" -numberOfFiles=[Number of files to migrate] -autoExit=true

      View the WorkspaceConsole parameters for migrating files in the table below.

      Parameter	Parameter value	Parameter description
      -operation	ExecuteScript	Runs out-of-the-box or custom executable code (*.dll). Required.
      -fileName	FileMigrator.dll	The path to the FileMigrator.dll file. Required.
      -typeName	FileMigrator.Executor	FileMigrator.Executor class whose instance is required for work. Service information. Required.
      -workspaceName	Default	The name of the workspace (configuration). Out of the box, all users work in the “Default” workspace. Required.
      -confRuntimeParentDirectory	For .NET Framework: [Path to the directory that contains an installed Creatio instance]\Terrasoft.WebApp For .NET 6: [Path to the directory that contains an installed Creatio instance]	Path to the parent directory of the ..\Terrasoft.WebApp\conf directory. You must use the parameter in commands that compile Creatio or generate the static content. Required.
      -logPath	[Path to the directory that contains log files]	The utility saves the operation log file to this directory. The file name consists of the operation start date and time. Optional.
      -sourceStorage	[Storage name]	Type of storage from which files are migrated. Find the list of all the available values in the “Code” column of the File content storages lookup. To migrate files from Creatio database to the S3 file storage, set -sourceStorage parameter to Database. Required.
      -targetStorage	[Storage name]	Type of storage to which files are migrated. Find the list of all the available values in the “Code” column of the File content storages lookup. To migrate files from Creatio database to the S3 file storage, set -targetStorage parameter to S3_storage. Required.
      -excludeSchemaNames	[List of schemas to exclude from the operation]	List of configuration element schemas whose files to forcibly exclude from the operation. Can accept multiple values separated by semicolon. Use the parameter to exclude files in listed objects from migration. Optional. If you omit the parameter, the utility migrates all files from Object schema type that inherit the “File” object schema. As a rule, the names of these schemas contain the “File” suffix. To migrate files with exception, for example, do not migrate files of the Contacts section, use the "ContactFile" parameter value. “ContactFile” object schema stores files from the contact attachments. The utility will migrate all files except files of the Contacts section.
      -schemaNames	[List of schemas to include in the operation]	List of configuration element schemas whose files to exclude from the operation. Can accept multiple values separated by semicolon. Use the parameter to migrate only files in listed objects. Optional. If you omit the parameter, the utility migrates all files from Object schema type that inherit the “File” object schema. As a rule, the names of these schemas contain the “File” suffix. For example, “ContactFile” object schema that stores files from the contact attachments.
      -numberOfFiles	[Number of files to migrate]	Number of files to migrate. Use the parameter to migrate files in multiple stages. If you omit the parameter, the utility migrates all files. Optional.
      -autoExit	true or false	Specify whether to finish the utility process automatically after performing the operation. The default value is false. Optional.

As a result, Creatio will migrate files from database to S3 file storage. If the files were migrated successfully, the utility automatically deletes the files from the database. After you integrate S3 file storage and migrate files to it, Creatio will store all files in the file storage.

If the error occurs while you migrate the files, FileMigrator utility:

• Finishes the file migration procedure.
• Logs an error for each file.
• Keeps the file that caused the error in the initial storage.

If you migrate files from external file storage to Creatio database, migrated files will remain in the external file storage. If needed, delete the migrated files manually.

---

See also

Use external files storages

Delivery using the WorkspaceConsole utility (developer documentation)