ArcFM Desktop Configuration Guide
Workflow Manager Subtasks

Version: 10.2.1c and 10.2.1c SP3

Resource Center Home
ArcFM Desktop > Set Up Process Framework Tools > Workflow Manager Subtasks

Below is a list of the subtasks available for use with Workflow Manager, the criteria necessary for them to be enabled, and the steps that are performed when they are executed. Many of these subtasks are named after the task with which they are associated. You may create custom subtasks (see Customizing Process Framework). Use the Process Framework Admin Tool to group subtasks and create custom tasks.

Approve Design

Performs actions that should occur when a design is approved.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is a design node.
  • There may not be another approved design in the same work request.

Execute

  1. Sets the Approved Date and Approved By fields on the design node.
  2. Enters the design’s ID in the MM_WMS_APPROVED_DESIGNS table.
  3. Looks for the ConstructOnApprove value in the MM_PX_CONFIG table. If the ConstructOnApprove value is false, the subtask is complete. If this configuration value is true, the subtask gets the design’s parent node and checks to see that it is a work request. If the parent node is a work request, the Construct Work Request task is executed on the parent node to set its state to In Construction.

Approve Imported Design

Approves a design on the enterprise after it has been approved in the field and imported into the enterprise database.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask must be a design.

Execute

  1. Check to see if the design has been approved and skips the design if it has not been approved.
  2. If any design in the same work request has already been approved, it will be unapproved.
  3. Approves the imported design on the enterprise.
  4. Checks the MM_PX_CONFIG table to see if the ConstructOnApprove flag has been set. If it is set, the Work Request will be given a state of In Construction.

Begin Construction

Executes the Construct Work Request task on the design’s parent work request if it is necessary.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is a design node.

Execute

If the ConstructOnApprove configuration value is false, the subtask gets the design’s parent and checks to see if it is a work request. If the parent node is a work request, the Construct Work Request task is executed on the parent node to set its state to In Construction.

Change Design's Owner to Mobile User

Allows the user to change the owner of a design to a mobile user.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask must be a design.
  • Users must exist with the Mobile role assigned.

Execute

  1. Allows the user to select from a list of mobile users.
  2. Assigns design to the chosen user.

Parameters

  • DefaultUser: takes a user name as a value.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt.

Change Owner

Allows the user to assign the work request or design to another user.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is a work request or design node.
  • Determines if there are any other users that have a role that can access the node in its current state.

Execute

  1. Checks to see that the node is a design or work request.
  2. Finds a list of users that have the roles necessary to access the current node.
  3. Asks the user to specify a new user.
  4. Attempts to transfer ownership of the node to the selected user.
  5. If design is open in ArcMap, it will be closed.

Parameters

  • DefaultUser: takes a user name as a value.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt.

Change Owner to Include All Users

Changes the owner of a design to another user.

Enabled

  • The node passed to this subtask must be a design or work request.
  • At least one user must exist in the MM_PX_USER table.

Execute

  1. Identifies the users with the appropriate roles assigned to own the selected node.
  2. Allows the user to select from a list of valid users.
  3. Assigns the node to the chosen user.

Parameters

  • DefaultUser: takes a user name as a value.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt.

Change Owner to Self

Changes the owner of the selected node to the current user.

Enabled

  • The node passed to this subtask must be a design or work request.
  • If the node passed to the subtask is a work request, the user must be on the enterprise. Users cannot change the owner of a work request in the field.
  • At least one user must exist in the MM_PX_USER table.

Execute

Changes the owner of the node to the current user.

Close Design

Closes a design that has been opened in ArcMap.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is a design node.
  • Workflow Manager must be open through ArcMap.
  • A design must be open in ArcMap.

Execute

  1. Closes the open design.
  2. Sets the PxApplication on the Process Framework Tasks tool extension to nothing.

Close Express Design

Closes an express design that has been opened in ArcMap.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is an express design node.
  • Workflow Manager must be open through ArcMap.
  • An express design must be open in ArcMap.

Execute

  1. Prompts the user to save any outstanding edits.
  2. Checks for conflicts.
  3. Reconciles and posts the design.
  4. Closes the express design.
  5. Marks the design's version for deletion (unless it has been opened for as-built editing).
  6. Sets the PxApplication on the Process Framework Tasks tool extension to nothing.
  7. Enables the Stored Items tools.

Close Express Design with GDBM

