GNA – Mobile Configuration Editor

Mobile Configuration Editor

Overview

The Mobile Configuration editor allows administrators of the mGovern Mobile Solution to control aspects of the subset database that is generated for their mobile deployment. The Initialize Mobile Database process is used to create a subset of the main source database. Copies of system resources, i.e. reports, tables, views, and so on are also copied. In addition, general and selected module parameters and tables for given years are created. This process is executed at the initial setup of the Mobile device, or when changes occur in the source database. The Mobile Configuration Editor offers an interface for administrators to manage the tables, views, and functions that are transferred during the initialization process, or the refresh/update process.

Functionality

The Mobile Configuration editor is the user interface for the The Database Objects Exclusion, and the Add and Update User Tables features. This point and click interface simplifies the manual inclusion and exclusion process. For this interface, the following tables were implemented:

SY_MOBILE_DB_OBJ_EXCLUSION – This table will contain all object names that should be excluded during the GNA Initialize Mobile Database process.
SY_MOBILE_TABLE
SY_MOBILE_COLUMN

For more information on manually excluding objects, or adding and updating user table, see the following:

Exclude Database Objects (In Exclude Database Object section)
Add and Update User Tables (In Add and Update User Tables section)

User Interface (UI)

The Mobile Configuration User Interface is a grid that allows for the selective exclusion of required database objects in the Mobile deployment database. The grid of the UI displays all system Tables, Views, and Functions. Each Table/View/Function is displayed as a line item in the grid. The database objects that are available for selection are accessed by selecting either the Table, Views, or Functions tab.

Mobile Configuration – Command Buttons

Save – After make selections, click Save to save you changes.
Cancel – Click Cancel [x] to cancel any changes made to the line items, i.e. objects in the grid.

Mobile Configuration grid – Column Headings

Each Table/View/Function is displayed as a line item in the grid.
Name – This column displays the system name of the Table/View/Function.
System – A checkbox is displayed in this column which corresponds to each Table/View/Function.

NOTE: Check boxes under the System column cannot be selected, if not previously selected, or deselected, if previously selected. These are System objects that are not accessible to users.

Exclude from Initialize Mobile Database

In the column heading there is a check box that will allow the selection of all objects in the grid. When the check box beside the line item under this column is selected, the database object on the line will be excluded from the Initialize Mobile Database process.
After selecting or deselecting the database objects, Tables/Views/Functions, required, click Save on the Mobile Configuration tab.

System Validation Tables

Overview

System Validation Tables are used throughout Govern to provide input for a variety of drop-down lists on the forms. Information on specific tables is provided in the documentation on the specific modules. They are similar to user validation tables, but all are maintained by Govern.

This page provides information on the general setup and features.

Documentation

To view this information in pdf format, click on the following link:
SystemValidationTableEditor.pdf

Accessing the System Validation Table Editor

Read More...Read Less...

To access the System Validation Table Editor:

Launch GNA.
Select Editors > System Validation Table Editor.

System Validation Table Action Buttons

New
Click the New button to create a new System Validation Table. When you click New, the Cancel button is available.
Save
Click Save to save modifications to a table.
Note: The Save button is disabled for the System Validation Tables created by Govern.
Delete
When you click Delete, a confirmation message appears. If you click OK, you delete the table and the codes created for the table.
Note: The Delete button is disabled for the System Validation Tables created by Govern.
Codes
Click the Codes button to view or create

System Validation Table Parameters

Table Name
The table name is unique. Only alphabetical and underscore characters are used. All characters are in uppercase.
English / French Description
Enter a English and French descriptions for identifying the table.

System Validation Table Options

The section describes the options that are applicable to some tables.

Securable

Select this option to enable security on the validation codes for the selected table. The security is applied in the Govern Security Manager.
The following scenario illustrates how to apply security on the Permit Activities validation codes table.

Scenario: Setting Security on the Mailing Index

To enable security settings for the Mailing Index codes:

Launch GNA.
Select Editors > System Validation Table Editor.
Select MAILTYPE – Mailing Index Type in the list of tables on the left.
Select the Securable option.
Click Save.

Follow the next procedure to set restriction on the Mailing Index Type Validation Codes, as required.
The Validation Codes are shown in the following screen shot:

Setting Security Permissions on the Validation Codes

To set security on the Mailing Index Codes:

Launch the Govern Security Manager (GSM).
Select Synchronize All.
Select Applications > Validation Tables > System Validation Tables.
Only the tables with the Securable option selected appear in the list.
Double-click Mailing Index Type to expand the table and view the codes.
Right click on the code on which you want to restrict permission.
Select Exclusions.
Select the users you want to exclude.
Click Save.

For further details on the GSM, refer to the Govern Security Manager (GSM) documentation.

Generate Database View

Select this option to create a database view from the selected table. The view is saved under Views in the Govern database. The format is table name with the prefix V_.
To generate a Database View:

Launch GNA.
Select Editors > System Validation Table Editor.
Select the applicable category.
Select the applicable table in the list on the left.
Select the Generate DB View option.
Click Save.
Select Utilities > Database Verification in the GNA ribbon.
Run the Database Verification procedure.

Added Fields

Added fields are used for some validation tables. In this procedure, you create a new database column for the selected table.

To set up added fields for a user validation table:

