101-std-fea-024-ofr

OpenForms Standard Feature – Form Generic Link Controller Setup

Version 6.0 / Version 6.1

Overview

This standard OpenForms Controller can be added to a form to provide a Link to another Form. Two (2) versions of the controller exists, depending on the underlying business rules and whether it is allowed to delete a link once it has been established.

  1. Without Delete Capabilities (CO_GenericLink_Control)
  2. With Delete Capabilities (CO_GenericLinkWithDelete_Control)

Prerequisites

The following conditions are required for form setup in order to enable the Controller.OpenForms Designer Setup:

  1. The Form’s ID Setters Properties must contain the Linked to Form Govern ID (i.e. NA_ID, P_ID, ST_ID, AR_ID, and so on…)
  • The Govern ID must be displayed in the search GRID used for the Linked Form

Profile Security

  • The Linked to Form must be available in the profile (GNA)
  • The user must have security access (GSM) to the profile’s form.

Configuration

Configuration of this controller occurs in the Govern OpenForms Designer (OFD) application. Two (2) versions of the controller exist. The version used will be dependent on the underlying business rules required; i.e. whether once the link has been established, will be allowed to be deleted.

Control to use

Link without Delete

  • Without delete capabilities (CO_GenericLink_Control)

Link with Delete

  • With delete capabilities (CO_GenericLinkWithDelete_Control)

For more information, refer to the following:

OpenForms Designer (OFD)

Controller Setup

Adding a Custom Control to a Form

To add the Custom Control…
1. In the OpenForms Designer (OFD), drag the Custom Control Icon to the desired area (row or column, group.. ) on the form.
Custom Control Form Configuration
2. Once the Custom Control is displayed on the form, click on the inserted control object to configure it. The following parameters are to be completed:
Layout

  • Height
  • Horizontal alignment
  • Margin
  • Text style
  • Vertical alignment
  • Width

Action

  • Assembly Name = Msgovern.OpenForms.CustomControls.dll (by default)
  • Class Name = CO_GenericLink_Control OR CO_GenericLinkWithDelete_Control

Custom Control Properties

  • Allows the selection of current ID (Will automatically show the current Govern ID item and the user will be allowed to select it)
  • Current ID Description
  • Header Override
  • Selected Description
  • Selected Form Name
  • Selected ID Code (na_id, pid, …)
  • Selected Search Group
  • Selected Search Style
PROPERTIES Setting Description
ID
Element ID N/A (set by system) System generated information
Layout
Height Height of the form
Horizontal alignment Stretch Aligns the text at the top and left of the cell. Increases the width
of the column if the text is long and requires more space.
Margin 7,3,7,3 Margins are used to ensure that there is space between
items on the user forms. Defaults are for the right, top, left,
and bottom margins.
Text style Expression to specify the text style
Vertical alignment Stretch Aligns the text at the top and left of the cell. Increases the
width of the column if the text is long and requires more
space.
Width If required, enter a value for the width of the label inside
the cell in the Width text box.
Misc
Action MsGovern.OpenForms.CustomControls.dll
CO_GenericLink_Control
Is enabled Hidden on load Hidden on Load hides the Browse screen from view when the
record is loaded to the form.
Is tab stop Checkbox is selected if a tab sequence number is entered.
If deselected the tab sequence number is removed.
Is visible Selected Select the checkbox
Name CO_GenericLink_Control
Properties
AlternateAttributeName This is optional. By default, we use an attribute with the same
name as SelectedIdCode to get the id we want to link to. If we
want to use a different attribute we can set it here. For example,
if we want to use the attribute REF_ID.
NEW!AutoCloseModalWindowExpression This will allow the setup of an expression that can automatically
close the modal
window when clicking on: Save button or Cancel button
CurrentIdDescriptionQueryName This query gives the description to use for the CurrentId option
when using AllowSelectCurrentId.
DefaultSelection
FastNameCreation
HeaderOverride This is optional. It sets the control header.
NEW! OpenFormAsModal Opens the link as a modal window. When using this, a new
instance of GovernIds is used so that the current profile
GovernIds won’t be affected by the modal form when open.
QuickSearchIndexGroup
SelectedDescriptionQueryName Description that is displayed for the selected ID.
SelectedFormNameInProfile Form to open.
SelectedIdCode The Govern ID that is set when the link is clicked.
SelectedSearchGroup Search group
SelectedSearchStyle Search style
SuggestedLinksQueryName Select a query for the description (Optional)
Tab sequence number

 

