Other utility commands

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Deployment  > Advanced Deployment > How to apply a deployment package > Apply the package using command line >

Other utility commands

Overview

The Command Line Deployment have extra methods that can be taken into account to automate some manual operations. The information will be detailed in this article:

 

1.Environment Variables configuration.

2.Passwords Encryption.

3.Force entity replication.

4.Stop components

5.Stop Scheduler

6.Start Scheduler

7.Scheduler Status

8.Scheduler backup

9.Stop Operation Service

10.Start Operation Service

11.Database backup

12.Stop IIS

13.Start IIS

14.Run Clean up

15.Stop application pool

16.Start application pool

17.Web application backup

18.Unzip patch

19.Export configuration templates.

 

1. Environment Variables configuration

Bizagi has predefined and custom variables that can be configured depending on user's needs. This functionality helps to update a project's general configuration values, which will reflect on execution behaviors. For example, if you wish to change the time it takes for Bizagi to wipe its cache, you can modify the value of the corresponding Environment Variable in order to do so.

Other

The way to specify the variables and its corresponding values is through the execution of BizagiAutomation.exe in a command line as follows:

 

BizagiAutomation.exe --runtype UpdateEnvironment --DSNDB "..." --Provider "..." –EnvironmentName "..." --BizagiValues "..." --CustomValues "..." --Config "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of the BizagiAutomation.exe program. In this case the value of this parameter is UpdateEnvironment since Environment Variables are being updated.

DSNB: Connection String to the project database. This parameter is mandatory.

When using SQL Server:

"Persist Security Info=True;User ID=[SQL_Login];Password=[Login_password];Data Source=[DB_Server]\[Named_instance];Initial Catalog=[Database];"

Consider:

o[SQL_Login]: The login account used to connect to that SQL Server database instance.

o[Login_password]: The password for the above login.

o[DB_Server]: Name or IP address of the database server. Use \[Named_instance] when applies, if your database instance is not the unnamed default one.

o[Database]: The name of the project's database.

 

When using Oracle:

"Data Source=[DB_Server]:[Port_number]/[Service];User ID=[User_schema];Password=[User_schema_password];Unicode=True;"

Consider:

o[DB_Server]: Name or IP address of the database server.

o[Port_number]: The TCP port used for the connection to the database service.

o[Service]: The service identification for an Oracle instance.

o[User_schema]: The name of the project's database.

o[User_schema_password]: The password for that user schema. It is strongly recommended to encrypt the password using Password Encryption feature.

Provider: Database client. This parameter is mandatory.

oFor Oracle databases use the following string: Oracle

oFor SQL Server databases use the following string: MSSqlClient

EnvironmentName: Type of the environment to configure. Can be: Development, Test or Production. This parameter is mandatory.

BizagiValues: predefined properties to be updated in JSON Syntax. This parameter is optional.

CustomValues: user defined properties to be set in JSON Syntax. This parameter is optional.

Log: File where the execution logs should be appended. This parameter is optional.

ErrorLogger: File where the error logs should be appended. This parameter is optional.

Config: File with the execution parameters in JSON syntax. If you use the Config file, the previous parameters are included inside the JSON. See Using the Config File.

 

Command Example

Lets us assume that you have a Custom Value in your production environment, as displayed as follows:

 

CLD_08

 

You have to register the following command:

 

BizagiAutomation.exe --runtype UpdateEnvironment --DSNDB "Persist Security Info=True;User ID=sa;Password=****;Data Source=localhost\SQLEXPRESS2017;Initial Catalog=Prod_MyProject;" –-EnvironmentName "Production" --CustomValues "{\"MyName\": \"New Value\"}" --Provider "MSSqlClient" --Log "C:\temp\log.txt" --ErrorLogger "C:\temp\Errorlog.txt"

 

Notice that the Custom Values parameter is a JSON with the double quotes escaped \"  inside.

 

--CustomValues "{\"MyName\": \"New Value\"}"

 

This updates the value of the Custom Parameter. Default values or the name cannot be updated using command  line.

 

CLD_09

 

If you have multiple values you can separate them with a coma:

 

--CustomValues "{\"Parameter name 1\": \"New Value 1\" , \"Parameter name 2\": \"New Value 2\"}"

 

