TX – BP Load LockBox Entries (101-tx-bp-005)

Load LockBox Entries Batch Process

Release 6.1.1912 | 6.0.1904 | 6.0.1903

Overview

This batch process will load a payment lockbox file from a third party to Govern.

Documentation

When available a link to documentation is located here.

Configuration

This Batch Process uses the standard BP configuration.

TECH NOTE: Process code: GWF_LOCKBOX

Load LockBox Entries batch process Parameters

Preload: Create a record in table AR_LOCKBOX_HEADER and load all records from selected file to table AR_LOCKBOX_DETAIL

Replace File: if the file already loaded, a message will show ” and won’t let you load the file. If you want to delete the previous file and reload it, you need to check this option.

Process From File: Preload the file to table and load the payments

Update Duplicate Bill in Mailing: after loading the payment, the field DUPLICATE_BILL will be updated to -1

Process Preload file(s): Load the payments from (Table: AR_LOCKBOX_DETAIL) from the selected batch number.

NOTE: The batch number is required.

File Validation Only: Select this option to go through all records from the file, simulate the load of payment and list all error(s).

Scheduler Configuration

To process a payment, the Accounts Receivable (AR) needs a department; when run in Govern the process will use the Profile department.

If the batch process is run through the Scheduler, there is no Department set. At the location indicated below, select a department configuration that the Lockbox will use when it is run in the Scheduler:

Applicable Business Rules

N/A

Miscellaneous Billing (MB) – Lien Transfer Batch Process

Specification Overview

Purpose

Run the batch Miscellaneous Billing Lien Transfer process to transfer outstanding balances from the Accounts / Receivable to the Real Property Taxation sub-system. This process will only transfer Balances from MB Accounts that have a parcel linked to it. The balances will be transferred as an Override Levy on the Parcel so it can be included on the next Property Tax billing.

Identification

Process Name: MB_LIEN_
Requirement Number: 16117

Records to be processed:

See Selection Criteria

Batch Processing:

The batch program can be scheduled to run periodically.
The transaction Mode “Roll Back If One Transaction Failed” is not supported. It will be “Continue If One Transaction Failed” by default
Refer to the Standard Batch Process details Batch Program Setup or Govern Scheduler for more details

Read More...Read Less...

Batch User Interface

The following parameters and options are available:

Selection Criteria

Year

Enter the year by which the records are saved.
Note: This field appears only if A/R Master by Fiscal Year is selected for the Miscellaneous Billing subsystem on the A/R General Parameters form in Govern Admin.

Minimum Balance Due

Enter the minimum balance due. Accounts with a balance due less than this amount are not transferred.

Billed Up to

Enter the last billing date that will be able to be transferred. Any invoices billed after that date will not be included.

A/R Class Code

Select an A/R Class Code from the drop-down list (Table: VT_USR_AR_CLASS) to be used to Add a Lien charge to the existing balance. The default amount in the AR Class code setup it used for the Charge. Would be nice to have a parameter to enter the Charge amount on the Batch screen.

Batch Variables

A/R Reason Code

Select a justification for the transfer, from the drop-down list (Table: VT_USR_ARREASON). This will be included in the AR_DETAIL records created on the MB subsystem for the credit charges.

Batch Execution

The batch program can be executed on demand or scheduled with Govern Scheduler.

During the execution, warning and error messages will be presented in the batch result grid.

On error, the misc. billing account id will be displayed in the message – to verify
For any error, double-click on the message to access the full text

Once completed, information will be displayed, that includes:

A unique batch audit ID
Application name and version, such as Govern Batch Processing, 6.0
Batch process name with any additional notes, such as parameters loaded
User ID
Date and time the process was started
Date and time the process was completed
Parameters and Options used
Total number of records read
Total number of records processed
Indication as to whether the process was successful or not

Lien Transfer Log
A log of Miscellaneous Billing Accounts Transferred will be generated.

Batch Processing (Technical)

Before Executing Subprocesses:

Select all parcel ID and frozen ID related to the year (or all year if none selected) the jurisdiction, or the neighborhood or the saved dataset if chosen.

Execute Subprocess

For each batch process

Error Reporting
In addition to the standard Batch Processing standard error reporting, any additional validations will be listed below:

Troubleshooting

The following is to help troubleshoot the batch process.

After changes, it is always best to compute for a single year and small dataset
The parcel id is listed in the error message
Turning on the Govern Diagnostic Tool
Turning on the SQL Profiler Tool (system administrator)

Miscellaneous Billing (MB) – Sales Tax Compute Process

Overview

Run the Miscellaneous Billing Compute Sales Tax batch process, after changing the sales tax parameters on the Miscellaneous Billing General Parameters form. These parameters are saved by year. The batch process recalculates all unposted Miscellaneous Billing invoices that meet the following criteria:

Standard (one-time) Invoices
Recurring Invoices

Invoices with items that are subject to sales tax.
Are Invoiced for the year entered in the Year parameter.
All these invoices are recalculated with the sales tax definitions of the corresponding year.

For details on defining the sales tax , see Miscellaneous Billing General Parameters

Read More...Read Less...

Accessing the Miscellaneous Billing Compute Sales Tax Batch Process

The Miscellaneous Billing Compute Sales Tax Process can be run from Govern, GNA (for testing purposes), or the Govern Scheduler.
To set up run the MB Compute Sales Tax Process from Govern:

Launch Govern.
Open a Profile that contains Miscellaneous Billing.
Select the Miscellaneous Billing form.
Enter the year, corresponding to the invoices that you want to update and the sales tax definitions, in the Year parameter.
Do one of the following:

Click the the Run arrow to run the process immediately.
Click Schedule to set up a schedule to run the process at a later date or on a regular basis.

Verifying the Miscellaneous Billing Compute Sales Tax Batch Process

If you are running the Miscellaneous Billing Compute Sales Tax batch process from Govern, you can click the Processing tab of the batch process and verify the execution. A progress bar is displayed along the top and information and warning messages are displayed.

After the process has run, The End is displayed on the progress bar. You can review the error, warning, and informational messages. The latter include:

Starting and Ending Time
Number of Records Processed
User ID
Batch ID
Transaction Mode
Batch Process Name

Notes

Synchronous Mode
This batch process runs in Synchronous mode only. If it is configured to run in Asynchronous mode in GNA:

A warning message appears to indicate that the process is running in Synchronous mode.
An information message appears to indicate that the Transaction Type parameters is set to Asynchronous.

Executing the Miscellaneous Billing Sales Tax Computation Batch Process

The Miscellaneous Billing Sales Tax Computation batch process performs the following calculations sin order to update the unposted Miscellaneous Billing invoices. It is run on both standard (one-time) invoices and recurring invoices.

It is typically run when changes are made to the Miscellaneous Billing Sales Tax rates on the Miscellaneous Billing General Parameters form in GNA.

Compute

The computation is run on all standard (one-time) and recurring Miscellaneous Billing that are unposted.

The computation is run on all standard (one-time) and recurring Miscellaneous Billing that are unposted.
The following fields are calculated:

Total
Sales Tax 1
Sales Tax 2

For all items, the price is multiplied by quantity:
ITEM_PRICE * ITEM_QTY

The totals for the sales tax are calculated:
TOTAL_SALE_TX_1
TOTAL_SALE_TX_1

Notes

Sales Tax 1 and Sales Tax 2 are calculated only for items that are subject to sales tax.

This is defined on the Miscellaneous Billing Items form in GNA. For each item, the option Subject to Sales Tax 1 and Subject to Sales Tax 2 can be selected or deselected.

The Miscellaneous Billing Account, which is set up for an individual or a company, can be exempt from one or both sales taxes. This is defined on the Miscellaneous Billing Account form in Govern. For each account, the options Exempt #1 and Exempt #2 can be selected or deselected.

Related Information

Refer to the Standard Batch Process details Batch Program Setup or Govern Scheduler for more details

Batch Execution

The batch program can be executed on demand or scheduled with Govern Scheduler.

During the execution, warning and error messages will be presented in the batch result grid.

On error, the misc. billing account id will be displayed in the message – to verify
For any error, double-click on the message to access the full text

Once completed, information will be displayed, that includes:

A unique batch audit ID
Application name and version, such as Govern Batch Processing, 6.0
Batch process name with any additional notes, such as parameters loaded
User ID
Date and time the process was started
Date and time the process was completed
Parameters and Options used
Total number of records read
Total number of records processed
Indication as to whether the process was successful or not

Log
A log of Miscellaneous Billing Accounts Computed will be generated. – need to verify if needed

Batch Processing (technical)

Before Executing Subprocesses:

Execute Subprocess
Error Reporting

In addition to the standard Batch Processing standard error reporting, the following will be validated:

What’s New

[6.0] Batch program created for OpenForms

Troubleshooting

The following is to help troubleshoot the batch process.

After changes, it is always best to compute for a small dataset
The parcel/account no. id is listed in the error message
Turning on the Govern Diagnostic Tool
Turning on the SQL Profiler Tool (system administrator)

Batch Process Definition Setup – Version 5

Version 6.x | Version 5 and lower

Overview

The GNA Batch Process Definitions form is used to define how you want your batch processes to appear and run in Govern. This includes setting up the menus and submenus for organizing your batch processes, configuring whether each process is run on a single server or on multiple servers, associating one or multiple reports, and synchronizing the batch process definitions and adding permissions. When complete, the batch processes are displayed in Govern.
This procedure has two major steps:

Configuring Batch Process Definitions
Adding Batch Processes Definition to Govern.

Read More...Read Less...

Configuring Batch Process Definitions

Configuring Batch Process Definitions describes the following topics:

Batch Process Definitions User Interface

This section provides a tour of the Batch Process Definitions UI. The interface is comprised of a treeview, the definition form, and a secondary window for creating the menus and submenus or categories.
To access the Batch Process Definitions form:

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.

Once you create menus and define batch processes, the selected items are listed in a treeview on the left of the form. You can display or hide the treeview according to your preference.

About Batch Process Definitions

You can view, add, or modify a batch process definition, as described later in this section.
To display or hide the English and French long and short descriptions, click on the arrow beside the text box at the top of the form.

About the Menu Manager

The Menu Manager form is used for creating the menus and submenus for organizing your batch process definitions in Govern.NET.
To access the Menu Manager

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.
Click the ellipsis button beside the Category text box.

If categories are already created, they are listed on the left. You can expand a category to view secondary levels if they exist. The name of selected menu is displayed on the right. You can expand the name to view the English and French short and long descriptions.

Creating a Batch Process Category

