Data Dictionary
Classes
Class | Module | Definition |
|---|---|---|
Agent | Global | An agents is something that bears some form of responsibility for an activity taking place, for the existence of an entity, or for another agents activity within the context of a projects |
Agent Relation | Global | Defines binary, ordered relationships between two agents. See https://spec.edmcouncil.org/fibo/ontology/FND/Relations/Relations/ |
Document | Global | Documents associated with specific models within the scope of the project portal |
Document Access Group | Global | Authorizes users to access specific shared documents using policies |
Job | Bidding | An activity wher a person provides labor or services in exchange for a wage or salary as specified by some deontic declaration. |
Job Posting | Bidding | A listing that describes a job opening within the scope of a specific project |
Project | Project | A set of coordinated activities that is intended to achieve one or more objectives. |
Project Feature | Project | Named featured types associated with a project.Examples: Indian Field 2 Watershed (Brosnan) |
Project Job | Bidding | A third party contractual role to perform a specific set of tasks over a specific duration of time within the context of a project |
Project Measurement | Project | The assignment of a number to a characteristic of a project, which can be compared with other projects. Each measurement consists of a value, a unit of measurement, and property (quantity kind). |
Project Stage History | Project | Record of project stage changes including the start and end date as described by formal project documentation |
Proposal | Bidding | A formal offer submitted by a contractor to provide services in response to a job posting |
Proposal Agreement Status | Bidding | Tracking the status of the pre-submission agreement that must be confirmed by the applicant to submit |
Quantity Kind | Project | Observable properties that can be measured and quantified numerically. |
Submission | Bidding | The act (prov:Activity) of submitting a completed proposal by a contractor in accordance with the specifications described in a job posting in pursuit of a job |
Submission Status | Bidding | Enumeration describing the current state of a submission in response to a job posting |
Term | Global | Word or phrase used to label a concept that belongs to a controlled (type) vocabulary |
Unit | Project | A unit of measure, or unit, is a particular quantity value that has been chosen as a scale for measuring other quantities the same kind (more generally of equivalent dimension). |
Upload | Global | Files transferred from a local computer to a remote device such as a web server or cloud storage device |
User | Global | The principal using a client to interactively retrieve and render resources or resource manifestations. |
User Relation | Global | Defines binary, ordered relationships between two users. See https://spec.edmcouncil.org/fibo/ontology/FND/Relations/Relations/ |
Vocabulary | Global | Terminological dictionary which contains designations and definitions for one or more specific subject fields |
Vocabularies
title | associated_model | description | usage_note |
|---|---|---|---|
Agent Roles | ProjectAgent | A list of defined roles that someone or something has when they act on behalf of a person or organization within the context of a projects | |
Agent Types | Agent | Kinds of agents described within the scope of a portal project, predominantly derived from the PROV and Organization Ontologies (https://www.w3.org/TR/prov-o/) | |
Document Types | Document | A classification vocabulary for documents where each category is scoped to a particular module | Top-level categories for the organization of documents in the portal |
Feature Types | ProjectFeature | Type values for physiographic features that are the basis for projects in the portal | Assign named features a generalized physiographic feature type |
Feature Types | ProjectMeasurement | Type values for physiographic features that are the basis for projects in the portal | Assign named features a generalized physiographic feature type |
Job Types | Job | A categorization scheme for contractor jobs managed through the project portal | |
Project Stages | Project | Distinguishable part of a project that occupies a section of sequence described in a project plan. Stages are defined by the sequential position in the lifecycle and the tasks therein. | Establish a timeline with milestones defined by stage transitions |
Project Types | Project | A list of defined terms that specify the types of projects associated with services provided by EPR | The projects type vocabulary is a child of the service domain vocabulary |
Service Domains | ProjectType | A list of defined terms that constitute all services provided by EPR and EPR staff. | Service domains is the parent type vocabulary for projects types |
Upload Types | Upload | Categorization scheme for files uploaded through the user interface | Only applies to files uploaded through the interface without any information regarding how the file will be used. The categorization is strictly scoped to the file itself. |
Vocabulary Terms
Term | Definition | Vocabulary |
|---|---|---|
Client | Party that purchases professional services from, or has a formal relationship to purchase services from another party | Agent Roles |
Contributer | An Agent responsible for making generalized contributions to a project. | Agent Roles |
Land Owner | The owner of the property where the projects will take place. | Agent Roles |
Partner | agents of a partnership whose participation level is specified in a partnership agreement, such as a service contract | Agent Roles |
Principal | Agent that is responsible for the management of daily business operations of an organization | Agent Roles |
Project Manager | Person officially designated as manager of a project and ultimately responsible for the project itself. | Agent Roles |
Sponsor | Individual, company, or organization responsible for the financing of a projects | Agent Roles |
Subcontractor | A subcontractor is a person or business that undertakes to perform part or all of the obligations of another's contract. | Agent Roles |
Business Entity | Represents the legal agent making (or seeking] a particular offering. This can be a legal body or a person. A business entity has at least a primary mailing address and contact details. | Agent Types |
Government Agency | A unit of government responsible for oversight and regulation of certain activities or the administration and provision of specific services. | Agent Types |
Non-profit Organization | organization that uses its surplus revenues to further achieve its purpose rather than distributing its surplus income to the organization's owners (directors, investors, and equivalents] as profit / dividends | Agent Types |
Organization | Collection of one or more people, or groups of people formed together to act, or that is designated to act, towards some purpose, such as to meet a need or pursue collective goals on a continuing basis | Agent Types |
Person | Individual human being, with consciousness of self | Agent Types |
Client Upload | File uploaded by a client | Document Types |
Contract | Voluntary, deliberate agreement between competent parties to which the parties agree to be legally bound, and for which the parties provide valuable consideration | Document Types |
Deliverable | Formal project deliverables | Document Types |
Figure | Paper map embedded in a figure that is appended to a project deliverable in the appendix. Maps are the primary basis for maps in the project portal. | Document Types |
General Report | Provides a structured description of something, prepared on ad hoc, periodic, recurring, regular, or as required basis | Document Types |
Project Image | Digital photo associated with some aspect of a project | Document Types |
Project Plan | A document used to guide project planning, execution and control, specifying the project's goal and objectives and the activities and resources required to achieve these, setting out the project schedule, and identifying the major workpackages, milestones and deliverables | Document Types |
Test File | A file uploaded strictly for testing purposes | Document Types |
Administrative | Geographic feature that is defined by adminstrative processes such as legislation, regulation, policy or procedure. | Feature Types |
Drainage Basin | The area of land drained by a river and its tributaries | Feature Types |
Fluvial Landform | "Fluvial landforms" are features on the Earth's surface produced by the action, i.e. erosion and deposition, of a stream or river and include such landforms as bars, levees, braided and meandering channels, and alluvial fans. "Fluvial processes" are those processes included in the action of running water in a stream or river | Feature Types |
Project Area | The spatial extent of a project as defined in formal project documentation and commonly associated with naturally-occurring spatial features such as watersheds. | Feature Types |
Reach | A continuous segment of a stream uniform with respect to discharge, depth, area, and slope, which a single gage affords a satisfactory measure of the stage and discharge. | Feature Types |
River | A stream of water which flows in a channel from high ground to low ground and ultimately to a lake or the sea, except in a desert area where it may dwindle away to nothing. A river and all its tributaries within a single basin is termed a drainage system. | Feature Types |
Stream | A long narrow channel of water that flows as a function of gravity and elevation across the Earth's surface. Many streams empty into lakes, seas or oceans. Streams are smaller than rivers and often considered secondary features (tributaries] of a river. | Feature Types |
Watershed | The land area that drains water to a particular stream, river, or lake. It is a land feature that can be identified by tracing a line along the highest elevations between two areas on a map, often a ridge. | Feature Types |
Wetland | An area that is saturated by surface or ground water with vegetation adapted for life under those soil conditions. | Feature Types |
Construction | Site construction for purposes of ecosystem restoration during the construction stage of a project | Job Types |
Design | Site design for ecological restoration during the Mitigation Banking stage of a project | Job Types |
Construction | The process of restoring the natural conditions of a specific site that has been disturbed by human activity as described in a Mitigation Banking Instrument | Project Stages |
Mitigation Banking Instrument | In a banking instrument, the mitigation sponsor agrees to provide compensation that will be initiated before credits are approved for release by an Interagency Review Team. | Project Stages |
Mitigation Plan | A prov:Plan as it relates to a mitigation banking project | Project Stages |
Monitoring | An assessment of the success of the construction phase relative to the goals in the mitigation plan that occurs over a specific duration of time in regular intervals | Project Stages |
Prospectus | The initial exploratory phase of the projects | Project Stages |
Biological Assessment | That part of an environmental assessment that specifically evaluates the potential risks to plant and animal communities and their habitats. | Project Types |
Environmental Impact Assessment | An activity designed to identify, predict, interpret and communicate information concerning the environmental consequences of legislative proposals, policies, projects and/or operational procedures | Project Types |
Full Delivery | Comprehensive Ecosystem Restoration Services that covers all stages of an ecosystem restoration projects as described at EPR. | Project Types |
Mitigation Banking | A site, or suite of sites, where resources (e.g., wetlands, streams, riparian areas] are restored, established, enhanced, and/or preserved for the purpose of providing compensatory mitigation for impacts authorized by DA permits. | Project Types |
Permittee-Responsible Mitigation | An aquatic resource restoration, establishment, enhancement and/or preservation activity undertaken by the permittee (or an authorized agents or contractor] to provide compensatory mitigation for which the permittee retains full responsibility. | Project Types |
Applied Science | The use or the study of the use of scientific knowledge to develop technology. | Service Domains |
Ecosystem Restoration | Methods for decontaminating, reclaiming, and restoring natural resources or reducing the effects of hazards. | Service Domains |
Environmental Planning | The identification of desirable objectives for the physical environment, including social and economic objectives, and the creation of administrative procedures and programmes to meet those objectives. | Service Domains |
Job Submissions | Documents upload by job applicants in the bidding module | Upload Types |
Monitoring Reports | Documents uploaded by clients/contractors during a project for progress reporting purposes | Upload Types |
Portal Documents | Documents published by user with the admin and editor role for sharing with clients/contractors | Upload Types |
Full version of terms list is available here: vocabulary-terms.csv
Portal Enums
- Several value domains are stored as static enumerations then made available to models and controllers. These leverage the new enumerations type introduced with PHP 8. As defined in the PHP documentation
Enumerations are a restricting layer on top of classes and class constants, intended to provide a way to define a closed set of possible values for a type.
Enumerations
Enumeration | Description | Example(s) |
|---|---|---|
AgentRelationPredicatesEnum | The predicated term that defines the relationship between two agents | Member of, Employed By |
AgentRelationSubjectRolesEnum | The functional role of a subject agent in a uni-directional relationship with a related agent | primary contact |
DocumentStatusEnum | Categorization scheme for the status of uploaded documents | New |
RasterMediaTypesEnum | File extensions of raster images | png |
SchemaElementCategory | A controlled value list that categorizes database schema elements into functional types | System |
ThumbnailMediaTypesEnum | File type validation for creating thumbnails from uploaded files, the creation of thumbnails is limited to the file extensions in this enumeration | |
USACEDistrictsEnum | Current list of US Army Core of Engineers Districts | Charleston |
UserRelationSubjectRolesEnum | Controls the role of the subject user in a uni-directional relationship with a related user | client manager |
ValidMimeTypesEnum | Upload file type validation, Lists the permitted filetypes that may be uploaded through the user interface | png |
Enumeration Values
Term | Definition | Enum |
|---|---|---|
Belongs to | The simplest asymmetric relationship between two agents with no indication as to the nature of the relation, the cardinality, or the type of agents involved | AgentRelationPredicates |
Member Of | Indicates that a source agent (type person) is a member of an object agent (group types such as organization) with no indication of the nature of that membership or the role played. | AgentRelationPredicates |
Parent Of | Indicates a hierarchical relationship between two group agents with no indication of the nature of the relation. A group agent is any agent type that describes a collection of individual agents | AgentRelationPredicates |
Employed By | Means that some agent (person or organization) is promised and delivered an incentive (usually financial) to perform some work for an organization. This exchange is usually governed by law and formal regulations in the particular country or social context in which the work is being performed. | AgentRelationPredicates |
Primary Contact | The person that serves as the primary communication conduit for which an organization can be contacted | AgentRelationSubjectRoles |
Principal | Agent that is responsible for the management of daily business operations of an organization | AgentRelationSubjectRoles |
Manages Client Relationship | The asymmetric relation between two users where an admin user (user has role admin/editor) manages the relationship between the company and client user (user has role client) | UserRelationPredicates |
Client Manager | An admin user (user with role editor/admin) that manages the relationship between a specific client (user with role client and the related_user) and the company. | UserRelationSubjectRoles |