If you want to update the Custom Parameter in the development environment, but in all the tabs:

 

CLD_10

 

You must change the EnvironmentName parameter of the command:

 

–-EnvironmentName "Development" for the Development tab

–-EnvironmentName "Test" for the Test tab

–-EnvironmentName "Production" for the Production tab

 

Using the Config File

This parameter is an option the user has to send the parameters to the command line program that facilitates the process. In case you want to set the parameters for the execution using a file, you have to build a config file with the following format:

 

{

   "DSNDB":"[DSNB String as it was described above]",

   "Provider":"[MSSqlClient or Oracle]",

   "environmentName": "[Development or Test or Production]",

   "bizagiValues":{

     "sendEmailCopyTo": "alex@company.com",

     "enableEmail": false,

     "interfaceThresholdTime":2500

   },

   "customValues": {

     "AdmonEmail": "user@company.com",

     "defaultHolidays": "200"

   }

}

 

When choosing to send a config file with the parameters, the user should write it before hand and execute the BizagiAutomation.exe command with the --config parameter only. Providing next to it the path to the file containing the execution parameters. For example:

 

BizagiAutomation.exe --runtype UpdateEnvironment --Config "Path to file"

 

Please note that mandatory parameters should be specified in at least one way, either on the command prompt or the config file. In case it is specified on both, Bizagi will only consider the value given in the command prompt.

 

Regarding the BizagiValues and CustomValues, take into account that:

There should at least be one value for BizagiValues and one for CustomValues for the program to execute.

All CustomValues specified must match an existing one with the same exact name.

You can set as many of them as you like, defining them in JSON format.

All the BizagiValues available are:

 

AttribMaxLengthThreshold

EmailIntegrationPassword

QueryEngineDSNDB

UploadMaxFileSize

BizagiSchedulerInterval

EmailIntegrationPort

QueryEngineProviderType

UploadPath

CacheAvailableMemoryPercentageLimit

EmailIntegrationUsername

RepDsndb

WebDavFolder

CacheExpirationCheckInterval

EmailRecipient

RepProviderType

WebDavUrl

CryptographyEncryptionAlgorithm

EnableEmail

SendEmailBccTo

WebServicesTimeOut

CryptographyHashAlgorithm

EnableEntityLog

SendEmailCopyTo

WsLegacyEnabled

CryptographyKeyUrl

EnableMMFactLog

SkipRecipients

WsSecurityEnabled

DataStoreEnabled

EnablePushNotifications

SmtpAccount

WsSecurityPassword

DisableAbortNotifications

EnableTrace

SmtpEnableSsl

WsSecurityUserName

EmailIntegrationAccount

EntityTableCacheTimeout

SmtpPassword

WsSecurityX509CertFindType

EmailIntegrationConnectionType

EntityTesting

SmtpSenderAcc

WsSecurityX509CertFindValue

EmailIntegrationEnabled

InterfaceThresholdTime

SmtpServer

WsSecurityX509CertStoreLocation

EmailIntegrationEnableSsl

Logging

SmtpType

WsSecurityX509CertStoreName

EmailIntegrationHost

ParamEntityInstancesThreshold

SoaBusinessKeyEnforcement

WsSecurityX509CertValidationMode

 

2. Passwords Encryption

Password Encryption allows you to add an extra security layer to passwords or other relevant information in your project. This feature uses SHA-2 hashing function to encrypt any text string. This feature is also available through the Work Portal and can be used in every environment. For further information on this feature via the work portal, refer to this article.

 

Just as it works in the Work Portal, Bizagi allows you to generate encrypted passwords through Command Line Automation. In order to use this functionality you just need to run the BizagiAutomation.exe command line tool with GeneratePassword runtype parameter as follows.

 

BizagiAutomation.exe --runtype GeneratePassword --Password "..." --EncryptType "..." --Log "..." --ErrorLogger "..." --Config "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case GeneratePassword is used as the value of this parameter since the need is to encrypt a password.

Password: it is used to specify the text that the user wants to encrypt. It should be passed as the value of this parameter. This parameter is mandatory and should be included in the command line or in the config file for the execution.