Launch GNA.
Select Editors > System Validation Tables.
Select the table.
Select Add Field in the Added Fields tab.
The Database Field Creation form appears.
The existing columns are listed on the right.
Enter the name of the new column in the New Column Name field.
The Description field is automatically populated with the new column name. Modify this if required.
Select a data type, such as currency, date / time, numeric, or text in the Column Type field.
Click Save.

Used In

The Used In section, at the bottom of the form, lists the entities that contain the table.

Creating Validation System Codes

To create validation codes:

Launch GNA.
Select Editors > System Validation Tables.
Select the table.
Click the Codes button on the Validation Table Editor to create codes for the selected table.

The New, Save, and Delete buttons are disabled for the System Validation Codes.
Code
Enter a unique code for the validation user code. This is used for identification.
English and French Short and Long Descriptions
Enter a description to easily identify the validation code in lists and on reports.
English / French Full Description
Enter a longer description in this field. If the Use Rich Text option is selected, then character styles can be applied to the text.
Do not show the validation code on the screen.
Select this option to hide the selected validation code from view.
See Also
User Validation Table Editor

103-ED-009

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

User Validation Tables

Overview

Version 6.1
Maintain the User Validation Tables in this form. These tables are used to validate the information entered in the various fields. Create and maintain the elements of the tables on the Validation Codes form.

To access the User Validation Table Editor, in the Govern New Administration (GNA):

Select Setups /Editors > Editors > User Validation Table Editor…

Adding Rich Text Format to Global Messages

Read More...Read Less...

You can add Rich Text Format (RTF) to Global Messages. With RTF, you can change the font and font size; add numbers or bullets; add character formatting, such as, bold, italics, or underline; change the alignment to left, center, or right; and add highlights and color to your messages.

Global messages are predefined in the Message Type User Validation Table in GNA They can be updated or modified, as required for the situation, in Govern.

For details on adding rich text format, click on the following link:
Global Messaging

Command Buttons

New: Click New to create a new System Validation Table.

NOTE: When you click on New, the button changes to Cancel ; this will allow you to cancel the creation of the current record. The Cancel button is present until the new record is saved.

Save: Click Save to save any changes to an existing validation table or to save a new table.
Delete: Click to select an existing Validation table from the List of Validation Table list on the left hand column; click Delete to delete the table.
Securable: Select Securable to enable administrators to secure the codes within the validation table. Refer to the Vertical Security section of the GSM release 4.6, or later guide.
Codes: Click Codes to access the code editor for the validation table.

Properties tab

Table Type: The Table Type is system-generated and is used, as follows:

R: Regular
A: Accounts / Receivable
C: Property Control (for multimedia and zoning information)
B: Property Control (for the Property Area function)
M: Mass Appraisal
P: Permits and Inspections
S: Super User
T: Tax: Aircraft, Boat, Motor Vehicle, Personal Property and Real Property
U: Utility Billing

All tables created with the User Validation Table form are automatically assigned the Regular table type.

List of Validation Tables: This column contains the list of the existing system validation tables; newly added tables will appear in this list.
Table Name: This field displays the name of the table. Use a descriptive name such as acctNum for Account Number. Table names can be a maximum of eight characters.
English / French Description: Use these fields to enter a brief description or title for the table.

Creating a User Validation Table
To create a new user validation table…:

Click New to clear the form fields.
Enter a Table Name.
Enter a description in the Description fields.
Click Save to create a new User Validation Table.

Add a User Validation Table Code
To add codes to a new or existing validation table:

Either follow the steps above to create a user validation table, or select an existing table from the List of Validation Table column on the left hand side.
Click Codes to display the Code Editor form.
Click New to clear the form fields.
Enter a Code Name; enter Short and Long Descriptions, and any other second language descriptions in the required fields.
Click Save.

A Note about Validation Table Codes

When the Verify the Existence, and Creation of Database Object process is run in GNA, the Govern user validation tables; i.e, the tables that are preceded by VT_USR_ in the Govern database are transferred to a single VT_USER table. During this process all codes are also transferred. Note that there is no process to copy the codes for User Validation tables that are created in GNA to Govern for Windows.

Permit Type Validation

In the Code Editor, it is possible to configure the system to apply a name type validation. This validation or filter is based upon the permit type that is being created. By default, when linking a name type, regardless of what permit type is being selected the system will display all name types. This applies to linking a name to a Complaint/Greivance/Request For Service/Workflow, Offence / Violation, or Permit/License/Certificate permit type in Govern.NET. When there are many name types in the list, the searching process for the name type can be tedious. When the validation filter is used, only the name types that apply to the permit type is displayed.
Permit Types that can be filtered are as follows:

Complaints/Workflows/Grievance/Request for Services
Offences/Violations
Permits/Licenses/Certificates

User Validation Tables

Overview

User Validation Tables are used throughout Govern to provide input for a variety of drop-down lists on the forms. Information on specific tables is provided in the documentation on the specific modules. This page provides information on the general setup and features.

Accessing the User Validation Table Editor

To access the User Validation Table Editor:

Launch GNA.
Select Editors > User Validation Table Editor.
Select one of the following:

Regular
Accounts Receivable
Mass Appraisal
Workflow Management
Property Control
Tax Billing
Utility Billing

NOTE: Some tables that are specific to a module, such as Accounts Receivable, are found under Regular.

Read More...Read Less...

Documentation

To view this information in pdf format, click on the following link:
UserValidationTableEditor.pdf

