Workflow Management Specification and Business Rules
Version 6.1 (In Development)
General Specification
General Module
- Module Workflow is by name or property
- A/R generated is name base (mandatory)
- A/R generated is linked to a parcel when Category Entry Key Type is set to Parcel ID
- A/R generated can be year base when Sub-System defined parameter is set By Year
- A/R sub-systems for Land Management workflow are LM and L2 (partially)
* Valid A/R class code types = Billed or Blank - A/R sub-systems for Other workflow includes all sub-systems (MA, UB, MB, ST, DC…)
* Valid A/R class code types = Fee (only) - Department ID is numeric in some cases and alpha in other – to be verified
Workflow Definition
- Workflow Kind must be unique
- Workflow Category must be unique among all Kinds
- Workflow Type must be unique for the Kind and Category – to be verified
- Added Fields can be added to Kind and Categories
- Added Fields must be unique for the Kind and Category – or all to be verified
- Workflow Steps are linked at the type level
- Workflow Activities are defined at department level and are linked to steps
- Workflow Multimedia codes are defined at the department level
- Activity number is auto-generated as it needs to be unique and recorded as a guid
- Activity answers (unlimited answer codes can be defined – only 4 can be used – completion status 1 to 4)
- Inspection type codes are defined at the department level
- Inspectors are defined at the department level
Workflow Records
- Workflow Reference Numbers are unique (Application, Number and Certificate sequences)
- Workflow Reference Numbers counters are stored in USR_DYNAMIC and follow the Workflow Configuration Business Override Rules (Kind, Category, Department, Type)
- Inspectors are linked to one or more department(s)
- Inspectors are linked to a territory or all territories
- Inspectors are linked to selected inspection type codes (or all) available for the department
- Inspections are linked to workflow and inspectors
- Workflow Activity Tasks can be linked to a specific user
- Workflow Activity Tasks can be linked to a specific department – to verify
- Workflow Records can expire
System Integrity Rules (to be or not to be)
The following integrity rules are applicable in order to prevent orphan records:
- Departments with workflow setup cannot be deleted – to be verified
- Parcel records cannot be deleted if a permit is linked to it.
- Name records cannot be deleted if a permit is linked to it.
- Building records cannot be deleted or inactivated if a permits is linked to it.
- Kind, Categories and Added Fields cannot be deleted (roadmap)
- Activity records cannot be deleted if used in Workflow Type Steps.
- Workflow with AR cannot be deleted
Features & Characteristics
Workflow Classification (Business Rules)
Historical
- Workflow can be classified as historical. To verify – field is deprecated. In this mode, the workflow can be viewed only by users with Full Access Rights who can modify the data. (to review )
Voided
- Workflow can be classified as void or nullified. Voided permits appear in red and are marked as voided on all reports and inquiries. (to review)
On Hold
- Workflow can be classified as On-Hold. No further activity steps are executed for the workflow. The words *On-Hold* are displayed in red and can be viewed when you select the workflow through a search. It remains on-hold until this option is deselected. (to review)
Not Subject to Tax Title/Lien
- Workflow can be classified as Not Subject to Tax Title/Lien. (to review)
User Defined Workflow Linking
Link Types
- Workflow Link Type Codes are defined (unlimited) at the Organization Level (see GNA Workflow Application Configuration menu)
- Workflow Link Type Codes are linked at the Category Level (supported links)
- Workflow Name Link Type Codes includes Applicant, Owner, Contractor, Inspector ….
- Workflow Other Link Type Codes includes:
- Projects and Folios (roadmap)
- Parcels, Buildings, Misc. Billing, Utility Billing, Self-Reported Tax, Personal Property
- Other Existing Workflows (Kind and Category)
- Submissions, Events, Conditions (roadmap)
Default Link Options by Kind
- Workflow Default AR Link Name Type is set up at the Kind Level (i.e. Owner, Applicant, Primary Contact, Primary Inspector) [vt table wmname]
- Workflow Default Applicant Type is set up at the Kind Level [vt table wmname]
Automatic Linking Options
Automatically Link Owner (category option)
- The property owner is automatically listed as an Owner, if Automatically Assign Owner is selected on the Workflow parameters form in Govern Admin. If the property has multiple owners, all the owners are listed. – roadmap
Automatically Link Applicant (category option)
- The property owner is also automatically listed as the Applicant, if Automatically Assign Applicant is selected on the Workflow Parameters form in Govern Admin. If the property has multiple owners, the Primary Owner is listed as the Applicant. The Primary Owner is either the owner assigned Priority Sequence 1 on the Owner Information form or the name from the first record for this form.
Auto Assign Inspector
- The inspector assigned to the Inspection Territory for the parcel is automatically listed as the Approval Inspector, if Automatically Assign Inspector is selected on the Workflow Parameters form in Govern Admin (Tables: PC_AREA and WM_INSPECTORS).
Option Prompt License to Individuals
- If the Prompt License to Individuals option is selected on the Workflow Parameters form in Govern Admin and one or more licenses are linked to the name, a Browsing screen is displayed.
- Highlight the applicable license and click Select. The expiration date is automatically added to the list.
Display All Licenses Issued to the Individual
- All Licenses (workflow type) for the name linked is listed on the Name Link Form Entity (roadmap)
- The following was included on prior versions to be reviewed if available by default or by user config of wm_link controller for the different workflow link types (wmLINKTYPES)
- License Expiration Date: This field displays the date the contractor’s license will expire.
- Linked Type: This field displays the Workflow Type associated with the name or group if multiple permit types are entered on the General tab.
- Telephone Number: This field displays the telephone number associated with the name as entered in the Additional Name Information table.
Automatically Link System IDs
- (roadmap – to verify if parcel, building, etc.)
Name Groups
- Automatically Links all the names that are part of the Contractor predefined selected group of names (roadmap)
Workflow Reference Numbers (User Key Dynamics)
The reference number can contain up to 16 characters .
- A reference number is generated for application, number and certificate
- Registration number refers to the certificate number on certain workflow kind (i.e animal licenses….)
- A reference number is generated for Project Folio number and Hearing number (roadmap)
- The reference number includes a user defined prefix and the number of numerical digits to be generated.
- For each subsequent workflow application, number and certificate the system increments the series by one.
Workflow Number Override Rules
Sequence number generated for permits, licenses and other workflow types can be setup at 3 different levels:
- Kind: Same sequence for all the workflow of this category
- Category: Same sequence for all the workflow of this category
- Department: Same sequence for all the workflow types within the department
- Permit/Workflow type: Sequence numbers are generated by type
Same Sequence Number Option (to be reviewed)
- Standard: To use the Standard Method, select Same Sequence Numbers for All Functions on the General tab. With the Standard Method, you can enter one alphabetic character in the first field and the digits in the second field. For example, enter an A for the applications, a P for the permits and a C for the certificates. Then enter a series of eight numbers. For the first application, permit and certificate, the system uses this number: The number of digits you can enter depends on the number specified in the Sequence Number of Digits field.
- Alternate (Sequence Numbers by function): With the alternate method, you can create different sequence numbers for each function. The functions are listed in the left column. You can enter two alphabetic characters in the first field and, as before, the digits in the second field. The number of digits you can enter depends on the number specified in the Sequence Number of Digits field on the General tab, in the second field. For example, enter an AE for the Electrical Permit Applications, a PE for the Electrical Permits and a CE for the Electrical Certificates. Then enter your sequence of x digit numbers.
Alternate Workflow ID Number (deprecated?)
The Alternate Permit ID (P_ID) number is used as a secondary means of keeping track of workflow.
- This Alternate P_ID is created by the user.When you attach secondary permits to a primary permit ID, if the alternate permit ID field is blank, then any linked permits will share the same Alternate P_ID.
- Linked workflow share the same Workflow MASTER ID’s. The Alternate Permit ID (P_ID) number is used as a secondary means of keeping track of workflow.
- This Alternate P_ID is created by the user.
- When you attach secondary permits to a primary permit ID, if the alternate permit ID field is blank, then any linked permits will share the same Alternate P_ID.
Linked Workflow Search Feature
- This feature now introduces possibilities with searches; now when you do a workflow search using the Alternate Workflow ID, all linked permits can be retrieved. For example, in issuing an electrical permit for exterior signage, we can link related Building, and Electrical permits and enter an Alternate P_ID.
Workflow Dates (to review)
Starting Dates
- You can define a starting date that is automatically generated from an activity. (to verify) This is defined on the Workflow Activity Actions setup in Govern Admin.
- Alternately, you can enter the Starting Date directly when completing an activity.
Expiration Dates
- Like the Start Date, the expiration date can be generated automatically from an activity or entered directly on the Workflow function form.
Complete Before Dates / Critical Dates (deprecated)
- Like the Start Date, the complete before date can be generated automatically from an activity or entered directly on the Workflow function form.
Workflow Security
- General Security by form profile, role and user
- Department Security for Multimedia
Accounts Receivable
Setup
A/R Sub-systems that can be used To validate
- LM / L2 AR Class Codes
- LT AR Class Codes (deprecated)
- Other sub-systems
A/R parameters Setup
Can be defined at any of the following levels:
- Departmental: Through the Workflow Management Department Configuration
- Workflow Type: Through the Department Type Configuration.
- Activity Step Fee Action: Through the Department Type Steps Configuration (can allow user override)
- Fee: Through the Category Configuration of Kind and Category.
NOTE: If these parameters are defined at more than one level, those set at the most specific level are used; i.e., A/R parameters defined at the fee level override all others, those defined for the Activity Step override those defined for the Permit Type, Department or Organization; parameters defined for the Permit Type override those defined for the Department or Organization and those defined for the Department override those defined for the Organization. |
A/R Name Business Rule To Validate
Default A/R Name option
- The default (or mandatory) name type must be defined at the category level.
- Depending on the setup (verify validation rules) you may need to associate an individual or company with the workflow before saving a new record, if for instance, a fee is generated from the start of the process and A/R needs to be created. – to be verified
- A warning message appears if a name has not been associated with the workflow – deprecated?
Action Button – Create A/R for Workflow To Validate
- The A/R can be created prior to generating a fee in the case where a deposit is required before starting the process.
- The action button must be configured on the form
Fee Generation & Override
to be reviewed
Total Fee
- This field displays the total amount calculated through the Activity Steps. – to verify
Last Fee Date
- This field displays the date of the last calculation. To verify
Last Fee
- This field displays the last calculated fee. You can override this amount if the Allow Fee & G/L Override option is selected on Workflow Department? Parameters form in Govern Admin. –to verify
Fee Distribution Override
- The Fee Distribution Override pop-up is used to modify the Fee, Fee Description, G/L Account and A/R Class Code for the selected workflow type under the following conditions:
- If the Allow Fee & G/L Override option is selected on the Workflow Management Parameters form in Govern Admin, you can modify both the fee and fee description.
- If the Link to A/R option is selected on the Workflow Management Parameters form, you can specify the G/L account and the A/R Class Code.
- If the Allow Fee & G/L Override option is not selected, you can modify only the fee description.
Workflow System Functionalities
Group of Name Definition
roadmap
The Group of Names form is used to group individual names together. This is useful; for example, when you need to link a permit to many names, such as an architect, electrician and plumber working for the same contractor. Instead of linking each name separately, you can link all, at the same time.
Allow Quick Data Entry
to be reviewed
- If the Allow Quick Data Entry option is configured, different fields appear on the Quick Data Entry form when a new workflow type is selected. – deprecated?
Duplicate Workflow
to be reviewed
Duplicate Workflow
The Duplicate Permit option can be used to duplicate workflow applications for all workflow Kind functions, associated with a property record, including Building, Electrical, Plumbing and General Permits; Approvals; Bonds; Decisions; Prosecutions and Appeals. When you select Edit > Duplicate Permit, you are copying the current permit application to one or more parcels. This creates a new permit record with the same permit types and generates a new Application Number. The fees, applicant name and links are not copied.
Allow Duplicate Workflow State OPTION (Issue Permits)
Note: Unless the Allow Duplicate Issue Permits option has been selected in the Land Management Parameters form in Govern Admin, this option can only be used for permits that have not yet been issued. See Allow Duplicate Issue Permits on page 14
Duplicate Workflow to a Dataset
to be reviewed
You can select individual parcels or duplicate the permit to all parcels in an extermal record set (Table PC_EXTERNAL).
Name Groups
- Name Groups can be defined and linked – Roadmap
- Multiple Groups for Builder/Contractor Teams
Standard System Options
Workflow Multimedia
Multimedia Image Queue
Link Multimedia to all Workflow for Property (bp) – deprecated
The Link Multimedia Files to Permits function is used to link multimedia files to multiple permits. See Link Multimedia Files to Permits on page 707
Audit Trail
You can set the Audit Trail on the Forms or Dimensions tab of the Permit functions. The following tables can now be set on the Audit Trail and Data Duplication Setup form:
Central Notes
to be reviewed
Query Tool
- Query Tool (to be reviewed)
- Central Notes (not applicable)
Standard Application Features
Split/Merge Processing
roadmap
Permits linked to Property
Permits linked to Building
Parcel Duplication
roadmap
Roll Forward and Audit
roadmap or obsolete or deprecated?
ACH Processing
roadmap
Technical Specifications
Database Standards & Tables
- All Workflow Management (WM) Database Tables are prefixed with WM_
- All tables contain the Primary Key WM_ID
- Workflow Kind Tables are prefixed with WM_KIND_[Kind Code]
- Workflow Category Tables are prefixed and suffixed with
- SINGLE Type categories are prefixed with WM_CATEGORY_[Category Code]
- MULTIPLE Types categories adds the suffix WM_CATEGORY__[Category Code]_TYPES
- WM Standard Database Tables are created on running the DB Verify Database Utility in GNA.
- Master Tables: WM_MASTER, WM_LINKED_IDS
- Parameter Tables: WM_PARM_ Kind, Category, Depart, Type, Fee, Inspection
- Dynamic Changes are made in the Tables and Business Entities upon configuration of Kind, Categories and Type and will appear the next time the Business Entity Designer is opened.
OpenForms Govern IDs
Profile IDs
- Parcel ID, Name ID
Govern Reference IDs
- Parcel ID (Tax map, Subdivision & Lots, Legal) including non-parcel ID (Streets, Parcs, Roads and other polygon areas)
- Name ID (Applicant, Contractor Name Group, Inspector….)
- Workflow ID
- User ID (Assigned to, Inspector …) – roadmap
- Dept ID – roadmap
- Project ID -as part of the Special Assessment roadmap
- Building ID & Sequence
- Sub-System Reference ID (MB, UB, PP …)
- A/R Detail ID
- Permits (PM ID) Offense (OF ID), Complaint (CO ID)… deprecatred in 6.1+
Other Workflow Links:
- Other Workflow
- Inspections
- Parcels
- Buildings (pm_lk_permit_bldg)
- Miscellaneous Billing Account (PM_LK_MISC_PERMIT)
- Self-Reported Tax Account (pm_lk_st_keys)
- Utility Billing Account (pm_lk_ub_permit)
- Personal Property Account
- Submissions (pm_lk_subm)
- Project / Folio (pm
- Conditions (pm_lk_conditions)
- Events (pm_lk_events) – assigned to usr_id
See Also
Workflow Setup
Organization Level
- Kind & Category
- Workflow Link types
Department
- Department & Type
- For more info, see Configurations
101-wm-brules