Closes an express design and supports integration with Geodatabase Manager. Geodatabase Manager provides the GDBM Set Posting Priority which reconciles and posts designs using a batch process.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is an express design node.
  • Workflow Manager must be open through ArcMap.
  • An express design must be open in ArcMap.

Execute

  1. Prompts the user to save any outstanding edits.
  2. Checks for conflicts.
  3. Reconciles and posts the design.
  4. Closes the express design.
  5. Sets the PxApplication on the Process Framework Tasks tool extension to nothing.
  6. Enables the Stored Items tools.

Parameters

  • Priority: Sets the post priority on the version. The default is 0, which is the lowest priority.
  • ShowMessages: Determines whether message boxes are displayed should problems occur while the subtasks is executing. The default setting is True. If the user sets this value to False, message boxes are not displayed, but messages are still logged. 

Confirm

Verifies that the user wishes to continue.

Enabled

This subtask is always enabled.

Execute

Displays a message box that asks the user if she wishes to continue. If the user selects no, this subtask returns false and subsequent subtasks will not be executed.

Confirm Delete Staking Job

Verifies that the user wishes to continue deleting the selected staking job.

Enabled

This subtask is always enabled.

Execute

Displays a message box that asks the user if she wishes to continue. If the user selects no, this subtask returns false and subsequent subtasks will not be executed.

Copy Design

Allows you to create a copy of an existing design.

Enabled

  • The node passed to this subtask is a design node.
  • The design has been opened in ArcMap and saved (creating an associated version).
  • The WMSUseWRVersions value in the MM_PX_CONFIG table is set to 0. If this value is set to 1 the Copy Design subtask is disabled.

Execute

  1. User interface prompts user for set-up information.
  2. Creates WR (if user specified "create new WR").
  3. Creates new design(s) based on number of copies entered by user.
  4. Copies the contents of the original design to the new design(s) depending on the set-up information entered.

Create Design

Adds a new design node to an existing work request.

Enabled

  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open and visible.
  • The node passed to this subtask is a work request node.
  • The work request has a state of either Initialized or In Design.
  • There may not be another approved design in the same work request. If there is another approved design, the subtask is disabled.

Execute

  1. Calls Terminate on Process Framework’s active control if the active control is an IMMPxControl2. This gives the form displayed in Process Framework a chance to cancel this operation or to take some action before it is replaced by the design’s control.
  2. Creates a new design node.
  3. Sets these properties on the design: Work Request ID, Create Date, Design Number, default design name.
  4. Adds the node to the Tree.
  5. Sets the build object.
  6. Calls the "Create Design" transition programmatically. If the transition does not exist it sets the design node's state to the initial state set in the Node Types tab.

Create Work Request

Adds a new work request node.

Enabled

  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open and visible.
  • The selected node is a TopLevel node.

Execute

  1. Creates a new work request.
  2. Sets these properties on the work request: default work request name and description, and current owner.
  3. Adds the node to the Tree.
  4. Sets the node’s build object.

Delete

Removes the node and attempts to remove all of the associated version data from ArcMap. If it cannot remove the version data from ArcMap, the data is marked as orphaned and may be deleted using the Clean Up tool.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask is a work request node or a design node without child copies. Nodes with child copies cannot be deleted unless the children are deleted first.

Execute

  1. Closes the design if it is open in ArcMap.
  2. Calls the node’s deleter object.
  3. Deleting a design may change the state of its parent work request. The work request state will be set to Initiated if the parent work request does not have any children. If the work request has children, the state of the work request will be based on the state of the children. If the work request is in the Complete state, the state of the work request will not be changed.

Delete Sibling Designs

Deletes all designs in the work request except the one selected when this subtask is performed. You may use this subtask in conjunction with subtasks such as Verify Design or Begin Construction to delete alternate designs from a work request when one is approved. This subtasks also requires the existence of a task called Delete No Prompt. The Delete No Prompt task should include the following subtasks (in order): Does user own work request or design?, Is design locked?, Delete. Note that there is no subtask to confirm deletion. Refer to the sample data to see how tasks are configured.

Enabled

  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open and visible.
  • The node passed to this subtask is a design node.

Execute

  1. Prompts the user to confirm deletion.
  2. Gets the parent work request.
  3. Compiles a collection of siblings.
  4. Passes in the selected design.
  5. Deletes each sibling and retains the design passed in.

Design Cost Report

Displays the cost of a design.

Enabled

  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open through ArcMap.
  • The node passed to this subtask is a design node, and it is open.