User Validation Table Action Buttons

New
Click the New button to create a new User Validation Table. The table is created under the selected menu; i.e., if you selected Accounts Receivable from the User Validation Table Editor menu, the new table is created under Accounts Receivable.
When you click New, the Cancel button is available.
Save
Click Save to save modifications to a table.
Delete
When you click Delete, a confirmation message appears. If you click OK, you delete the table and the codes created for the table.
Codes
Click the Codes button to view or create

User Validation Table Parameters

Table Name
Enter a unique name for the table. Only alphabetical and underscore characters can be saved. Characters are automatically entered in uppercase.
English / French Description
Enter a English and French descriptions for identifying the table.

User Validation Table Options

The section describes the options that are applicable to some tables.

Securable

Scenario: Setting Security on the Permit Activities Codes

To enable security settings for the Permit Activities codes:

Launch GNA.
Select Editors > User Validation Table Editor > Workflow Management.
Select DEPPMACT – Permit Activities in the list of tables on the left.
Select the Securable option.
Click Save.
Follow the next procedure to set restriction on the Permit Activities Codes, as required.

Setting Security Permissions on the Validation Codes

To set security on the Permit Activities Codes:

Launch the Govern Security Manager (GSM).
Select Synchronize All.
Select Applications > Validation Tables > User Validation Tables
Double-click Permit Activities to expand the table and view the codes.
Right click on the code on which you want to restrict permission.
Select Exclusions.
Select the users you want to exclude.
Click Save.

For further details on the GSM, refer to the Govern Security Manager (GSM) documentation.

Generate Database View

Select this option to create a database view from the selected table. The view is saved under Views in the Govern database. The format is table name with the prefix V_. You must run the Database Verification to complete the procedure.
To generate a Database View:

Launch GNA.
Select Editors > User Validation Table Editor.
Select the applicable category.
Select the applicable table in the list on the left.
Select the Generate DB View option.
Click Save.
Select Utilities > Database Verification in the GNA ribbon.
Run the Database Verification procedure.

Maintained By System

The Maintained By System option is selected for the user validation tables that are created and maintained by Govern.
This option cannot be modified from the User Validation Table Editor form.

Use Rich Text

You can now add Rich Text Format (RTF) to the full description of all user validation tables. This is particularly useful for Global Messages. With RTF, you can change the font and font size; add numbers or bullets; add character formatting, such as, bold, italics, or underline; change the alignment to left, center, or right; and add highlights and color to your messages.
Global messages are predefined in the Message Type User Validation Table under the Editors menu in GNA These messages can be modified in Govern, as required for the situation.
For details on adding rich text format, click on the following link:
Global Messaging

By Year

This option is selected for the user validation tables that are maintained by year. For example, many Mass Appraisal user validation tables are defined by year. These tables are defined in Govern and cannot be modified on this GNA form. However, you can create new tables By Year.

When the By Year option is selected, the Year ID column is added to the Validation Codes form for the table.

The Year parameter displays the year for the selected validation code.

You can set a validation code in one year to Is History, while maintaining the code in other years.

By Jurisdiction

This option is selected for the user validation tables that are defined for a specific jurisdiction. This tables are defined in Govern and cannot be modified on this GNA form. However, you can create new tables By Jurisdiction.
The Jurisdiction column is added to the table.

The Jurisdiction is listed by code in the column. It is listed by Code and Short Description in the Jurisdiction parameter at the bottom of the form.

By Department

This option is selected for the user validation tables that are set up by department. For example, the Workflow Management user validation tables are defined by department. This tables are defined in Govern and cannot be modified on this GNA form. However, you can create new tables By Department.

If the By Department option is selected, the Department column is added to the validation codes for the table. This is shown in the following screen shot of the Permit Activities table:

Note that the departments are listed by code in the Department column. However, the code and short description are provided in the Department parameter under the table.

Added Fields

Added fields are used for some validation tables. In this procedure, you create a new database column for the selected table.
To set up added fields for a user validation table:

Launch GNA.
Select Editors > User Validation Tables.
Select the category, such as Regular or Mass Appraisal.
Select the table.
Select Add Field in the Added Fields tab.The Database Field Creation form appears.The existing columns are listed on the right.
Enter the name of the new column in the New Column Name field.
The Description field is automatically populated with the new column name. Modify this if required.
Select a data type, such as currency, date / time, numeric, or text in the Column Type field.
Click Save.

Used In

The Used In section, at the bottom of the form, lists the entities that contain the selected table.

Creating Validation User Codes

Click the Codes button on the Validation Table Editor to create codes for the selected table.

Code

Enter a unique code for the validation user code. This is used for identification.

English and French Short and Long Descriptions

Enter a description to easily identify the validation code in lists and on reports.

English / French Full Description

Enter a longer description in this field. If the Use Rich Text option is selected, then character styles can be applied to the text.

Is History

Select this option if the selected validation code is no longer required. This option is useful if the validation code is used in records from previous years that you are maintaining, but is not applicable for any current or future records.

To apply the Is History option:

Launch GNA.
Select Editors > User Validation Tables.
Select the category, such as Regular or Mass Appraisal.
Select Editors > User Validation Tables.
Select the table.
Click the Codes button to open the Validation Codes Editor for the table.
Select the code that is no longer required.
Select Is History.
Click Save.

