Adding or Modifying Enterprise EDD Formats

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > Installation and Configuration > Configuration > Enterprise EDP Configuration >

Adding or Modifying Enterprise EDD Formats

Enterprise supports multiple EDD formats. Setting EDD formats up for use is fairly straightforward, as long as you have proper permissions to the server and the database, which is essentially a two-step process:

 

Permission Prerequisites:

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 ST_CONFIG (for adding additional formats).

 

Add Format Files to Server

 

For standard installations, the server administrator can add the format files within the Enterprise 7 directory by adding an additional 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 ST_CONFIG will also need to be updated with the Format path as seen in Figure A below.

 

Add Format Files to Database

 

The zipped (*.zip) format file can be uploaded to DT_FILE using the Explorer Widget in Enterprise or the Docs and Photos Form in Professional.

 

Update Enterprise to use Files

 

When the schema is created, the Enterprise configuration is set with two sets of records in ST_CONFIG for two formats. These can be modified through the Workflow Widget Properties. To add additional formats, add the formats as described below and they will be reflected through the GUI after the workflow services have been restarted.

 

Another alternative is to edit the records in ST_CONFIG. Each format has three or four associated records in ST_CONFIG which define the Format and the Commit Type, whether or not it accepts warnings or if it is a default format. As mentioned previously, the existing records can be updated to point to the new format, location, and format name. If modifying the existing records to point to a new format, filter on the config_section = efdManagmentConfiguration and config_key = efd (see example image below). Update the four records in the ST_CONFIG table, and then save the changes.

 

Note: Making changes to ST_CONFIG requires the Enterprise Workflow Services to be restarted on the server.

 

Warning: Do not make any changes to records in ST_CONFIG other than the intended records for modifying the EDD formats.

 

 

If a format is being added, it is then necessary to add these three or four rows to ST_CONFIG and populate the proper values based on the information below. Note that most formats will have three records, where OBJECT_VALUE = "xsdFileName", "commitType", and "acceptWarnings". The default format for the Enterprise instance should have a fourth record, where OBJECT_VALUE = "isDefault" and STRING_VALUE = "True". This record is not necessary for the other formats.

 
Figure A:

ST_CONFIG_EDD_FORMATS

 

EDP Formats

 

EDP formats that can be used to process data are shown below.

 

ST_CONFIG

VALUE

REMARK

EXAMPLE 1

CONFIG_SECTION

efdManagementConfiguration

 

 

CONFIG_KEY

efd

 

 

OBJECT_TYPE

<format name>

This name must match the name in the EDD file name.

EQEDD

OBJECT_VALUE

xsdFileName

 

 

STRING_VALUE

<location of format>

The location needs to be the full path to the format file.

 

The format file can be a .zip or .xse/.xsd

 

Customized Alive formats need to be .zip

 

If the format is stored in the database then this needs to be FILE_ID from DT_FILE.

C:\Program Files\EarthSoft\EQuIS\Formats\EQEDD.zip

 

C:\Program Files\EarthSoft\EQuIS\Formats\EQEDD.xse

 

 

 

 

1267

 

 

EDP Commit Type

 

Commit type for the format.

 

Changing commit types through ST_CONFIG or through the Workflow Widget require Enterprise Workflow Services to be restarted in order for the changes to be applied. Please contact support@earthsoft.com if you require the Workflow Services to be restarted for a hosted Enterprise site.

 

ST_CONFIG

VALUE

REMARK

EXAMPLE 1


CONFIG_SECTION

efdManagementConfiguration

 

 

 

CONFIG_KEY

efd

 

 

 

OBJECT_TYPE

<format name>

 

EQEDD


OBJECT_VALUE

commitType

 

 

 

STRING_VALUE

<commit type>

Acceptable commit types are:

Default (insert and update), None (insert only), Merge, Update, and Replace

Default

 

 

EDP Warnings

 

Determines if the format accepts warnings. By default, warnings are not accepted in Enterprise.

 

ST_CONFIG

VALUE

REMARK

EXAMPLE 1

CONFIG_SECTION

efdManagementConfiguration

 

 

CONFIG_KEY

efd

 

 

OBJECT_TYPE

<format name>

 

EQEDD

OBJECT_VALUE

acceptWarnings

 

 

STRING_VALUE

<true or false>

 

True

 

EDP Default Format

 

Format to be used as the default format.

 

ST_CONFIG

VALUE

REMARK

EXAMPLE 1

CONFIG_SECTION

efdManagementConfiguration

 

 

CONFIG_KEY

efd

 

 

OBJECT_TYPE

<format name>

 

EQEDD

OBJECT_VALUE

isDefault

 

 

STRING_VALUE

<true or false>

 

True