Specific Configurations

In the OFD, depending on the controller use, configure the target form as illustrated below.

Generic Link Controller

PROPERTIES Information
Browse
Columns Click to edit
Hidden on load
Show on left
Size 150
Controller
Controller MsGovern.OpenForms.CustomControls.dll
CO_GenericLink_Controller
Controller properties
Misc
SelectedIdCode na_id – name id
SelectedSearchGroup
SelectedSearchStyle stAccountByName – Retrieve ST Account

Linked to Name Controller

PROPERTIES Information
Browse
Columns Click to edit
Hidden on load
Show on left
Size 150
Controller
Controller MsGovern.OpenForms.CustomControls.dll
LinkedToName_Controller
Controller properties
Misc
SelectedSearchGroup naName – Name Search
SelectedSearchStyle

Linked to Self-Reported Tax Controller

PROPERTIES Information
Browse
Columns Click to edit
Hidden on load
Show on left
Size 150
Controller
Controller MsGovern.OpenForms.CustomControls.dll
LinkedToSelfReportTax_Controller
Controller properties
Misc
SelectedSearchGroup
SelectedSearchStyle stAccountByName – Retrieve ST Account

Troubleshooting

The following are some issues that may arise during configuration, their possible resolution.

Issue: Form was designed for a different Govern ID access (P_ID, NA_ID), but the setup is the same.
Possible Resolution:

  • The ID Setters properties for the entity must be configured.
  • The Govern ID must be displayed in the GRID

Issue: The form does not work.
Possible Resolution:

  • Form was designed for a different Govern ID access (PID_ NA_ID, and so on…) than the controller property.
  • The form’s ID Setters properties must be configured on the form

Issue: Cannot select existing name or property
Possible Resolution:

  • The select existing feature requires to have the Govern ID displayed in the GRID of the search result

 

Related Topics

Govern OFD MANUAL Govern OpenForms Designer, version 6.1 see Chapter 3 – Links
Standard Feature Overview

 

 

101-std-fea-024-ofr

 

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

OF Std. Feature – Form Generic Link Controller

OpenForms Standard Feature – Form Generic Link Controller

Version 6.0 | Version 6.1

Overview

Generic Links is a custom control that manage adding links to a related parent item. For example, it may be used to link an owner to a property name and address. The Generic Link Controller (CO_GenericLink_Controller) is attached to a form that allows users to retrieve a Govern ID attribute from the result of an eSearch query. The resulting ID can then be added to a form to provide a link to a name or property.

NOTE: There are two (2) controllers that inherit from it, linked to Name and ST, and both are used in the License to Name feature.

Functionality

An existing key will display the description with a link that will display a configured form. It is critical that this form is in the same profile.
Non-existent keys will be displayed as Radio Buttons. Upon saving the form, a new key and a new record will be displayed in the corresponding table. This will feed the entity attribute that is mapped to the key. When the Radio Button is selected, there will be a search for an existing key. this key will feed the entity attribute mapped to the key.
The controller will search for a Govern ID that will be sent to a corresponding attribute. The LinkedToName_Controller specifies an NA_ID as its Govern ID and the LinkedToSelfReportTax_Controller specifies an ST_ACCT_ID; both are then used by the License to individual Form. The CO_GenericLink_Controller can be setup on any form that…:

  • Does not have a controller already installed.
  • Contains a Govern ID attribute that matches the ID name that the controller has been configured with.

Configuration

Configuration of this controller occurs in the Govern OpenForms Designer (OFD) application.
Refer to the Form General Link Setup page for details.

What’s New

Related Topics

Form General Link Controller Setup
Standard Form General Link Controller Overview
Govern OpenForms Designer V6.1 User Manual – See Chapter 3 – Links

 

 

101-std-fea-024

 

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

Govern Knowledge Base Help

Govern Help

Overview

What is Govern Help

The Govern Help is the term used to describe one or more technologies that are available for users of the Govern suite of applications. The Help system is an alternate implementation of the end-user Online Help found with Govern for Windows. In prior releases, Help came in the form of PDF files that required the installation of the Adobe AcrobatTM Reader.