If you decide that you would like to reinstate the code, you can deselect this option at any time.

Scenario: The Is History Option on Property Records

The following scenario illustrates how the Is History option can be applied to property records.
In this scenario, one of the validation codes in the Mass Appraisal Value Change table is no longer needed. The Is History option is applied.
In the first screen shot, the Environmental Disaster option is selected for the Change Reason on a Mass Appraisal Property Information record for the last time.

To apply the Is History option to this code.

Launch GNA.
Select Editors > User Validation Tables > Mass Appraisal.
Select the MA_CHNG – Appraisal Change reason table.
Note that the entity that uses the table is displayed under Used In.
Click the Codes button to open the Validation Codes Editor.
Select the Environmental Disaster code.
Select Is History.
Click Save.

To view the change in Govern:

Launch Govern.
Select a Profile that contains the Mass Appraisal Property Information.
Select the Property Information form.
Expand the Value Change drop-down list.
Note that the Environmental Disaster option is not there.
Select a record on which this code was previously selected.
Note that the code is still selected for the record, but that a dot appears it.

Data Mapping Editor

Overview

When an external application, e.g. a GIS application, is required to communicate with the Govern system, it will need to understand how data is stored within the system. Govern’s Web service methods accept requests, to Retrieve, Update, or Delete data.
The Data Mapping Editor allows users to map specific tables and columns within the Govern database to unique Data Element Names. When the application makes a request from Govern, the data element names must be included in the methods that are sent to the Web services.
There are specific rules that are required when making a request to the Web Service, e.g. the Data Element Name of the data map must exist, or the parcel ID requested must exist in the database, etc. Refer to the MS Govern Property Control System Service API guide for the list of methods and file structure details.
There are three (3) tables in the Property Control section that can currently be updated, (Table: PC_AREA, PC_PARCEL, and PC_LEGAL_INFO).

To access the Data Mapping Editor…

In GNA select Setups/Editors > Editors > Data Mapping Editor…

Read More...Read Less...

Data Mapping Editor buttons

New – To create a new data mapping record click New.
Cancel – Use Cancel to cancel the creation of an new entry. The Cancel button replaces the New button a save of the entry is made.
Save – Click Save to save a new record or any changes to an existing record. New records will appear under the List of Data Mappings column on the left hand side of the editor.
Delete – After selecting an existing mapping record from the List of Data Mappings list on the left hand column, click Delete to delete the record.

Data Mapping Editor parameters

Choosing Data Element Names – The names that are used for Data Elements must ensure that no Special Characters or Reserved Keywords are used. Refer to Govern Keywords for a list of keywords that should not be used.

Oracle Users and Data Element Names

Due to the case sensitivity of table names, a convention of all Uppercase or all Lowercase names should be decided upon. Do not use any Oracle Keywords for Data Element Names.

Data Element Name

Specify a Data Element Name for the mapping record. This is a unique name that must be included in the request from the external application to the Web service.

NOTE: This field has a maximum of 15 characters; no special characters or spaces are allowed.

Enter a descriptive name for the mapping record that will be used in the following parameters:

English Short Description – Enter a short description for the mapping record. This is useful for fast data entry and look-ups if space is limited on the forms.
English Long Description – Enter a long description for the mapping record. This will be displayed for look-ups on forms and is normally used for reporting.

Second Language Fields

When there is a 2nd language, or multiple languages, ensure that these description fields are also completed; i.e. French Short Description, and French Long Description.
Table Name – From the drop down menu, select the name of the Govern table that the data will be mapped to. Available tables are:

PC_LEGAL_INFO
PC_AREA
PC_PARCEL

Column Name – The table columns that are listed are filtered according to the table that is selected in the Table Name parameter.

Creating a Data Map record

To create a data map record, use a Data Element Name that will be acceptable to the requesting external application. This name will be used in the method that will be sent to the Web service.

On the GNA ribbon, select Editors (tab) > Data Mapping Editor…
Click New in the Data Mapping Editor.
Locate the parameter called Data Element Name; enter the Data Element Name.
If not expanded click the expansion arrow (A) to display the additional parameters in the form; complete the parameters.
Select a table from the Table Name drop down menu.
Choose a column name within the table that was selected.
Click Save to save the mapping record to database.

When the external application makes a request to the web service, if the Data Element Name is in the method, the data will be retrieved, updated or deleted from the Govern database.
Testing a Web Service Request

As an example, we want to make a request that will obtain the tax map and the zoning information of the following Parcel ID’s, 16800, 16804, and 16807. This can be done in three (3) steps.

STEP 1 – Create the data mapping records

It is necessary to create the data mapping records for the elements that will be called in the method structure. For our example we will be using the pcTaxMap and areaZoning elements.

On the GNA ribbon, select Editors (tab) > Data Mapping Editor…
Click New, to create a new Data Mapping Record.
Enter a Data Element Name of pcTaxMap.
Click to expand the fields and enter an English Short and Long Description; enter PC Tax Map as a description.
The tax map information will be coming from is the PC_AREA table in the ZONING column; select PC_PARCEL for the Table Name, and TAX_MAP for the Column Name.
Click Save to save your mapping record.

Repeat the above steps to create the areaZoning data element. Use PC Area Zone as the description. The Table Name and Column Name are PC_AREA and ZONING

STEP 2 – Create the XML request structure

