Contents   Index   Previous   Next



Help (HLP)

 

 

In the Help (HLP) tab, the administrator may select from two rules groups: Global or Agency. These rules groups are listed and described below.

 

Global

The Global rules group are default program help elements that are configured for the entire agency and subagency network. These elements are set by Datamaxx Applied Technologies, Inc. personnel only.

 

Agency

The Agency rules group are default program help elements that are agency specific. These elements are set by the agency’s system administrator, and only at this level can these defaults be changed for subagency help elements.

 

By selecting the Agency option, a list of all help elements available to all users in an agency are displayed. The administrator may select one help element from the list and perform the following functions: New, Copy, Save, Cancel, Move, Edit, Delete, Show, Help and Done.

 

The New button is available to create a new copy of the selected help element. By clicking this button, the administrator is prompted to save changes to the new element in the database.

 

The administrator may save the new help element in the database by clicking the Save button. Note the new Identifier precedes the element name.

 

The Copy button allows the administrator to copy a help element.

 

The administrator may save the copy of the help element by clicking the Save button. Note the new Identifier precedes the element.

 

The Cancel button allows the administrator to quit any changes to a help element before saving to the database. The administrator clicks the Cancel button to quit the creation of a new help element process and the following dialog box is displayed. The administrator clicks Yes to cancel the process, or No to continue the create new help element process.

 

The administrator clicks Yes to confirm the intention to quit the creation of the new help element process. The administrator is returned to the Application Rules Editor screen. Note: The new definition is deleted from the help elements list.

 

The Move button allows the administrator to move the element to another place in the help elements list.

 

The administrator clicks the OK button and the Move Help Confirmation dialog box is displayed. The administrator selects the new location for the help element. The administrator clicks the OK button once again to move the help element to a new location.

 

APP_RULES_HLP_EDIT

 

The Edit button allows the administrator to make any changes to the help element properties. Note the ID, Name, and Version fields are displayed in grayed text (“grayed-out”) and cannot be altered. These fields are referred to as primary keys and are used as search criteria. The Properties fields shown in blue are mandatory fields.

 

The New button on the Help Rules Editor allows the administrator to create a new help element for the help elements list. The administrator may save the new help element by clicking the Save button.

 

The administrator may define the new help element by entering data in the following fields:

 

Type – The format of the help element. The administrator may select from five options: Paragraph, List, 1 Column Table, 2 Column Table, or 3 Column Table. These options are listed and described below.

 

Paragraph

The Paragraph type allows the administrator to enter paragraph text for the highlighted help element.

 

List

The List type allows the administrator to define the selected help element in a list format. The List is divided into multiple List Items.

 

The first list item is defined by the administrator for the selected help element.

 

The second list item is defined by the administrator for the selected help element.

 

1 Column Table

The 1 Column Table is divided into multiple rows with one column per row. The administrator inputs the data for the second row, first column in the 2 Column Table.

 

2 Column Table

The 2 Column Table is divided into multiple rows with two columns per row. The administrator inputs the data for the first row, first column in the 2 Column Table. Next, the administrator inputs the data for the second row, first column in the 2 Column Table. Finally, the administrator inputs the data for the second row, second column in the 2 Column Table.

 

3 Column Table

The 3 Column Table is divided into multiple rows with three columns per row. The administrator inputs the data for the first row, second column in the 3 Column Table. Secondly, the administrator inputs the data for the first row, third column in the 3 Column Table. Next, the administrator inputs the data for the second row, first column in the 3 Column Table. Then, the administrator inputs the data for the second row, second column in the 3 Column Table. Finally, the administrator inputs the data for the second row, third column in the 3 Column Table.

 

The Cancel button allows the administrator to quit any changes to the help element before saving to the database.

 

The administrator clicks the Cancel button to quit the create paragraph process and the Cancel Confirmation dialog box is displayed. The administrator clicks Yes to cancel the process, or No to continue the create paragraph process.

 

The administrator clicks Yes to confirm the intention to quit the create a paragraph process. Note: The new paragraph is deleted from the help element list.

 

The Down button moves the highlighted help item down one place in the list.

 

The Up button moves the highlighted help item up one place in the list.

 

The Delete button allows the administrator to select the help item for deletion. The list item is highlighted by the administrator.

 

