Test environment deployment

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Deployment of processes and new versions > One-click Deployment >

Test environment deployment

Overview

Deploying Processes to a Test environment is strongly recommended in order to perform user-acceptance tests and certify that the Processes behave as expected.

In this section we will illustrate how to perform a deployment to the Test environment by means of the One-click Deployment featured in Bizagi.

 

Deployment00_ReleaseCandidateTest

 

 

Prerequisites

Before reading this document and launching a deployment to the Test environment, make sure you have read the prerequisites for a deployment.

Click for more information about the Previous considerations and requirements of a deployment.

 

 

Deployment to Test

Take into account that the steps and options for a deployment to Test differ if the deployment is the first deployment of the project to the Test environment or not.

 

Notice that the options presented for a deployment to Test are also slightly different to those presented for a deployment to Production.

 

 

First deployment to Test (initial deployment)

In a first deployment of a project to any environment, Bizagi will automatically create that project's environment at the target servers (create the Work Portal and the Scheduler at the Bizagi server, and the Bizagi database at the database server).

 

This means that to create a project, you should review and ensure that your servers for the test environment are configured properly to allow a new project.

 

For the first deployment of a project to the test environment, the procedure is described below.

 

1. Launch the One-click Deployment Wizard.

Go to the seventh step of the Wizard (Execute) and click on Deploy Process.

 

Deployment01_Step7

 

2. Select the target environment.

In the appearing window, mark the environment to which you want to deploy your Processes.

 

Note that when the chosen environment is Test, you may mark the Release Candidate option to lock the Processes versions in the Development environment (so that changes are not allowed to them).

Click for more information about the Release Candidate option.

 

Deployment00_Test

 

Mark the Test environment checkbox and click on Next.

 

3. Select the target server

