This document is a modified version with the comments from the customer embedded.

SquidSoft Inc. - GUIDOs

Overall Design Document - Data Dictionary


[ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ]

Name: Alert_Level
Type: integer
Description: non-key attribute of Inventories; this integer is used to decide whether or not to reorder by comparing it to the Quantity of the same product, if Quantity <= Alert_level, then the reorder occurs

Name: ascend_descend
Type: boolean
Description: this boolean is used to decide between an ascending sort and a descending sort in the sort_criteria

Name: bulk unit size
Type: natural number
Description: A non key attribute of "Production"

Name: canned
Type: [ 'have access' | 'don't have access']
Description: An attribute of "Security." It determines whether a user has access to view information about canned goods.

Name: category
Type: ['canned'|'meat'|'dairy'|...]
Description: A non key attribute of "Production". Each product is under one and only one category.

Name: description
Type: string
Description: A non key attribute of "Production". To describe each product.

Name: desc_categories
Type: { Description + Category }
Description: these are 2 non-key attributes from the entity Product they appear on the grid and are thus required in almost all the inventory processes

Name: dairy
Type: [ 'have access' | 'don't have access']
Description: An attribute of "Security". It determines whether a user has access to view informaiton related to dairy products.

Name: Employee
Type: @employee id + store id + first name + last name + security + posisiton + password
Description: This is the entity Employee with all the system information for an employee

Name: employee
Type: Employee
Description: data flow in DFD, corresponds to a single instance of the entity Employee

Name: employee id
Type: integer
Description: data flow in DFD, corresponds to the Key attribute employee ID in the entity Employee

Name: employee listing
Type: {Employee}
Description: data flow in DFD, corresponds to the set of employees in the entity Employee

Name: Employees
Type: { Employee }
Description: data store on DFD, of employees

Name: employees
Type: {Employee}
Description: data flow in DFD, corresponds to a set of instances of the entity Employee

Name: find_criteria
Type: grid_record
Description: data flow which comes from user describing fields in which to search by all fields are optional

Name: first name
Type: string
Description: corresponds to the attribute first name of the entity Employee, and is a data flow on the DFD

Name: function selection
Type: button press
Description: data flow on the DFD, representing which button was pressed on the personnel screen

Name: grid_record
Type: Inventories + desc_categories
Description: this is a data flow which is a conglomeration of attributes from Inventories and Product and is what appears on the screen in the inventory grid

Name: grid_records
Type: { grid_record }
Description: this is a data flow corresponding to a group of grid_records

Name: groceries
Type: @UPC + description
Description: This is a data flow corresponding to an occurance of groceries

Name: Groceries Ordered
Type: @order number + @grocery UPC + quantity ordered + quantity received
Description: Corresponts to each instance that a product is ordered

Name: Inventory
Type: Inventories
Description: a data flow on the DFD for an occurence of Inventories

Name: Inventories
Type: @UPC + Quantity + Sales_Price + Status + Alert_Level + Restock_Qty
Description: Entity representing the inventory items of the grocery stores

Name: Inventories
Type: { Inventories }
Description: Data store representation of the entity Inventories

Name: inventories
Type: Inventories
Description: a data flow on the DFD for a group of occurences of Inventories

Name: last name
Type: string
Description: corresponds to the attribute last name of the entity Employee, and is a data flow on the DFD

Name: make orders
Type: ['have access' | 'don't have access']
Description: An attribute of "Security." It determines whether a user has access to make orders.

Name: manager
Type: string
Description: non-key attribute of entity Store, should be non-empty and contain at least one character that is neither a space or a tab

Name: meat
Type: [ 'have access'|'don't have access' ]
Description: An attribute of "Security." It determines whether a user has access to view information about meat. Name: Menu Choice
Type: integer
Description: Used as an internal variable to determine which choice the user has made at the main menu (which button corresponding to a menu item has been clicked

Name: new password
Type: string
Description: Password that an employee wants to use later

Name: null password
Type: string
Description: a data flow on the DFD, it's an empty string to be stored

Name: Order
Type: @order number + @grocery UPC + employee ID + status
Description: a data flow corresponding to an order

Name: order number
Type: integer
Description: an attribute of orders

Name: password
Type: string
Description: A non-key attribute of "Employees"

Name: personnel report
Type: {Employee}
Description: data flow on the DFD, which is the printed report listing all employees

Name: phone number
Type: integer
Description: non-key attribute of the entity Store, should be 10 digits long (3 for area code, 7 for the local number, cannot be left empty

Name: position
Type: string
Description: a data flow on the DFD, corresponding to the attribute position of the entity Employee

Name: produce
Type: ['have access' | 'don't have access' ]
Description: An attribute of "Security." It determines whether a user has access to view information about produce

Name: Production
Type: @UPC + description + category + unit cost + bulk unit size
Description: Corresponds to each product

Name: Productions
Type: { Production }
Description: Database for all products

Name: Products
Type: { Product }
Description: a data store for the entity Product

Name: quantity ordered
Type:integer
Description: a dataflow representing the number of an item ordered

Name: quantity received
Type: integer
Description: a dataflow representing the number of an item received

Name: qty update
Type: [ 'have access' | 'don't have access' ]
Description: An attribute of "Security." It determines if a user has access to change the quantity of goods

Name: Quantity
Type: integer
Description: non-key attribute of Inventories; this number refers to the current amount of a product in the inventory either as a product count, or a weight

Name: Restock_Qty
Type: integer
Description: non-key attribute of Inventories; this integer describes the amount of a product to be ordered when the Quantity <= Alert_Level

Name: Sales_Price
Type: integer
Description: non-key attribute of Inventories; this number refers to the price an item is currently selling at

Name: Securities
Type: { Security }
Description: data store on DFD for Security

Name: Security
Type: @Security level + make orders + security + produce + meat + canned + diary + qty update + ...
Description: Each security level determines the type of access to the system. Each security level has to have at least one type of access to the system. NOTE: we need a detailed category list from the customer in order to determine the total number of attributes in this entity

Name: security df
Type: Security
Description: An instance of Security database, a data flow on the dfd

Name: security
Type: ['have access' | 'don't have access' ]
Description: An attribute of "Security." It determines whether a user has access to modify the Security database.

Name: Security level
Type: string
Description: A key attribute of "Security"

Name: sort by choice
Type: Employee
Description: data flow that represents user input as a number of fields to search through Inventories for a match. Note that sort_criteria is much like a grid record except that any field may be null in sort_criteria and there is not key attribute

Name: sort_criteria
Type: { grid_record + ascend_descend }
Description: data flow that represents user input as a number of fields to search through Inventories for a match. Note that sort_criteria is much like a grid record except that any field may be null in sort_criteria and there is not key attribute

Name: Status
Type: [ "automatic" | "manual" | "manager approval " ]
Description: non-key attribute of Inventories; this enumerated value is used to determine the reordering process for the particualr item it is attached to

Name: status
Type: [ "complete" | "incomplete" | "pending" | "filled" ]
Description: non-key attribute of Orders. this enumerated value is used to determine the status of a particular order.

Name: Store
Type: @store id + store name + address + manager + phone number
Description: entity -- represents the information about the stores in the system

Name: store address
Type: string
Description: non-key attribute of entity Store, should contain at least one character that is not a tab or a space, should include Postal code and province

Name: store id
Type: integer
Description: corresponds to the attribute store id of the entity Store, and is a data flow on the DFD, max five digits

Name: store name
Type: string
Description: non-key attribute of the entity Store, should be non-empty and contain at least one character that is NOT a tab or a space

Name: stores
Type: [Store]
Description: data store -- stores instances of Store

Name: Stores
Type: { Store }
Description: data store on DFD, of stores

Name: unit cost
Type: natrual number
Description: A non key attribute of "Production".

Name: UPC
Type: string
Description: A key attribute of "Production". That can only contain numeric characters

Name: UPCs
Type: { UPC }
Description: A data flow on the DFD for a group of UPCs

Note: All strings are a max of 256 characters long.

  Data Dictionary  

Login  
Main Menu  
Security  
Orders  
Product  
Personnel  
Stores  
Cashier  
Inventory  

Client Concerns  

Glossary  
Main Page  


About SquidSoft Inc.