The first step is to create categories for your batch processes. The categories are used for displaying the batch processes in the Govern .NET menu. Create as many categories as required in order to facilitate user input.
To create a Batch Process:

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.
Click the ellipsis button beside the Category text box. This opens the Menu Manager.The Menu Manager is used for creating categories for the batch processes. You can have multiple levels. For example, you could group batch processes by module, such as: Accounts / Receivable, Tax Billing, and Mass Appraisal. Then, you could add another level that groups processes according to when they need to be run; i.e., daily, monthly, or yearly. You can create any type of category that is useful for your organization.
Enter a name for the category in the text box at the top right. This is automatically added to the English Long Description field.
Click the button to the left of the text box where you entered the category name. This expands a menu with additional descriptions.
Add an English Short Description and French Short and Long Description as required. These fields are optional.
Click Save to add the category to the menu.

If you click the Select button without saving your new category, a confirmation message appears:

Deleting a Menu Category

To delete a menu category from the Menu Manager:
1. Launch Govern New Administration (GNA).
2. Select Batch Process > Definitions.
3. Click the ellipsis button beside the Category text box to open the Menu Manager.
4. Expand the applicable menu.
5. Select the category from the Menu list on the left.
6. Click the Delete button in the menu at the top right.
7. When the confirmation message appears, click Yes to delete the record.

Selecting a Category for the Batch Process

You need to define the processes under the categories to which they are assigned and will appear in Govern. Before defining a batch process, select the menu category where it will be saved.
To select a Batch Process:

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.
Click the ellipsis button beside the Category text box to select the category for the batch process. This opens the Menu Manager.
Expand the root menu to display the submenus.
Select the applicable submenu or category.
Click the Select button .

The root menu and all submenus are displayed in the Category text box and in the Parent Path text box. The existing batch processes are listed on the left.

Defining a Batch Process

Use the following process to name the definition and to associate it with a Govern Batch process.

NOTE: You need to define the processes under the category to which they are assigned and will appear in Govern.

To define a Batch Process:

Select the category where you are defining the process as described under Selecting a Category for the Batch Process. The batch processes already defined for the category are displayed in the treeview on the left.
Click the New button.
Enter a code for the new batch process definition. This is a required field.
Select a Govern batch process from the Process drop-down list. This is a required field.
Enter a name for the record in the text box at the top right. This is automatically added to the English Long Description field.
Click the button to the left of the text box where you entered the name. This expands a menu with additional descriptions.
Add an English Short Description and French Short and Long Description as required. These fields are optional.
Click the Save button to add the category to the menu.
If you click the New button without saving your modifications, a confirmation message appears:

Defining the Transaction Type
The Govern batch processes can be run synchronously or asynchronously. If they are run synchronously, they are run on the same server. If run asynchronously they are run on multiple servers at the same time.
Select Synch or Asynch as required. For processes with multiple transactions, it is recommended to use asynchronous processing as this spreads the load over multiple servers and makes for faster processing time.
Pool #: For Asynchronous processes only, enter the maximum number of transactions to be handled by the client servers at any one time.
This works as follows: If you are running asynchronous batch processing, there is one master server that manages all the transactions and is responsible for sending them to the client servers. The value In the Pool # field indicates the maximum number of transactions to send out by the master server at any one time.

Scenario: Running a Batch Process Asynchronously
The following scenario illustrates how asynchronous batch processing works.
The parameters are as follows:

Master server: one
Client servers: five
Transactions: 50,000
Pool #: 50

The master server sends out the first 50 transactions to the client servers. Each server is responsible for ten transactions. As soon as a server completes one transaction, the master server sends it another. This continues until all transactions have been processed. However, there are never more than 50 transactions being handled by the client servers at any given time.

Defining the Transaction Mode

Select one of the following transaction modes for the process.

Break If One Transaction Failed: the process terminates when the transaction fails.
Roll Back If One Transaction Failed: the process terminates when a transaction fails and all the transactions that were completed are cancelled. Computations are returned to the starting point.
Continue If One Transaction Failed: Continue to run the process even if a transaction fails.

Adding a Report

Use the following procedure to associate one or more reports with the selected batch process.
To add a report: to the batch process:

Launch the Batch Process Definitions form.
Select the category for the process as described under Selecting a Category for the Batch Process.
Select the batch process from the treeview on the left.
Click Add Reports.
Select one or more reports from the Choose the Reports menu.
TIP: You can select multiple reports using the left mouse button.
Click Select Reports.

The selected reports are displayed in the List of Reports text box. The parameters for the report are displayed in the Report Parameters list box.
The List of Parameters text box displays the parameters that can be included in the report and that can be used to build an external report; for example, these could include Date To and Date From fields. The purpose is to give you the exact reference and wording of these fields.

Deleting a Batch Process Definition

To delete a batch process:

Launch the Batch Process Definitions form.
Select the category for the process as described under Selecting a Category for the Batch Process.
Select the batch process from the treeview on the left.
Click the Delete button .

Adding Batch Processes Definition to Govern

When you have defined your batch processes, you need to add them to Govern.NET. In order to do this, you need to launch the Govern Security Manager and synchronize your new processes between GNA and Govern. Then, you need to assign access permissions.

Synchronizing Batch Process Definitions

When you have synchronized your new batch process definitions, they appear on the Govern.NET menu.
To synchronize the new batch processes:

Launch the MSGovern Security Manager (GSM).
Select your database connection key.
Right-click on Applications and select Synchronize menu from the dropdown list. A confirmation message appears.
Click Yes on the confirmation message.

Permissions and Batch Processes

Use the following procedure to assign access permissions to the new batch process definitions. You can grant permissions by batch process, batch process menu, or by batch process definition.

