Create Workflow Database (Workflow Manager)

Available with Workflow Manager license.

Summary

Creates Workflow Manager (Classic) schema and configures an enterprise geodatabase as the Workflow Manager (Classic) database.

The Workflow Manager (Classic) database is used to store the job and configuration information for your work management system. Creating a Workflow Manager (Classic) database is an administrative activity that creates the Workflow Manager (Classic) schema in the specified enterprise geodatabase. The Workflow Manager (Classic) database schema consists of system tables and one feature class that is used to store the geometries for the area of interest (AOI) for your jobs.

Note:

The Workflow Manager (Classic) system tables created by this tool are geodatabase tables that are registered with your enterprise geodatabase. It is recommended that you do not delete or modify these tables using your database tools.

Note:

The Workflow Manager (Classic) repository name is based on the database instance name and user name, for example, <instance name>_<username>. If operating system authentication is used, the name of the user logged in to the system will be used.

Usage

• When creating a Workflow Manager (Classic) database, a data creator user account with Update, Insert, Select, and Delete privileges is required, and a direct connection file (*.sde) to the enterprise geodatabase must be used.

  Note:

  The Update, Insert, Select, and Delete privileges are database-level permissions and should be assigned by your database administrator for the Workflow Manager (Classic) database.

• When creating the Workflow Manager (Classic) database, define a spatial reference for the AOI feature class. The spatial reference chosen for the AOI feature class is applied to all AOIs in the Workflow Manager (Classic) database. It is recommended that you use a global spatial reference if the AOIs of your jobs are going to be in different locations of the world.

  Note:

  For more information about the Workflow Manager (Classic) AOI, see Specify a location of interest.

• When creating a Workflow Manager (Classic) database, a configuration with the Workflow Manager (Classic) elements is imported. The Import Configuration parameter provides the following three options to import a configuration into the new Workflow Manager (Classic) database:

  • Minimum Configuration—Imports the basic elements the Workflow Manager (Classic) system requires to function properly. The file required for the import is included as part of the Workflow Manager (Classic) installation. The following is a list of imported elements:
    • Privileges
    • User Groups - Only Administrator group
    • Status Types
    • Activity Types
    • Job Notification Types
    • Settings
    • Priorities
    • Hold Types
  • Quick Configuration—Imports all elements in the Minimum Configuration option as well as samples of the other elements. The file required for import is included as part of the Workflow Manager (Classic) installation. The samples are as follows:
    • Users
    • User Groups
    • Job Queries
    • Step Types
    • Hold Types
    • Settings
    • Job Types
    • Default Properties
    • Workflows
    • Naming Schemas
  • Custom Configuration—Imports a configuration from an existing Workflow Manager (Classic) database. You can generate the file required for import by exporting the configuration from an existing Workflow Manager (Classic) database.

    Learn more about exporting configuration files

    Learn more about exporting a configuration with jobs

• Check with your database administrator for information about a database configuration keyword to be used if a specific keyword has been set up for Workflow Manager (Classic). If no configuration keyword is specified, the DEFAULTS keyword is used.

• The User Store parameter defines the user store from which the user and role information is imported. When Portal is chosen, the users are retrieved from an existing portal and added to the Workflow Manager (Classic) repository. When Traditional is chosen, the users and group roles are defined by the administrator in ArcGIS Workflow Manager (Classic) Administrator. The roles can be imported from an Active Directory or created manually.

  Note:

  To import the user store information using the Portal option, you must be signed in to the portal.

• The output is a database file (.jtc) with the Workflow Manager (Classic) schema.

  The .jtc file is stored in the Project folder.

Syntax

arcpy.wmx.CreateWorkflowDatabase(Input_Database_Connection, AOI_Spatial_Reference, Import_Configuration, Input_Custom_Configuration, {User_Store})

