WorkspaceConsole utility parameters
-help
Display the comprehensive list of utility parameters and their brief descriptions. If you specify other parameters, the utility ignores them.
-operation
The name of the operation to execute. Required. By default, "LoadLicResponse."
Available values
LoadLicResponse | Upload licenses to the database specified in the connection string. The only operation that does not require the |
SaveRepositoryContent | Save the *.zip package archives specified in the |
SaveDBContent | Save the database content to the file system. The |
SaveVersionSvnContent | Dump the package hierarchy as a set of *.zip archives. The |
RegenerateSchemaSources | Regenerate the source code and compile it. Requires the |
InstallFromRepository | Install the package from *.zip archives into the configuration. If needed, the utility runs bound SQL scripts, regenerates source code, and installs bound data. Works exclusively with updated or new packages and their schemas. Requires either the |
InstallBundlePackages | Install the bundle of packages listed in the |
PrevalidateInstallFromRepository | Check if installing packages from *.zip archives is possible. |
ConcatRepositories | Merge several repositories. |
ConcatSVNRepositories | Merge several SVN repositories. |
ExecuteProcess | Run the business process in the configuration if the utility detects such a process. Requires the |
UpdatePackages | Update the packages ( |
BuildWorkspace | Compile the workplace (configuration). Use when developing schemas in Visual Studio. Learn more: Write C# code. Requires the |
ReBuildWorkspace | Recompile the workplace (configuration). Use when developing schemas in Visual Studio. Learn more: Write C# code. Requires the |
UpdateWorkspaceSolution | Update the solution and files of the Visual Studio project. Learn more: Write C# code. |
BuildConfiguration | Generate the static content in the file system. Learn more: Set up WorkspaceConsole for compilation. Uses the following parameters:
Requires either the |
RestoreConfiguration | Restore the configuration from the package backup. Requires the |
UpdateConfiguration | Update the configuration. |
DeletePackages | Delete the packages from configuration. Requires the |
ChangeFeatureState | Change the feature status. Requires the |
ExecuteScript | Run out-of-the-box or custom executable code (*.dll). |
SetFileStorageConnectionString | Change the connection settings for an external file storage, for example, S3 or Azure Blob. This is useful to arrange automation, such as rotating credentials regularly. Requires the |
InstallApp | Install the app from *.zip archives into the configuration. If needed, the utility runs bound SQL scripts, re-generates source code, and installs bound data. Works exclusively with updated or new packages and their schemas. Requires the Since version 8.3.1, Creatio applies the same validation rules as for app installation via the Application Hub. Added the following validation rules:
|
InstallZipPackage | Install a dedicated package from *.zip archive into the configuration without generating the source code and installing dependencies. The utility runs bound SQL scripts and installs bound data. Works exclusively with updated or new packages and their schemas. Requires the Since version 8.3.1, Creatio applies the same validation rules as for app installation via the Application Hub. Added the validation rule for missing dependencies. |
Execute the BuildConfiguration operation after executing the InstallApp, InstallFromRepository, InstallBundlePackages, UpdatePackages operations to ensure Creatio works correctly.
-user
Username for authorization. Specify the value if the utility's configuration file lacks a username or you need to execute the operation on behalf of a different user.
-password
User password for authorization. Specify the value if the utility's configuration file lacks a user password or you need to execute the operation on behalf of a different user.
-featureCode
The code of the additional feature. If you change the feature absent from the database, the utility adds the corresponding record to the database table automatically. Required for ChangeFeatureState operation.
-featureState
Status of the additional feature. Required for ChangeFeatureState operation.
Available values
true | Enabled. |
false | Disabled. |
-adminUnitName
The name of the user (the Name column value in the SysAdminUnit database table) that changes the feature status. Required for ChangeFeatureState operation.
If you specify the parameter, the utility modifies the corresponding record in the AdminUnitFeatureState database table.
If you omit the parameter, the utility sets the default value for the feature (the DefaultState column value in the Feature database table).
-workspaceName
Name of the workplace (configuration) where the exported packages are specified. By default, all users work in the "Default" workplace.
-packagesToDelete
The names of packages to delete. Can take multiple values separated by commas. Specify whether to delete the package as part of the configuration update. Required for DeletePackages operation and optional for UpdateConfiguration operation.
-autoExit
Whether to end the utility process automatically after the operation finishes. By default, "false."
Available values
true | End the utility process automatically after the operation finishes. |
false | Do not end the utility process automatically after the operation finishes. |
-processName
Name of the process to run.
-repositoryUri
Address of the SVN repository that stores the package structure and properties. Optional. If you specify the parameter, the utility uses its value instead of the value of the -workspaceName parameter.
-sourceControlLogin
Login of the SVN repository user.
-sourceControlPassword
Password of the SVN repository user.
-workingCopyPath
Local directory of the working copies of packages stored in SVN.
-contentTypes
Type of content exported to the drive from the database.
Available values
SystemData | JSON data of system schemas. Dumps all system schemas and their columns except for data specified in the |
ConfigurationData | JSON data of schemas. Dumps all schemas except for data specified in the |
Resources | Localizable XML resources of schemas. |
LocalizableData | Localizable XML content of schemas. Dumps only the text columns. Specify additional restrictions in the |
Repository | ZIP workplace data. |
SqlScripts | SQL scripts bound to packages. |
Data | JSON data of system schemas and configuration schemas. The combination of "SystemData" and "ConfigurationData" values. |
LocalizableSchemaData | Data of localizable objects. |
All | All content types. |
-sourcePath
Path to a local directory from which to fetch the data. For example, apps, packages, schemas, or resources. Can accept several values separated by commas for the ConcatRepositories and SaveVersionSvnContent operations.
-destinationPath
Path to a temporary local directory to save the data. For example, packages, schemas, or resources.
-webApplicationPath
Path to the Creatio installation directory. The utility follows this path to fetch the database connection information from the "ConnectionStrings.config" file. If you omit this parameter, the utility connects to the database specified in the configuration string in the utility's configuration file.
The -webApplicationPath parameter specifies the path to the Terrasoft.WebApp directory for the BuildWorkspace, ReBuildWorkspace, and UpdateWorkspaceSolution operations.
-configurationPath
Path to the "..\Terrasoft.WebApp\Terrasoft.Configuration" directory. The utility exports the source code and resources of user-made package schemas to this directory in the file system development mode.
-backupConfiguration
Whether to back up the configuration before package installation. By default, "true." Optional for InstallFromRepository and UpdateConfiguration operations.
Available values
true | Back up the configuration before package installation. |
false | Do not back up the configuration before package installation. |
-fileName
File name. Required for the LoadLicResponse and ExecuteScript operations.
-typeName
Name of the class whose instance is required for work. Service information. For example, set the parameter value to "FileMigrator.Executor" when using FileMigrator utility. Required for the ExecuteScript operation.
-excludedSchemas
Names of schemas to exclude from the operation.
-excludedSchemaColumns
Names of the schema columns to exclude from the operation.
-excludedWorkspaceNames
Names of the workplace (configurations) to exclude from the operation.
-includedSchemas
Names of schemas to forcibly include in the operation.
-includedSchemaColumns
Names of the schema columns to forcibly include in the operation.
-cultureName
Language culture code. Required if you specify the "Resources" and/or "LocalizableData" values in the -contentTypes parameter.
-schemaManagerNames
Names of schema managers in the operations. By default, "EntitySchemaManager."
-packageName
Package name in the configuration specified in the -workspaceName parameter. The utility downloads the packages on which the current package depends as well. If you omit the parameter, the utility downloads all packages of the configuration.
-clearWorkspace
Whether to clear the workplace before the update. By default, "false."
Available values
true | Clear the workplace before the update. |
false | Do not clear the workplace before the update. |
-backupPath
Path to a local directory that contains the *.gz archives of package backups.
-installPackageSqlScript
Whether to run the SQL scripts before and after saving the packages. By default, "true."
Available values
true | Run the SQL scripts before and after saving the packages. |
false | Do not run the SQL scripts before and after saving the packages. |
-installPackageData
Whether to install the bound package data after saving the packages. By default, "true."
Available values
true | Install the bound package data after saving the packages. |
false | Do not install the bound package data after saving the packages. |
-updateDBStructure
Whether to update the database structure after saving the packages. By default, "true."
Available values
true | Update the database structure after saving the packages. |
false | Do not update the database structure after saving the packages. |
-regenerateSchemaSources
Whether to regenerate the source code after saving the packages to the database. By default, "true."
Available values
true | Regenerate the source code after saving the packages to the database. |
false | Do not regenerate the source code after saving the packages to the database. |
-continueIfError
Whether to abort the installation after receiving the first error. By default, "false."
Always set the -continueIfError parameter to "false" for the InstallFromRepository operations. These operations manage updated or new packages and their packages. The utility detects the updated packages by comparing the new and existing package structures. As such, if you run the command without specifying the -continueIfError=true key and an error occurs, then rerun the command for the same configuration, the second command will finish without errors yet will not update the database. In this case, the first operation synchronizes the package structures of the configuration and repository, meaning the second operation will be unable to detect the updated package schemas.
Available values
true | Abort the installation after receiving the first error. The installation process goes through to the end. You will receive the list of the errors encountered. |
false | Do not abort the installation after receiving the first error. |
-skipCompile
Whether to run the compilation. Will work if you set the -updateDBStructure parameter to "false." By default, "false."
Available values
true | Do not run the compilation. |
false | Run the compilation. |
-autoUpdateConfigurationVersion
Whether to update the configuration version in the database to the Creatio version. By default, "false."
Available values
true | Update the configuration version in the database to the Creatio version. |
false | Do not update the configuration version in the database to the Creatio version. |
-warningsOnly
Whether to display an error notification if the utility detects an operation execution error. By default, "false."
Available values
true | Display an error notification if the utility detects an operation execution error. |
false | Do not display an error notification if the utility detects an operation execution error. |
-confRuntimeParentDirectory
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:
RegenerateSchemaSourcesInstallFromRepositoryInstallBundlePackagesUpdatePackagesBuildWorkspaceReBuildWorkspaceExecuteProcessExecuteScriptInstallApp
-dbCommandTimeout
Set the database connection timeout for any WorkspaceConsole operation. We recommend using the -dbCommandTimeout parameter when the timeout cannot be changed using the "ConnectionStrings.config" file parameters. For example, the PostgreSQL database server by default restricts setting a timeout greater than 1024. In this case, use the -dbCommandTimeout parameter to set the PostgreSQL database connection timeout to greater than 1024.
-storageCode
Storage code specified in the File content storages lookup. Required for the SetFileStorageConnectionString operation.
-storageConnectionString
Connection string specified in the connectionString parameter of the "ConnectionStrings.config" file. Required for the SetFileStorageConnectionString operation.