WorkspaceConsole utility parameters

Medium
-help

Displays the comprehensive list of utility parameters and their brief descriptions. If you specify other parameters, the utility will ignore them.

-operation

Name of the operation to execute. Required. The default value is LoadLicResponse.

Possible values
LoadLicResponse Uploads licenses to the database specified in the connection string. The only operation that does not require the -workspaceName parameter.
SaveRepositoryContent Saves the *.zip package archives specified in the -contentTypes parameter from the directory specified in the -sourcePath parameter to the directory specified in the -destinationPath parameter.
SaveDBContent

Saves the database content to the file system. The -contentTypes parameter determines the content type. The -destinationPath parameter determines the content export path in the file system.

Requires either the -webApplicationPath or -configurationPath parameter.
SaveVersionSvnContent Dumps the package hierarchy as a set of *.zip archives. The -destinationPath parameter determines the content export path in the file system. The -sourcePath parameter specifies the SVN repositories.
RegenerateSchemaSources

Re-generates the source code and compiles it.

Requires the -confRuntimeParentDirectory parameter.
InstallFromRepository

Imports the package content and metadata from *.zip archives into the configuration. If needed, the utility will run the bound SQL scripts, re-generate the source code, install the bound data. Works exclusively with updated or new packages and their elements. Requires either the -webApplicationPath or -configurationPath parameter.

Also requires the -confRuntimeParentDirectory parameter.
InstallBundlePackages

Installs the bundle of packages listed in the -packageName comma-separated list to the workspace specified in the -workspaceName parameter.

Requires either the -webApplicationPath or -configurationPath parameter.

Also requires the -confRuntimeParentDirectory parameter.
PrevalidateInstallFromRepository Checks if installing packages from *.zip archives is possible.
ConcatRepositories Merges several repositories.
ConcatSVNRepositories Merges several SVN repositories.
ExecuteProcess

Runs the business process in the configuration if the utility detects such a process.

Requires the -confRuntimeParentDirectory parameter.
UpdatePackages

Updates the packages (-packageName parameter) in the database. Will only update the packages included in the product package hierarchy (-productPackageName parameter).

Requires either the -webApplicationPath or -configurationPath parameter.

Also requires the -confRuntimeParentDirectory parameter.
BuildWorkspace

Compiles the workspace (configuration). Use when developing schemas in Visual Studio.

Requires the -confRuntimeParentDirectory parameter.
ReBuildWorkspace

Recompiles the workspace (configuration). Use when developing schemas in Visual Studio.

Requires the -confRuntimeParentDirectory parameter.
UpdateWorkspaceSolution Updates the solution and files of the Visual Studio project.
BuildConfiguration

Generates the static content in the file system.

Uses the following parameters:

  • -workspaceName
  • -destinationPath
  • -webApplicationPath
  • -logPath
  • -force
  • -configurationPath

Requires either the -webApplicationPath or -configurationPath parameter.

Attention. Execute the BuildConfiguration operation after executing the InstallFromRepository, InstallBundlePackages, UpdatePackages operations to ensure Creatio works correctly.

-user

Username for authorization. Specify the value if there is no username in the utility's configuration file or you need to execute the operation on behalf of a different user.

-password

User password for authorization. Specify the value if there is no user password in the utility's configuration file or you need to execute the operation on behalf of a different user.

-workspaceName

Name of the workspace (configuration) where the exported packages are specified. By default, all users work in the Default workspace.

-autoExit

Specifies whether to end the utility process automatically after the operation finishes. Can be true or false. The default value is false.

-processName

Name of the process to run.

-repositoryUri

Address of the SVN repository that stores the package structure and metadata. Optional. If you specify the parameter, the utility will use 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.

Possible values
SystemData JSON data of system schemas. Dumps all system schemas and their columns except for data specified in the -excludedSchemas parameter.
ConfigurationData JSON data of configuration element schemas. Dumps all schemas except for data specified in the -excludedSchemas parameter.
Resources Localizable XML resources of configuration element schemas.
LocalizableData Localizable XML content of configuration element schemas. Dumps only the text columns. Specify additional restrictions in the -excludedSchemas and -excludedSchemaColumns parameters.
Repository ZIP workspace data.
SqlScripts SQL scripts bound to packages.
Data JSON data of system schemas and configuration element 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, packages, schemas, or resources. Can accept several values separated by commas for the ConcatRepositories and SaveVersionSvnContent operations.

-destinationPath

Path to a local directory to save the data. For example, packages, schemas, or resources.

-webApplicationPath

Path to the Creatio installation directory. The utility will follow this path to fetch the database connection information from the ConnectionStrings.config file. If you omit this parameter, the utility will connect 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 will export the source code and resources of custom package schemas to this directory in the file system development mode.

-filename

File name. Required for the LoadLicResponse operation.

-excludedSchemas

Names of configuration element schemas to exclude from the operation.

-excludedSchemaColumns

Names of the columns of configuration element schemas to exclude from the operation.

-excludedWorkspaceNames

Names of the workspaces (configurations) to exclude from the operation.

-includedSchemas

Names of configuration element schemas to forcibly include in the operation.

-includedSchemaColumns

Names of the columns of configuration element schemas 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 configuration element schema managers in the operations. The default value is EntitySchemaManager.

-packageName

Package name in the configuration specified in the -workspaceName parameter. The utility will download the packages on which the current package depends as well. If you omit the parameter, the utility will download all packages of the configuration.

-clearWorkspace

Specifies whether to clear the workspace before the update. Can be true or false. The default value is false.

-installPackageSqlScript

Specifies whether to run the SQL scripts before and after saving the packages. Can be true or false. The default value is true.

-installPackageData

Specifies whether to install the bound package data after saving the packages. Can be true or false. The default value is true.

-updateDBStructure

Specifies whether to update the database structure after saving the packages. Can be true or false. The default value is true.

-regenerateSchemaSources

Specifies whether to re-generate the source code after saving the packages to the database. Can be true or false. The default value is true.

-continueIfError

Specifies whether to abort the installation after receiving the first error. If set to true, the installation process will continue until the end. You will be able to review all errors that occurred. Can be true or false. The default value is false.

Always set the -continueIfError parameter to false for the InstallFromSvn and InstallFromRepository operations. These operations manage updated or new packages and their elements. The utility detects the updated elements 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 elements.

-skipCompile

Specifies whether to run the compilation. Will work if you set the -updateDBStructure parameter to false. Can be true or false. The default value is false.

-autoUpdateConfigurationVersion

Updates the configuration version in the database to the Creatio version. Can be true or false. The default value is false.

-warningsOnly

Specifies whether to display an error notification if the utility detects an operation execution error. Can be true or false. The default value is false.

-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:

  • RegenerateSchemaSources
  • InstallFromRepository
  • InstallBundlePackages
  • UpdatePackages
  • BuildWorkspace
  • RebuildWorkspace
  • ExecuteProcess