Introduction

The WorkspaceConsole utility is designed to work with bpm'online packages. Use the utility to:

• Export packages from development environments and migrate them to test environments or production environments (the packages are saved as archives).
• Install new packages when upgrading or migrating from development environments.
• Import and export schema resources and data for localization.
• Create workspaces and migrate them between applications.
• Work with configuration schemas.

The utility executable file (Terrasoft.Tools.WorkspaceConsole.exe) is located in the bpm'online application directory:

[Path to the catalog with installed application]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\

The build version of the utility must match the build version of the application.

ATTENTION When updating the application, the build version of WorkspaceConsole must correspond with the target build version. For example, if the current version of the bpm’online build is 7.8.2.1035, and you need to update the packages to 7.8.2.1561, then you must use version 7.8.2.1561 of the utility.

Setting up the utility

WorkspaceConsole works directly with the bpm'online application database. Thus, it is necessary to specify database connection string in the configuration file (Terrasoft.Tools.WorkspaceConsole.exe.config) for the utility to work properly.

To do this – find the name of the current database connection string in the <db> XML element of the configuration file. Change the value of the connectionString attribute in the <connectionStrings> element so that it corresponds with the value found in the ConnectionStrings.config configuration file. For more information on modifying the settings in ConnectionStrings.config file, as well as their purpose, please refer to the "How to deploy bpm'online on-site" article. Below is an example of a configured db section of the Terrasoft.Tools.WorkspaceConsole.exe.config file:

<terrasoft>
 ...
  <db>
    <general connectionStringName="db" ... />
  </db>
</terrasoft>
<connectionStrings>
 ...
  <add name="db" connectionString="Data Source=DBServer; Integrated Security=SSPI; Initial Catalog=DBName; MultipleActiveResultSets=True; Pooling=true; Async=true" />
</connectionStrings>

NOTE To perform a one-time operation with WorkspaceConsole, run the utility with the webApplicationPath parameter. Specify the path to the application directory in this parameter. In this case, the utility will independently determine all necessary database connection settings from the ConnectionStrings.config file. The database connection parameters in the Terrasoft.Tools.WorkspaceConsole.exe.config file will be ignored.

The utility requires access to bpm’online libraries to work properly. Before you begin working with the utility, copy the contents of [Path to application directory]\Terrasoft.WebApp\bin to [Path to application directory]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole.

Select the version of Terrasoft.Tools.WorkspaceConsole.exe depending on whether you are using a 32-bit or 64-bit operating system. 32-bit and 64-bit files are located in [Path to application directory]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\х86 and [Path to application directory]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\х64 folders respectively.

To avoid any possible mistakes while copying the libraries manually, the PrepareWorkspaceConsole.x86.bat and PrepareWorkspaceConsole.x64.bat batch files are supplied with the WorkspaceConsole utility. A batch file that corresponds with the operating system version will prepare the WorkspaceConsole utility automatically by copying all the necessary libraries.