ArcFM Solution Developer Guide
Process Framework Tasks

Version: 10.6.1a

Resource Center Home

You may localize the Process Framework task names as they appear in the user interface. Unlike the other localization tasks discussed in this section, Process Framework tasks require no code modifications. You may localize the task names by simply setting configuration keys and editing the task names in the Process Framework Administration tool. It is a wise idea to localize the task names on your Enterprise Process Framework database before distributing it to any Mobile users. This prevents you from having to localize on field machines as well as your Enterprise database.

There are two steps to editing task names in the Process Framework Administration tool. Both steps are required and the names MUST match in both locations. Follow the steps outlined below to modify the name of a task.

Step 1: Change the Task Name

  1. Open the Process Framework Administration tool and login to the database in which the tasks reside (e.g., Process Framework database on the Enterprise).
  2. Select the Node Types tab.
  3. Choose the node on which the task is enabled and then select the task in the list below.
  4. Click Properties.
  5. Edit the task name in the Task Name field. This changes the name in the user interface.

Figure 1, change the Task Name in Process Framework Administration tool


Figure 2, New task name appears in UI, but corresponding button is disabled

In the example above the Create Design task has been renamed to Create a New Design (Figure 1). If you select the task from the drop down menu and click Execute, it will work. However, notice that the Create Design button remains disabled (Figure 2). This is because the code behind the button is still looking for the Create Design task, not the Create a New Design task. This issue will occur whenever a task has a corresponding button. Any time a subtask calls a task that has been renamed, it will fail. To alleviate these problems follow the steps below to set the proper configuration values.

Step 2: Set the Configuration Value

  1. In the Process Framework Administration tool, select the Configuration tab.
  2. Click Add to create a new row.
  3. Enter the configuration value (e.g., WMSTaskCreateDesign) in the Name column. The tables at the bottom of this page lists all of the available configuration names and their default values. If you change the default name for any task, on the Node Types tab, you must add the corresponding configuration name and the name to which you changed it.
  4. Add your localized name (e.g., Create a New Design) in the Value column. This value MUST match the value in the Task Name field on the Node Types tab (Figure 1).

If these two task names (on the Node Types and Configuration tab) do not match, you will encounter errors. These names are not case sensitive, but beware of extra spaces at the end of a task name. Even if they're name the same, an extra space on the end of one can cause problems.

Figure 3, Configuration Name

With the configuration value set properly to match the task name on the Node Types tab, the corresponding button is enabled and any subtasks that reference the task will behave correctly.

Figure 4, button is now enabled

When you're finished localizing, close the Process Framework Administration tool and save changes when prompted.

 

Workflow Manager Task Names/Config Values

Default Task Name

Configuration Value

Approve Design

WMSTaskApproveDesign

Begin Construction

WMSTaskBeginConstruction

Change Owner

WMSTaskChangeOwner

Close Design

WMSTaskCloseDesign

Complete Work Request

WMSTaskCompleteWorkRequest

Construct Work Request

WMSTaskConstructWorkRequest

Copy Design

WMSTaskCopyDesign

Create Design

WMSTaskCreateDesign

Create Work Request

WMSTaskCreateWorkRequest

Delete

WMSTaskDelete

Delete No Prompt

WMSTaskDeleteNoPrompt

Design Cost Report

WMSTaskDesignCostReport

Open Design

WMSTaskOpenDesign

Post Design

WMSTaskPostDesign

Reconcile Design

WMSTaskReconcileDesign

Reject Design

WMSTaskRejectDesign

Save Design

WMSTaskSaveDesign

Send Design

WMSTaskSendDesign

Send Design to Current Field Owner

WMSTaskSendDNToCurrentFieldOwner

Send to field

WMSTaskSendToField

Submit Design

WMSTaskSubmitDesign

Transition to Mobile

WMSTaskTransitionToMobile

Undo Approve

WMSTaskUndoApprove

Undo Approve without Checking Other Conditions

WMSTaskUndoApproveNoMatterWhat

Undo Begin Construction

WMSTaskUndoBeginConstruction

Undo Construct Work Request

WMSTaskUndoConstructWorkRequest

Undo Construct Work Request to Initialized

WMSTaskUndoConstructWRToInit

Undo In Design Work Request

WMSTaskUndoInDesignWorkRequest

Verify Design

WMSTaskVerifyDesign

 

Session Manager Task Names/Config Values

Default Task Name

Configuration Value

Change Session Owner

SNTaskChangeSessionOwner

Close Session

SNTaskCloseSession

Create Session

SNTaskCreateSession

Delete Session

SNTaskDeleteSession

Is Session Locked

SNTaskIsSessionLocked

Mobile Submit Session

SNTaskMobileSubmitSession

Open Edit Session

SNTaskOpenEditSession

Open Redline Session

SNTaskOpenRedlineSession

Post Session

SNTaskPostSession

Reconcile Session

SNTaskReconcileSession

Reject Session

SNTaskRejectSession

Save Session

SNTaskSaveSession

Send Session to Current Field Owner

SNTaskSendToCurrentFieldOwner

Send Session to Enterprise

SNTaskSendSessionToEnterprise

Send Session to Field

SNTaskSendSessionToField

Submit Session

SNTaskSubmitSession

 

 

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com