Create Workflow Database

Available with Workflow Manager license.

Summary

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

The Workflow Manager database is used to store the job and configuration information for your work management system. Creating a new Workflow Manager database is an administrative activity that creates Workflow Manager schema in the specified enterprise geodatabase. The Workflow Manager 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 system tables added by the Create Workflow Database tool are geodatabase tables and are registered with your enterprise geodatabase. As the Workflow Manager system tables are geodatabase tables, it is strongly advised that you not delete or modify these tables using your RDBMS tools.

Note:

The Workflow Manager repository name is created based on the database instance name and the user name resulting in <instance name>_<username>. If operating system authentication is used, the user name of the current user logged in to the system is retrieved.

Usage

• When creating a new Workflow Manager database, an owner user account, with privileges, including Update, Insert, Select, and Delete, is required and a direct connection (*.sde) file to the enterprise geodatabase 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 database.

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

  Note:

  For more information about the Workflow Manager AOI, see Essential Workflow Manager Vocabulary.

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

  • Minimum Configuration (Default)
  • Quick Configuration
  • Custom Configuration

  The default option to import configuration is Minimum Configuration, which imports basic elements the Workflow Manager system requires to function properly. The file required for the import is included as part of the Workflow Manager installation. The elements imported are the following:

  • Privileges
  • User Groups - Only Administrator group
  • Status Types
  • Activity Types
  • Job Notification Types
  • Settings
  • Priorities
  • Hold Types

• The second option to import configuration is Quick Configuration; it imports all basic elements in the Minimum Configuration as well as samples of the other elements. The file required for import is included as part of the Workflow Manager installation. The samples include the following:

  • Users
  • User Groups
  • Job Queries
  • Step Types
  • Hold Types
  • Settings
  • Job Types
  • Default Properties
  • Workflows
  • Naming Schemas

  If you want to import a configuration from an existing Workflow Manager database, choose Custom Configuration and browse to the configuration file generated by exporting the configuration from an existing Workflow Manager database.

  Note:

  For more information on exporting an existing configuration, see exporting configuration files. For more information on exporting a configuration with jobs, see the Export Job Data tool.

• 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. If no configuration keyword is specified, the DEFAULTS keyword is used.

• The User Storeparameter defines from which user store the user and role information is imported. You have two choices to get the information: Portal and Traditional. When Portal is selected, the users are retrieved from an existing portal and added to the Workflow Manager 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.

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

  The .jtc file is stored in the Workflow Manager Database folder.

Syntax

CreateWorkflowDatabase_wmx (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 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 several ways: By inputting the path to a .prj file, such as c:/workspace/watershed.prj By defining a spatial reference object prior to using this tool, such as AOI_Spatial_Reference = arcpy.SpatialReference("c:/data/Africa/Carthage.prj") or AOI_Spatial_Reference = arcpy.SpatialReference('WGS 1984'), which you then use as the spatial reference parameter	Coordinate System
Import_Configuration	The Workflow Manager elements to be imported in the new Workflow Manager database. The default import configuration option is Minimum Configuration. Minimum Configuration —Imports the basic elements that the Workflow Manager system requires. Quick Configuration —Includes the minimum configuration elements plus samples for several elements. Custom Configuration —Specify a Workflow Manager 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 a preexisting Workflow Manager database.	File
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 repository. The portal user profile information cannot be edited using Workflow Manager Administrator. The users and roles can be created in the Workflow Manager 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. 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 repository using Workflow Manager Administrator. Users and roles can be imported from the Active Directory when this option is used. This is the default.	String

Code sample

CreateWorkflowDatabase example 1 (stand-alone Python script)

This script creates and sets up a Workflow Manager database in an existing enterprise geodatabase, and the user store is set up in the 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'
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 Python script)

This script creates and sets up a Workflow Manager 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 utilized.

# 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 Python script)

This script creates and sets up a Workflow Manager 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

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