Workflow Management – General Link Type Editor
Version 6.1
Overview
Adding Links to a Workflow
This page describes how to add links using the Workflow Links Controller. This controller adds a central location for all links associated with a workflow. There are two categories for these links:
- Links to Names
- Links to Everything Else: This category includes other properties, departments, buildings, workflows, inspections, hearings, miscellaneous billing, self reported tax, and personal property.
This document describes the following topics:
Configuring Links
- Configuring links in the OpenForms Designer
Creating Link Types in GNA
- Using Links in Govern
Documentation
To view this information as a pdf, click on the following link:
Links.pdf
Confluence Technical Document: Workflow Link Type Editor
Configuring Entities for the Links in the OpenForms Designer (OFD)
Link Types are created in GNA. They are made available in Govern through the Workflow Links Controller. You must add and configure this controller to the following entities:
Adding the Workflow Controller for Names
To add the Workflow Links Controller for Names:
- Launch the OpenForms Designer (OFD).
- Open the required workflow form.
- Open the Name Links entity.
- Select Custom Control in the Controls explorer.
- Drag it to the required position on the entity.
- Select the new custom control.
- Complete the parameters as describe in the next section:
- Click Save.
Configuring the Layout Properties
To configure the Layout properties:
- Expand Layout and modify the margins, and the horizontal and vertical alignment if required.
- Click the ellipsis button beside the Text style parameter to modify the foreground style of the name control.
Note: The background color cannot be changed for the custom control.
The foreground color is applied to the heading, but not the options Only the font size and bold and italic character styles are applied.
This opens the Expression Selector.
- Open the name of the text style between single quotation marks and click OK on the Expression Selector.
A text style is applied to the Workflow Control for Names in the following screen shot:
Configuring the Controller Properties
To configure the Controller properties:
- Expand Misc > Action.
- Click the ellipsis button.
This opens the Extension Selector.
- Select MsGovernOpenForms.CustomControls.dll under Assembly.
- Select WM_Link_Control under Class.
- Click OK on the Extension Selector.
Configuring Additional Properties
You can add expressions to enable the controller and / or to make it visible only under certain conditions. Refer to the Expressions section of the OpenForms Designer documentation for details.
Configuring the Name Links Entity
To configure the Name Links entity, you need to set up the Browse window and add the configuration for the filters.
Setting Up the Browse
To set up the Browse window:
- Open the form in the OFD.
- Select the tab for Name Links entity.
- Click the ellipsis button in the Columns parameter.
This opens the Select Columns window.
All attributes are listed under Available.
- Select the Description attribute and move it to the Selected column.
- Click OK.
Adding Filters to the Name Links Entity
You need to add the following configuration for the filters. The Name Links entity is defined to filter on the Name ID (NA_ID) reference type.
To add the configuration for the filters:
- Open the form in the OFD.
- Select the tab for Name Links entity.
- Expand Misc in the Properties explorer.
- Click the ellipsis button in the Configuration parameter.
- This opens the Entity Configuration window.
- Add the ID Type under Filter by Constants.
- Select equal to under Operator.
- Select NA_ID under Constant.
- Click OK.
Adding the Workflow Controller for Other Links
Other Links refers to all links other than names.
These include
To add the Workflow Links Controller for Other Links:
- Launch the OpenForms Designer (OFD).
- Open the required workflow form.
- Open the Other Links entity.
- Follow the remaining steps under Configuring the Name Links Entity
Configuring the Other Links Entity
To configure the Name Links entity, you need to set up the Browse window and add the configuration for the filters.
Setting Up the Browse for Other Links
To set up the Browse, follow the procedure Setting Up the Browse on page 179.
Adding Filters to the Other Links Entity
The procedure is almost the same as Adding Filters to the Name Links Entity on page 180. The difference is in the operator that you select for the Reference ID under constants. For the Other Links select Not equal to.
To add the configuration for the filters:
- Open the form in the OFD.
- Select the tab for Other Links entity.
- Expand Misc in the Properties explorer.
- Click the ellipsis button in the Configuration parameter.
- This opens the Entity Configuration window.
- Add the ID Type under Filter by Constants.
- Select equal to under Operator.
- Select NA_ID under Constant.
- Click OK.
Managing Link Types in GNA
Link Types facilitate the management of all the links added to a workflow. This section describes how to view the existing link types and how to create new ones.
Viewing Link Types
By default, Link Types are provided for the following:
- Names:
- Applicant
- Primary Contact
- Contractor
- Owner
- Primary Inspector
- Other:
- Building
- Miscellaneous Billing
- Parcel Information
- Self Reported Tax
- Utility Billing
- Workflow
You can create all the additional Workflow Link Types that you require.
To view the predefined Link Types:
- Launch GNA.
- Select Applications Configurations > Workflow Management > Link Types.
- By default, link types are listed by code and short description.
- Select the link type that you want to view in the tree view.
- Click the arrow beside Code to view the Short and Long Descriptions.
- Parameters are defined as follows:
Reference Type
The Reference Type drop-down list contains the Govern System IDs (System Validation Table: BRULE – Business Rules). They are selected as follows:
- Applicant: NA_ID – Name ID
- Building: BLDG ID – Building ID
- Primary Contact: NA_ID – Name ID
- Primary Inspector: NA_ID – Name ID
- Miscellaneous Billing: MB_ID – Misc. Billing ID
- Owner: NA_ID – Name ID
- Parcel Information: P_ID – Parcel ID
- Personal Property: PP_ID – Personal Property ID
- Self Reported Tax: ST_ACCT_ID – Self Reported Tax ID
- Utility Billing: UB_ID – Utility Billing ID
- Workflow: WM_ID – Workflow ID
Form Name
The Form Name drop-down list contains the Govern user form created in the OpenForms Designer (OFD). They are selected as follows:
- Applicant: NA 01 – Name & Address
- Building: MA026 – CAMA Buildings
- Primary Contact: NA 01 – Name & Address
- Primary Inspector: NA 01 – Name & Address
- Miscellaneous Billing: MB01 – Miscellaneous Billing
- Owner: NA 01 – Name & Address
- Parcel Information: PC01 – Property Information
- Personal Property: PP01- Personal Property Information
- Self Reported Tax: ST007 – Self Reported Tax
- Utility Billing:
- Workflow:
Expression for Reference Type Description Header
Click the ellipsis button in this parameter to open the Expression Selector. The header is entered between single quotation marks. This appears above the Search parameter on the Govern user form.
The following screen shot show the parameter for the applicant.
- Applicant: Name – Applicant
- Building: Building
- Primary Contact: Name – Contact
- Primary Inspector: Name – Inspector
- Miscellaneous Billing: Misc Billing
- Owner: Name – Owner
- Parcel Information: Property Information
- Personal Property: Personal Property
- Self Reported Tax: Self Reported Tax
- Utility Billing: Utility Billing
- Workflow: Workflow
Name for Reference Type Description Query
The queries must have a column named ID and a column named Description. For the Building, there must be a query name Sequence, as well. The entry point is either the Parcel ID for the workflow record or a linked ID.
All IDs already linked to the workflow are excluded.
Applicant: WMDESCNA – Name Description
For the Name query, the same Name ID (NA_ID) can be displayed multiple times in the same list. For example, the same name could be displayed for the Owner and Applicant. This is not true for any other system IDs.
For the names, the query returns all names
Building: WMDESCBLDG – Building Description
For the building, the query returns all buildings (PC_LK_PARCEL_BLDG. BLDG_ID) linked to the record.
Primary Contact: WMDESCNA – Name Description
For the contact, the name query is used.
Primary Inspector: WMDESCNA – Name Description
For the inspector, the name query is used.
Miscellaneous Billing: WMDESCMB – Misc. Billing Description
For Miscellaneous Billing, the query returns all Miscellaneous Billing records (MB_MASTER.MB_ID) linked to the parcel.
Owner: WMDESCNA – Name Description
For the owner, the name query is used.
Parcel Information: WMDESCPA – Property Description
For the parcel, the query returns all other active (Parcels PC_PARCEL.P_ID) linked to the parcel on which the workflow is based.
Personal Property: WMDESCPP – Personal Property Desc.
For Personal Property, the query returns all Personal Property records (PP_ASSESSMENT.PP_ID) for the Year ID and Frozen ID linked to the parcel.
Self Reported Tax: WMDESCST – SRT Description
For Self Reported Tax, the query returns all Self Reported Tax accounts (ST_MASTER.ST_ACCT_ID) linked to the parcel.
Utility Billing: WMDESCUB – Utility Billing Desc.
For Utility Billing, the query returns all Utility Billing records (UB_MASTER. U_ID) linked to the parcel.
Workflow: WMDESCWM – Workflow Description
For the workflow, the query returns all workflows with the same P_ID linked to the parcel.
Search Group Code
For the defaults, no search group is selected.
Search Style Code
Applicant: WMSEARCHNA – By Name ID
For the Names, the user can search for a name in the database (Search for existing) or create a new name.
If the user selects Search for existing, the Name Search is displayed. A Name ID can be entered.
Building: WMSEARCHBLDG – By Building ID
For the building, the user can search for any building by Building ID.
Primary Contact: WMSEARCHNA – By Name ID
For the contact, the name search is used. The user can search by Name ID.
Primary Inspector: WMSEARCHNA – By Name ID
For the inspector, the name search is used. The user can search by Name ID.
Miscellaneous Billing: WMDESCMB – Misc. Billing Description
For Miscellaneous Billing,.
Owner: WMSEARCHNA – By Name ID
For the owner, the name search is used. The user can search by Name ID.
Parcel Information: WMDESCPA – Property Description
For the parcel, the query returns all other active (Parcels PC_PARCEL.P_ID) linked to the parcel on which the workflow is based.
Personal Property: WMDESCPP – Personal Property Desc.
For Personal Property, the query returns all Personal Property records (PP_ASSESSMENT.PP_ID) for the Year ID and Frozen ID linked to the parcel.
Self Reported Tax: WMDESCST – SRT Description
For Self Reported Tax, the query returns all Self Reported Tax accounts (ST_MASTER.ST_ACCT_ID) linked to the parcel.
Utility Billing: WMDESCUB – Utility Billing Desc.
For Utility Billing, the query returns all Utility Billing records (UB_MASTER. U_ID) linked to the parcel.
Workflow: WMDESCWM – Workflow Description
For the workflow, the query returns all workflows with the same P_ID linked to the parcel.
Used In
The Used In list box of the bottom of the form displays the Workflow Categories that use the current Link Type.
Creating New Link Types
To create a Workflow Link Type:
- Launch GNA.
- Select Application Configurations > Workflow Management > Link Types.
- Do one of the following:
- Click Copy to create a new link type from an existing one. You must change the Code and make any modification on the form.
- Click New to create a new link type.
- Modify the parameters as required.
- Click Save.
Adding Link Types to Workflow Kinds and Categories
To add a Link Type to a Workflow Kind and Category:
- Launch Govern.
- Select Workflow Management > Kinds and Categories.
- Select the required Workflow Kind, such as Permits, in the tree view.
- Select the Categories tab.
- Select the General tab under Categories.
- Select the required category in the tree view.
- The Link Types that you created are displayed under Supported Link.
- Select the link types that are applicable to the category.
- Deselect the link types that are not applicable.
- Click Save.
Using Link Types in Govern
Overview
By default, Link Types are added to two separate entities on the Workflow form in Govern.
To add a Name Link Type:
- Launch Govern.
- Open a Profile that contains the Workflow form.
- Open the Workflow form.
- Select the Name Links entity.
- Click New to add a new linked name.
- Select the type from the Link Type drop-down list.
- All the link types, set up by NA_ID, that you have selected for the Workflow Kind and Category are displayed.
- Select a link type from the drop-down list.
The Create New and Search for existing parameters are displayed.
- In addition, the Suggested Links parameter is displayed if a name was already added to the form. The same NA_ID can be added multiple times to a form.
- Follow one of the procedures in the following section:
- The name and address are added to the Description list.
- Click Save.
Adding a New Name and Address Account
You can create a new name and address account for the record. In order to update the record from a direct link, the Name and Address form must be added to the same Profile as the Workflow form.
To create a new Name and Address record:
- Follow the procedure for adding a new Name Link up to step 8.
- Click Create New.
- A new NA_ID is added to the form.
- Click Save.
- Click the new name link to open the Name and Address form.
- Enter the information for the new name account on the Name and Address form.
- Click Save on the Name and Address form.
Adding an Existing Name and Address Account
You can link a name from a name and address that is in the Govern database.
To add an existing name and address record:
- Follow the procedure for adding a new Name Link up to step 8.
- Click Search for existing to add an existing name to the form.
- The Name and Address search screen opens.
- Enter your search criteria.
- Select a name and address account from the list.
The name and address are displayed on the form.
Adding a Name From the Suggested Links
If name accounts are already linked to the Workflow record, they are displayed under Suggested Links. This is shown in the following screen shot:
To add a name from the Suggested Links list:
- Follow the procedure for adding a new Name Link up to step 8.
- Select a name from the Suggested Links list to add the name and address to the form.
- The name and address are added to the Description tree view on the left. They are displayed by link type.
- Click Save.
103-wm-parm-401




(0 votes, average: 0.00 out of 5)
You need to be a registered member to rate this.
Loading...