EncryptType: it is used to indicate the encryption type required. The different possible values are P for project file's passwords, and C for configuration file's passwords. mandatory. This parameter is mandatory and should be included in the command line or in the config file for the execution.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

Config: File with the execution parameters in JSON syntax. This parameter is mandatory when one or more mandatory parameters are not sent.

 

note_pin

The result of the execution will be the encrypted value which will be returned on the command prompt.

You can copy and paste this string wherever it is required.

 

3. Force entity replication

Bizagi can be integrated with external data sources to obtain information from other systems that an organization may already have in place. One of those mechanisms is data replication, which consists of local copies of external data sources that are updated periodically to provide current information from other systems to a Bizagi application. For more information on Data Replication refer to this article.

 

When a deployment process is done, the database will start from scratch by default. This means that there will be no information whatsoever of any entity, including replicated tables. To avoid waiting for the update process of the data replication to run and populate the required information, Bizagi provides a way to enforce the replication of the information via the Command Line Deployment.

 

To do so, you may execute the BizagiAutomation command line tool with the ForceReplication runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype ForceReplication --DSNDB "..." --Provider "..." --Config "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

Parameters enclosed in squared brackets ("[", "]") are optional. This means that the user may or may not use them for the execution.

Parameters not enclosed in squared brackets are mandatory. This parameters should be included in the command line or in the config file for the execution.

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case ForceReplication is used as the value of this parameter since the need is to enforce the replication of the external data source.

DSNB: Connection String to the project database. This parameter is mandatory.

When using SQL Server:

"Persist Security Info=True;User ID=[SQL_Login];Password=[Login_password];Data Source=[DB_Server]\[Named_instance];Initial Catalog=[Database];"

Consider:

o[SQL_Login]: The login account used to connect to that SQL Server database instance.

o[Login_password]: The password for the above login.

o[DB_Server]: Name or IP address of the database server. Use \[Named_instance] when applies, if your database instance is not the unnamed default one.

o[Database]: The name of the project's database.

 

When using Oracle:

"Data Source=[DB_Server]:[Port_number]/[Service];User ID=[User_schema];Password=[User_schema_password];Unicode=True;"

Consider:

o[DB_Server]: Name or IP address of the database server.

o[Port_number]: The TCP port used for the connection to the database service.

o[Service]: The service identification for an Oracle instance.

o[User_schema]: The name of the project's database.

o[User_schema_password]: The password for that user schema. It is strongly recommended to encrypt the password using Password Encryption feature.

Provider: Database client. This parameter is mandatory.

oFor Oracle databases use the following string: Oracle.

oFor SQL Server databases use the following string: MSSqlClient.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

Config: File with the execution parameters in JSON syntax. This parameter is mandatory when one or more mandatory parameters are not sent.

 

4. Stop components

Bizagi uses two main components to run the processes and their elements, these components are the Scheduler and the Web Application. After the deployment procedure, you may need to reset these components so they reflect the changes performed in the deployment procedure.

 

To stop the components, you may execute the BizagiAutomation command line tool with the StopComponents runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StopComponents --Project "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StopComponents is used as the value of this parameter since the need is to stop the Scheduler and the Web application components.

Project: it is used to indicate the project in which, you want to stop its components.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

5. Stop Scheduler

The Bizagi Scheduler is a service created in each Bizagi project, to carry out jobs such as: sending alarms, triggering timers (activating timed delays), and running custom jobs and Asynchronous Activities. After the deployment procedure, you may need to reset the scheduler to reflect the changes performed in the deployment procedure.

 

To stop the Scheduler, you may execute the BizagiAutomation command line tool with the StopScheduler runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StopScheduler --Project "..." --ServiceName "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StopScheduler is used as the value of this parameter since the need is to stop the Scheduler of a local or remote project.

Project: it is used to indicate the local or remote project in which, you want to stop its Scheduler service. This parameter is optional, if this parameter is not present, the ServiceName parameter is mandatory.

ServiceName: it is used to indicate the local or remote Scheduler service that you want to stop. This parameter is optional, if this parameter is not present, the Project parameter is mandatory.

ComputerName: it is used to indicate the name of the machine where you want to stop the scheduler service. This parameter is optional, if this parameter is not present, the local scheduler is stopped.