Launch the MSGovern Security Manager (GSM).
Select your database.
Expand Applications > MSGovern.NET > Batch Process > Batch Process.
Continue to expand the menus until you are the level where you want to grant permission.
Right-click on the item that you want to secure.
Define the permissions and exclusions as required and as described in the Govern Security Manager.

Batch Process Definition Editor

Version 6.x | Version 5 and less

Overview

The GNA Batch Process Definitions editor is used to define how you want your batch processes to appear and run in Govern. This includes setting up your batch processes, configuring each process, associating one or multiple reports, and synchronizing the batch process definitions and adding permissions. When complete, the batch processes are displayed in Govern.
This procedure has two major steps:

Configuring Batch Process Definitions
Adding Batch Processes Definition to Govern.
Configuring Sequential Batch Processes (101-std-fea-046)
Configuring Sequential Batch Processes (101-std-fea-046)

Read More...Read Less...

Configuration

Configuring Batch Process Definitions

Configuring Batch Process Definitions describes the following topics; locate the appropriate sections on this page:

User Interface
Defining a Batch Process
Defining the Transaction Type
Defining the Transaction Mode
Adding a Report
Deleting a Batch Process Definition

Batch Process Definition – User Interface

This section provides a tour of the Batch Process Definitions UI. The interface is comprised of a treeview (left hand side), the definition form (main central area), and a secondary window for creating the menus and submenus or categories.
To access the Batch Process Definitions form:

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.

Once you create menus and define batch processes, the selected items are listed in a treeview on the left of the form. You can display or hide the treeview according to your preference.

About Batch Process Definitions

About the Menu Manager

The Menu Manager form is used for creating the menus and submenus for organizing your batch process definitions in Govern.NET.
To access the Menu Manager

Launch Govern New Administration (GNA).
Select Batch Process > Definitions.
Click the ellipsis button beside the Category text box.

Defining a Batch Process

Use the following process to name the definition and to associate it with a Govern Batch process.

NOTE: You need to define the processes under the category to which they are assigned and will appear in Govern.

To define a Batch Process:

Select the category where you are defining the process as described under Selecting a Category for the Batch Process. The batch processes already defined for the category are displayed in the treeview on the left.
Click the New button.
Enter a code for the new batch process definition. This is a required field.
Select a Govern batch process from the Process drop-down list. This is a required field.
Enter a name for the record in the text box at the top right. This is automatically added to the English Long Description field.
Click the button to the left of the text box where you entered the name. This expands a menu with additional descriptions.
Add an English Short Description and French Short and Long Description as required. These fields are optional.
Click the Save button to add the category to the menu.
If you click the New button without saving your modifications, a confirmation message appears:

Master server: one
Client servers: five
Transactions: 50,000
Pool #: 50

Defining the Transaction Mode

Select one of the following transaction modes for the process.

Break If One Transaction Failed: the process terminates when the transaction fails.
Roll Back If One Transaction Failed: the process terminates when a transaction fails and all the transactions that were completed are cancelled. Computations are returned to the starting point.
Continue If One Transaction Failed: Continue to run the process even if a transaction fails.

Adding a Report

Use the following procedure to associate one or more reports with the selected batch process.
To add a report: to the batch process:

Launch the Batch Process Definitions form.
Select the category for the process as described under Selecting a Category for the Batch Process.
Select the batch process from the treeview on the left.
Click Add Reports.
Select one or more reports from the Choose the Reports menu.

TIP: You can select multiple reports using the left mouse button.
Click Select Reports.

Deleting a Batch Process Definition

To delete a batch process:

Launch the Batch Process Definitions form.
Select the category for the process as described under Selecting a Category for the Batch Process.
Select the batch process from the treeview on the left.
Click the Delete button.

Adding Batch Processes Definition to Govern

Synchronizing Batch Process Definitions

When you have synchronized your new batch process definitions, they appear on the Govern.NET menu.
To synchronize the new batch processes:

Launch the MSGovern Security Manager (GSM).
Select your database connection key.
Right-click on Applications and select Synchronize menu from the dropdown list. A confirmation message appears.
Click Yes on the confirmation message.

Permissions and Batch Processes

Use the following procedure to assign access permissions to the new batch process definitions. You can grant permissions by profiles and grant permissions to the Batch Process Editor application in Govern Administrator.

Launch the MSGovern Security Manager (GSM).
Select your database.
Expand Applications > MSGovern.NET > Batch Process > Batch Process.
Continue to expand the menus until you are the level where you want to grant permission.
Right-click on the item that you want to secure.
Define the permissions and exclusions as required and as described in the Govern Security Manager.

What’s New

[6.0] Batch processes no longer use categories. They are linked to a profile.
- For more information, see What’s New in Govern Administrator (GNA) What’s New and Govern Scheduler What’s New

Standard Batch Process – Email Notification

Overview

The Email Message Template editor is designed for creating email messages that can serve as templates for later use within Govern. These are the messages that can be used in Govern modules that have an email functionality. This Email Notification Batch Process is designed to send an email message based upon a user’s queries. This process is configured in the GNA Batch Process Definition editor.
Using a Batch Process, it is possible to configure a SELECT query that will then use an email template. When the batch process is run, each record retrieved from the query will trigger a “Send Email” action. As an example, a query can be written that will retrieve outstanding overdue A/R records. Each record then sends an email message to the associated recipient indicating that they have an account in arrears.

Functionality

The purpose of this batch process is to send an email message based upon the records that are returned by a user designed query. Queries can be written to extract relevant Govern ID’s for tasks such as late payment notifications, impending due dates, and so on. A user with administrator status can design a SELECT query that will retrieve a recordset. The resulting recordset is processed, with each record triggering the sending of an email message. The formatted messages sent will use the email template created in the GNA Email Template Editor.

