Data Dictionary Maintenance |
|
NOMADS includes the Data Dictionary Maintenance utility for building and maintaining the data dictionary. This utility presents all the different options and fields necessary to complete the basic steps for creating definitions in the data dictionary.
These basic steps include:
In addition, the data dictionary can be created from an external database (ODB, MySQL, OCI, ADO or DB2). See Using External Databases to Create a Data Dictionary.
Data Dictionary Maintenance is displayed below with a sample entry:
To invoke Data Dictionary Maintenance, use one of the following methods:
Location |
Method |
From the PxPlus IDE Main Launcher |
Expand the Data Management category and select Data Dictionary Maintenance. |
From the NOMADS Session Manager |
Select Dictionary > Maintenance from the menu bar. |
From the PxPlus Command window |
Select Utilities > Data Dictionary from the menu bar. |
From the PxPlus Command window |
Enter: DD (or DD tablename) |
The Main panel consists of options for Updating the Data Dictionary and embedding the definition in the physical file. These options include table name, key definition, access logic and notes.
Two tabbed folders, Info and Elements, are provided for specifying details about the data files and their elements:
|
Contains fields that are used to describe the physical file, including pathname, group, file type and block size. | |
|
Presents a grid with fields that are used to define all the data elements within the current definition, as well as for the Global Dictionary. |
The Menu Bar and Tool Bar provide options for adding and maintaining the data file definitions.
The Main panel includes the following fields:
Descriptive name for your data source to identify its definition in the data dictionary; e.g. Client List. (Maximum 64 characters.) Create a new definition by entering a name that does not already exist. You are prompted to confirm the creation of a new definition. See Creating a Definition. Note:
| |
Description |
A short description of the table contents. |
This information is updated automatically whenever a change is made in the data dictionary definition (i.e. updating the description, notes, options or elements, changing keys, etc.). This information is used by the Update Physical Files utility. (Last File Change was added in PxPlus 2021.) | |
This information is updated automatically when the file is updated by clicking the Update File toolbar button or selecting File > Update File from the menu bar. This information is used by the Update Physical Files utility. If a data dictionary definition is copied (see Import Dictionary) or a Physical File is entered that does not exist, the Last Physical Update information will be cleared. (Last Physical Update was added in PxPlus 2021.) |
PxPlus provides a Global Dictionary to which you can optionally add data elements for global use. When an element is defined globally, you can select and load its definition into various file definitions using the Elements tab. Global Dictionary element definitions are stored in the data dictionary files, providex.ddf and providex.dde.
Loading the Global Dictionary Definition
Load the Global Dictionary definition by clicking the Global Dictionary button (globe) next to the browse buttons on the Main panel. You can also click either the Query Table View button (magnifying glass) or the Query button (binoculars) and then select {Global Dictionary} from the list.
Once the Global Dictionary definition is loaded, data elements can then be added, deleted and maintained using the Data Elements grid, just like any other data definition. See Adding a Data Element to the Global Dictionary.
(The Global Dictionary button was added in PxPlus 2017.)
(The Data Elements grid was added in PxPlus 2020.)
Adding a Data Element to the Global Dictionary
After the Global Dictionary definition is loaded, new data elements can be added by using any of the following methods:
Method |
Description |
Create a new element from the beginning |
Enter a new element in the last blank row of the Data Elements grid. A new element can also be inserted before or after an existing element. Click the Field Name of the existing element above or before which you want to insert the new element. Right click on this selection and choose Insert Element (Before or After) from the popup menu or use the Insert Element Before (or Insert Element After) buttons beside the grid to insert a new row. Alternatively, create a new element by clicking the button in the Dtl column to invoke the Element Description window. When the new element is saved, it is added to the bottom of the Data Elements grid. Use the Move Up/Move Down buttons beside the grid to reposition the new element. Note: |
Create a new element from an existing element |
In the Data Elements grid, click the Field Name of the existing element with settings you want to use for the new element. Right click on this selection and choose Repeat Element from the popup menu. The new element is inserted below the existing element with the same settings and is initially assigned the same Field Name ending with _ (underscore) and a number (e.g. Address_1). The settings for the new element can be modified as needed. |
Add an existing element from another table |
On the Main panel, select the table containing the element you want to add to the Global Dictionary. In the Data Elements grid, click the Field Name of the element you want to add to the Global Dictionary. Right click on this selection and choose Add to Global Elements from the popup menu or use the Add Selected Data Element to Global Dictionary button (globe) beside the grid. A message will display when the Global Dictionary has been updated. To verify, load the Global Dictionary definition and review the Data Elements grid. Note: |
The Info tab describes features about the physical database file; i.e. pathname, group, file type, and size. The Elements tab provides various options and settings for defining elements in the physical files.
These tabbed folders consist of the following:
Physical File |
Pathname of the actual database file - either a Fixed value (e.g. XX_AR) or an Expression (e.g. %COMPANY$+"_AR"). Click the Query button to select a file. | ||||||||||||||||||||||||||||||||||
(Display Only) Indicates whether the current file is a Native (PxPlus) file, a database Link file, or a database Prefix file. (The File Type was added in PxPlus 2023.) | |||||||||||||||||||||||||||||||||||
(Available when File Type is a database Prefix File or a database Link File) Button (beside File Type) that is used to display the contents of a database Prefixfile entry or Link file in view-only mode. This button is disabled for Native files. Example:
(The View Prefix File Entry/Link File Contents button was added in PxPlus 2023 Update 1.) | |||||||||||||||||||||||||||||||||||
(The Force Data Validation option was added in PxPlus 2017.) | |||||||||||||||||||||||||||||||||||
Non-Normalized |
(Available when File Type is Native File) Select this check box to allow the definition of non-normalized data files. See Non-Normalized Data. | ||||||||||||||||||||||||||||||||||
Record Format |
(Available when File Type is Native File) Record type description for non-normalized data files. | ||||||||||||||||||||||||||||||||||
Define |
(Available when Non-Normalized check box is selected) Select this button to display the Non-Normalized Record Definitions window. See Non-Normalized Data. | ||||||||||||||||||||||||||||||||||
Search Grid for: (F3) |
Input field that is used for searching the field names in the Data Elements grid as letters are entered (case insensitive). Access this field by using the mouse or by pressing either the F3 key or the Tab key. (The Search Grid option was added in PxPlus 2021.) | ||||||||||||||||||||||||||||||||||
Grid that displays all the data elements in the selected table, along with their settings. This grid can also be used to add, edit and delete a data element. To make bulk changes to multiple data elements in the PxPlus data dictionary and apply the changes to selected tables, use the Bulk Edit Data Elements utility.
|
| Enter the name of an existing data class or use the Query button to load the information from a data class definition into the element's fields. A data class can also be created on the fly. Enter a new name for the Data Class and respond Yes to the displayed message, which launches Data Class Definitions. If the data class assigned to the element has been deleted in Data Class Definitions maintenance, the Data Class name will change to dark red. If a data class with the Class Name "Email" or "URL" (case insensitive) is assigned to a data dictionary field, the input entered for the field will be validated as either an email address or URL on a generated Webster+ HTML page. See File Maintenance Generator. (The dark red text indicating a deleted Data Class was added in PxPlus 2021.)
|
Description
| Brief description of the element, which can be a Fixed value, Expression or Message Library Reference.
|
Type
| Indicate whether the element is Numeric or String.
|
Len
| Set the maximum length of the data field. The system will validate that the length specified agrees with the Format selected; otherwise, a message will display. (Length validation in the Elements grid was added in PxPlus 2021 Update 1.) Numeric field lengths can be defined using implied decimal format. Example: 6.2: 6 represents total length of the field, excluding explicit signs and decimals, where applicable, and 2 represents scaling factor or number of decimal places.
|
| Options that define the format for writing the data field to the file. See Format Mask in the Element Description window.
|
Display
| Print/input format. See Format Mask Options.
|
Ext
| Check box to indicate that the element forms part of an external key and is not duplicated in the data portion of the record. Example: Key: CST_ID$ Data: CST_NM$, CST_ADDR$, CST_PHONE$ In this case, CST_ID$ forms the key and is not duplicated in the data portion of the record.
|
Req
| Check box to indicate that the element is a required field and must contain data before the record can be written in File Maintenance.
|
U/C
| Check box to indicate that the data should always be in uppercase letters. Used by NOMADS sub-systems.
|
R/O
| Check box to indicate that the element is designated as read only or locked. Used by NOMADS sub-systems. (The R/O check box was added in PxPlus 2021.) (The Data Elements grid was added in PxPlus 2020.) | |||||||||||||||
Move Up |
Buttons used to move the selected data element up or down within the Data Elements grid. | ||||||||||||||||||||||||||||||||||
Insert Before |
Buttons used to insert a new element before or after the selected data element. Same as using the Insert Element popup menu option when right clicking on a Field Name in the Data Elements grid. (The Insert Before/Insert After buttons were added in PxPlus 2020.) | ||||||||||||||||||||||||||||||||||
Delete |
Button used to delete the selected data element. Same as using the Delete Element popup menu option when right clicking on a Field Name in the Data Elements grid. | ||||||||||||||||||||||||||||||||||
Undo |
(Available when a change is entered only in the Data Elements grid) Button used to undo the last change(s) entered only in the Data Elements grid. The Undo button will not undo any changes entered using the Add/Edit Notes button. It will also not undo any changes entered in the Element Description window (accessed from the Dtl column). Important Note:
| ||||||||||||||||||||||||||||||||||
(Available when a new data element is entered or an existing data element is selected) Button used to add (or edit) notes for a new or existing data element. Maximum 1024 characters. The button's appearance and tooltip change to indicate that a note was added for the element. Alternatively, notes can be added or edited for an element in the Element Description window by using the Notes input control on the User Aids tab. (The Add/Edit Notes button was added in PxPlus 2022.) | |||||||||||||||||||||||||||||||||||
Update Global Dictionary Elements in other Files |
(Available when Global Dictionary is selected) Button used to invoke the Update Global Dictionary Elements window. If the selected global element does not exist in other data tables, a message will display. | ||||||||||||||||||||||||||||||||||
Add Data Element to the Global Dictionary |
(Not Available when Global Dictionary is selected) Button used to add the selected element to the Global Dictionary. Same as using the Add to Global Elements popup menu option when right clicking on a Field Name in the Data Elements grid. If a data element with the same name already exists in the Global Dictionary, a message asks if you want to update this Global Dictionary record. Responding Yes updates the Global Dictionary record with the settings from the selected data element. Responding No does not change the Global Dictionary record. |
The options below are listed in the order that they appear on the menu bar: File, Edit, Options, Utilities, Projects, NOMADS Tools and Wiki Info.
Some of these options are also available as tool bar buttons. | |
Displays the Change/Create Dictionary window for changing or creating the pathname to a new providex.ddf file. Specify a different pathname by clicking the Query button or manually entering it.
If no providex.ddf file exists in the pathname specified, a prompt will ask if you wish to create the dictionary. Responding Yes creates the dictionary files providex.ddf/dde in the pathname specified. Responding No does not create these files. If the Change Directory check box is selected, the directory containing the dictionary becomes the current working directory. (Support for creating a new dictionary was added in PxPlus 2019 Update 1.) | |
New Table |
Adds a new file. Selecting this option clears the current record to allow you to enter the details for the new definition. (The New Table option was added to the File menu in PxPlus 2023 Update 1.) |
Copy Table |
Launches the Copy Data Dictionary window for copying an existing data dictionary definition in the same dictionary to a new table name. (The Copy Table option was added to the File menu in PxPlus 2023 Update 1.) |
Rename Table |
Changes the selected table to a new name. A database link file or prefix file cannot be renamed. |
Delete Table |
Deletes the selected table. |
Define Keys |
Sets up primary and alternate keys for the physical file. See Defining Keys. |
IO Procedure |
Launches the Embedded I/O Procedures window for entering the name of a program that contains logic for controlling file access. PxPlus provides the ability to specify an object using the syntax obj=xxxxx.
|
Update File/Prefix/Link |
If the current file is a native PxPlus file, updates and/or creates the physical file. If a data conversion is required, the Update physical window will display. See Updating the Data Dictionary. If the current file is a database link file or prefix file, updates the link file or the entry in the prefix file. To update the external database for field/key changes, use the Database Manager program. (The Update File/Prefix/Link option was added in PxPlus 2023.) |
Update Files |
Launches the Update Physical Files utility for updating/creating physical files for multiple selected native (PxPlus) files. (The Update Physical Files utility was added in PxPlus 2023.) |
Create SQL Key Defn File |
Creates providex.kdf in the same directory as the providex.ddf and providex.dde files. This file contains SQL key definitions for a PxPlus data dictionary table, keyed by the logical table name (64 characters). If the providex.kdf file already exists, a prompt to delete and recreate the file will display. |
Database Export Utility |
If a native PxPlus file is currently selected, launches the Database Export Utility for adding the data file to an existing database (ODB, MySQL, OCI, ADO or DB2). If no table or database link file or prefix file is currently selected, launches the Bulk Database Export Utility for exporting table definitions from the PxPlus data dictionary into an existing database. (The Database Export Utility was added in PxPlus 2023.) |
Database Import Utility |
Launches the Database Import Utility for importing table definitions from an existing database (ODB, MySQL, OCI, ADO or DB2) into the PxPlus data dictionary. (The Database Import Utility was added in PxPlus 2023.) |
Export Dictionary |
Launches the Export Data Dictionary Definition utility that is used to export the data dictionary definitions of one or more selected tables to a text file. Used in conjunction with the Import Data Dictionary Definition utility. (The Export Dictionary Utility was added in PxPlus 2021.) |
Import Dictionary |
Launches the Import Data Dictionary Definition utility that is used to import the data dictionary definitions of one or more tables selected from an export text file into a data dictionary in another location. Used in conjunction with the Export Data Dictionary Definition utility. (The Import Dictionary Utility was added in PxPlus 2021.) |
Exit |
Closes Data Dictionary Maintenance. |
Provides options to use in conjunction with the Data Elements grid (the Elements tab must be selected). | |
Add Element |
Adds a new row at the current location in the grid for adding a new data element. |
Delete Element |
Deletes the selected data element. Prior to the deletion, a message will display. |
Bulk Edit Elements |
Launches the Bulk Edit Data Elements utility for applying bulk changes to data elements in the PxPlus data dictionary. (The Bulk Edit Data Elements utility was added in PxPlus 2023.) |
Add Globally |
Adds the selected data element to the Global Dictionary. A message will display when the Global Dictionary is updated or if a data element with the same name already exists in the Global Dictionary. |
Provides additional data dictionary options. | |
SQL Key Definition Update |
Determines whether the SQL Key Definition file will automatically be updated when the PxPlus Data Dictionary key definition is changed. |
Provides additional data dictionary tools and security control. | |||||||
|
Launches the Print Data Dictionary Definition utility that is used to generate output in a standard format that lists all of the elements in the definitions that have been selected for printing. | ||||||
Compare Definitions |
Launches the Data Dictionary Compare utility for comparing two tables from the same or different data dictionaries or physical files (or a combination of both). It compares file attributes, fields and key structures in one table with the fields in another. | ||||||
Generate external |
Sub-menu for accessing the following selections:
| ||||||
Merge |
Launches the Data Dictionary Merge Utility that allows table definitions to be merged from one set of dictionary files (ddf/dde) to another. | ||||||
Import Dictionary |
Launches the Copy Data Dictionary Definition window that is used to copy a file definition from a different PxPlus data dictionary (in another directory) into the current file definition. | ||||||
Data Class Definitions |
Launches Data Class Definitions maintenance that is used to create and maintain data classes, including Dynamic data classes, for specific control types. (Data Class Definitions was added to the Utilities menu in PxPlus 2021 Update 1.) | ||||||
File Link Maintenance |
Launches the File Link Maintenance utility for defining and maintaining the cross-reference linkages that exist between application data files. (File Link Maintenance was added to the Utilities menu in PxPlus 2021 Update 1.) | ||||||
View Data |
If the current file is a native PxPlus file, launches the File View Utility for viewing data file information, such as type, record size, primary key size, current number of records, etc. If the current file is a database link file or a prefix file, any data in that file displays in a separate window for viewing only. (The ability to view data in a database link file or prefix file was added in PxPlus 2023.) | ||||||
File Splitting |
(Available when File Type is Native File) Launches the Historical File Splitting utility that is used to split larger data files into multiple independent files. This option does not apply for database link and prefix files. (The File Splitting option was added to the Utilities menu in PxPlus 2023 Update 1.) | ||||||
Security |
Provides access to set up and maintain the optional security system that controls user access to the system. See NOMADS Security Manager. |
Provides access to project-related options. (The ability to add dictionary entries to a Project was added in PxPlus 2014 - Feature Pack 1.) | |
Create New Project |
Launches the Create Project dialogue for entering a new project for the current working directory. Click the Query button to select a different working directory. |
Add to Project |
Launches the Add to Project dialogue for adding the current task to an existing project that is selected from the Project drop box. To manage all the tasks within a project, see Project Maintenance. For information on adding tasks to a project from other locations, see Adding Tasks to Projects from Other Locations. Note: |
Provides access to NOMADS development tools for creating and editing library objects. (The NOMADS Tools menu option was added in PxPlus 2023 Update 1.) | |
Open Project Application Library |
Runs the Open Project Application Library task that opens Library Object Selection using the project default library. If no default library was defined for the current project, a message will display. (The Open Project Application Library task was added in PxPlus 2023 Update 1.) |
Panel Definition |
(Not Available in the PxPlus Web IDE) Runs the Panel Definition task for creating or editing a panel. (The Panel Definition task was added in PxPlus 2023 Update 1.) |
Query Definition |
Runs the Query Definition task for creating or editing a Standard query or a Query List definition. (The Query Definition task was added in PxPlus 2023 Update 1.) |
Menu Bar Definition |
Runs the Menu Bar Definition task for creating or editing a menu. (The Menu Bar Definition task was added in PxPlus 2023 Update 1.) |
File Maintenance Generator |
Runs the File Maintenance Generator task for creating or editing a file maintenance panel. (The File Maintenance Generator task was added in PxPlus 2023 Update 1.) |
(The Wiki Info menu option was added in PxPlus 2023.) | |
|
Spawns EZWeb for the PxPlus Wiki (if not already running) and then displays the file information for the current table in a new tab on your default Web browser. Example: When the PxPlus Wiki launches, the file information for the current table, Clients, displays:
|
The tool bar consists of the following buttons:
New |
Adds a new file. Selecting this button clears the current record to allow you to enter the details for the new definition. |
Update File/Prefix/Link |
(Button varies depending on File Type) If the current file is a native PxPlus file, updates and/or creates the physical file. If a data conversion is required, the Update physical window will display. See Updating the Data Dictionary. If the current file is a database link file or a prefix file, updates the link file or the entry in the prefix file. To update the external database for field/key changes, use the Database Manager program. (The ability to update a database link file or prefix file was added in PxPlus 2023.) |
Update Files |
Launches the Update Physical Files utility for updating/creating physical files for multiple selected native (PxPlus) files. (The Update Physical Files utility was added in PxPlus 2023.) |
Copy |
Launches the Copy Data Dictionary window for copying an existing data dictionary definition in the same dictionary to a new table name. |
Rename |
(Available when File Type is Native File) Changes the selected table to a new name. This button is disabled for database link and prefix files. |
Delete |
Deletes the currently loaded table. |
Bulk Edit |
Launches the Bulk Edit Data Elements utility for applying bulk changes to data elements in the PxPlus data dictionary. (The Bulk Edit Data Elements utility was added in PxPlus 2023.) |
SQL Keydef |
Opens the SQL Key Definition window that is used to create/remove the SQL key definition for a selected table.
Button is hidden if providex.kdf does not exist. To create the providex.kdf file, select File > Create SQL Key Defn File from the menu bar. See SQL Key Definition. |
Define Keys |
Sets up primary and alternate keys for the physical file. See Defining Keys. |
IO Procedure |
Launches the Embedded I/O Procedures window for entering the name of a program that contains logic for controlling file access. PxPlus provides the ability to specify an object using the syntax obj=xxxxx.
|
Export ("Database" tool bar section) |
If a native PxPlus file is currently selected, launches the Database Export Utility for adding the data file to an existing database (ODB, MySQL, OCI, ADO or DB2). If no table or database link file or prefix file is currently selected, launches the Bulk Database Export Utility for exporting table definitions from the PxPlus data dictionary into an existing database. (The Database Export Utility was added in PxPlus 2023.) |
Import ("Database" tool bar section) |
Launches the Database Import Utility for importing table definitions from an existing database (ODB, MySQL, OCI, ADO or DB2) into the PxPlus data dictionary. (The Database Import Utility was added in PxPlus 2023.) |
If the current file is a native PxPlus file, launches the File View Utility for viewing data file information, such as type, record size, primary key size, current number of records, etc. If the current file is a database link file or a prefix file, any data in that file displays in a separate window for viewing only. (The ability to view data in a database link file or prefix file was added in PxPlus 2023.) | |
|
Launches the Print Data Dictionary Definition utility that is used to generate output in a standard format that lists all of the elements in the definitions that have been selected for printing. |
Export ("Dictionary" tool bar section) |
Launches the Export Data Dictionary Definition utility that is used to export the data dictionary definitions of one or more selected tables to a text file. Used in conjunction with the Import Data Dictionary Definition utility. (The Export Utility was added in PxPlus 2021.) |
Import ("Dictionary" tool bar section) |
Launches the Import Data Dictionary Definition utility that is used to import the data dictionary definitions of one or more tables selected from an export text file into a data dictionary in another location. Used in conjunction with the Export Data Dictionary Definition utility. (The Import Utility was added in PxPlus 2021.) |
File Splitting |
(Available when File Type is Native File) Launches the Historical File Splitting utility that is used to split larger data files into multiple independent files. This button is disabled for database link and prefix files. |