Execute

  1. Generates a cost report for the design.
  2. Converts the cost report to HTML using an XSL style sheet.
  3. Displays the design cost report.

Does User Own Work Request or Design Node?

Checks to see if the user is also the current owner.

Enabled

If the user is not the owner, the Enabled method will return false and the subtask will be disabled.

Execute

Always returns true.

Incremental Copy Design

Copies a design but NOT its compatible units.

Enabled

  • The node passed to this subtask is a design node.
  • The design has been opened in ArcMap and saved (creating an associated version).
  • The WMSUseWRVersions value in the MM_PX_CONFIG table is set to 0. If this value is set to 1 the subtasks is disabled.

Execute

  1. Creates a new work request.
  2. Copies the design node to the new WR. Any CUs associated with the design are NOT copied.

Is Design Locked?

Checks the design to determine if the opened design is locked.

Enabled

  • Disabled if the design’s node is locked and the design is not currently opened.
  • Disabled if the design is state locked.
  • Disabled if the design is non-postable.
  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.

Execute

Always returns true.

Is Design Open?

Checks the design to determine if it is open.

Enabled

Disabled if the design is not currently opened.

Execute

Always returns true.

Is Express Design?

Checks to see if the selected design is enabled for Designer Express. This subtask determines the design type using the product family type table.

Enabled

  • Selected node must be a design.
  • MMWorkflowManager must be the current extension.
  • Selected design node must be an express design.

Execute

Always returns true. 

Is Standard Design?

Checks to see if the selected design is enabled for Designer (and not Designer Express). This subtask determines the design type using the product family type table.

Enabled

  • Selected node must be a design.
  • MMWorkflowManager must be the current extension.

Execute

Always returns true. 

Mobile Approve Design

Executes the approve design task so the design will be in the proper state (approved) before it is sent to the enterprise by another subtask.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.
  • The Approve Design task must be enabled.

Execute

Executes the Approve Design task.

Mobile Reject Design

Changes a mobile design’s status to In Design and allows the user to assign it to another user.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask must be a design.
  • The Reject Design task must be enabled.

Execute

Executes the Reject Design task.

Mobile Submit Design

Changes the mobile design’s status to Pending Approval and allows the mobile user to assign it to an approval officer.

Enabled

  • MMWorkflowManager must be the current extension.
  • The node passed to this subtask must be a design.
  • The Submit Design task must be enabled.

Execute

Executes the Submit Design task.

Move Design

Assigns a design to a different work request.

Enabled

  • The selected node must be a design.
  • The design may not be currently open in ArcMap.

Execute

  1. Compiles a list of all available work requests and presents it to the user for selection. This list excludes the selected design’s parent work request and any work requests that have an approved design.
  2. Moves the design to the selected work request.
  3. If the selected design has been approved, the MM_WMS_APPROVED_DESIGNS table is updated.
  4. If moving the design affects the state of the source work request, then there must a valid transition defined that allows the work request state to change before adding the destination work request to the list.

Normal Copy Design

Copies a design and its compatible units.

Enabled

  • The node passed to this subtask is a design node.
  • The design has been opened in ArcMap and saved (creating an associated version).
  • The WMSUseWRVersions value in the MM_PX_CONFIG table is set to 0. If this value is set to 1 the subtasks is disabled.

Execute

  1. Creates a new work request.
  2. Copies the design node and its associated compatible units to the new WR.

Open Design

Opens the design node in ArcMap.

Enabled

  • A design node must be selected and it must not have a verified state.
  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open from ArcMap and visible.

Execute

  1. Calls Terminate on Process Framework’s active control if the active control is an IMMPxControl2. This gives the form displayed in Process Framework a chance to cancel this operation or to take some action before it is unloaded.
  2. Opens the design.
  3. Sets the PxApplication on the Process Framework Tasks Tool extension.

Open Express Design

Opens the selected design for editing in Designer Express.

Enabled

  • An express design node must be selected.
  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be opened from Designer and visible.

Execute

  1. Gets the express design.
  2. Determines whether the express design should be opened as View Only.
  3. Creates the workspace for the express design.
  4. Opens the express design and updates the MM_PX_Versions table to indicate the design exists.
  5. Sets the PxApplication on the Process Framework Task Tool extension.
  6. Enables the Active Annotation Target tool.
  7. Disables the Stored Items tool.

Open Express Design for As-Built Editing