UserName: it is used to indicate the user name of the remote machine where you want to stop the scheduler service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to stop the scheduler service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

6. Start Scheduler

The Bizagi Scheduler is a service created in each Bizagi project, to carry out jobs such as: sending alarms, triggering timers (activating timed delays), and running custom jobs and Asynchronous Activities. After the deployment procedure, you may need to reset the scheduler to reflect the changes performed in the deployment procedure.

 

To start the Scheduler, you may execute the BizagiAutomation command line tool with the StartScheduler runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StartScheduler --Project "..." --ServiceName "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StartScheduler is used as the value of this parameter since the need is to start the Scheduler of a local or remote project.

Project: it is used to indicate the local or remote project in which, you want to start its Scheduler service. This parameter is optional, if this parameter is not present, the ServiceName parameter is mandatory.

ServiceName: it is used to indicate the local or remote Scheduler service that you want to start. This parameter is optional, if this parameter is not present, the Project parameter is mandatory.

ComputerName: it is used to indicate the name of the machine where you want to start the scheduler service. This parameter is optional, if this parameter is not present, the local scheduler is started.

UserName: it is used to indicate the user name of the remote machine where you want to start the scheduler service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to start the scheduler service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

7. Scheduler Status

The Bizagi Scheduler is a service created in each Bizagi project, to carry out jobs such as: sending alarms, triggering timers (activating timed delays), and running custom jobs and Asynchronous Activities. Before or after the deployment procedure, you may need to know the status scheduler service.

 

To know the Scheduler status, you may execute the BizagiAutomation command line tool with the SchedulerStatus runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype SchedulerStatus --Project "..." --ServiceName "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case SchedulerStatus is used as the value of this parameter since the need is to know the status of the Scheduler service of a local or remote project.

Project: it is used to indicate the local or remote project in which, you want to know the status of the Scheduler service. This parameter is optional, if this parameter is not present, the ServiceName parameter is mandatory.

ServiceName: it is used to indicate the local or remote Scheduler service that you want to know its status. This parameter is optional, if this parameter is not present, the Project parameter is mandatory.

ComputerName: it is used to indicate the name of the machine where you want to know the status of the Scheduler service. This parameter is optional, if this parameter is not present, the status of the scheduler is checked locally.

UserName: it is used to indicate the user name of the remote machine where you want to know the status of the Scheduler service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to know the status of the Scheduler service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

8. Scheduler backup

The Bizagi Scheduler is a service created in each Bizagi project, to carry out jobs such as: sending alarms, triggering timers (activating timed delays), and running custom jobs and Asynchronous Activities. Before the deployment procedure, you may need to take a backup of the Scheduler service in case you need to rollback the changes performed in the deployment procedure.

 

To take a backup of the Scheduler service, you may execute the BizagiAutomation command line tool with the SchedulerBackup runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype SchedulerBackup --Project "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case SchedulerBackup is used as the value of this parameter since the need is to take a backup of the Scheduler of a local or remote project.

Project: it is used to indicate the local or remote project from which you want to take the backup of the Scheduler service.

ComputerName: it is used to indicate the name of the machine where you want to take the backup of the Scheduler service. This parameter is optional, if this parameter is not present, the backup is taken from the local machine.

UserName: it is used to indicate the user name of the remote machine where you want to take the backup of the Scheduler service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to take the backup of the Scheduler service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

9. Stop Operation Service

The Bizagi Operation Service handles the communication between environments during operations such as project creation and update, deployment, licensing, nodes administration, among others. After the deployment procedure, you may need to reset it to reflect the changes performed in the deployment procedure.

 

To stop the Operation Service, you may execute the BizagiAutomation command line tool with the StopOperationsService runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StopOperationsService --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StopOperationsService is used as the value of this parameter since the need is stop the operation service of a local or remote project.

ComputerName: it is used to indicate the name of the remote machine where you want to stop the operation service. This parameter is optional, if this parameter is not present, the local operation service is stopped.

UserName: it is used to indicate the user name of the remote machine where you want to stop the operation service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to stop the operation service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

10. Start Operation Service