Refer to the Service Contract section of the MS Govern Property Control System Service API guide; this will provide you with the expected structure of the MSGovern_GetElementValue function. From the guide we obtain the following information:

Function MSGovern_GetElementValue (
ByVal strXmlElement As String ) As String
The retrieve elements must in structure of xml:
<?xml version=”1.0″ encoding=”utf-8″?>
<getElementValue>
<ParcelIds>
<ParcelId value=”16800″/>
<ParcelId value=”16807″/>
<ParcelId value=”23452″/>
</ParcelIds>
<ElementItems>
<ElementItem name=”areaZoning”/>
<ElementItem name=” areaSchDist “/>
</ElementItems>
</getElementValue>

For our example we will use the following…

<?xml version=”1.0″ encoding=”utf-8″?>
<getElementValue>
<ParcelIds>
<ParcelId value=”16800″/>
<ParcelId value=”16804″/>
<ParcelId value=”16807″/>
</ParcelIds>
<ElementItems>
<ElementItem name=”pcTaxMap”/>
<ElementItem name=”areaZoning”/>
</ElementItems>
</getElementValue>

The Parcel ID’s that we are requesting are specified within the <ParcelIds> tags. our Element Items are specified within the <ElementItems> tags. Note that the names are identical to what was specified in GNA in STEP 1 above.

NOTE: Verify that the XML structure is identical to specifications in the MS Govern Property Control System Service API document.

Always ensure that the Element Item name is identical to the one created in GNA.

STEP 3 – Validate the XML request with the Test Client

Locate the WcfTestClient.exe application that is included with the WCF PC Web Services package. This program is usually located in a folder called Test Application. Refer to the MS Govern Property Control Service Setup and Configuration guide for details about using the test application.

Start the test application; add the WCF Service.
On the left hand side, under the list of available methods in the service, locate the MSGovern_GetElementValue() method.
Double click on the method to load it in the Test Client.

NOTE: A limitation of the supplied test client is that Return characters and Line feeds are not recognized. These characters must be manually removed in the editor.

As an example, the following formatting will become a single line when the returns and line feeds are removed.

becomes…

<?xml version=”1.0″ encoding=”utf-8″?><getElementValue><ParcelIds><ParcelId value=”16800″/><ParcelId value=”16804″/><ParcelId value=”16807″/></ParcelIds><ElementItems><ElementItem name=”pcTaxMap”/><ElementItem name=”areaZoning”/></ElementItems></getElementValue>

The above is only a charateristic of this test client; other clients may differ in behavior.

4. Copy the single line version of your XML code and paste it into the Value field in the Test Client.
5. Click Invoke; any errors will be displayed in a dialog box.
6. When the action is successful, a response is displayed in the Response pane of the Test Client.

Viewing the Results

In the Test Client, the request and response parameters can be displayed in two (2) modes, Formatted, and XML. You can switch between the two views with a click on the corresponding tabs along the bottom of the Request pane. When you are in XML mode results from the successful requests to the Service can be observed.

103-ED-011

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

GNA – Resource File Editor

Resource File Editor

Overview

Resource files typically contain data that is intended to be deployed with applications. This data can be in the form of text strings, and occasionally images. The Resource File also allows the storage of different language versions used for localization of the user interface.
The Govern Resource File contain text, headings, labels, exceptions and error messages that appear in the applications within the suite. Other areas and applications that access resource files are the, Mobile Inspector, the eComponents Web pages and their respective Help files.
To access the Resource File Editor, in the Govern New Administration (GNA):

Select Editors (tab) > Resource File Editor…

Resource File Structure

The resource file hierarchy is as follows:

(ROOT) Resource File Name (1) > Module (2) > Function (3) > Key (4)

Read More...Read Less...

Resource File Module

The Resource File Editor allows you to access and make modifications to the contents of the Govern Resource File. In the file each item or Module is saved containing one or more Functions.
The modules are organized as follows:

NEW: New modules are indicated with a NEW!.

Module	Type of information
AR	Electronic payment transactions
BE	Text and messages for the Business Entity Designer (BED)
BP	Batch Process text and messages.
BR	Bankruptcy messaags
BW	Web audit and Web translation error messages
CC	Credit Card Processor error messages
CI	Text for the DeployEZ™ Installer
CO	eComponent error messages
CR	Cadastral Renewal text
CX	Text and messages for the Govern Security Manager (GSM)
DE	Property Control messages and text
ES	Text and messages for the Dynamic Search pane in Govern.NET
GI	Text and messages for the embedded Search pane in Govern.NET
GL	Text and messages for Govern FMS module
IN	Inspection business rules
MA	Text and messages for the Govern.NET Mass Appraisal module.
MB	Text and messages for the Govern.NET Miscellaneous Billing module.
MD	Text and error messages for the Govern Model Designer (MoD).
ME	MelissaData business rules
MO	Inspection Scheduling messages
NA	Business rules for Name and Address records
OD	OpenForms Designer
OF	Text and messages for OpenForms.
PC:	Business rules for Property Control records
PM	ePermit business rules
QT	Text and messages for Govern QueryTool
RB	Text and messages for the Govern.NET ribbon menu interface.
SB	Subscription Plan business rules and renewal notices
SC	Data Synchronization process text and error messages.
SF	Authentication messages
SL	GIS Application text and messages
SM	Text and messages for the Govern Security Manager . module.
ST	Messages and labels for the Govern.NET Self-Reported Tax module.
SY	System wide messages and error messages
TE	Test translation text
TX	Tax business rules
UB	Business Rules for the Utility Billing searches
UL	UEL Table related text (Quebec)
US	Entries for the Govern User Registry
WB	Text and error messages for the Web pages
WD	Text and error messages for the Govern New Administration (GNA) and DeployEZ™ Publisher
WF	Business rules for the Permit Activities
WM	Workflow Management
WP	Web Profile business rules
WZ	Text and messages for the Data Access Block and Web Configuration