Opens the selected design for as-built editing in Designer Express.

Enabled

  • An express design node must be selected.
  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be opened from Designer and visible.

Execute

  1. Gets the express design.
  2. Determines whether the express design should be opened as View Only.
  3. Creates the workspace for the express design.
  4. Opens the express design and disables the Design Palette tab.
  5. Updates the MM_PX_Versions table to indicate the design exists.
  6. Disables the Stored Items tool.

Open Redline Design

Opens a design for redline (graphic) editing in ArcFM Viewer for ArcGIS Engine.

Enabled

  • A design node must be selected.
  • MMWorkflowManager must be the current extension.
  • The design may not have a state of Verified.
  • Workflow Manager must be open from ArcFM Viewer for ArcGIS Engine and visible.

Execute

  1. Gets the design.
  2. Creates a Mobile packet if one does not already exist for the design.
  3. Determines whether the design should be opened as View Only.
  4. Loads the design's stored display (if it exists).
  5. Loads the design's Mobile packet.
  6. Activates the mobile graphics layer.
  7. Sets the PxApplication on the Process Framework Task Tool extension.

Output CIM XML

Writes information about the selected design or work request node to a CIM-compliant XML file.

Enabled

  • The user must have the correct user role assigned. This role is determined by the MessageRoleName config value.
  • A design or work request node must be selected.
  • MMWorkflowManager must be the current extension.

Execute

  1. If an input dictionary key is provided, looks in the task dictionary for XML message.
  2. If input XML path is provided, gets the XML message.
  3. If neither input parameter has a value, prompts the user for an XML file and retrieves the XML message from the path provided by the user.
  4. Opens XML and processes according to verb provided. If New Verb parameter has a value, uses this verb to process.
  5. If output dictionary key is provided, writes the XML for the selected node to the task dictionary.
  6. If output XML path is provided, writes to a local XML file.
  7. If neither output parameter has a value, prompts the user for a path to where the XML file should be written and writes out the XML.

Parameters

  • Input Dictionary Key: Dictionary key from which the message is received.
  • Input XML Path: Local path to XML where message may be retrieved.
  • Output Dictionary Key: Dictionary key to which the message is stored.
  • Output XML Path: Local path to XML where message is to be stored.
  • New Verb: You may modify the verb using this parameter.

Process CIM Message

Looks at the request noun and verb of a CIM-compliant message, and forwards the message to the appropriate processor.

Enabled

  • The user must have the correct user role assigned. This role is determined by the MessageRoleName config value.
  • MMWorkflowManager must be the current extension.

Execute

  1. If an input dictionary key is provided, looks in the task dictionary for XML.
  2. If input XML path is provided, gets the XML.
  3. If neither input parameter has a value, prompts the user for an XML file and retrieves the XML from the path provided by the user.
  4. Opens XML and processes.
  5. If output dictionary key is provided, writes the XML to the task dictionary.
  6. If output XML path is provided, writes to a local XML file.
  7. If neither output parameter has a value, prompts the user for a path to where the XML file should be written and writes out the XML.

Parameters

  • Input Dictionary Key: Dictionary key from which the message is received.
  • Input XML Path: Local path to XML where message may be retrieved.
  • Output Dictionary Key: Dictionary key to which the message is stored.
  • Output XML Path: Local path to XML where message is to be stored.

Reconcile Design

Reconciles the parent version to the current design.

Enabled

  • MMWorkflowManager must be the current extension.
  • Workflow Manager must be open through ArcMap.
  • The selected node is a design node.
  • The user must have an editing session started in ArcMap.
  • A design must be open in ArcMap.
  • Reconcile target must either be default version or a postable version.

Execute

  1. Determines whether the DefineConflictsByColumn configuration value is set in the Process Framework Admin Tool. If this value is set to 1, conflicts are defined by column. If this value is set to 0 or not set at all, conflicts are defined by row.
  2. Reconciles the parent version to the open design.

Refresh Database Connection:

This subtask is currently not in use and will always remain disabled.

Reject Design

Changes the design’s status to In Design and allows the user to assign it to another user.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node and it has a state of Pending Approval.

Execute

  1. Prompts the user to select a new user.
  2. Attempts to transfer ownership.
  3. Tells the builder that the user has changed so it can update the tree if necessary.
  4. If ownership is changed, the design is closed.

Re-send Design to Field

Executes the Send to Field task if the node’s current owner has the Mobile role assigned.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node must be a design.