Read More...Read Less...

Configuration

NOTE: For a listing of the queries used as examples, refer to the List of Queries in the Appendix section below.

The recommended approach for correct implementation is to take the following steps:

1. Design your email template

Determine the format that your email message will take in the GNA Email Template Editor. In the Parameters Expression field, build the expression that will be used to extract the parameters needed for your email message. For example a message that is pertaining to overdue accounts might require some of the following pieces of information.
From and To fields for the email, account holder names and account numbers, dates, and so on.
Refer to the Email Template Editor Wiki page or user guide for details about using the editor.
As indicated earlier, build your query in the parameters expression, it is here that you will determine the required Govern ID’s.
For example…:
{
To = Query(‘naNameInfo’, ‘EMAIL’);
Name = Query(‘naNameInfo’, ‘FULLNAME’);
AccountNumber = Query(‘stAccountNo’, ‘ACCOUNT_NO’);
Category = Query(‘stCategoryCode’, ‘SHORT_DESC_EN’);
PeriodeCode = Query(‘stPeriodCode’, ‘SHORT_DESC_EN’);
PeriodeNumber = Query(‘stPeriodNumber’, ‘SHORT_DESC_EN’);
DueDate = Query(‘stDueDate’, ‘DUE_DATE’);
}
In the above expression, we need the NA_ID’s for name information, ST_ID’s for ST account information and due dates, and so on.

NOTE: Each required query must be created. Refer to the Appendix section below for a listing of queries.

The SELECT query is now written to retrieve the Govern ID’s that are needed in the email template.

NOTE: A message will also need to be created under the Message sub tab in order to be able to save your Email Template; see the Sample Email Message below for an example message

2. Design Your Query

The SELECT Query

It is within the SELECT query being used that you set the Govern ID’s.
Looking at the following query…:
SELECT top 100 f.st_acct_id,
f.na_id,
f.st_id
FROM st_filing_master f
INNER JOIN NA_NAMES n ON n.na_id=f.na_id
WHERE f.unfiled <> 0 AND
f.due_date < GETDATE() AND
(n.email IS NOT NULL AND n.EMAIL <> ‘ ‘)
ORDER BY f.st_acct_id, f.st_id;
The above query was designed in the Select Query Editor in GNA. It will list all filings that are late. An email will be sent to the NA_MAILING address. For the purpose of this example, only the top 100 records are selected.

NOTE: No entities or Govern ID’s are used in the above query. When it is run in the Scheduler or Govern, no ID’s will be set except for the user ID’s and the run date.

3 – Define a New Batch Process

Define a new Batch Process in the GNA Batch Process Definition Editor. This batch process will be initiated through Govern.

Create a new Code.
Complete the Short and Long Description fields.
in the Process parameter, select the “Send Email From Template” option
Click the Save icon on the Batch Process Definition tab.

TIP: Ensure that the newly defined Batch Process has been added to the required profile so that it will be accessible under the Govern Batch Processes Explorer tab.

4 – Design or Select an Email Template

As mentioned earlier, email templates are designed in the GNA Email Template Editor. In the email template parameter expressions can be used. Refer to the About Parameters Expression Field section.
For our example, an email message will be sent to all mailing addresses with a late filing. The information that is required will be retrieved by the Govern ID’s. Each record returned by the query will look through each column to see if it corresponds to a Govern ID; if this is the case, the Govern ID will be set. Then when the email is being sent via the template, the Govern ID will be passed to the template to be used directly within the email, or as a Parameter Expression that is passed to another query. This expression can be designed in the Expression selector.
In our example, another query has been designed to extract information such as the naNameInfo, EMAIL, FULLNAME, ACCOUNT_NO, and so on.

Batch Process Parameters

Selection Criteria group parameters

Looking at the batch process in Govern, the parameters are the standard that are required to be completed.
Select Query – This is the list of available SELECT queries.
Email Template – All email templates in the system.

Run the Batch Process

Once the batch process has been run, each email message will be formatted with the extracted information. All parameters have been replaced with the values requested.

Troubleshooting

Any issues that are associated with this Batch Process that fall under the heading of troubleshooting will be listed in this section.

APPENDIX

List of Queries

The following queries were used as examples for demonstration purposes. They can used as a starting point and modified for other purposes.

— Query Expression:

— To be used in the Parameters Expression field of the Email Template
{
To= Query(‘naNameInfo’,‘EMAIL’);
Name = Query(‘naNameInfo’,‘FULLNAME’);
AccountNumber = Query(‘stAccountNo’,‘ACCOUNT_NO’);
Category = Query(‘stCategoryCode’,‘SHORT_DESC_EN’);
PeriodeCode = Query(‘stPeriodCode’,‘SHORT_DESC_EN’);
PeriodeNumber = Query(‘stPeriodNumber’,‘SHORT_DESC_EN’);
DueDate = Query(‘stDueDate’,‘DUE_DATE’);
}

— Sample Email Message

The following is a sample email message that can be modified as required:

Dear @Name,
The following Account #@AccountNumber has registered a late payment for the @PeriodeCode period of @PeriodeNumber in the @Category.
The actual due date was @DueDate.

— naNameInfo

SELECT EMAIL,
CASE
WHEN FORMAT_CODE=‘c’THEN COMPANY
ELSE FIRST_NAME ||‘ ‘|| LAST_NAME
ENDas FULLNAME
FROM NA_NAMES
WHERE NA_ID=@idna_id

