Workflow Management – General Form Information
Version 6.1 (In Development)
Overview
The Workflow Management forms depend on the workflow configuration and setup. Generally it will contain the following separators or entity tabs:
- Main Form (root) – Master Worklow Record (wmid) with information common to all workflow records
- Additional Type – Additional Type management for workflow models that allow additional types to be created with the master root record (one to many)
- Activities – Workflow Process Steps and Activities
- Name Links – Names linked to the main Workflow Record
- Other Workflow Links – Govern Ids linked to the main Workflow Record: parcels, master records (re, pp, st, mb, sa, etc.)
Additional functionalities can also be added to the main workflow form or as a stand alone form, and includes: :
Inspectors are setup in Govern, using this standard form:
- Inspectors wm006 (ofr)
Setup Overview
Click here for detail information on the Installation or OpenForms Configuration.
When you create a new Workflow Management Kind and add one or more Categories, in GNA, the Business Model and Entities are created automatically in the Business Entity Designer (BED).
The next step is to create a new Workflow Management user form manually in the OpenForms Designer (OFD). The following controller and custom control are required on all Workflow Management user forms:
- Workflow Form General Controller
- Workflow Type Custom Control
- Workflow Additional Type Custom Controller (for Categories that allow multiple)
They perform essential validations and actions in the Workflow Management module. These are listed in the following section, Validations Performed by the Controller.
This document describes the following:
- Creating a New Workflow Kind
- Creating a New Workflow Form in the OpenForms Designer (OFD)
- Adding the Form to a Profile
- Creating a New Record
- Scenario Creating a New Workflow
Documentation
To view this information in pdf format, click on the following link:
WorkflowGeneralController.pdf
Validations Performed by the Controller
As explained in subsequent sections, the Workflow Controller:
- Ensures that the required tables are included in the entity:
WM_MASTER
WM_LK_MASTER
The table linked to the Category - Ensures one of the following:
If the Allow Additional Type Option on the Workflow Kinds and Categories form is set to True, the table linked to the Kind is not included in the entity.
If the Allow Additional Type Option is set to False, the table linked to the Kind is included in the entity.
Creating a New Workflow Kind and Category
Perform the following steps in order to create a new Workflow Kind:
- Launch GNA.
- Select Applications Configurations > Workflow Management > Kinds and Categories.
- Click New.
- Complete the required parameters.
- Click Save.
Creating a New Category
- Launch GNA.
- Select Applications Configurations > Workflow Management > Kinds and Categories.
- Select the required Kind on the left.
- Select the Category tab.
The Code and Short and Long Descriptions for the Workflow Kind are displayed at the top of the form. - Select the New Field icon.
- Enter a Code and Short and Long Descriptions for the Category.
- Select a key type from the Entity Key Type drop-down list.
- Click Save.
Viewing the Automatically Generated Business Model and Entities
The business model and entities are created automatically in the Business Entity Designer (BED).
To view the business model and entities:
- Launch the Business Entity Designer (BED).
- Select the Business Models explorer.
- Select the new model in the tree view.
- Double-click an entity in the model to open it in the Business Entity Designer.
- Alternatively, select the Business Entities explorer and select the entity.
Creating the Workflow Form in the OFD
Once the business model and entities are automatically created, you need to create the form manually in the OpenForms Designer (OFD). You need to add both the Workflow Management Controller and the Workflow Type Controller.
To create the form and add the Workflow Type Controller:
- Launch the OpenForms Designer (OFD).
- Click New to create a new form.
- Select the Business Model in the Select a Model parameter.
- Enter a name for the form in the Form Name parameter.
- Enter a code in the Form Code parameter.
- Click OK.
Adding the Workflow Controller
To add the workflow controller:
- Open the new form in the OFD.
- Select the ellipsis button beside Controller under Controllers.The Extension Selector opens.
- Select Only show classes that implement the custom control interface.
- Select MsGovernOpenForms.CustomControls.dll on the left.
- Select WM_Controller.
- Click OK on the Extension Selector.
- Click Save in the OFD.
Configuring the Controller
To configure the controller: (to be reviewed)
- Open the workflow form in the OFD.
- Select the ellipsis button beside Configuration in the Properties Explorer.
- Under Filter by System ID:
Select Reference ID under Attribute and Name ID or Parcel ID under System ID.
Select Primary Department under Attribute and Department under System ID. - Under Filter by Constants:
Select Reference ID under Attribute.
Select Equal To under Operator and NA_ID under Constant. - Select Key Type under Attribute.
Select Equal To under and the required workflow key type under System ID. - Under Order by
Select the Workflow Type ID under Attribute and Ascending or Descending under Direction. - Under Reposition
Select the Workflow Type ID under Attribute and System ID. - Under ID Setters
Select the Workflow Type ID under Attribute and System ID. - Click OK on the Configuration window.
- Click Save on the OFD.
Adding the Type Control
To enable the ability to create additional workflow types on the form, select the IsAdditionalType property under Misc > Properties > Misc.
As with any custom control, security permissions can be applied.
In the OFD, Create the form for each model created by GNA and add the Workflow Controller and the Type Control into the root form.
- Open the new form in the OFD.
- Select Custom Control under Controls.
- Drag the custom control to the form.
- Click the ellipsis button beside Action
- Select MsGovern.OpenForms.CustomControls.WM_Type_Control.
- Optionally, in order to enable the ability to create additional types, expand Properties > Misc and select IsAdditionalTypeComboBoxEnabled.
This enables the Additional Type combo box in GNA. - Click Save.
Adding the Form to a Profile
As with any new form, you need to add it to all required Profiles in GNA. Then, return to the OFD and set up the security permissions.
To add the form to a Profile:
- Launch GNA.
- Open the Profile Editor.
- Select the required Profile.
- Select the Links tab.
- Click Add in the Forms section.
- Select the form in the secondary window.
- Click Save.
Adding Security Permissions to the Form
As with any new form, you need to add the security permissions in the OFD.
To add the security permissions:
- Launch the OFD.
- Open the required Workflow form.
- Select the Security icon.
- Select the required Type (Normal or Alternative), Profile, and Role or user.
- Define permissions on all items as required.
- Click Save.
- Repeat steps 4 to 6 for all required combinations of Security Type, Profile, Role and User.
Creating a Workflow Type
Prerequisites
Before creating Workflow Types, ensure that:
- All required departments in the Department Maintenance form.
- All required Workflow Kinds and Categories are created.
- The Allow Additional Types option is selected on the General tab of the Workflow Management Category.
- The Display All Licenses Issued to the Individual is selected on the General tab of the Workflow Management Department.
Steps for Creating a Workflow Type
Perform the following steps in order to create a new Workflow Type:
- Launch GNA.
- Select Applications Configurations > Workflow Management > Departments.
All the departments in the deployment are listed on the left. - Select a department.
- Select the Types tab.
- Enter a code for Department Types in the Code parameter.
- Select a kind from the Kind combo box.
All the kinds created on the Workflow Kind and Categories form are displayed. - Select a category from the Category parameter.
All the categories created on the Workflow Kind and Categories form are displayed. - Select a default A/R Class from the Default A/R Class parameter.
All the A/R Classes created for Workflow Management are displayed. - Click Save.
101-wm-frm-000