Execute

  1. Gets the node's owner.
  2. Executes the Send Design to Current Field Owner task if the node's owner has the Always Mobile role assigned.

Save Design

Saves the current open design.

Enabled

  • MMWorkflowManager must be the current extension
  • A design node must be opened through ArcMap.
  • The user must have an editing session started.

Execute

Saves the design.

Send Design

Identifies whether the user is in the field or on the enterprise and executes the appropriate task: Send Design to Enterprise or Send Design to Field.

Enabled

A design node must be selected.

Execute

  1. Checks to see if the user is in the field or on the enterprise.
  2. If the user is in the field, executes Send Design to Enterprise task.
  3. If the user is on the enterprise, executes the Send Design to Field task.

Send Express Design to GIS

Identifies whether the user is in the field or on the enterprise and executes the appropriate task: Send Design to Enterprise or Send Design to Field.

Enabled

A design node must be selected.

Execute

  1. Checks to see if the user is in the field or on the enterprise.
  2. If the user is in the field, executes Send Design to Enterprise task.
  3. If the user is on the enterprise, executes the Send Design to Field task.

Send to Enterprise

Takes a design from the mobile environment and puts it back on the enterprise server.

Enabled

  • The MM_Mobile_State table must exist in the current Process Framework database.
  • MMWorkflowManager must be the current extension.
  • The selected node must be a design.

Execute

  1. Gets the parent node of the selected design.
  2. Closes the design if it is open in ArcMap.
  3. Adds the packet to the transporter.
  4. Deletes the design and work request if it doesn't contain another design.

Send to Field

Takes a design from the enterprise server and puts it in the mobile environment.

Enabled

  • The Database ID field must have a value. This field is located in the Process Framework Administration Tool on the Extensions tab.
  • MMWorkflowManager must be the current extension.
  • The selected node must be a design.
  • The MM_Mobile_State table must exist in the current Process Framework database.
  • The current design must have not already been imported.
  • Another design cannot be approved for this design's work request.

Execute

  1. Creates a mobile packet if one does not already exist.
  2. Closes the design if it is open in ArcMap.
  3. Saves the mobile packet.
  4. Adds the mobile packet to the transporter.

Set to Express Design

Changes the product type of the selected design to be an express design.

Enabled

  • A design node must be selected.
  • MMWorkflowManager must be the current extension.

Execute

  1. Gets the design.
  2. Sets the mmWMSDesignerProductType enumeration value to mmExpress.

Set to Standard Design

Changes the product type of the selected design node (e.g., express design or stake job) to be a design.

Enabled

  • A design or work request node must be selected.
  • MMWorkflowManager must be the current extension.

Execute

  1. Gets the design.
  2. Sets the mmWMSDesignerProductType enumeration value to mmDesigner.

Submit Design

Changes the design’s status to Pending Approval and allows the user to assign it to an approval officer.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.
  • There may not be another approved design in the same work request. If there is another approved design, the subtask is disabled.

Execute

  1. Prompts the user to select an approval officer.
  2. Attempts to transfer ownership.
  3. Tells the builder that the user has changed so it can update the tree if necessary.
  4. If ownership is changed, the design is closed.

Transition Stake Job to Enterprise

Transitions the selected stake job and its work request to "In Construction" before it is sent to the Enterprise.

Enabled

A design node must be selected.

Execute

Executes the Construct Work Request task on the work request that contains the selected design.

Undo Approve Design

Changes the design’s status from Approved to Pending Approval.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.

Execute

  1. Removes the values for the Approved Date and Approved By ID properties in the design.
  2. Removes the corresponding entry in the MM_WMS_APPROVED_DESIGNS table.

Undo Begin Construction

Calls a task that changes the work request’s status from In Construction to In Design.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.

Execute

Transitions the design’s parent work request to In Design by executing the Undo Construct Work Request task.

Verify Design

Posts the design and changes the work request’s state to Complete before removing it from the Tree. Completed work requests may be viewed using the Completed Work filter.

Enabled

  • MMWorkflowManager must be the current extension.
  • The selected node is a design node.
  • The user must have an editing session started in ArcMap and have a design open.
  • The user must be able to post if using a versioned database.

Execute

  1. Post the design.
  2. Transitions the design’s parent work request to Complete by executing the Complete Work Request task.
  3. Sets the work request node to hidden.

 

 

Send Comment to ArcFMdocumentation@schneider-electric.com