File Maintenance Generator

Step 1: File Maintenance Object Definition

Select the type of form(s) to create and the data dictionary table to use. The file maintenance object for the file definition is also specified, if applicable.

Note:
For file maintenance panels, Table Name and Object Name are required before proceeding to Step 2: Properties.

This panel consists of the following:

Select the file maintenance template and layout format

Select a template to apply its settings to the new panel(s) or HTML page(s) to be generated.

A template consists of predetermined settings that define the appearance of a panel or HTML page. Using templates makes designing new panels or HTML pages easier and gives them a consistent look and feel.

The templates data file "maint_templates.dat" is created according to the prefix settings the first time the File Maintenance Generator is accessed on a new PxPlus installation or for a new PxPlus project. Therefore, different PxPlus projects may have unique template data files.

(Support for creating the templates data file according to prefix settings was added in PxPlus 2021.)

Different templates can be used to create different panel or HTML page designs. For example:

   • A simple maintenance panel with (or without) browse buttons
   • A panel that includes a folder with top (or bottom) tabs
   • A panel that includes a folder with left (or right) sidebar tabs
   • A panel with an embedded toolbar

To save template settings for future use, click the Save Template button in Step 7: Finish.

File Maintenance Template

(Available when a template exists)

Click the drop-down arrow for a list of previously saved templates (if applicable). See Save Template (in Step 7: Finish).

When a template is selected, its settings are applied to the current panel or HTML page to be generated.

If no templates exist or an existing template is not selected, the default will be None.

If a template was saved with the Default Template check box selected (see Save Template), that template name will be the default when a new file maintenance panel is being generated, and the words *Default Template* will display.

Note:
If a panel is being regenerated, the File Maintenance Template drop box will initially be disabled. To enable this drop box and choose another template, select the Reset Template check box.

(The default setting "None" was added in PxPlus 2019 Update 1.)

Layout

(Available when creating a new file maintenance panel)

Click the drop-down arrow to select the panel layout to use in Step 6: Fields. Starting with PxPlus 2024, the default is the Enhanced layout.

Enhanced

When selected, the Layout Grid defaults to two Half sections. You can leave the rows as Half sections or change individual rows to a different Section size (i.e. Full Section, Half Section, Third Section or Quarter Section) by using the right-click menu.

See Enhanced Layout.

Important Note:
The Enhanced layout is not backwards compatible with previous versions.

(The Enhanced layout was added in PxPlus 2024.)

Two-Column

When selected, the Layout Grid defaults to the Left Side and Right Side layout that existed prior to PxPlus 2024. You can leave the rows as Half rows or change individual rows to a different size (i.e. Full Row or Half Row) by using the right-click menu.

See Two-Column Layout.

The Layout option cannot be changed when regenerating a panel.

If you are creating a new panel and have not entered anything in Step 6: Fields, you can still go back to Step 1: Definition and change the Layout option; otherwise, a message will display.

Note:
If regenerating a panel that was created using an earlier version of the File Maintenance Generator (i.e. prior to PxPlus 2024), the Layout option will display Two-Column and be disabled.

(The Layout option was added in PxPlus 2024.)

(Copy Templates from another location)

(Available when no templates are defined)

Button (beside the File Maintenance Template drop box) that launches the Copy File Maintenance Templates window.

This window is used to copy the file maintenance templates from an existing templates data file (maint_templates.dat) to the templates data file in the current PxPlus installation or project. This allows previously defined templates to be available in subsequent PxPlus installations or projects without having to recreate them.

For example, assuming that file maintenance templates were defined in PxPlus 2020, after installing PxPlus 2021, you would need to use the Copy Template button to copy those existing templates to the currently empty templates data file in PxPlus 2021.

This window consists of the following:

Template File	Specify the location of the existing file maintenance templates data file (maint_templates.dat) to copy from.
OK	Copies the existing templates from the selected data file into the currently empty templates data file. The File Maintenance Template drop box is loaded with the templates from the specified file, and the Copy Templates button is hidden.
Exit	Closes the Copy File Maintenance Templates window without copying any templates.

Note:
If a panel is being regenerated and the template used is invalid for the new installation or project, the template will be reset to the original value if it is valid after the copy is complete.

(The Copy Template button was added in PxPlus 2020.)

(Delete Template)

(Available when a previously saved template is selected)