Resource File Function

Records are resource files that are organized by module. For example, text that might be related to payments might appear under AR (Accounts Receivable) and permit text under PM (Property Management). The modules are further subdivided according to the type of information they may contain.

Resource File Keys

Each separate Record, may contain multiple Key’s. Each key will contain three (3) columns titled, Key (this is the key name), English (or your first language), and French (a second language). Each of these fields is a text field. Typically, keys are grouped by Function and Module.
The Key is a unique identifier for the text within the function, and should not be modified. You can, however, modify any of the French or English text, in order to create customized Web pages. For example, you can change labels, headings and error messages to match your organization’s Web site.

WARNING: It is critical that the name of a Key should never be modified. Modifying the name of a key can potentially disable the correct functioning of a module.
Modifying Text in the Resource File Editor

Use the following procedure to modify any of the text that is saved to the Resource File Editor. This includes all the labels, headings, exceptions and error messages that appear on a Mobile Inspector, eProfile and eComponent Web pages.

An ampersand (&) before a word or letter displays an underline; for example, &File, E&xit, &Help appears as File, Exit and Help. The F, x and H in this example are hotkeys; i.e., Alt + F displays the File menu, Alt + H displays the Help menu and Alt + F, X closes the application.
To display an ampersand on the Web, you need to enter two ampersands (&&) in the Resource files; for example to display Cat & Dog Licenses, enter Cat && Dog Licenses.
To modify the text:

In the Govern New Administration (GNA), select Editor (tab) > Resource File Editor…
Select File > Open (Ctrl + O)
Navigate to the directory where GovernNet.en.resources and GovernNet.fr.resources are located. By default, these files are located in a folder called ResourceFiles. This folder is created in the root of the MS Govern installation; the folder is called ResourceFiles.
Select and open one of these files. Both files will open in the Editor.
Click File > Find on the .NET Resource Editor main menu bar or click Ctrl + F on your keyboard, to locate the text you want to modify.
Enter the text string that you want to locate in the Find textbox.
Check Exact Match if you want to locate the whole word or phrase exactly as entered.
Click Find to locate the text or click Cancel to close the Find form without any further actions.
If the text was found, right-click on the text string to display a floating menu; select Edit… (1) to open the Resource Files Text Editor.
Make your modifications directly in the English String (2) and French String (3) text boxes, as required.

NOTE: You should not modify the Label or Key, Function, or the Module.

11. Click OK.

NOTE: When you click OK, this closes the text box. You need to save the file in order to save your changes.
Click File > Find Next, on the .NET Resource Editor, or F3 on your keyboard, to locate the same text in another file, if required.

12. Click File > Save, or Ctrl + S, when you have completed your modifications. Both the French and the English files are saved.
13. Click File > Close the file. A confirmation message appears if there are any unsaved modifications. You need to save the file in order to save your modifications.

Similarly, when you click Exit, a confirmation message appears if there are any unsaved modifications.

Upgrading Resource Files

NOTE: The Resource File Merge feature is required for upgrades only.

Merging Resource Files

Performing an upgrade to the next version of one of MS Govern’s eGovern – Public Self Service Portal can lead to loss of modifications made to the resource file. In order to avoid losing these modifications, you will need to run the Resource Files Merge process.
In running the resource file merge process, new Keys, containing the new text and features, are added to your existing file while existing keys are left untouched.
To merge two resource files together:

Click File > Merge on the .NET Resource Editor main menu bar, or click Alt + F, M, to open the Merging Resource Files process.
Click Browse beside the Base File parameter and navigate to the new file that you want to merge with your existing file.
Click Browse beside the File to include text box and navigate to your existing file.
Click OK. All the new keys will be added to your existing file. All existing text is left as is. If the merge was successful a confirmation window will appear; click OK.

Click Cancel to close the form without merging the files.

Resource File Locking and IIS

Users of Govern’s eGov should note that when the Internet Information Services (IIS) is running, resource files cannot be maintained by the Resource File Editor. IIS locks the files making it inaccessible. In order to access the resource file, you must stop the IIS service. This can be performed through the Control Panel; Control Panel > Administrative Tools > Services > Internet Information Services (IIS) Manager

Managing User Changes to Resource Files

Internally the Govern system uses the following methodology to maintain resource files and manage any user modifications.

The Methodology

The methodology for updating the resource files located in the ResourceFile folder of the deployment directory is as follows:
When changes are made to the Resource file by the user, the modifications are not saved directly into the GovernNet.xx.resources files (xx = 2 letter culture language, e.g. en = English, fr = French, etc.). A new file called GovernNetClient.xx.resources is created that holds all user modifications.
When a new deployment is prepared and is ready for installation a three (3) step process occurs:

