How to update the default workflow
On this page
An in-place upgrade keeps your existing workflow and applies selected updates. It does not install the complete Default Workflow of the new version. To replace your workflow with the complete Default Workflow, create a pilot database and choose Install Default Workflow in the Database Management wizard. Test and adapt the workflow in the pilot, then move it to production by switching the pilot to production or exporting and importing its workflow. Both methods are described below.
Consider replacing your workflow when it no longer serves your processes, when an installation upgraded over several years lacks features you want to use, or when several administrators have changed the workflow and you are unsure what it does now. For what the Default Workflow includes, see Default Workflow Configuration.
IMPORTANT: Install Default Workflow replaces the workflow in the new pilot database, including customizations. Plan to re-create the customizations you need. Review what is deleted and what is kept before choosing this option. Creating the pilot leaves production unchanged.
Before you begin
- Every path of the Database Management wizard requires a SQL Server login that is a member of the sysadmin fixed server role. Otherwise the wizard stops with "You must be a member of the sysadmin role on the specified SQL Server instance. Please contact your system administrator."
- The pilot route accepts an Alloy Navigator database of version 6.0 or later. The pilot steps are not available on Azure SQL, where the Upgrade Scenario page hides Pilot Upgrade and selects Production Upgrade.
- The choice is offered only when you migrate an Alloy Navigator database into a new pilot database with Create Pilot Database. It is not part of an in-place upgrade and cannot be reached from one, and it cannot be reached from Update Pilot Data or Switch to Production.
- To sign in to the Settings App, your account needs the Basic Administrative Access permission; see Work in the Settings App.
Know what you keep and what you lose
Install Default Workflow replaces the pilot's workflow configuration, including forms, templates, and workflow parameter values. Dashboards, their role assignments, role memberships, personal views, and existing business records are preserved. For the detailed list of what is deleted and what is kept, see Upgrade Considerations.
On a migration from version 6 or 7, Create Pilot Database with Install Default Workflow empties the Workflow Log. On a database below version 8.0.0, it also points the Alloy Discovery Connector jobs at three 8.0.0 Alloy Discovery Connector actions and two Chromebook actions, and deletes the other Alloy Discovery Connector create and update actions, apart from the exceptions listed there, and every other Chromebook action; see Upgrade Overview.
Your production database is not touched by any of this: Create Pilot Database leaves the production database as it was. For the full comparison with what an upgrade keeps, see Upgrade Considerations and Default Workflow Configuration.
Upgrade the production database in place (optional)
You can first upgrade the production database to the new version with Production Upgrade. The in-place upgrade accepts a database of version 8.0.0 or later and keeps your workflow; it cannot install the Default Workflow of the new version. See Upgrade a Production Installation.
Install the server components for the pilot
Install the new Alloy Navigator server components with the Alloy Navigator setup program; see Upgrade Through a Pilot Database.
Create a pilot database with the Default Workflow
In the Database Management wizard:
- Start the Database Management wizard. On the Task page, Upgrade your existing database, the button above the Manage Existing Database label, is preselected.
- On the Source Database page, specify the production database.
- If the Upgrade Scenario page appears, choose Pilot Upgrade. The page appears for a database of version 8.0.0 or later that is older than the wizard. For a database of an earlier version, or one already at the wizard's version, the wizard goes straight to the pilot page.
- On the Pilot Upgrade page, click Create Pilot Database. The page is titled Pilot Testing when the production database is already at the wizard's version.
- On the Target Database page, enter a name for the pilot database in Database. If a database of that name already exists, the wizard asks "The database '<name>' already exists. Delete the database?" and deletes it only when you click Yes.
- If you use the advanced options on the Target Database page, complete the Database Files page.
- On the Workflow Upgrade page, which reads "Choose how to upgrade your workflow and business logic.", select Install Default Workflow: "Remove your existing workflow and replace it with the default workflow that comes with the latest version of the product." Keep Existing Workflow ("Keep your existing workflow.") is preselected. Alloy recommends Install Default Workflow, although the wizard preselects Keep Existing Workflow.
- If the New Permissions page appears, grant each new permission to roles with its check box. The page is shown only when permissions were introduced after the production database's version.
- On the Backup Location page, enter the backup file of the production database in Back up the production database to:. The file is created on the computer where SQL Server runs. This backup cannot be turned off.
- Complete the Database Account and Database Access Key pages.
- On the Ready to Proceed page, start the run. After the run, click Finish on the Summary page.
Create Pilot Database restores the backup of the production database into the pilot database, turns off every job of the pilot except the business rules (Trigger On Condition jobs), and pauses sending from the pilot's notification queue. The wizard does not turn any job on again.
Test and adapt the workflow in the pilot
Install and configure the web applications for the pilot, start the Automation Server and the Inventory Server for the pilot, and test the pilot database; see Install the web applications for the pilot and Test the pilot. While you test, the notifications that the pilot creates are queued but not sent. If you turn a job on in the pilot, it still has its production settings, such as its mailbox and inventory connection.
Evaluate the new workflow and change it in the pilot as you need; for what workflow is made of, see Workflow Overview. To refresh the pilot with current production data, run Update Pilot Data. It puts the pilot's own configuration back after it copies the production data, so your work on the pilot's workflow is kept, and you can repeat it. Configuration you change in production after you created the pilot is not carried over.
Move the workflow to production
Use one of these ways.
Switch the pilot to production
When the pilot is ready, take the production system down, run Switch to Production in the Database Management wizard, move the web applications to production, and finish the switchover; see Take the production system down, Switch to production, Move the web applications to production, and Finish the switchover. Switch to Production copies the production data onto the pilot and puts the pilot's configuration back, including its jobs, so the pilot's workflow becomes the production workflow. Configuration changed in production after the pilot was created is not carried over.
Export the workflow from the pilot and import it into production
In the Settings App, signed in to the pilot database:
- On the File > Export and Import submenu, click Export All Settings....
- On the Create a complete workflow pack page, keep Mark the output file as complete (preselected). Only a complete file offers to overwrite the existing workflow when it is imported.
- Select the file in Export Configuration To.
- Enter a description, and finish the wizard. A finished export shows "Export completed successfully."
In the Settings App, signed in to the production database:
- On the File > Export and Import submenu, click Import Settings... and select the file in the Import Configuration From dialog.
- On the page that says "The file contains a complete workflow pack for <scope>.", select Overwrite the existing workflow for <scope>.
- In the Backup group, keep Enable backup selected, and select the backup file in Back up to:.
- Click Import.
With Overwrite the existing workflow selected, an enabled backup of all settings is exported first as a complete pack. Then the non-system workflow configuration of the pack's class is deleted, or of every class when the class is not found, and the file is loaded. A security role that an imported record refers to is written from the file only when the database does not already hold it; an existing role is never overwritten. For what else can block an import, see Export and Import Configuration.
Result
Your production database runs the Default Workflow of the new version, or the workflow you built from it in the pilot.