Using Custom Properties
When you set up workflow, a variety of custom properties are available for implementing various features. This topic describes how to use the custom properties.
Making Custom Properties Available in a Process Definition
Before you can use a custom property, you need to add the property to the process definition. You must do this for each of your process definitions.
To add a custom property to a process definition:
Access the Custom Properties dialog box using either of these ways.
-
Open the process definition and click the Custom Properties toolbar icon.
-
Open the process definition, select a task, select Open Properties, select Business Properties, click the Custom Properties button (#), and then click the Define Properties button.
-
Enter the property information in the Property Name and Description fields in the Custom Properties list:
Note: You must use the exact property names as they appear in the following section. You can provide your own descriptions.Click OK.
Click Save.
Custom Properties
These custom properties are available for Public Sector Licensing and Permitting process definitions.
Property |
Usage |
---|---|
PSC_LIST_ORDER |
Use this property to set the order for human tasks when there are multiple possible paths through the process definition. The order does not affect the workflow process, but it allows users to see the possible future workflow tasks in a logical order. Enter an integer value to indicate the sequence. For example: 2 The Workflow page for a transaction includes an option to view a list of all past, present, and not started human tasks for the permit. The list displays past and present tasks in chronological order. However, the chronology for tasks that haven’t been started is not necessarily fixed. The branching logic in a process means that some tasks might be omitted or might occur in a different order depending on permit data or on the outcome of previous tasks. To control the order in which not started human tasks appear, use the PSC_LIST_ORDER custom property. On the Workflow page’s list view, tasks that have not yet started are listed in the order you specify. If multiple not started tasks have the same number, they appear in the list in random order. |
PSC_FINAL_ACTIVITY |
Use this property to identify a human task that is not allowed to progress when the transaction has a condition that applies the Prevent Issue or Final condition rule. In particular, use this property to identify the final human task in the process definition. Yes identifies the final activity. A blank value or a No value means that the task is not the final activity. See Setting Up Conditions and Applying Conditions to Applications. |
PSC_ACTIVITY_TYPE |
Use this property to identify the final inspection task in the process. Setting this property is necessary to support the transaction business logic that auto-advances the inspection task when the last inspection is closed. Inspection is the only value with related business logic. Leave this property blank for other types of activities. Permit processing includes logic to automatically progress past the final inspection step in the process definition when permit inspections are complete. To enable this functionality, you must identify the final inspection task in the process definition using the PSC_ACTIVITY_TYPE custom property. Further, you must identify the workflow action to apply to that task using the PSC_AUTO_UPDATE_ACTION custom property. This property is also used for plan review completion, planning activities, and assigning or reassigning planners. The value entered for the Assign Planner task should match what's entered on the Update Workflow action in the Business Rules Framework rule. |
PSC_AUTO_UPDATE_ACTION |
Use this property to identify the action to take when auto-advancing a task in a process. Setting this property is necessary to support the transaction business logic that auto-advances the inspection task when the last inspection is closed. It's also used to auto-advance an assigned planner. Use the exact action name as specified in the Action property for the human task. Take extra care with the spelling, capitalization, and punctuation of the action name. For example: Approve or Assign Planner. Note: Security roles related to the Mobile
Inspector app and the Plan Reviewer should be included in the task swimlane
mapping.
|
PSC_UNRESTRICTED_ACTIONS |
Identifies actions that can be taken for the task even if there is logic preventing the task from advancing. Use this property when the task includes possible outcomes that return to a previous task rather than advancing. For example, if the final inspection can be advanced with an action of “Approve” or returned with an action of “Needs More Information,” then use the PSC_UNRESTRICTED_ACTIONS property to make “Needs More Information” an unrestricted action. This allows users to take the “Needs More Information” action, even though the logic that prevents the final inspection task from advancing disallows other actions. Currently, the PSC_UNRESTRICTED_ACTIONS property is applicable only for the Inspection action, as identified by the PSC_ACTIVITY_TYPE. When there are multiple unrestricted actions, separate the actions with commas but no spaces. This is the same format used in the Actions property where you define all of the available actions for a human task. For example: Needs more Info, Proceed, OK |
PSC_MIGRATION_TASK |
Use this property to map the transaction statuses of your migrated legacy data to the correct Public Sector Licensing and Permitting workflow user tasks. You must set this property for your process definition workflow user tasks before running the Prepare Migrated Data for PSCR process. See Assigning Workflow Status to Migrated Transactions. The status of the migrated legacy transaction. For example: SUB |
PSC_REQUEST_ACCEPT_INFO_HIDE |
Use this property on human tasks to hide the Request Info button on the two-panel workflow tab in the transaction details pages. Setting the value to True or TRUE hides both the Request Info button and the Accept Info button. Example: True For more information on the Request Info button and Accept Info button see Using Workflow. |
PSC_REQUEST_INFO_LABEL |
Use this property on human tasks to provide a custom label for the Request Info button that appears by default on the two-panel workflow tab in the transaction details pages. Example: Request Details |
PSC_ACCEPT_INFO_LABEL |
Use this property on human tasks to provide a custom label for the Accept Info button that appears by default on the two-panel workflow tab in the transaction details pages. Example: Accept Details |