— stAccountNo

SELECT ACCOUNT_NO
FROM ST_MASTER
WHERE ST_ACCT_ID=@idst_acct_id

— stCategoryCode

SELECT VT_USER.SHORT_DESC_EN
FROM ST_FILING_MASTER
INNERJOIN VT_USER ON VT_USER.YEAR_ID=ST_FILING_MASTER.YEAR_ID AND
VT_USER.DEPT=ST_FILING_MASTER.DEPT AND
VT_USER.CODE=ST_FILING_MASTER.CATEGORY_CODE
WHEREST_FILING_MASTER.ST_ID=@idst_idAND
VT_USER.TABLE_NAME=‘ST_CATEG’

— stPeriodCode

SELECT (CASEWHEN ST_FILING_MASTER.PERIOD_CODE =‘ST_INACTIVE_PER’THEN‘Inactive’ELSE VT_USER.SHORT_DESC_EN END)AS SHORT_DESC_EN
FROM ST_FILING_MASTER
INNERJOIN VT_USER ON VT_USER.YEAR_ID=ST_FILING_MASTER.YEAR_ID AND
VT_USER.DEPT=ST_FILING_MASTER.DEPT AND
VT_USER.CODE=ST_FILING_MASTER.PERIOD_CODE
WHEREST_FILING_MASTER.ST_ID=@idst_idAND
VT_USER.TABLE_NAME=‘ST_PER’

— stPeriodNumber

SELECT VT_USER.SHORT_DESC_EN
FROM ST_FILING_MASTER
INNERJOIN VT_USER ON VT_USER.YEAR_ID=ST_FILING_MASTER.YEAR_ID AND
VT_USER.DEPT=ST_FILING_MASTER.DEPT AND
VT_USER.CODE=(ST_FILING_MASTER.PERIOD_CODE +‘_’+CAST(ST_FILING_MASTER.PERIOD_NB ASVARCHAR))
WHEREST_FILING_MASTER.ST_ID=@idst_idAND
VT_USER.TABLE_NAME=‘ST_PER_DETAIL’

— stDueDate

SELECT DUE_DATE
FROM ST_FILING_MASTER
WHERE st_id=@idst_id

Verify Database Process

Running the Verify Database Process for the first time

Overview

As of version 6.0.1408, database tables, fields and views can be created using the Govern New Administration (GNA) Verify Database process. This will facilitate implementation while centralizing the information of tables and fields into one location (MSGDatabaseStructureMods.xml) with TFS source safe control.
In addition, all indexes created and used by the Govern applications will be identified as such and will start with the letters GV or PK when the index is a primary key. This will enable the application to manipulate these indexes when needed. Indexes created by the customer will not be modified or manipulated in any way.

Preliminary Steps

Prior to beginning the database creation process, decide on a name that reflects the current version of the Govern, i.e. DB_NAME60. The 60 is an indication of the Govern release version. This will prove helpful in a multiple database environment.

Main Steps

1. Create an Empty Database

Using an application like SQL Server Management Studio, create an empty database. During the database creation process, make sure that a default username and password has been created. In addition this default username and password should have db_owner access permissions.
Security > Users > “userName” (double-click)
Click Memberships to display DB role memberships
These credentials will be used during the creation of the connection key in DeployEZ.

2. Generate a Deployment with DeployEZ

NOTE: Always ensure that you are using the latest version of the DeployEZ application. Current versions can be located at http://deployez.msgovern.com/

Using the DeployEZ application, create a connection key (CK) to the database that was created in Step 1. Select the applications that you are licensed to use in your deployment. During the generation of the connection key, access to the database will be tested.

NOTE: Ensure that the Govern New Administration (GNA) and the Govern Security Manager (GSM) are two of the applications that are included in the deployment.

Before Running GNA Verify Database Script…

Prior to the running of the Verify Database process, Release 6.0.1408, depending on your requirements, custom scripts incorporating the changes to datatypes of columns key tables may be required to be run.

NOTE: The following is an example of the type of script that may be run on the database. As these scripts are often customized to meet specific user requirements it will be necessary to contact Govern Technical

– START –
ALTERTABLE MA_MRA
ALTERCOLUMN FINAL_ADJ_PERCENT REAL
ALTERTABLE MA_MISC_STRUCTURES
ALTERCOLUMN FINAL_ADJ_PERCENT REAL
ALTERTABLE MA_LD_INFO
ALTERCOLUMN FINAL_ADJ_PERCENT REAL
ALTERTABLE MA_BLDG_INFO
ALTERCOLUMN FINAL_ADJ_PERCENT REAL
– STOP –

3. Run GNA

Once creation of the deployment is complete, locate the deployment folder and install the Govern Net Administration (GNA) release 6.0.
Typical Location:
\\%System_Root%\DEPLOYMENTS\Deployments\DBName_60_ServerName_SQL\GNAA

Running the GNA for the first time…

When the GNA is run for the first time a “Reset to Default” process is initiated. This process consist of the following steps:

- Any required tables are created and empty rows are initialized with NULL’s.
- A comparison between the version of the launched application and the database is performed; this is done by looking at the value in the NET_DB_VERSION column of USR_KEY_MASTER, i.e. (Table: USR_KEY_MASTER.NET_DB_VERSION).

Prior to fully launching the application, a message box is displayed warning of an inconsistency between the application and the database. A click on Yes on the dialog box will launch a Database Verification Process. and the creation of a “Govern Super User” role and a security synchronization.