Govern Help is invoked with the standard F1 key. This keystroke will invoke Govern Web Help. Web Help will display the contextual help information related to the feature or form within the Govern application. Govern Web Help displays help information through a Web browser. This browser must have access to the Govern Knowledge Base web site located at (http://kb.harrisgovern.com).

User Customized Help

In some instances, as in the case of the Govern application, there is a user configured Help feature. User configured help is initiated through the Ctrl + F1 key combination. When properly configured by the user, depending on the Govern application, Ctrl + F1 invokes the help document that has been configured by the user.

Availability

Unless otherwise stated, Govern Help is available in Release 6.0.1509 and Release 6.1.1509; the level of detail that will be provided to the user is found in the following grid.

NOTE: If Help information for the specific area of the application is not available, the top level information will be displayed by default.

Read More...

Govern Application Location Level of information
provide to user		 Command Key
DeployEZ Help button (upper right hand side) or command key Top level – General application information F1
Govern New Administration (GNA) Help icon (in the ribbon under Help tab) Top level and select utilities and tools F1
Govern Security Manager (GSM) Ribbon (in the Help group) Top level – General application information F1
OpenForms Designer (OFD) Help button on ribbon Top level – General application information F1
Business Entity Designer (BED) Help button (upper right hand side) or command key Top level and application panes F1
Govern Help button under Help tab in the ribbon Top level – General application information Ctrl + F1 (F1 invokes PDF Help)
Govern Scheduler (GS) Help Menu (Help > Show Help) Top level – General application information F1
Query Tool (QT) Button on ribbon Top level – General application information F1

Troubleshooting

Although the requirements for Governs’ Web Help are basic, i.e. the installed Govern application and any one of the supported Web browsers, occasionally issues may arise. Resolution to some Web Help related issues will be listed below.

Access to the Knowledge Base

The most common error that is encountered with Govern Web Help is to ensure that you have an account to access the Govern Knowledge Base. If you do not have an access account, contact Govern Support.

Related Topics

R&D Developers – How to set-up new codes PRODUCT_RD 101-std-fea-027

 

 

101-std-fea-027

 

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

Std. Feature – View Query Link

Standard Feature – View Query Link

Overview

Query Links are a powerful feature in Govern for OpenForms. This feature allows the addition of a link in a custom control that will open another form or report. In addition, with this feature users are able to set and pass a Govern ID before opening a report or OpenForm. There are a few ways that this feature is implemented in the Govern for OpenForms application.

View Query Link

Why a View Query Link

The main purpose if this implementation is to have an account set up with a principal record, and all satellite offices associated with that record were to then be presented in a grid. When this ACCOUNT that is based on a name ID, is retrieved, if the current ID is set to NA_ID1, then a click on a link could be made to open the name and address of its satellite offices, NA_ID2, NA_ID3, and so on. Previously this link could be performed to another OpenForm, but it was not possible to change the active Name ID (NA_ID) on the linked form. One previous workaround was to take the ID of the current form, go to the configuration of the form and set the NA_ID as an ID setter, as this was not always desirable, often a button was used to control whether the ID would be set. With the View Query Link feature, a more streamlined solution is obtained. When this feature is configured, there are multiple methods of implementing it.

NOTE: The end results are similar, but the methods of implementation differ.

 

BUSINESS RULES:

  • If the profile is parcel based, and you search for a P_ID that exists in the profile, a reposition will occur, i.e. the focus will be on the new parcel which will be set as active.
  • If the P_ID that is being searched for is not in the profile, that record containing the P_ID will be added to the Treeview, i.e. populate the Treeview.
  • If it’s not the same ID, ex. Only a Name ID, the ID will be set, but nothing will be appended to the Treeview.

View Query Link – Type 1

What are referred to as Type 1 View Query Links are the basic implementation of the View Query Link feature. The link is presented as a hyperlink or a button that will initiate the link. To demonstrate this feature, we will add a link to the Coordinate parameters on the parcel information OpenForms.

Configuration

When a link is placed in the Coordinates group. This link will be set with different properties. As is allowed in the OpenForms Designer (OFD), the link can be initiated as a Hyperlink, or an Action Button.

View Query Link – Type 2

A second implementation is used within the Self Reported Tax Estimate form. A link is created within a View Query. When this link is selected, it will launch the SRT Form on the Tax Filing entity for the specified period.

Configuration

Using the ST Estimate feature as an example, a link to the ST account entity will need to be created. The required configurations are made in the Govern New Administration (GNA) and the OpenForms Designer (OFD). In addition a standard view query will need to be modified through the GNA.

View Query Link – Type 3

The third implementation the View Query Link yields the same link results as the Type 1 and Type 2 implementation, i.e. for SRT, it will launch the Form on the Tax Filing entity for the specified period. Links are created under the Govern Home tab in the Dashboard area.

Configuration

The setup of this View Query Link type is made in the Profile Editor of the Govern New Administration
Examples of the use of the three types of view query links can be observed in the attached documentation.

Importance of Syntax

Modifying the Query

To modify the query, we will use the SQL Query editor in the GNA. The following queries are to be modified for this example:

  • smPC07 – Current Owner Names & Address
  • smPC08 – Previous Owner Names & Address

Before we can modify the column we need to change to a link, we need to add another column.

  1. On the GNA Ribbon, go to GNA > Editors (tab) > Select Query Editor.
  2. Look for the smPC07 query; click to select this query for editing.
  3. In the editor we will add another column BEFORE the column that is to be changed to a link.

‘Form=NA01;NA_ID’ + CAST(NA_ID AS VARCHAR) ‘<LINK>’

Proper use of the <LINK> tag

When the ‘<LINK>’ tag is seen before the column, this is an indication that the column is to be hidden and the link information is to be applied to the next column.
DEVNOTE: The Same column can be added twice if single quotes ‘aLink’ are used; there is a restriction if double quotes “” are used.

NEW Select a specific Entity on the form

An enhancement has added to the View Query Link functionality. It is now possible to open a form and re-position to a specific entity within the form. The ID can then be auto-selected by setting the Govern ID.
To access a specific form and tab item, use the following syntax for the query…
‘Form=FormNum:EntityName;NA_ID=’
…where <FormNum> is the Govern form number, e.g. ST007 immediately followed by a colon “:”, then the <EntityName>, e.g. ST-Filing. There are no spaces between any of the names. Here is an example that will access the Self Reported Tax form (ST007), and specifically target the ST-Filing entity. The Govern ID is then specified, in the following case, an NA_ID
‘Form=ST007:ST_Filing;NA_ID=’

NOTE: If the entity specified in the query is not available, the result will default back to the top level form.

Key Parts of the Modification to the Query

The modifications needed for the query are made up of three (3) parts.

  • The column must be named as follows: ‘<LINK>’
  • Indicate what the column is to return NA_ID’ + CAST(NA_ID AS VARCHAR)
  • The form that is to be opened. ‘Form=NA01;NA_ID’
    i.e. the form NA01 is to be set with the NA_ID. Alternatively, the syntax can also be modified to open a report by referencing the report name: ‘Report=NA01;NA_ID’
NOTE: The order of the information is important. The column that will have the link will always be on the next column.

Error Handling Messages:

DEVNOTE: If a code is entered for a non-existent form, an error message is invoked: This form is not accessible, review with your administrator.

If the configuration was performed correctly, the P_ID will be changed. Incorrect configurations can result in errors. Often the error that is encountered is related to syntax. For example an error screen such as the following may be displayed.
In the following, the “=” was missing from the p_id portion of the query.
‘p_id’+ @attrX + ‘;na_id=’ + @attrY (ERROR)
‘p_id=’+ @attrX + ‘;na_id=’ + @attrY (OK)

Documentation

Below is the documentation related to this feature:

101-std-fea-036-View_Query_Link.pdf

Related Topics

Business Tax – Corporate Account

Govern Standard Module Product Map

 

101-std-fea-036

 

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

Standard Feature – Saved Datasets

Saved Datasets

Overview

Govern Saved DatasetsThe Govern Saved Dataset pane is standard in release 6.0 and higher. This pane will allow users to load, save, and delete saved datasets. All saved datasets for the current user, excluding datasets that are present prior to the hibernate process.
In addition, users are able to create new datasets from a search result, append to an existing dataset, load, edit, or delete one or multiple datasets.

What’s New

When applicable, new features, or new ways of performing an old function in Govern will be listed below. Version Numbers and sections will be indicated in the list.

Saved Datasets Interface

The interface is an auto-hide pane. This pane appears with a click on the Saved Datasets icon on the Ribbon, or by hovering the mouse pointer over the tab.

Saved Dataset Grid Behavior

The Saved Dataset grid allows for creation and maintenance of user saved datasets.

Select all saved datasets in the list…

Click on the check box of the first header column to select all items in the grid.

Sort Grid by Headers…

As is standard with Govern grids, a click on a column header will sort the list in ascending or descending order. Ascending or Descending order is determined by the direction of the triangle that appears in the column heading. Typically the list is sorted by the name or the date.

Restoring the default Sort Order

Click the header until the arrowhead indicating the direction of the sort disappears.

Quickly Load a Saved Dataset to the Treeview…

When you want to quickly load a dataset to the treeview pane, double click on a row to clear the Dataset Treeview and load all selected dataset to the tree view.

Grouping by Columns…

The Governs interface drag and drop features allow for additional possibilities in the grid. The space above the columns is referred to as the Grouping Area. When possible, this space expands to accommodate column names when they can be added.
To group according to a column…

  1. Click and drag the column head to the space marked “Drag a column header here to group by that column“.
  2. Release the Column header in the area.
  3. Repeat the drag and drop action for additional required columns.

Removing Column Groupings…

To remove column groupings…

  1. With the mouse pointer, click and drag the column heading from the grouping area.
  2. When your cursor is outside the grouping area, the cursor will change to a large “X”.
  3. Release the cursor; the grouping will be removed.

Command Buttons

The Saved Datasets pane can be displayed by hovering over the auto-hide tab. When you want the pane to display permanently without sliding back, click the Auto-Hide pin icon. The pane will remained fixed in the interface until the Auto-Hide button is re-selected.

Load to Treeview

Click Load to Treeview to load a dataset to the Treeview. The feature is enabled only if at least one item is checked. When clicked, the action will clear the dataset treeview and load all selected datasets to the treeview.

Append to TreeView

To append to the records that are in the treeview, click Append to Treeview. This button will only be active when one or more datasets have been selected in the Saved Datasets grid. When the append action is performed, all records from the selected datasets will be appended to the treeview.

Add / Replace Dataset

Toggle button between add and replace dataset. If at least one item is selected, replace the items in the selected dataset, otherwise create new dataset by showing the Save dataset window.
This button is always visible. When the user selects the Add a New Dataset button, they will be prompted with the Create New Dataset screen. Enter a name and click Save.

Append Dataset

Append Dataset will append all items from the tree view to any selected datasets in the list of saved datasets. This button is only active when one or more saved datasets has been selected in the list.

Delete Dataset

This button is used to delete saved datasets. To delete one or more dataset from the list, select the datasets that are to be deleted, and click Delete Dataset.

Share Dataset

Users that are members of other roles may share their Saved Datasets. This is done through Share Dataset feature.
To share saved datasets…

  1. Select the check box for the dataset that you would like to share.
  2. Click Share Dataset.
  3. In the Share Dataset window, enter a name for the shared dataset.
  4. Select the Roles and or Users that you are a member of, and would like to share the dataset with.
  5. Save the change with a click on the Share button.
NOTES: Saved Dataset names can be up to 50 characters including spaces. The datasets that are displayed are only for current ID’s, as an example if the open profile is based upon a P_ID, then only saved datasets that have a Reference Type of P_ID are displayed.

Video

NOTE: There are no Training Videos available

 

 

101-std-fea-006

 

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

101-std-fea-015

Govern Hibernate

Overview

An area that is critical to productivity in Govern is the user interface and workspace. The Govern Hibernate standard feature is designed to enhance the user experience. Benefits of using the feature are the following:

  • Personalization of user interface and workspace.
  • Reduced time required to recommence work after restarting the application.
  • Increased productivity by not having to re-establish interface setting and searches.

When enabled, the Hibernate feature will create a snapshot of the user work area, save the snapshot, and restore the workspace when the user restarts the application. Interface settings, i.e. Window location and pane settings are stored in (Table: USR_HIBERNATE).

Location

The Hibernate feature is located under the Options tab > Hibernate Mode group in the Govern Ribbon.

NOTE: Hibernate Mode is securable in the Govern Security Manager (GSM) if it is not available in the Govern ribbon, users should verify with an administrator as to whether they have sufficient access rights.

Settings

WARNING: Effective from versions: 6.0.1409.0113 and 6.0.1410.0017, a new table (Table: USR_HIBERNATE) containing 2 fields. These fields contain the User_ID and details of the Hibernate Environment in XML format. As a result of this new table, before running Govern users must first run the Database Verification process in GNA.

There are three (3) user setting options/states for the Hibernate feature. Hibernate states/options are available as a drop down menu that is displayed with a click on Hibernate Mode in the ribbon.
Options are as follows:

Auto (Default)

Auto is the default state of the application. When Govern is installed, the Hibernate Mode will be enabled. Exiting from the application will result in the current workspace being saved.

NOTE: When Auto is selected, the Save User Interface option cannot be selected.

 

NOTE: When there are multiple OpenForm Profiles opened prior to the hibernate process, i.e. save and exit, upon restarting, the last active profile will be opened in the forefront.

On Demand

Select On Demand to give the option to:

  • Save the current workspace; saves the current workspace; the current appearance will be restored when the application is reopened.
  • Keep previously saved workspace. When you click OK, the previously saved workspace will be saved, i.e. the setting that was displayed when the application was opened.
  • Clear Previously saved workspace.

The above three (3) options are user selectable through a dialog box that appears when exiting the application.

NOTE: If the dialog box is closed, or the user clicks Cancel, the user will be returned to the application.

Off

When Off is selected, the interface will not be saved. Upon restarting the interface will be reset, i.e. no user panes will be opened, neither will any query results be restored.

NOTE: When Off is selected, the Save User Interface option cannot be selected.

Business Rules

When the Hibernate feature is enabled, and a user workspace is saved, the following business rules will apply
1. All open profiles will be recorded, and restored when the Govern application is restarted.
2. When there are multiple OpenForms profiles open, when Govern is restarted, the focus will be on the active profile.

  • Each profile will be defined in the user interface settings file by its unique code and instance number to establish layout hierarchy.
  • If previously opened, all profile items, i.e. forms, reports, view queries, etc. will be reopened.
  • All dataset record keys will be loaded.
  • Active record will be selected.
  • The toolboxes layout will be saved using the ActiPro (Save/Load layout) feature.

3. A click on Save User Interface in the ribbon will save a snapshot of the user interface/workspace following the above rules 1 and 2.
4. In the event of an unrecoverable system failure, i.e. application “crash” the stored user workspace file is reset; all settings will be erased. The “Hibernate” Mode is set to “Clear”.

What’s New

[6.0] Previously the XmlHibernateByUser.xml file was used. Now the information is recorded in (Table: USR_HIBERNATE).

 

 

101-std-fea-015

 

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

Govern Help Documentation

Govern Help

Overview

Installation of the Govern Help system is managed by the Deploy EZ application during the installation or update process. It is during this process that required directories are created and help content is updated. For the Govern application, unlike the Help system of the other applications in the suite, Govern help content is not invoked with the F1 key. Help content is displayed with a click on one of the help icons (A) displayed under the Help tab (B) in the Govern application interface. The user selects the icon that corresponds to the profile, form, or entity of interest.

NOTE: Users can still invoke Help content with the F1 key in all other applications within the Govern suite. All help content that is presented to the user is contextual, i.e. relevant to the active user screen.

 

Read More...

User Interface

Govern

For a user to open the Help file within the Govern application, they will need to select the Help tab in the ribbon of the Govern application (A). Under the ribbon, the help content which corresponds to the Application, the Profile, the displayed Open Form, and the Entity is displayed (B).

  • Applications – Content corresponding to the suite Application; the General group
  • Profile – Help content for the Profile
  • Form – The help content for the displayed Open Form
  • Entity – Help content related to the Entity
  • Report – This is the Report associated with the form or entity.

The Help button displays information for the main application, and the OpenForm Help will display Help content that is related to the active OpenForm.

Missing / Unavailable Help Content

When content is not present the broken help link icon is displayed. This icon is an indication that there is an issue with accessing the Help file(s). Issues can be anything from the files not being present or incorrect directory structure due to a change in the Open Forms General Settings form in GNA; the Help Folder Structure Type parameter may have been changed.To correct this situation, users will need to either:

  • Place the required content in the appropriate directory

OR

  • Verify that the Help Folder Structure Type parameter setting in the Open Forms General Settings form in GNA is set to the correct Help folder structure.

 

Help Content Directory Structure

Open Form Hierarchy

The Open Forms hierarchy is as follows with order of precedence decreasing from left to right.
The above hierarchy is reflected in the structure of the Help directories and subdirectories.

Order of Precedence for Help files Directories

When a user calls the help file, the Govern system first checks in the Custom folder. If the requested file is not found, it will default to the Standard folder to display the file. The Custom folder is reserved for users that want to generate their own custom PDF help files.

Directory Structure

As illustrated in the grid illustration, the structure of the Help directory is multi-leveled. The <HELP ROOT> refers to the root level of the help directory, and not the actual deployment installation of the Deploy EZ application.

Grid illustration examples:

  • Standard (same level option)
    • The versionNum directory will be a version number, i.e. 5.1, 5.2, 6.0,…
  • Custom (same level option)
    • The structure for the Custom directory is nearly identical to that of the Standard directory.
    • The exception is that the Version directory is not present at Level 1. All sub-directories are shifted up by one level.
  • Custom (profile option)
    • Different profiles will require the same report. When the Profile option is selected in the System Registry, the different profiles will be using the same report.Copies of the same report are placed in the different Profile directory.
101-std-fea-002-GOV60-(UI HelpStruct-StdDir-SameLvl)-[v6.0].png
STANDARD – SAME LEVEL option

 

101-std-fea-002-GOV60-(UI HelpStruct-CustDir-SameLvl)-[v6.0].png
CUSTOM – SAME LEVEL option

 

101-std-fea-002-GOV60-(UI HelpStruct-CustDir-ProflOptn)-[v6.0].png
CUSTOM – PROFILE option

Click the diagram to enlarge and open in a new window

Setup

GNA – System Registry (xxx)

Default folders & options

The directory structure, as in previous releases, has two (2) principal subdirectories, Standard, and Custom. Both the Standard and Custom directory structures are set by the system and should not be modified by the user. The structure, and how the system will access the Custom directory can be determined by the user through settings in the Govern New Administration (GNA). There are two (2) options to choose from in the form. [to be verified]

To open the form, in the GNA, select System Parameters > General Settings Editor…
In the Open Forms General Settings editor, select the following:

  1. Under the Registry Filter, select General.
  2. Locate the General Section Name, available options are Profile or Same Level.
  3. The selection of Profile or Same Level, are dependent upon user requirements.

 

Same Level option

Users that are content with the Property Control (PC) profile that is the system default should use the Same Level option. The same profile will be used by all departments, i.e. the same Open Forms will be accessible to all users. All users will be viewing the same help content for the active forms.

NOTE: The Same Level option is the system default.

Profile option

In situations when different profiles are required for the same, or different departments customized profiles will need to be designed. For example, a PC profile that is created for the Assessors department may not necessarily be the same one used by the Public Works department. As the Profiles and Forms are different, the Help content may not be the same. Some confusion regarding functionality may arise unless specific instructions are provided. In this situation, the option for Profile should be selected. With the Profile option, content is placed in a separate directory that corresponds to each customized profile.

NOTE: Changing the parameter after the directory structure has been established is not destructive to the custom help content, but it will no longer be available until the settings are restored.
101-std-fea-002-GOV60-(UI HelpStruct-Schema)-[v6.0].png
Help Content Directory Structure – Click image to open in new window.

GSM – Security & Custom Folders

There is no security imposed on the Custom Help directories. This is the default setting for the installation. Administrators that wish to limit user access to these directories will have to do so using Windows security. Security settings will also need to be done on a user by user basis.

Custom HELP Directories

Security

There is no security imposed on the Custom Help directories. This is the default setting for the installation. Administrators that wish to limit user access to these directories will have to do so using Windows security. Security settings will also need to be done on a user by user basis.

Security Best Practices

BEST PRACTICES – SECURITY
The recommended security setting for administrators that require user restriction to directories, is as follows:

  • All top level Help directories should be set to READ ONLY. for the Custom folder.
  • In order for users to be able to add or update custom content, sub-directories of the top level Custom folder should be made accessible, i.e. READ / WRITE for users. This will allow them to place help in the directories when required.*

 

NOTE: The structure of default Standard, and Custom folders should not be modified.

Users are not required to create directories for the Custom Help folder; the structure established during installation must be kept in order for the content to be available.

NOTE: Unless additional files are required, the help content are in PDF format. Any additional formats that are mentioned above are files that are supplemental to the PDF with the main help content.

 

NOTE: When including any supplemental content, users must ensure that the file format is supported by the end-users system; e.g. if a MicroSoft Office PowerPoint document is to be one of the supplemental files, a PowerPoint viewer or a fully licensed version must be installed on the installation computer.

Note: Network traffic …

Custom HELP Content Nomenclature

CUSTOM HELP CONTENT NOMENCLATURE

  • Lower case names should be used.
  • Users should try to limit filenames of help content to no more than 12 characters because the group will expand to accommodate the name. See image below
  • Limit the length of directory names directories; try not to exceed 12 characters
  • Use the underscore character “_” in place of spaces. Ex. parcel_asmnt
  • Ensure that the extension of the file is supported by the end-user’s system that the content will be viewed on.
  • As a result of the brevity required for the filename, a detailed description of the Help Content can be entered using the Resource File editor in GNA. The node that contains this information is located in the WD module, CustomHelp function. The Keys for tool tips will be appended with an _TT in the names.

Refer to the Govern New Administration (GNA) Resource File editor. <LINK>

Help files Administration

Downloading

Deploy EZ option

Creating

The Govern application is designed to be flexible, with the understanding that users are able to design forms and reports. It is therefore expected that they may have a requirement to customize their Help files contents. When users customize Govern, supplementary help content can be created in one of two (2) ways.

  • Annotate existing system Help files
  • Generate new content with new PDF files

Annotating System Help Files

Users may annotate, i.e. add Notes, to existing system PDF files that correspond to the modules. Although system files should not be modified, there are steps that can be taken to ensure that system integrity is maintained.

Annotation Best Practices

BEST PRACTICES – ANNOTATING SYSTEM FILES
When annotating system PDF files, users should make a complete back up of the installed files. Only the copied files should be annotated and placed in the Custom folder. Original system files will remain in the Standard folder.

Generating PDF Help Files

When generating a PDF file with custom content, in order for the system to recognize the custom PDF file, it must have the same name as the one that is used in the Govern application or module.

For example, the Hazards (PC24) OpenForm in the Property Control module has been customized. A new PDF file is made containing custom instructions. In order for it to be accessible, the new PDF file should have the same name as the system default Help file. For Hazards the file is PC24.pdf; when this file is created, it should then be placed in the appropriate subdirectory in the Custom folder.

NOTE: When a custom PDF is placed in the Custom folder, it is not necessary to remove the system default help file in the Standard folder. System files should never be modified.

Adding or Replacing Help Content
There are two zones to the Help content ribbon in Govern. Zone 1 which contains the icon for the help content file is the area to click when you need to access the content. Zone 2, when selected, will give access to the directory that the content is located in.

NOTE: In instances where there is no help content and the broken help link icon is displayed, a click on the link will also display the directory.

The directories at the custom content is to be placed in is easily accessible with a click on the icon under the Help tab in the Govern ribbon.

Upgrades

The subject of upgrades is undergoing validation. News will be forthcoming.

Documentation

How to configure System Help

Click to view the Configure System Help document.

 

What’s New

Read More...

Web Help

[v6.0 1509.x] A Web based Help system is in place for the following Govern applications:
DeployEZ, Govern, Govern New Administration (GNA), OpenForms Designer (OFD), Business Entity Designer (BED), Govern Scheduler (GS), Govern Security Manager (GSM), and the Query Tool (QT).

On-line Help

[v6.x] On-Line Web Help
Product on-line Help&Doc Web

[v6.x Beta] Product Knowledge Base access
Access to Product Knowledge Base

Changes to the Help Directory

[Release 6.0.1407] Help is available for the batch processes
To setup:

  1. Standard or Custom Folders
  2. Then a folder “Batch Processes”
  3. Then a folder whose name is the bp name code
[Release v5.1] From Govern Release 5.1 and greater, changes were made to the structure of the Help file directories. The new structure was created to be able to present users with help content in different file formats. Content can include video clips, user system supported file types, custom images, and so on. As with prior versions of the help, the Adobe Acrobat PDF file format is used to distribute the content.
Help content is stored in multiple level directories. All standard content will be deployed as a ZIP archive file. Upon installation, the.ZIP package is then extracted to the Standard directory.

Subject Author Replies Views Last Message
No Comments

 

 

101-std-fea-002

 

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