#

User Reserved Words Maintenance |

User Reserved Words Maintenance is used to reserve specific words to restrict their use as table and element names in the Data Dictionary or as names of NOMADS controls or both.

This program is designed to allow two word lists: PxPlus Supplied Words and User-Defined Words. The PxPlus Supplied Words list is a predefined PxPlus system list, which cannot be edited. The User-Defined Words list is initially empty to allow developers to add whatever words they choose whenever they want, as well as delete words. If desired, the same word may be used for both lists. However, adding a word from the PxPlus Supplied Words list to the User-Defined Words list allows the default restrictions on the word to be overridden, changing the PxPlus-supplied behavior for that word.

When a new table name or element name is entered in Data Dictionary Maintenance, both lists are checked to determine if the word is restricted for use in the Data Dictionary. When a new control name is entered in the NOMADS Panel Designer, both lists are checked to determine if the word is restricted for use as a NOMADS control name. In both cases, a warning message displays when a reserved word is detected.

(User Reserved Words Maintenance was added in PxPlus 2020.)

To invoke User Reserved Words Maintenance, use one of the following methods:

Location | Method
From the PxPlus IDE Main Launcher | Expand the Data Management category. Select User Reserved Words Maintenance.
From the NOMADS Session Manager | From the Dictionary menu, select User Reserved Words Maintenance.
From the PxPlus Command line | Enter: CALL "*winproc","resv_words","*win/scrnlib.en"

This window consists of the following:

Reserved Words to Display | Select the list of words to display in the Reserved Words grid below: User-Defined Words or PxPlus Supplied Words. By default, User-Defined Words is selected. This list is initially empty when User Reserved Words Maintenance is accessed the first time. #### Note: If unsaved changes to the User-Defined Words list are detected when selecting PxPlus Supplied Words from the drop box, a message will display to save the changes.
(Reserved Words Grid) | Displays the words in the list selected from the Reserved Words to Display drop box and indicates if a word is restricted for use in the Data Dictionary and/or for NOMADS controls. This grid is used when adding, editing and deleting a reserved word. The PxPlus Supplied Words list is a predefined PxPlus system list and cannot be edited. The User-Defined Words list is initially empty to allow developers to add whatever words they choose whenever they want, as well as delete words. If desired, the same word may be used for both lists. However, adding a word from the PxPlus Supplied Words list to the User-Defined Words list allows the default restrictions on the word to be overridden, changing the PxPlus-supplied behavior for that word.
Reserved Word | Word that is reserved. To add a new User-Defined Word, type the new word in the next available blank row. User-Defined Words must begin with a letter and contain only alphanumeric, period, underscore or dash characters (no spaces). These words are case insensitive. PxPlus Supplied Words cannot be edited and are shown in uppercase letters with their rows grayed out. If adding a User-Defined Word that is also in the list of PxPlus Supplied Words, this word will be grayed out in the Reserved Word column; otherwise, User-Defined Words are accessible for editing. Reserved words are initially sorted alphabetically in ascending order. Click the Reserved Word column heading to toggle between ascending/descending order.
Data Dictionary | Select this check box to indicate that the reserved word should not be used for a table name or element name in the Data Dictionary; otherwise, leave it unchecked to allow it to be used. #### Note: If this check box is selected and the reserved word is subsequently used in a new table name or element name, a warning Message will display.
NOMADS Controls | Select this check box to indicate that the reserved word should not be used for a NOMADS control name; otherwise, leave it unchecked to allow it to be used. #### Note: If this check box is selected and the reserved word is subsequently used in a new NOMADS control name, a warning Message will display.
Delete Words(s) | Button used to delete one or more User-Defined Words selected in the grid. PxPlus Supplied Words cannot be deleted. To delete multiple words, select the words using Shift-Click (consecutive selections) or Ctrl-Click (random selections) and then click the Delete Word(s) button. Prior to deleting the selected words, a message will display.
Search Dictionary | Button that launches the Search Data Dictionary for Reserved Words window. This window is used to search the current Data Dictionary to look for instances where reserved words restricted for use in the Data Dictionary may have been previously used as table names or element names. Click the Search button to activate the search. Any instances that are found are displayed in the grid. This window consists of the following:
(Search Results Grid) | Displays any instances where a reserved word restricted for use in the Data Dictionary was located in either a table name or an element name.
Table Name | Name of the Data Dictionary table in which the reserved word was located.
# | Displays the element number if the reserved word was located as a data element. This column will be blank if the reserved word was located as a table name.
Element Name | Displays the element name if the reserved word was located as a data element name. This column will be blank if the reserved word was located as a table name.
Reserved Word | Displays the reserved word.
User | A check mark indicates that the reserved word found is a User-Defined Word.
Search | Button used to activate the search. When the search is completed, a message displays in the lower left corner of the Search window to indicate if any reserved words were located. #### Note: Once search results are displayed, right click within the grid to access popup menu options for finding the next or previous instance of a particular word, for exporting the results to a spreadsheet and for printing the results.
Exit | Closes the Search window and returns to User Reserved Words Maintenance.
OK | Saves any changes and exits User Reserved Words Maintenance.
Cancel | Closes User Reserved Words Maintenance without saving any changes.
Apply | Saves any changes without exiting User Reserved Words Maintenance.

## Reserved Words Usage

Reserved words that are restricted for use in the Data Dictionary are typically SQL commands that may cause issues in the event that a PxPlus application is ported to a relational database. These words are checked when a new Table Name or Element Name is entered in Data Dictionary Maintenance.

Reserved words that are restricted for use as NOMADS control names are NOMADS variables used within the NOMADS programs. These words are checked when a new control name is entered in the NOMADS Panel Designer.

In both cases, a warning message is displayed when a reserved word is detected:

| When a reserved word is detected (Data Dictionary) | When a reserved word is detected (NOMADS Control)

Responding OK will override the warning and allow the reserved word to be used.

Responding No will not allow the reserved word to be used.

Responding Always OK will add the reserved word to the list of User-Defined Words, removing any restriction for its use either in the Data Dictionary or for NOMADS control names.

#### Important Note:
Any new Data Dictionary element names and NOMADS control names starting with the characters "FN" will be flagged and will not be accepted to avoid confusion with Function names.
If a new element or control name starting with "FN" is entered, a message will display. To continue, enter a new name that does not start with "FN".

## See Also

Creating Panel Controls