The old GovernNet.xx.resources files on the client are deleted.
A new empty file called GovernNet.xx.resources is created on the client, and the user changes within the GovernNetClient.xx.resources files are appended to these newly created files.
Now a second append is performed by combining the new GovernNet.xx.resources file located on the server to the one on the client (this is the one with the appended user changes). The resulting resource file is then updated on the server.

This process will ensures that all client changes are kept when the resource file is updated, in addition the server will always maintain a version of the resource file with all user changes.

But what happened to my resource changes?

Modifications that are made to a resource node will be updated the next time a deployment is regenerated in the DeployEZ application.

NOTE: User modifications to resource files should be made to the GovernNet.xx.resources file. The system will internally manage the changes. Users should NOT modify the GovernNetClient.xx.resources file.

NOTE: Users of the eGovern – Public Self Service Portal should note that the resource files containing the content of the eGovern menu Help text, i.e. GovernNetHelp.en.resources and GovernNetHelp.fr.resources are separate from the main system resource files. These files are also maintained with the GNA Resource File Editor, but should be backed up in a separate location.

103-ED-012

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

GNA – Field Mask Editor

Field Mask Editor

Overview

With the Field Mask Editor, you can define a set of Field Masks that can then be applied to fields in the Business Entity Designer (BED). Applying a field mask automatically formats the data entered in the field according to a defined pattern. For example, you can define a pattern for telephone numbers and apply it to a Telephone field in the BED. When the user enters 18005551212 in an OpenForm, this is automatically formatted as 1-800-555-1212.

Use this editor for phone numbers, postal or ZIP codes, Tax Map Numbers, Social Security Numbers, etc.

NOTE: By default the fields on a form are “collapsed”, i.e. they are not fully visible. This is to give the form a cleaner appearance. Additional fields can be displayed with a click on the Collapse/Expand button.

Multi Box Field Masks

NEW! Along with the single box field masks, it is possible to specify Multi Box field masks. Field masks can be displayed in a single long field, or displayed over multiple fields. The Multi Box Field Mask Control takes a custom Govern mask and transforms each part into separate Text Box Masks that are parsed individually. This display option is available during the mask set up in the Field Mask Editor in the Govern New Administration (GNA). Govern’s set of mask rules and characters that apply to the control are below. See the Validation Rules for Multi Box Masks on the 103-ed-002 page.

Govern Mask Preview

103-SY-003-GNA60-(FieldMskEdtr_PrevwBx00).png

Click image to display full size.

NEW! In the GNA Field Mask Editor there is a preview option that can aid the design and prototyping process. After designing your mask, you are able to get a preview of how it will appear. Entries can be made in the preview fields for further confirmation. This preview feature is valid for single box or the multi box field masks section of 103-ed-002.

NOTE: Using MaskedTextBox (developers can either bind the mask to the preview textbox or call the Initialize directly). This feature is available as of GNA Release 6.0.1502.0083,

Field Mask Editor Command Buttons

New
Click New to clear the screen so you can create a new Field Validation Mask.

When you click on New, the button changes to Cancel ; this will allow you to cancel the creation of the current record. The Cancel button is present until the new record is saved.

Save
Click Save to save a new record or modifications to an existing one.

Delete
Click Delete to remove the current record.

Closing the Editor
To close the editor, click the Close Window button in the upper right hand corner of the form.

Field Mask Editor – Format Tab Parameters

Name
Enter a name for the field mask. This appears in the drop-down list that is displayed when you apply the mask.
NOTE: Only alphanumeric entries are permitted incode parameters. This means that names for codes can only be made up of letters and or numbers. Special characters such as the underscore “_”, the dash “-”, the ampersand “&” , etc. are not recognized.
English Short Description
Enter a short description to identify the department. This is useful for fast data entry and look-ups if space is limited on the forms.
English Long Description
Enter a long description to identify the department. This will be displayed for look-ups on forms and will be normally used for reporting.

Second Language Fields

When there is a 2nd language, or multiple languages, ensure that these description fields are also completed.
Is System
This flag / option is reserved for constants that are designated as Govern system constants.
Display as multiple text boxes
Select this option to display your Field Masks as a multiple box; the default is single box.

Click image to display full size.

System Reserved Values

Only users with Super-User access will be able to select and deselect the Is System option. In addition Super Users can also create new values and flag them for Govern system use.

NOTE: System constants are reserved for use by the Govern.NET system and as such should not be modified or deleted without a full understanding of the implications. Deletions of system values can damage the Govern.NET system, rendering it inoperable. Modifications that are made to System values should always be noted. When a system wide update is performed, these modifications may be overwritten.

Field Mask
In this parameter, enter the text string that will be used for your field mask.

The following tables list the symbols that can be used in field masks. The second table lists symbols that can be used for Tax Map Numbers only:

Valid Field Masks

