Upgrade Workflow Database

Available with Workflow Manager license.

Summary

Upgrades an existing Workflow Manager (Classic) database with the latest schema and configuration. The Workflow Manager (Classic) database is used to store the job and configuration information for your work management system and one feature class that is used to store the geometries for the Location of Interest (LOI) for your jobs.

In Workflow Manager (Classic) databases created with an earlier version than 10.3, a group named Administrator is created with the AdministratorAccess privilege. The user running the tool is added to the Administrator group, which grants the user administrator access. For more information about Privileges, see Privileges. Administrator access means the current user can connect to the selected database through the Workflow Manager Administrator to make edits to components of your system. The existing Workflow Manager (Classic) system settings are preserved during the upgrade.

Note:

The Workflow Manager (Classic) system tables are geodatabase tables and are registered with your enterprise geodatabase. Thus, it is strongly advised that you not delete or modify these tables using your RDBMS tools.

Note:

If upgrading a 10.0 Workflow Manager (Classic) database, see Upgrading an existing Workflow Manager (Classic) system for additional instructions.

Usage

• When upgrading a Workflow Manager (Classic) database, an owner user account with privileges—including Update, Insert, Select, and Delete—is required, and a direct connection file (.sde) to the enterprise database must be used.

  Note:

  The Update, Insert, Select, and Delete privileges are equivalent to those granted to the data creator user. These database-level permissions should be assigned by your database administrator for the Workflow Manager (Classic) database.

• The Upgrade Workflow Database tool updates system tables, adding new fields and tables that are part of the new schema. The following configuration elements are also updated.

  • Privileges
  • Groups
  • Status Types
  • Activity Types
  • Notification Types
  • Settings
  • Priorities
  • Holds

• The User Store parameter defines from which user store the user and role information is imported. You have two options to obtain the information: Portal and Traditional. When Portal is selected, the users are retrieved from an existing portal and added to the Workflow Manager (Classic) repository. When Traditional is selected, the users and group roles are defined by the Administrator in the Workflow Manager Administrator. These roles may be imported from an Active Directory or created manually.

  Note:

  To import the user store information from a Portal, you must be logged in to the portal.

Syntax

arcpy.wmx.UpgradeWorkflowDatabase(Input_Database_Connection, {User_Store})

Parameter	Explanation	Data Type
Input_Database_Connection	The location of the enterprise geodatabase connection file to the Workflow Manager (Classic) database, which contains Workflow Manager (Classic) system tables. The connection file must connect directly to the database and the connection should be made as a database owner.	Workspace
User_Store (Optional)	The user store from which to retrieve the users and roles. The users can be imported from a portal and are assigned to roles created in the Workflow Manager (Classic) repository. The portal user profile information cannot be edited using Workflow Manager Administrator. The users and roles can be created in the Workflow Manager (Classic) repository using the Traditional option. When using the Traditional option, the users and roles may be imported from the Active Directory in Workflow Manager Administrator. If no option is selected, Traditional is used by default. PORTAL —The users will be imported from the portal you are currently signed in to. TRADITIONAL —The users and roles will be created in the Workflow Manager (Classic) repository using Workflow Manager Administrator. Users and roles can be imported from the Active Directory when this option is used.	String

Derived Output

Name	Explanation	Data Type
Output_DatabasePath	The output database file (.jtc) with Workflow Manager (Classic) schema. The .jtc file is stored in the Workflow Manager (Classic) Database folder.	File

Code sample

UpgradeWorkflowDatabase example 1 (stand-alone script)

This script upgrades an existing Workflow Manager (Classic) database to the latest schema, and the user store is set up in Workflow Manager Administrator. Since no database configuration keyword is specified, DEFAULTS will be used by the tool.

# Import arcpy module
import arcpy

# Local variables:
Input_Database_Connection = r'C:\wmxrepository.sde'
User_Store = 'TRADITIONAL'

# Process: Upgrade Workflow Database
arcpy.UpgradeWorkflowDatabase_wmx(Input_Database_Connection, "", User_Store)

UpgradeWorkflowDatabase example 2 (stand-alone script)

This script upgrades an existing Workflow Manager (Classic) database to ArcGIS Pro schema, and the user store is imported from a portal you are currently signed in to. The database configuration keyword WMX is utilized.

# Import arcpy module
import arcpy

# Local variables:
Input_Database_Connection = r'C:\wmxrepository.sde'
Config_keyword = 'WMX'
User_Store = 'PORTAL'

# Process: Upgrade Workflow Database
arcpy.UpgradeWorkflowDatabase_wmx(Input_Database_Connection, Config_keyword, User_Store)

Environments

• Output CONFIG Keyword

Licensing information

• Basic: No
• Standard: Requires Workflow Manager
• Advanced: Requires Workflow Manager