The Bizagi Operation Service handles the communication between environments during operations such as project creation and update, deployment, licensing, nodes administration, among others. After the deployment procedure, you may need to reset it to reflect the changes performed in the deployment procedure.

 

To start the Operation Service, you may execute the BizagiAutomation command line tool with the StartOperationsService runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StartOperationsService --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StartOperationsService is used as the value of this parameter since the need is stop the Scheduler of a local or remote project.

ComputerName: it is used to indicate the name of the remote machine where you want to start the operation service. This parameter is optional, if this parameter is not present, the local operation service is started.

UserName: it is used to indicate the user name of the remote machine where you want to start the operation service. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to start the operation service. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

11. Database backup

The Bizagi Database is where all the business data and the project's metadata is stored. Before the deployment procedure, you may need to take a backup of the database of your project in case you need to rollback the changes performed in the deployment procedure.

 

To take a backup of the project's database, you may execute the BizagiAutomation command line tool with the DatabaseBackup runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype DatabaseBackup --Project "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case DatabaseBackup is used as the value of this parameter since the need is to take a backup of a project's database.

Project: it is used to indicate the local or remote project from which you want to take the backup of the database.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

12. Stop IIS

Bizagi Studio uses Microsoft Internet Information Services (IIS) for the processes execution. After the deployment procedure, you may need to reset the IIS to reflect the changes performed in the deployment procedure.

 

To stop the IIS, you may execute the BizagiAutomation command line tool with the StopIIS runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StopIIS --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StopScheduler is used as the value of this parameter since the need is to stop the IIS of a local or remote machine.

ComputerName: it is used to indicate the name of the machine where you want to stop the IIS. This parameter is optional, if this parameter is not present, the local IIS is stopped.

UserName: it is used to indicate the user name of the remote machine where you want to stop the IIS. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to stop the IIS. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

13. Start IIS

Bizagi Studio uses Microsoft Internet Information Services (IIS) for the processes execution. After the deployment procedure, you may need to reset the IIS to reflect the changes performed in the deployment procedure.

 

To start the IIS, you may execute the BizagiAutomation command line tool with the StartIIS runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StartIIS --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StartIIS is used as the value of this parameter since the need is to start the IIS of a local or remote machine.

ComputerName: it is used to indicate the name of the machine where you want to start the IIS. This parameter is optional, if this parameter is not present, the local IIS is started.

UserName: it is used to indicate the user name of the remote machine where you want to start the IIS. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to start the IIS. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

14. Run Clean up

Bizagi stores a cache to avoid an excessive reload of components related to the work portal or other tasks related to the Bizagi execution. After the deployment procedure, you may need to clean the temporary files to reflect the changes performed in the deployment procedure.

 

To clear the temporary files of a Bizagi project, you may execute the BizagiAutomation command line tool with the RunCleanup runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype RunCleanup --Project "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case RunCleanup is used as the value of this parameter since the need is to clear the temporary files of a local or remote project.

Project: it is used to indicate the local or remote project from which you want to clear the temporary files.

ComputerName: it is used to indicate the name of the machine where you want to clear the temporary files of a Bizagi project. This parameter is optional, if this parameter is not present, the backup is taken from the local machine.

UserName: it is used to indicate the user name of the remote machine where you want to clear the temporary files of a Bizagi project. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to clear the temporary files of a Bizagi project. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

15. Stop Application Pool

The Application Pool is a component of the IIS responsible for isolating the web application of your Bizagi Project from other applications in your server. After the deployment procedure, you may need to reset the Bizagi Application Pool to reflect the changes performed in the deployment procedure.

 

To stop the Bizagi Application Pool, you may execute the BizagiAutomation command line tool with the StopAppPool runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StopAppPool --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StopAppPool is used as the value of this parameter since the need is to stop the Bizagi Application Pool of a local or remote machine.

ComputerName: it is used to indicate the name of the machine where you want to stop the Bizagi Application Pool. This parameter is optional, if this parameter is not present, the local Bizagi Application Pool is stopped.

UserName: it is used to indicate the user name of the remote machine where you want to stop the Bizagi Application Pool. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to stop the Bizagi Application Pool. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

16. Start Application Pool

The Application Pool is a component of the IIS responsible for isolating the web application of your Bizagi Project from other applications in your server. After the deployment procedure, you may need to reset the Bizagi Application pool to reflect the changes performed in the deployment procedure.

 

