Documentation for the Dictionary Editor of the FRAMEwork System (FRAMES)


Title Page
Legal Notice
Table of Contents
Introduction
Requirements
Design
Quality Assurance and Testing
  

Requirements of the FRAMES Dictionary Editor

Dictionaries in FRAMES 2.0 describe the layout of how information is stored in a dataset. Each dictionary has a name, description of itself, privilege information, and variables. All dictionaries in FRAMES 2.0 must have a unique name. Each dictionary is stored in its own .DIC file.

Dictionaries are also used by modules to define the limitations and capability of a model's inputs and outputs. Modules create connection schemes of dictionaries to describe the type of information a module expects to consume and produce (see Module Editor documentation for more information).

The Dictionary Editor allows the user to manage dictionaries within FRAMES 2.0. The Dictionary Editor has the following requirements:

  1. Provide a dictionary (.DIC) file interface for creating, editing, and deleting dictionary files.
  2. Require that all .DIC files have a name and privilege information and provide an option to provide description information.
  3. Register .DIC files that are created outside of the FRAMES upon opening them in FRAMES.
  4. Automatically attach the .DIC file extension to new .DIC files created in FRAMES.
  5. Require a user name and password before allowing a user to edit system DIC files.
  6. Require a user with security clearance to specify a privilege setting for each DIC file created using FRAMES. The four privilege levels are 0 - system developer module inputs, 1 - system developer boundary conditions, 2 - module developer module inputs, and 3 - module developer boundary conditions.
  7. Ensure that each DIC file has a unique name.
  8. Allow the user to add, edit, and delete variables in a DIC file.
  9. Ensure that each variable in a DIC file has a unique name.
  10. Allow the user to specify variable properties (i.e., data type, minimum and maximum, measure, units, stochastic, and preposition).
  11. Allow the user to specify variables that use other parameters as indices.
  12. Allow the user to specify that a variable is a primary key.
  13. Allow the user to specify if a variable is a scalar or a vector.

Battelle Logo
Home | Security and Privacy | Contact Us