<< Click to Display Table of Contents >> Navigation:  EQuIS Library > Formats > EarthSoft Standard Formats > Facility Format

Format Name: Facility 

File Name: Facility.zip 

Source: EDP Standalone, EQuIS Professional, and EQuIS Enterprise (only in format installation folder)

Export(s): Yes (see section below)

Enumeration File: Not applicable

 

 

Description: The Facility format allows the importing of facilities with related coordinate and location data as well as associated location groups and group members.

 

 

Installation Instructions: The Facility format is included in the installation of EDP Standalone and EQuIS Professional in the \Formats\EarthSoft folder. This format is also provided with the installation of EQuIS Enterprise but requires configuration to be available in the Enterprise EDP EDD Upload widget. If the format should be configured for EQuIS Enterprise, an administrator will need to define the commit type and other EDP Enterprise elements as defined in the Workflow Widget and Add or Modify Enterprise EDP Formats articles.

 

 

Overview: The Facility format sections mimic the destination data table structure and can be used to edit existing data by exporting one or more of the referenced tables from EQuIS Professional. The Facility format can be used to create or update facility and facility-specific records in the database, such as:

•Facilities (DT_FACILITY)

•Facility Parameters (DT_FACILITY_PARAMETER)

•Facility Group (RT_GROUP and RT_GROUP_MEMBER)

•Nested Facilities (RT_GROUP and RT_GROUP_MEMBER)

•Subfacilities (DT_SUBFACILITY)

•Locations (DT_LOCATION)

•Coordinates (DT_COORDINATE)

•Location Parameters (DT_LOCATION_PARAMETER)

•Location Groups (RT_GROUP and RT_GROUP_MEMBER)

•Tasks (DT_TASK)

•Task Parameters (DT_TASK_PARAMETER)

 

This format can be used to edit existing data by exporting one or more of the above tables from EQuIS Professional using the 'Send to Microsoft Excel' icon, and then opening these from the Facility format.

 

Columns in the Facility format use different tables for their reference value lookups. The EQuIS EDD Description file includes which tables are used for the reference value source. Create the EQuIS EDD Description file in EDP or the Enterprise EDP EDD Upload widget.

 

 

Limitations/Assumptions: The checks and mappings in any EDD format involve assumptions. The following are limitations and assumptions for the Facility format:

•RT_GROUP_MEMBER.FACILITY_CODE cannot be null if MEMBER_TYPE = FACILITY_ID. If MEMBER_CODE = FACILITY_ID, a valid FACILITY_CODE must be populated.

•RT_GROUP.MEMBER CODE values ‘FACILITY_ID’ and ‘SYS_LOC_CODE’ must be present in the ST_GROUP_TYPE table.

•As this format does not map to the DT_TEST table, there are no relevant Test Alternate Keys (TAKs).

 

For custom checks, please see the EDD Description file for the Facility format.

 

 

Groups:

 

The rt_group and rt_group_member sections of the Facility format create records in the RT_GROUP and RT_GROUP_MEMBER tables to define:

•Location Groups,

•Facility Groups, and

•Nested Facilities in RT_GROUP and RT_GROUP_MEMBER tables.

 

Create Location Group(s)

•Add a record in the rt_group section for each Location Group where group_code = [Location Group name] and group_type = ‘sys_loc_code’.

•Add a record in the rt_group_member section for each location included in the [Location Group] where member_code = [sys_loc_code value]. For example

•member_code = 'B-30'

•group_code  = rt_group.group_code

•member_type = ‘sys_loc_code’.

 

 

 

Create Facility Group(s)

•Add a record to the rt_group section for each Facility Group where group_code = [Facility Group name] and group_type = ‘facility_id’.

•Add a record to the rt_group_member section for each facility included in the Facility Group where:

•member_code = [FACILITY_CODE] or [FACILITY_ID] value of the facility to be added to the Facility Group

•group_code = [rt_group.group_code]

•member_type = ‘facility_id’

•facility_code = [facility_code value]

 

Create Nested Facilities

•Add a record to the rt_group section for each Facility Group where group_code = [Facility Group name] and group_type = [FACILITY_ID].

•Add a record to the rt_group_member section to define the nested relationship between the Facility Groups in the rt_group section where:

•member_code = [the nested facility in rt_group.group_code]

•group_code = [the facility of the highest level in rt_group.group_code]

•MEMBER_TYPE = ‘group_code’

•facility_code = null

•Add a record to the rt_group_member section for each facility in the nested Facility Group where:

•member_code = [facility_code] or [facility_id] value of the facility being added to the Facility Group]

•group_code = [nested Facility Group rt_group.group_code]

•member_type = ‘group_code’

•facility_code = [facility_code value]

 

 

EQuIS Table Mappings:

 

 

Exports: The data returned will be automatically filtered by the facility to which the user is connected, as well as by the parameters selected prior to running the report. See the Exports from Professional EDP article for more information about running exports.