Button (beside the File Maintenance Template drop box) that is used to delete a template. Prior to deleting a template, a message will display.

This button is enabled when a previously saved template (other than None) is selected from the File Maintenance Template drop box.

Note:
If the template that was used to generate a panel is subsequently deleted, a message will display when regenerating the panel, stating that the template is no longer valid. However, the template settings that were used to generate the original panel will not be deleted.

Reset Template

(Available when an existing panel is being regenerated)

Select this check box to enable the File Maintenance Template drop box and reset the template by choosing one from the drop box. The settings associated with the selected template will be used instead of the settings when the panel was generated.

If the Reset Template check box is unchecked after another template has been selected, the original template name and its settings will be put back to the way they were on the original panel.

By default, this check box is not selected. When generating a new file maintenance (or inquiry-only) panel, this check box is hidden.

(The Reset Template option was added in PxPlus 2020.)

Screen Designer

(Available when an existing panel is being regenerated)

Button that opens the regenerated file maintenance panel in the NOMADS Panel Designer.

If any File Maintenance settings were changed, a message will display when clicking this button.

(The Screen Designer button was added in PxPlus 2023.)

Select the type of form(s) to create

A NOMADS panel, an HTML page or both types can be created. Non-File Maintenance forms, which do not use the standard file maintenance logic, can also be created.

Form Type

Select the type of form(s) to create: a NOMADS Panel (Default), a Webster+ HTML Page, or both types.

The Non-File Maintenance Form check box is used for creating a NOMADS panel and/or HTML page that does not use the standard file maintenance logic. Selecting this check box provides the capability to generate informational/dashboard-like panels or pages. Entering a data dictionary table is optional. If a table is entered, fields can be added to the layout if desired. The Non-File Maintenance Form setting is not saved to a template.

Before an HTML page can be created, a location must be defined to store the Webster+ generated HTML forms. This is done by selecting Webster+ > Directory on the Library Object Selection menu bar. If the location is not defined and the HTML Page option is selected, a message will display.

(The Form Type option was added in PxPlus 2021.)
(The Non-File Maintenance Form option was added in PxPlus 2022.)

Select the table from the data dictionary

A definition must exist in the data dictionary (providex.ddf and providex.dde files) to generate a new panel.

Table Name

Name of an existing data dictionary table for which the file maintenance object is being defined. Click the Query Table View button (magnifying glass) to invoke the Lookup Table Names window to search for a table name or type the table name.

If the Non-File Maintenance Form check box is selected, the table name is optional.

Note:
When the panel is generated, the table name is recorded in the Tag Field property in the Panel Header record for the main panel.

Panel Title

Title to display at the top of the generated panel. The panel title is required before proceeding to the next step.

By default, the panel title displays as xxxxxx Maintenance (where xxxxxx is the Table Name selected from the data dictionary).

If the Inquiry Only check box is selected, the panel title defaults to xxxxxx Inquiry.

If the Non-File Maintenance Form check box is selected, a panel title must be entered.

Note:
The default Panel Title is derived using the data dictionary description and one of the standard message library references - 'FM_TITLE' for the word 'Maintenance' and 'FM_INQ' for the word 'Inquiry'.

For generating panels in languages other than English, corresponding message library entries should be created.

Panel Title Symbol

(Applicable for HTML Pages Only)

A symbol can be optionally added before the panel title in Webster+ HTML pages. It can be either a Font Awesome symbol or a standard PxPlus bitmap selected from the Bitmap Library lookup button.

For a list of Font Awesome symbols, visit https://fontawesome.com/v4/icons/.

Note:
When specifying the Font Awesome symbol name, do not include the leading 'fa-'.

(The Panel Title Symbol option was added in PxPlus 2022 Update 1.)

Enter the maintenance object

Generated file maintenance panels require a file maintenance object as the Default Program in the Panel Header for a generated main panel. This object contains properties that correspond to the options on the Step 2: Properties panel. This object can be unique to each generated file maintenance panel or can be shared among different generated file maintenance panels.

File Maintenance Object

Click the drop-down arrow for available selections:

Use the Standard File Maintenance Object