Symbol	Description
#	Numeric value. Exact number of digits must be entered as defined in the “New Database Field Creation”. You can use the “-” (Dash) to separate the values.
9	Numeric value left justified compressed with trailing zeroes.
d	Numeric value left justified compressed with trailing zeroes.
Z	Numeric value right justified compressed with leading zeroes.
0	Numeric value right justified compressed with leading zeroes.
>	Alpha & Numeric values. Alphabetic characters must be in uppercase. If only ONE “>” is entered, then the number of digits entered can be LESS than defined in the “New Database Field Creation” Size. Otherwise, the exact number of characters must be entered as defined. You can use the “-” (Dash) to separate the values.
<	Alpha & Numeric values. Alpha in lowercase. If only ONE “<” is entered, then the number of digits entered can be LESS than defined in the “New Database Field Creation” Size. Otherwise, the exact number of characters must be entered as defined. You can use the “-” (Dash) to separate the values.
A	Alpha character in Uppercase. Number of characters entered must be as defined in “New Database Field Creation” Size. The Dash “-” or Hyphen can be used to separate values.
^	When present in mask will present each option as a Combo box for selection. NEW! – This symbol is no longer recognized as an “OR” clause.
!	Alpha and numeric values as entered, both uppercase and lowercase. You can use the dash, — to separate values.
“ “	Leaves a blank space before the next series of characters, in the same text box.

EXAMPLE: A zip code should have 5 digits but may have a dash and 4 other digits.
The pattern could be: #####^#####-####

NOTE: NEW! – The “^” symbol is no longer recognized as an “OR” clause; when used in this context, the masks will be displayed in a combo box, (drop down menu), for selection.

Valid Masks for Tax Map Number Fields Only

(To use with the “0”, “9”, “d” and “Z” masks only):

Symbol	Definition
.	Displays the next series of characters in another text box with the period in between.
:	Displays a single “.” Inside the series of characters, in the same text box.
“”	Displays the next series of characters in another text box.
–	Displays a “-” (Dash) inside the series of characters, in the same text box.

NEW! Validation Rules for Multi Box Masks

Symbol	Definition
^	When present in mask will present each option as a Combo box for selection. This symbol is no longer recognized as an “OR” clause.
#	Numeric value. Exact number of digits must be entered as defined in the “New Database Field Creation”.
9	Numeric value left justified compressed with trailing zeroes
d	Numeric value left justified compressed with trailing zeroes
Z	Numeric value right justified compressed with leading zeroes.
0	Numeric value right justified compressed with leading zeroes.
A	Upper case Alpha (transform lower case to upper case on key up)
a	Case insensitive Alpha
?	Any
!	Case Insensitive Alphanumeric
>	Upper case any
<	Lower case any
.	Separator
–	Separator
space	Separator
:	This character in the multi box field mask will function the same as a “ . ” separator in the single box field mask.

Other standard characters remain as is.

NOTE: The following rules apply for a Multibox

Parsing rules for areas with Read Only and Edit permissions

When parsing Read Only areas where masks are applied to, e.g. in the Treeview, and areas where the Edit permission is permitted, e.g. forms, the following rules will apply:

The user will be prevented from entering invalid characters.
If the mask contains a single “/”, it is validated as if the mask was the same length as the text

Symbol	Definition
#	Numeric
d	Numeric, remove / add trailing 0
9	Numeric, add / add trailing 0
0	Numeric, add / add leading 0
Z	Number, remove / add leading 0
>	Upper case any => Transform lower case
<	Lower case any => Transform Upper case
A	Upper case Alpha => Transform Lower case
a	Case insensitive Alpha
!	Case Insensitive Alphanumeric
?	Any

Other standard characters remain as is.

A Note to Users accessing Govern Remotely

NOTE: Users should note that parameters with field masks that are designed to accept hyphen separated entries entries, e.g. Telephone Numbers, Tax Maps, will display in OpenForms as a parameter with individual fields. These individual fields can be accessed with the tab key (A).

The Field Mask for the above would look like the like the following “XXX-”XXX-XXX-X”, each of the grouped X’s are separated. Users that are accessing Govern over a Remote Link, e.g. VPN should pay attention to the tab sequence when pressing the Tab key to jump to the next parameter. Over a remote connection, in the Tax Map parameter, the tab key will not move the cursor to the next field of the Tax Map number, rather it will jump to the Include Inactive parameter (1). This behavior only applies to remote connections to Govern.

TUTORIAL

Create a Zip Code Field Mask

In the following example we will create a custom Zip Code Number. This field mask will accommodate the United States zip code format, and the Canadian postal code format. The background information required is that US zip codes can be 5 numeric digits, or in a format called ZIP+4. ZIP+4 includes the standard five digits plus a hyphen and four more digits. The Canadian postal code uses six alpha-numeric (6) characters; the Alpha and Numerical characters alternate starting with and alpha character. For example H8T 2M3. The first character is always an alpha, and there is a space between the first three characters and the last three.

To create our custom mask…

In Govern New Administration (GNA), select Setups/Editors > Editors > Field Mask Editor…
In the Field Validation Mask Editor form, click New.
In the name field, enter zippostalcode.
Enter a Short Description of US Zip & Cdn Post in the field.
Click into the Long Description field, the Short Description will be copied into the Long Description, add any additional information to the name.
In the Field Mask field, enter the following mask pattern:
#####^#####-####^A#A#A# NEW! – Note:The “^” symbol is no longer recognized as an “OR” clause; when used in the context of Field Masks, the masks will be displayed in a combo box, (drop down menu), for selection
Click Save to save the mask.

Based on the information that was provided, the mask will format the following:
Five (5) numerical characters OR 5 characters a dash and then four (4) more numerical characters, OR six (6) alternating alpha and numerical characters.
NEW! – The Caret symbol, “^“, is no longer recognized as an “OR” clause; when used, the masks will be displayed in a combo box, (drop down menu), for selection.

103-ed-002

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