<< Click to Display Table of Contents >>
Navigation: Administration and Configuration > Options > Enterprise EDP Configuration >
Add or Modify Enterprise EDP Formats
Enterprise supports multiple EDP formats. If the user has proper permissions to the server and the database, setting up EDP formats for use is a two-step process:
1. Add EQuIS Format File to the Server or Database.
2. Update Enterprise to Use Format Files
EQuIS Format files can either be added to the Server or Database.
•Server Access – The ability to add the format files to the Enterprise 7 folder or alter folder permissions.
•Database Access – The ability to add or edit records in the ST_CONFIG table (for adding additional formats).
For standard installations, the server administrator can add the format files within the Enterprise 7 directory by adding a folder called Formats, if it does not already exist (e.g., C:\Program Files\EarthSoft\Enterprise7\Formats\EarthSoft). Using this structure will allow the application pool identity to have the same access to the formats folder as it does to the Enterprise 7 directory. If another directory is chosen, the folder permissions will need to be updated on the Format folder so that the IIS Application Pool Identity account has proper access to read and execute as well as list directory contents permissions on that folder.
The STRING_VALUE in the ST_CONFIG table will need to be updated with the Format path.
The zipped (*.zip) format file can be uploaded to the DT_FILE table using the:
•Explorer Widget in Enterprise (FILE_ID obtained by hovering the cursor over the file name. This displays the download link in the bottom left corner of your browser. The FILE_ID is the number at the end of the link.) or
•Docs and Photos Form in Professional (FILE_ID obtained from DT_FILE.FILE_ID).
The FILE_ID is used to populate 'XSD File Name Path or File ID' in the Workflow Widget or in ST_CONFIG.STRING_VALUE (step 2 below).
Roles or Users will need Viewer Permission on the file itself or the Files object type through the Permissions Grid in order to have access to the format in the EDP EDD Upload Widget .
Update Enterprise to Use Format Files
Note: The Unique Format name in the Workflow Widget or OBJECT_TYPE in ST_CONFIG cannot contain (.) periods.
When the Schema is created, Enterprise is configured with two sets of records in the ST_CONFIG table for two EQuIS formats: EQEDD and EFWEDD. Various default configuration settings have been applied for these formats and Enterprise workflow service agents; these should be reviewed and modified to meet user needs.
Administrators may modify or add new format files directly in the Workflow Widget or in the ST_CONFIG table. Follow the below steps to enter the records directly in ST_CONFIG:
1.Login to Professional and open the table ST_CONFIG.
2.Add a row and input the following details:
CONFIG_SECTION = efdManagementConfiguration
CONFIG_KEY = efd
OBJECT_TYPE = [format name] (e.g. EQEDD, EFWEDD, etc). The name of the format in OBJECT_TYPE cannot include (.) periods.
OBJECT_VALUE = xsdFileName
a.If the format has been added to the Server, STRING_VALUE = the directory where it was loaded (e.g. D:/home/Formats/EarthSoft/EZEDD.zip).
b.If the format has been added to the database, STRING_VALUE = [DT_FILE.FILE_ID] (e.g. 156478) .
3.Add another row with the same CONFIG_SECTION, CONFIG_KEY, OBJECT_TYPE and:
OBJECT_VALUE = [commitType]. See EQuIS Format Definition Configuration for descriptions of the possible commitTypes.
STRING_VALUE = Default
4.Add another row with the same CONFIG_SECTION, CONFIG_KEY, OBJECT_TYPE and:
OBJECT_VALUE = acceptWarnings
STRING_VALUE = True or False
5.Optional setting. This record is not necessary for the other formats. The default format for the Enterprise instance should have a fourth row, with the same CONFIG_SECTION, CONFIG_KEY, OBJECT_TYPE and:
OBJECT_VALUE = isDefault
STRING_VALUE = True
6.Click Save. Click Refresh and see if new entries were added.
See the EQuIS Format Definition Management chapter and associated articles for more details on the ST_CONFIG table settings.
Warning: Do not make any changes to records in the ST_CONFIG table other than the intended records for modifying the EDP formats.
Copyright © 2023 EarthSoft, Inc • Modified: 20 Feb 2023