The following section describes step number 4 of process deployment, as described in From Studio to the cloud.
In this step, you apply a deployment package into a target environment (e.g, testing or production).
Before you start
Before carrying out this step, make sure you and your software are ready:
•Applying a deployment package is a task that needs to be properly planned, coordinated, scheduled and communicated. It implies planned downtime for the service.
•Make sure the Automation Service environments you are going to import the package into has been created, even if it has not been in use yet (i.e., testing, production).
If you have not created a project yet, follow the steps described at Create a new project in Automation Service, and review whether you are using a Personal, or an Enterprise subscription.
The person in charge of this step should be authorized to administer Automation Service environments.
This person does NOT need to be technically skilled since no programming or IT-related tasks are involved. A self-service UI guides the person in charge of this step through the process.
Note that the Import processes option is available in the online Management portal available through your Automation Service subscription.
The person in charge of the import will need:
•To have access to the deployment package (.bex file) created in the previous deployment step.
•Internet connectivity and a browser to access the Management portal at https://manage.bizagi.com (as well as credentials with authorized access).
The person does NOT need access to Bizagi Studio (the Development environment).
What you need to do
In summary, here are the steps for applying a deployment package:
1.Access the Management portal and locate your target environment.
2.Temporarily stop your Automation Service service for the target environment (for Enterprise subscriptions).
3.Upload and apply the deployment package.
4.Verify the log to confirm a successful deployment.
5.Start up your Automation Service service for that target environment (for Enterprise subscriptions).
6.Verify your processes and service.
Follow the steps as detailed below.
1. Access the Management portal and locate your target environment
1.1. Open a browser (Chrome is preferred) and go into https://manage.bizagi.com.
Enter your authorized credentials and click Login:
1.2. Click your subscription to open it:
1.3. Locate the Run category and click Go to project board:
1.4. Locate your target environment.
Double-check that you are preparing to deploy into the correct environment.
Testing environments are identified by the icon.
Production environments are identified by the icon.
2. Temporarily stop your Automation Service service for the target environment (for Enterprise subscriptions)
2.1. Stop your chosen environment's service by clicking the Window maintenance option.
This is required for a successful deployment. We recommended that you schedule and perform deployments at non-busy hours, and announce in advance a maintenance period in which the service will not be available.
2.2. Enabling the Maintenance window option, temporarily stops the service. This makes it possible to import processes into that environment.
Confirm you are aware of the implications of enabling a Maintenance window by checking the Yes, I am sure I want to enable Maintenance checkbox and clicking Enable maintenance:
Planned downtime will start from this moment; however, it may take a minute or two to stop your environment's service:
When the services has stopped, the Maintenance window icon becomes highlighted, meaning that it is enabled:
An active environment with service up and running has this Maintenance window icon:
An environment with service stopped has this Maintenance window icon:
During an enabled Maintenance window, end users see the following screen when they access the Work portal:
3. Upload and apply the deployment package
3.1. Click Import process to upload the deployment package:
3.2. Select the .bex file containing the deployment package.
Note that the file name given has no functional significance. However, make sure you are uploading the correct file.
3.3. Double-check and explicitly confirm this action by clicking Confirm. If you own an Enterprise subscription you can View the package's content:
Uploading and applying the package results in importing processes, and may take a few minutes:
Once this is complete an Environment ready message displays at the top right corner:
You should also see the latest applied deployment package appear under the environment's name.
Even though the package has been imported, you must confimr that overall changes (imported processes, new process versions, etc.) behave as expected in your target environment.
You may rely on logs for this, if there is a problem, you can roll back a deployed package so that your environment is restored to its immediate previous state, as described next.
Rolling back a deployed package is available for non-Production environments like a testing or Staging environment.
4. Verify the log to confirm a successful deployment
4.1. Click the latest applied deployment package to view the history of applied packages for this environment:
Traceability features let you click each row if you have applied more than one deployment package. For each package, you can see the Deployment log:
The Deployment log provides the following features:
•A log for each package, regardless of whether the deployment succeeded or failed.
•The full list of deployment logs available with the most recent log at the top of the list.
•The log details the name of the package, a timestamp of its application date, and the name of the user who made the deployment.
•The latest applied package presents a icon. Click it to roll back that package and restore the environment to its previous state (not available for a Production environment and only available for Enterprise subscriptions).
•Click a row to download a previously applied package.
4.2. If you want to review not just the log, but also the deployment package you applied, you can download it.
If the download does not start automatically, make sure that run.bizagi.com is authorized to display pop-ups in your browser settings:
Once you have downloaded the deployment package, you can open it with Bizagi Studio to review the objects it contains.
5. Start up your Automation Service service for that target environment (for Enterprise subscriptions)
5.1. Start your service up again by clicking the Maintenance Window option, which should be highlighted.
This action disables the Maintenance window:
5.2. Note that disabling the Maintenance window makes the service available again to end users. Check the Yes, I am sure I want to disable the Maintenance window checkbox and click Disable maintenance:
This action can take a few minutes:
Once this is completed, The maintenance window option returns to its disabled state (its icon not highlighted).
6. Verify your processes and service
6.1. You may then click Run to review that your Bizagi service is up and running:
6.2. Once you have confirmed that your deployment was completely successful, via Bizagi confirmation messages, logs, and your own tests, you are done. You may announce to end users that your new processes and versions are available.
On the other hand, if you detect that something is not behaving as expected, or you realize that your imported deployment package did not contain the changes, or all the changes, you wanted to deploy, you can roll back the deployment (available in Enterprise subscriptions).
If you decide to roll back changes, click the latest applied deployment package and select its Restore to previous state icon:
When restoring to a previous state, keep in mind:
•This is available for changes deployed to a testing or Staging environment, not to a Production environment.
•You can roll back the latest deployed package only, and cannot restore to earlier states of the environment.
•This option is available for 30 calendar days after you import a package.
It is not available for deployed packages older than 30 days.
6.3. Restoring to a previous state undo the import of processes and changes included in the latest package. Check the Yes, I am sure I want to restore the previous state check box and click Restore package:
This action takes a few minutes. After it completes, you should verify that processes in their previous state are behaving as expected:
What should I do next?
At this point you have completed with a process deployment with Bizagi.
There is no formal next step. However we recommend that you review your deployment experience and, if necessary, adjust the preparations you make for incremental deployments in the future.
For more information about this topic, refer to Continuous improvement and incremental deployments.