Parameter	Explanation	Data Type
Input_Database_Connection	The location of the enterprise geodatabase connection file that will host the Workflow Manager (Classic) schema and configuration. The connection file must connect directly to the database, and the connection should be made as a database owner.	Workspace
AOI_Spatial_Reference	The spatial reference of the AOI feature class. You can specify the spatial reference in the following ways: Input the path to a .prj file, such as c:/workspace/watershed.prj. Define a spatial reference object—such as AOI_Spatial_Reference = arcpy.SpatialReference("c:/data/Africa/Carthage.prj") or AOI_Spatial_Reference = arcpy.SpatialReference('WGS 1984')—prior to using this tool, which you then use as the spatial reference parameter.	Coordinate System
Import_Configuration	Specifies the Workflow Manager (Classic) elements to be imported into the new Workflow Manager (Classic) database. The default is Minimum configuration (Minimum Configuration in Python). Minimum Configuration —Imports the basic elements that the Workflow Manager (Classic) system requires. Quick Configuration —Includes the Minimum Configuration elements plus samples for several elements. Custom Configuration —Specifies a Workflow Manager (Classic) configuration file in the Input Custom Configuration parameter, exported from a preexisting database.	String
Input_Custom_Configuration	A custom configuration file that was exported from an existing Workflow Manager (Classic) database.	File
User_Store (Optional)	Specifies the user store from which the users and roles will be retrieved. 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 ArcGIS Workflow Manager (Classic) 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 can be imported from the Active Directory in ArcGIS Workflow Manager (Classic) Administrator. 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 ArcGIS Workflow Manager (Classic) Administrator. Users and roles can be imported from the Active Directory when this option is used. This is the default.	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 Project folder.	File

Code sample

CreateWorkflowDatabase example 1 (stand-alone script)

This script creates and sets up a Workflow Manager (Classic) database in an existing enterprise geodatabase, and the user store is set up in the ArcGIS Workflow Manager (Classic) 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'
AOI_Spatial_Reference = arcpy.SpatialReference('WGS 1984')
Import_Configuration = 'Quick Configuration'
User_Store = 'Traditional'

# Process: Create Workflow Database
arcpy.CreateWorkflowDatabase_wmx(Input_Database_Connection, 
                                 AOI_Spatial_Reference, Import_Configuration, 
                                 "", "", User_Store)

CreateWorkflowDatabase example 2 (stand-alone script)

This script creates and sets up a Workflow Manager (Classic) database in an existing enterprise geodatabase, and the user store is imported from a portal you are currently signed in to. The database configuration keyword WMX is used.

# Import arcpy module
import arcpy

# Local variables:
Input_Database_Connection = r'C:\wmxrepository.sde'
AOI_Spatial_Reference = arcpy.SpatialReference('WGS 1984')
Import_Configuration = 'Minimum Configuration'
Config_keyword = 'WMX'
User_Store = 'Portal'

# Process: Create Workflow Database
arcpy.CreateWorkflowDatabase_wmx(Input_Database_Connection, 
                                 AOI_Spatial_Reference, Import_Configuration, 
                                 "", Config_keyword, User_Store)

CreateWorkflowDatabase example 3 (stand-alone script)

This script creates and sets up a Workflow Manager (Classic) database in an existing enterprise geodatabase, and the user store is imported from a portal you are currently signed in to.

# Import arcpy module
import arcpy

# Local variables:
Input_Database_Connection = r'C:\wmxrepository.sde'
AOI_Spatial_Reference = arcpy.SpatialReference('WGS 1984')
Import_Configuration = 'Custom Configuration'
Config_File = r'C:\WMX\CustomConfiguration.jxl'
User_Store = 'Traditional'

# Process: Create Workflow Database
arcpy.CreateWorkflowDatabase_wmx(Input_Database_Connection, 
                                 AOI_Spatial_Reference, Import_Configuration, 
                                 Config_File, "", User_Store)

Environments

Output CONFIG Keyword

Licensing information

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