Tables & Fields

During the initial Verify Database process the following verification steps will occur:

“Govern Users” role exists, if not it is created
“govern” User exists, if not create it with the password govern
“govern” is in the “Govern Users” role
“Govern Users” role has full access to GSM AND GNA

Example – Verify Database Process (ref. 6.1)

During this process the Verify Database process will create all tables and fields listed in MSGDatabaseStuctureMods.xml, and not present in the database used by the Connection Key (CK).

Table info:
- table name=”AC_AUDIT_INFO”
- description=”Aircraft Audit Table”
- action=”add” gnaaversion=”5.1.1304.0″ dbversion=”10.8″
- neededbyesearch=”False”
Field(s) info:
- column name=”AC_AUDIT_ID”
- type=”int”
- length=”0″
- nonull=”false” <!– if true, do not accept NULL values… –>
- identity=”true”
- action=”add” gnaaversion=”5.1.1304.0″ dbversion=”10.8″
- description=”Primary Key – TX_AUDIT in USR_KEY_MASTER”
- description=”Default …

Deleting a Non-Govern Index (unique index)

The system will not allow the deletion of any Non-Govern indexes. Deletion can only be effected manually or through the Delete Indexes option in the Database Verification process in the Govern New Administration (GNA).

Manually Altered Data Types are not Changed

In the database, columns with data types that were changed manually will not be changed during a Verify Database process; these fields must be altered manually. A warning will be thrown

4. Run the GSM

When the GNA process has been completed, run the GSM in order to give rights to users and create any other required users.
Note that the initial default setting of the GSM are as follows:
Full access is set to ALL applications, i.e. GIS, QT, etc.

What’s New!

NOTE: Changes are presented in reverse chronological order; i.e. newer to older.

Addition of VB6 Fail safe Notification for Verify Database Process

[Release 6.1.1803] Users that are prompted with a notification when they are upgrading from Govern for Windows to OpenForms are prompted with a dual confirmation message. See Addition of VB6 Failsafe Notification for details.

[Release 6.1.1706.0418 and 6.1.1707.0537]
RE / PP Tax Conversion Script to add Cycle Codes to RE and PP – See RE/PP Tax Conversion Scripts in the What’s New! section.

[Release 6.0.1412]
The following will occur when a new database is created:

Make sure “Govern Users” role exists, if not create it
Make sure “govern” User exists, if not create it with the password govern
Make sure “govern” is in the “Govern Users” role
Make sure “Govern Users” role has full access to GSM AND GNA

TROUBLESHOOTING

The following section contains information regarding issues that may occur during this process.

Error Screen starting GNA

ISSUE: Error screen displayed when launching GNA. When an error screen is displayed after an attempt to run the GNA, thoroughly review the error messages. Note the lines in the Database Alteration Errors screen. There is a permission denied error, an indication that the user access credentials do not provide Read/Write access to the database.

RESOLUTION: verify that the log-in has db_owner access permissions.
TIP: Users that are re-initializing a previously converted dataset will need to ensure that the NET_DB_VERSION value is set to NULL or else any further operations with the database will fail.

What’s New!

NOTE: Changes are presented in reverse chronological order; i.e. newer to older.

Implementation of Clustered Indexes (Release 6.1.1811)

NEW! As of Release 6.1.1811, clustered indexes have been implemented on some system tables. These indexes will be recreated during the next Database Verification Process. Due to the nature of the procedure, a significant amount of time will be required to perform the process. The recommendation is that this procedure should be performed over a week-end, or a period of low activity. Although all applications are able to perform without the use of clustered indexes, the implementation of this new methodology can improve overall system performance.

Addition of VB6 Fail safe Notification for Verify Database Process

Users that are prompted with a notification when they are upgrading from Govern for Windows to OpenForms need to be made aware that upon running the Verify Database Process, their database will be irreversibly changed. This means that they will not be able to perform a rollback that will allow them to once again run Govern for Windows on their database. As a result of the impact of this action, they must be prompted with a dual confirmation message. The message will remind them of the importance of performing a full backup of their database prior to running the process. They must also confirm that they are about to proceed with an irreversible process. Suitable notification to this effect have been added. Now when the user clicks START [>], and the system performs a compatibility check, they will first be prompted with the following message:

Versions of the application and the database are not compatible.
You must run a Database Verification before continuing. This will update your database to <updateVersionNumber>

WARNING: Ensure that you have made a backup of this database. This action is irreversible. Do you want to proceed?
Their selection options are YES or NOUpon clicking on YES, they are presented with a confirmation message that reads as follows:WARNING: You have clicked on YES. After running this Verify Database process, you will not be able to perform a rollback, and you will no longer be able to run Govern for VB6 with this database. Click ‘YES’ to proceed.
A click on YES will initiate the process.

RE / PP Tax Conversion Scripts to add required “RE” Cycle Codes

In Govern for Windows a Cycle Code was not mandatory. As a result of the architectural change in Govern for .NET, a Cycle code in Real Property (RE) and Personal Property (PP) is mandatory. The default Cycle Code is “RE”. A script will need to be provided in order to create a Cycle code and change all existing Data to this cycle code. See document below for details on the scripts.
103-ut-005_DB_Verification-RE_PP_Tax_Conversion_Script.pdf

New Process for Addition of System Columns
[Pending validation of release versions] When system columns have been added to the database, during the GNA Verify Database process, after the columns have been added, the process must scan all entities, and add a new attribute in all entities that use tables with added columns.
These changes are available in the following releases:

6.0.1608.x (6.0 Dev.)
6.0.1606.x (6.0 Rel.)
6.1.1608.x (6.1 Dev.)
6.1.1606.x (6.1 Rel.)

Standardized Storage of Boolean Data Types in Govern

In all releases of Govern, Boolean datatypes were stored in the database with three possible values:
FALSE = 0
TRUE = 1 or -1 (dependent on the version of Govern)
Newer tables predominantly used 1, whereas older tables used -1. In accordance with Governs’ ongoing standardisation process henceforth Boolean datatypes will be stored, WITHOUT EXCEPTION, as follows:
FALSE = 0
TRUE = -1
This standard will be carried out for all tables. This standard will be effective as of the following versions:

- 6.0.1608.0019 (6.0 Dev.)
- 6.0.1606.0023 (6.0 Rel.)
- 6.1.1608.0043 (6.1 Dev.)
- 6.1.1606.0042 (6.1 Rel.)

BA’s and Developers please refer to Confluence for additional details.

New Process in Database Verification Process

[6.0 / 6.1 Multiple Versions]

During the Database Verification process, at the ‘Check Column’ subprocess the application will now manage the description of fields in (Table:SY_DICT_DESC). The process is as follows, the Database Verification process reads the MSGDatabaseStructMods.xml file and reviews the SY_DICT_DESC. Each column is checked in the table to see whether the (ENG / FRA) descriptions exist, and if it needs to create (add) or remove (drop) them. In situations when a complete removal of a table is required, the process will remove any descriptions that are not connected.
Only the following fields are updated

LANGUAGE
TABLE_NAME
FIELD_NAME
DESCRIPTION
- Uses the property ‘description’ limited to 50 characters; all additional characters are truncated
DETAIL
- Uses the property ‘description’

These changes are available in the following releases:

6.0.1603.0410
6.0.1606.0010
6.0.1608.0006
6.1.1603.0481
6.1.1606.0021
6.1.1608.0016

[Release 6.1.1509.117]

Need to perform a verify database process. This is to apply a correction made to change the NULL 0 in (Table: VT_SYSTEM) INVISIBLE.

[Release 6.0.1412]

The following will occur when a new database is created:
.Make sure “Govern Users” role exists, if not create it
.Make sure “govern” User exists, if not create it with the password govern
.Make sure “govern” is in the “Govern Users” role
.Make sure “Govern Users” role has full access to GSM AND GNA

Property to Re-create Indexes for Extended Tables

A new property called hasextendedtables has been added in the Tables section of the MSGDatabaseStructureMods.xml. This property is used to recreate indexes for extended tables like (Table: MA_BUILDINGS) that can support additional tables like MA_BUILDINGS_2 to MA_BUILDINGS_9.

Below is an example of the property in the MA_BUILDINGS table definition in the MSGDatabaseStructureMods.xml file.
<table name=”MA_BUILDINGS” description=”Mass Appraisal Building.” action=”add” gnaaversion=”4.7.3.0″ dbversion=”10.7″ hasextendedtables=“True“>

Currently this property has been added for the following tables:
· MA_BUILDINGS
· MA_LAND
· MA_MRA
· MA_INCOME PP_ASSESSMENT”

6.0 R and 6.1 R and in their development branches( 6.0 dev and 6.1 dev).
This new attribute is available in the following releases:

6.0.1606.x
6.0.1608.x
6.1.1606.x
6.1.1608.x

103-ut-005a

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

Load LockBox Entries Batch Process

Overview

Documentation

Configuration

Load LockBox Entries batch process Parameters

Scheduler Configuration

Applicable Business Rules

Related Topics

Miscellaneous Billing (MB) – Lien Transfer Batch Process

Specification Overview

Purpose

Batch User Interface

Selection Criteria

Batch Variables

Batch Processing (Technical)

Troubleshooting

Related Topics

Miscellaneous Billing (MB) – Sales Tax Compute Process

Overview

Accessing the Miscellaneous Billing Compute Sales Tax Batch Process

Verifying the Miscellaneous Billing Compute Sales Tax Batch Process

Notes

Executing the Miscellaneous Billing Sales Tax Computation Batch Process

Compute

Notes

Related Information

Batch Processing (technical)

What’s New

Troubleshooting

See Also

Batch Process Definition Setup – Version 5

Overview

Configuring Batch Process Definitions

Batch Process Definitions User Interface

About Batch Process Definitions

About the Menu Manager

Creating a Batch Process Category

Deleting a Menu Category

Selecting a Category for the Batch Process

Defining a Batch Process

Defining the Transaction Mode

Adding a Report

Deleting a Batch Process Definition

Adding Batch Processes Definition to Govern

Synchronizing Batch Process Definitions

Permissions and Batch Processes

See Also

Batch Process Definition Editor

Overview

Configuration

Batch Process Definition – User Interface

About Batch Process Definitions

About the Menu Manager

Defining a Batch Process

Defining the Transaction Mode

Adding a Report

Deleting a Batch Process Definition

Adding Batch Processes Definition to Govern

Synchronizing Batch Process Definitions

Permissions and Batch Processes

Related Topics

Standard Batch Process – Email Notification

Overview

Functionality

Configuration

1. Design your email template

2. Design Your Query

The SELECT Query

3 – Define a New Batch Process

4 – Design or Select an Email Template

Batch Process Parameters

Selection Criteria group parameters

Run the Batch Process

Troubleshooting

APPENDIX

List of Queries

— Query Expression:

— Sample Email Message

— naNameInfo

— stAccountNo