The administrator clicks the Delete button and receives the Delete Confirmation dialog box.

 

The administrator clicks Yes to delete the help item highlighted by the administrator, or No to cancel the deletion process. If the administrator clicks Yes, the deletion process is complete.

 

The XML button allows the Standard Rules Editor to display the XML for a particular message definition.

 

The Standard Rules XML Editor provides the administrator with four options: Check, Cancel, Print, and Done. These options are listed and described below.

 

APP_RULES_HLP_TEST

 

Check

The Check button provides a sanity check for the XML coding of a particular message. Click the OK button to return to the Standard Rules XML Editor. The administrator may check for incorrect XML statements in the message code. A dialog box is displayed confirming well-formed code or an error in the code.

 

Cancel

This button cancels the print process and/or closes the Standard Rules XML Editor.

 

Print

The Print button prints a copy of the XML for a particular message on the user’s local printer.

 

Done

The administrator is provided with two options for closing the Standard Rules XML Editor: clicking the Done button or the button to return to the Help Rules Editor.

 

Help

The Help button provides helpful instructions for the Help Rules Editor and its functions.

 

Done

The Done button allows the administrator to exit the Help Rules Editor. If the data has not been previously saved, the administrator is prompted by a Save Changes dialog box.

 

APP_RULES_HLP_SHOW

 

The Show button allows the administrator to select the help layout from the Show Menu Main screen. The Print button allows the administrator to send the help dialog to the local printer. Close the Show Menu Main dialog box by clicking OK or the button to return to the Help Rules Editor.

 

Help

The Help button provides helpful instructions for the Help Rules Editor and its functions.

 

Done

The Done button allows the administrator to exit the Help Rules Editor. If the data has not been previously saved, the administrator is prompted by a Save Changes dialog box.

 

APP_RULES_VER_EDIT

 

If the administrator selects the Modify version of rules option, select the business rules version to modify by clicking the radio button located to the left of the rules version ID field, then click the Next button to continue.

 

APP_RULES_VER_ID

 

The Modified Application Rules Version screen is displayed. The administrator may define the new version of the business rules; however, the Identifier field is displayed in grayed text (“grayed-out”) and cannot be altered. Identifiers are referred to as primary keys and are used as search criteria.

 

Make modifications to the following parameters (if any):

 

Name – Enter the full name of the new business rules version.

 

Production Version – Clicking this check box ensures every user in the agency receives the same business rules version of the application.

 

Miscellaneous – Any desired miscellaneous text information can be entered for the new business rules version.

 

After making the necessary changes to the business rules version (if any), click the Next button to update the database. The Application Rules Editor contains the following elements:

 

Trans Forms (TFM) – Elements used to define the forms on which transactions are entered or displayed (reference Section 9.1.5.1).

 

Menu (MNU) – Elements used to define menu labels and actions (reference Section 9.1.5.2).

 

List (LST) – Controls used for displaying a list of acceptable inputs and allowing users to select an item form that list for entry (reference Section 9.1.5.3).

 

Edit (EDT) – Elements used to define standard edits for text (reference Section 9.1.5.4).

 

Msg Def (MDF) – Elements used to store message definition scripts that specify how the data entered on a form is transformed to one or more output messages (reference Section 9.1.5.5).

 

Help (HLP) – Elements used to define standard help text (reference Section 9.1.5.6).

 

APP_RULES_VER_DEL

 

If the administrator selects the Delete version of rules option, select the business rules version to delete by clicking the radio button located to the left of the rules version ID field, then click the Next button to continue. The Delete Application Rules Version Confirmation dialog box is displayed.

 

If the administrator decides not to delete the rules version, clicking the Cancel button will display the Cancel Confirmation dialog box. Click the OK button and the administrator returns to the Select Action Application Rules Version screen.

 

The administrator may confirm his or her intention to delete the selected application rules group by clicking the OK button. The Delete Application Rules Version message is displayed.

 

The administrator is not allowed to delete a version of the rules group if the business rules are selected as the Production Version. If this instance occurs, the Cannot Delete Production Rules Version message is displayed and the administrator is returned to the Select Action Rules Version screen.

 

If no further actions are required, the administrator may click Done, then the Next button to display the Rules Version Complete message.

 

The administrator clicks the OK button and returns to the Omnixx Console Applications Functions screen.