(Default) The panel will use the standard *win/fm_maint.pvc object and the properties on the Step 2: Properties panel will be set from the default values stored as %NOMADS Object properties. See File Maintenance and Object Inheritance.

     PROPERTY FM_Update_Option$='R'
     PROPERTY FM_New_Option$='0'
     PROPERTY FM_Clear_Option$='0'
     PROPERTY FM_Auto_Save_Option$='0'
     PROPERTY FM_Confirm_New_Rec$='0'
     PROPERTY FM_Acknowledge_Writes$='0'
     PROPERTY FM_Confirm_Deletes$='1'
     PROPERTY FM_Acknowledge_Deletes$='1'

Note:
These properties may be overridden by setting them in the NOMADS Environment Maintenance utility or by setting them individually elsewhere.

Create a New File Maintenance Object

Enter the name of a new object to be created with properties defined on the Step 2: Properties panel.

Use an Existing File Maintenance Object

Enter the name of an existing object to be used with properties defined at the time the object was initially created.

Note:
If an existing file maintenance object is entered, the options in Step 2: Properties will be set based on the values in the selected file maintenance object and cannot be modified. See File Maintenance and Object Inheritance for information on file maintenance objects.

(The File Maintenance Object drop box was added in PxPlus 2020.)

Object Name

Input depends on the File Maintenance Object drop box selection:

•	If Use the Standard File Maintenance Object is selected, Object Name defaults to the standard *win/fm_maint.pvc object and is disabled.
•	If Create a New File Maintenance Object is selected, enter a *new* Object Name. If a duplicate Object Name is entered, a message will display.
•	If Use an Existing File Maintenance Object is selected, enter an *existing* Object Name or click the Query button. If an Object Name is entered that does not exist, a message will display.

Note:
Object names must end with the file extension .pvc.

Inquiry Only

Select this check box to create a file maintenance panel in inquiry mode, which allows view-only access to records. Records cannot be added, edited or deleted.

If this check box is selected, the Panel Title defaults to xxxxxx Inquiry. In addition, all options in Step 2: Properties, as well as the Required Fields option in Step 4: Controls, are disabled.

Enter the optional HTML interface program

As with the File Maintenance logic in NOMADS, hooks are available to allow additional logic to be performed for the HTML page. If the HTML page requires additional logic at some or all of the following points, ensure that the methods are named as shown below:

FM_INIT	Will be performed on initial page display.
FM_POST_READ	Will be performed after each record is read.
FM_PRE_WRITE	Will be performed before writing any record.
FM_POST_WRITE	Will be performed after writing a record.
FM_PRE_REMOVE	Will be performed before removing a record.
FM_POST_REMOVE	Will be performed after removing a record.

Interface Program

(Applicable for HTML Pages Only)

Enter the name of the interface program or click the Query button.

An interface program is needed if you want to add code for any of the methods listed above. It is also needed to code events associated with various Objects (Buttons, Grids, Input Fields, etc.) that you are adding to the HTML page in Step 6: Fields.

If adding a Grid object, the HTML interface program is required to create a method to load the Grid using a memory file. The interface program name entered will be used as the default Initialization Program.

For an example of an interface program, see Grid Example. For additional Grid information, see Using Grids in Webster+.

(The Interface Program option was added in PxPlus 2021.)

File Maintenance Generator

Note:For file maintenance panels, Table Name and Object Name are required before proceeding to Step 2: Properties.

Note: If a panel is being regenerated, the File Maintenance Template drop box will initially be disabled. To enable this drop box and choose another template, select the Reset Template check box.

Important Note: The Enhanced layout is not backwards compatible with previous versions.

Note: If regenerating a panel that was created using an earlier version of the File Maintenance Generator (i.e. prior to PxPlus 2024), the Layout option will display Two-Column and be disabled.

Note: If a panel is being regenerated and the template used is invalid for the new installation or project, the template will be reset to the original value if it is valid after the copy is complete.

Note: If the template that was used to generate a panel is subsequently deleted, a message will display when regenerating the panel, stating that the template is no longer valid. However, the template settings that were used to generate the original panel will not be deleted.

Note: When the panel is generated, the table name is recorded in the Tag Field property in the Panel Header record for the main panel.

Note: When specifying the Font Awesome symbol name, do not include the leading 'fa-'.

Note: These properties may be overridden by setting them in the NOMADS Environment Maintenance utility or by setting them individually elsewhere.

Note: If an existing file maintenance object is entered, the options in Step 2: Properties will be set based on the values in the selected file maintenance object and cannot be modified. See File Maintenance and Object Inheritance for information on file maintenance objects.

Note: Object names must end with the file extension .pvc.

See Also