A list of available servers with Bizagi Server Components installed will appear as icons (those which are visible to the Development server's network).

 

Select the target server for the Test environment and click on Next.

Notice you may choose to input directly the name of the server in the first server icon if the Server's name does not appear within the listed icons.

 

deploytest_selectServer

 

 

You may also choose the path where the Test environment project files will be stored.

 

You may choose for the test server, the same one you have set for the Development environment (although for proper user acceptance tests it is usually recommended to have different servers).

 

note_pin

Inputting IP addresses instead of a Server name is supported, but take into account that while using IP addresses it is necessary to ensure that the IP addresses are not dynamic.

In other words, IP address for servers involved in the configuration of the deployment must not change.

 

 

If the selected test server differs to the development server (the local one), you must ensure that you have authorized credentials to create a new environment in the target server.

 

deploytest_authentication

 

This means that: either the Windows user performing the deployment must be a member of the Administrators and Bizagi groups of the selected server, or you have at hand an authorized account for that server (belonging to those groups, as described at Deployment's previous considerations and requirements).

 

 

4. Select the Database Server.

After choosing the server, Bizagi will search for installed databases instances.

Select the target Database Server that will be used for your Test project's database.

 

You may select it from the drop-down list, or type directly the database instance's name.

For the Test environment, the project's database name is defaulted as "Test_[myProject]" but you may alter this name as well.

 

Deployment06_Testdb

 

Input the database login information and then click Next.

 

5. Configure advanced options.

Within the next window, you may define deployment options for the following advanced configuration:

 

Deployment07_Testprocesses

 

 

Relate objects: You may mark additional objects (such as entity query forms) to be explicitly included in the deployment.

If the entities marked do not have attributes, they will not be included in the deployment.

 

RelateObjects_Entities

 

Click for more information about Relating objects.

 

Add more Processes: You may choose to include more than one version of the Processes in this same deployment.

 

Deployment08_Testaddmore

 

Include users in target environment: You may choose to initially include the users from the Development environment into your target environment.

Include records of parameter entities managed in Production: You may choose to take to the target environment the values of those parameter entities which are defined to be managed in Production.

 

 

note_pin

When users are not included for the deployment to Test (the Include users in target environment option is left unmarked), then only the domain\admon user will be automatically created in the Test environment.

oThis being the case, it is necessary to ensure that the domain\admon user has proper privileges to create other users.

Processes that are not explicitly selected will not be deployed, even when they are related anywhere else.

 

 

6.  Confirm your deployment configuration.

A summary window will appear showing the configured information related to this deployment.

Notice that you may review the selection of your Processes versions to include in the deployment, as well as their related objects (as described in the step above).

 

Deployment10_Summary

 

To start the deployment click on Finish.

Notice that the wizard will prompt you to close any Bizagi Studio or Management Console instances that has this same project loaded in order to begin the deployment.

 

Deployment11_Gowarning

 

7. Finish the Deployment.

The One-click Deployment will automatically run validations and create the target environment's project.

 

Deployment11_Createproject

 

It will then notify you once the deployment procedure is completed.

 

Deployment12_Deploy

 

When this deployment finished window is shown, click on Close.

 

Deployment13_Finished

 

 

 

Once the deployment has been completed, it is possible to run the Test Work Portal by using the Execute option in the Process Wizard, in which a published URL will be available.

 
Clicking in the published environment's label will launch the Work Portal:

 

 

Deployment_TestAfter

 

 

Subsequent deployments to Test (incremental deployments)

The concept of subsequent deployments to the test environment, apply to all those deployments done after the first one to that same environment.

In other words, options presented for a test deployment which is not the very first one, will slightly vary.

 

During subsequent deployments and by default, the existing test servers (as configured in the first deployment) are basically just updated with the selected processes versions, and no new project is created.

However, this setting can be edited so that a new test environment is created (by specifying a change in the target servers, whether for its Bizagi Engine or for the database server).

 

This procedure is as follows:

 

 

1. Launch the One-click Deployment Wizard.

Go to the seventh step of the Wizard (Execute) and click on Deploy Process.

 

Deployment01_Step7

 

Remember that if your latest deployment was made to the test environment and the deployed Processes versions were marked as Release Candidate, then you will be prompted to either Apply the Release Candidate or to cancel it.

To review information about this feature, refer to Using Release Candidate for a deployment to Test.

 

2. Select the target environment.

Note that when the chosen environment is test, you may mark the Release Candidate option to lock the Processes versions in the Development environment (so that changes are not allowed to them).

 

Deployment00_Test

 

Mark the Test environment checkbox and click on Next.

 

 

3. Define options from Production environment.

At this point Bizagi will show an additional option (when there is already a running Production environment).

 

If so, you may choose to either: deploy the Processes versions to the Test environment in an isolated manner, or to initially include in the Test environment those existing Processes from Production (and then, add up the deploying Processes from Development).

 

Deployment_Second_20_Both

 

Without production Processes: The Test environment will be created with only the Processes versions selected for this deployment (incoming from the Development environment).

Include production Processes: The Test environment will be both created with the Processes versions selected for this deployment, and those which already exist in the Production environment.

When including production processes, the option Overwrite test settings with production changes will be displayed. Select this option if you want to use Production's Environment settings in your Test Environment.

 

Note that with any of the above options, there will be no existing cases in the Test environment.

 

 

4. Configure advanced options.

Within the next window, you may define deployment options for the following advanced configuration:

 

Deployment07_Testprocesses

 

 

Relate objects: You may mark additional objects (such as entity query forms) to be explicitly included in the deployment.

Click for more information about Relating objects.

 

Add more Processes: You may choose to include additional Processes version in this same deployment.

 

Deployment08_Testaddmore

 

Include users in target environment: You may choose to initially include the users from the Development environment into your target environment.

Include records of parameter entities managed in Production: You may choose to take to the target environment the values of those parameter entities which are defined to be managed in Production.

 

 

note_pin

When users are not included for the deployment to Test (the Include users in target environment option is left unmarked), then only the domain\admon user will be automatically created in the Test environment.

This being the case, it is necessary to ensure that the domain\admon user has proper privileges to create other users.

 

5.  Confirm your deployment configuration.

A summary window will appear showing the configured information related to this deployment.

Notice that you may review the selection of your Processes versions to include in the deployment, as well as their related objects (as described in the step above).

You may also choose to use a different Test server by using the Change Server option.

 

note_pin

Changing the Test environment server will set the project to continue working with the new specified server. The old Test environment will not be deleted from the previous server.

Within this option, a new project will be created at the new Test server (Bizagi will present the same configuration steps as presented when selecting the servers for a first deployment).

If you choose this option, refer to the First deployment section above.

 

 

Deployment10_Summary

 

To start the deployment click on Finish.

Notice that the wizard will prompt you to close any Bizagi Studio or Management Console that has this same project loaded in order to begin the deployment.

 

Deployment11_Gowarning

 

6. Finish the deployment.

The One-click Deployment will automatically run validations, create a backup of the current environment's database, and then update the target environment's project.

 

Deployment_Second_Backup

 

This backup is stored at the Database's backup path.

 

For Oracle databases, this path is defined by the Store database backups path set when configuring an Oracle instance to work with Bizagi.

 

For SQL Server and in a local setup, this would be: "C:\Bizagi\Projects\[your_project]\Backups").

For SQL Server and when using a remote database, this path will be usually set as: "C:\Program Files (x86)\Microsoft SQL Server\[MSSQL_instance]\MSSQL\Backup\"

 

 

The One-click Deployment will notify you once the deployment procedure is completed.

 

Deployment13_Finished

 

When this deployment finished window is shown, click on Close.

 

What happens with existing cases in the Test environment ?

Whenever a deployment to the Test environment is carried out, previous Test cases are deleted (this does not happen in the Production environment.

Amongst expected user acceptance tests for the Test environment, it is advised to test the deployed Processes with new cases.