To start the Bizagi Application pool, you may execute the BizagiAutomation command line tool with the StartAppPool runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype StartAppPool --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case StartAppPool is used as the value of this parameter since the need is to start the Bizagi Application pool of a local or remote machine.

ComputerName: it is used to indicate the name of the machine where you want to start the Bizagi Application pool. This parameter is optional, if this parameter is not present, the local Bizagi Application pool is started.

UserName: it is used to indicate the user name of the remote machine where you want to start the Bizagi Application pool. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to start the Bizagi Application pool. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

17. Web application backup

Bizagi Work Portal is packaged in a web application hosted in your server. Before the deployment procedure, you may need to take a backup of the Bizagi Web application in case you need to rollback the changes performed in the deployment procedure.

 

To take a backup of the Bizagi Web application, you may execute the BizagiAutomation command line tool with the WebAppBackup runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype WebAppBackup --Project "..." --ComputerName "..." --UserName "..." --Password "..." --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case WebAppBackup is used as the value of this parameter since the need is to take a backup of the Bizagi Web application of a local or remote project.

Project: it is used to indicate the local or remote project from which you want to take the backup of the Bizagi Web application.

ComputerName: it is used to indicate the name of the machine where you want to take the backup of the Bizagi Web application. This parameter is optional, if this parameter is not present, the backup is taken from the local machine.

UserName: it is used to indicate the user name of the remote machine where you want to take the backup of the Bizagi Web application. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to take the backup of the Bizagi Web application. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

18. Unzip patch

Some patches are generated by the Bizagi Support team to fix or improve specific components for a given customer, these patches must be unzipped in the environment where the failure or the request was detected.

 

To unzip the patch, you may execute the BizagiAutomation command line tool with the UnzipPatch runtype specified. The command should be executed as follows.

 

BizagiAutomation.exe --runtype UnzipPatch --Source "..." --Target "..." --ComputerName "..." --UserName "..." --Password password --Log "..." --ErrorLogger "..."

 

Parameters notes and description:

runtype: it is used to specify the type of execution of BizagiAutomation command line tool. In this case UnzipPatch is used as the value of this parameter since the need is to unzip a patch in a local or remote machine.

Source: it is used to indicate the local or remote path where the zip file of the patch is located.

Target: it is used to indicate the local or remote path where the patch will be unzipped.

ComputerName: it is used to indicate the name of the remote machine where you want to unzip the patch. This parameter is optional, if this parameter is not present, the path is unzipped in the local machine.

UserName: it is used to indicate the user name of the remote machine where you want to unzip the patch. This parameter is mandatory if the ComputerName parameter is present.

Password: it is used to indicate the password of the remote machine where you want to unzip the patch. This parameter is mandatory if the ComputerName and UserName parameters are present.

Log: its value indicates the file where the execution logs are appended. This parameter is optional.

ErrorLogger: its value indicates the file where the error logs are appended. This parameter is optional.

 

19. Export configuration templates

If you are still not sure or confident enough to write the commands to perform a successful Command Line Deployment, Bizagi offers a way to generate examples of how each application should be executed. This will generate a folder containing all the examples for each of the runtypes of the BizagiAutomation tool.

 

To generate the templates execute the following lines in your command prompt.

 

BizagiAutomation.exe --runtype GenerateTemplates

 

Inside the MC tools folder, a new folder will be generated containing all the examples for each runtype.

 

1. Open a Command Prompt an navigate to MC folder (C:\Program Files\Bizagi\Bizagi Studio\MC).

 

CLD_02

 

2. Run the command described before.

 

CLD_03

 

3. Check the location stated in the command prompt and you will find the generated folder with its contents.

 

CLD_04

 

4. Each sub-folder corresponds to an application of BizagiAutomation.exe. Inside you will find an example config file, Execution (bat file) using the config file, Execution (bat file) using command prompt parameters and a ReadMe with further considerations.

 

CLD_06

 

5. Explore the generated files to understand how they work and replace the default parameters with your own in order to perform the Deployment as you need it. The .bat and config files may be opened with the text editor of your choice to see or edit their content.