efdManagementConfiguration.EFD

<< Click to Display Table of Contents >>

EQuIS 7  >>  Configuration > ST_CONFIG Entries > Enterprise Workflow >

efdManagementConfiguration.EFD

EQuIS Enterprise EDP format registration consists of a set of records in st_config for each Registered Format Name. The Registered Format Name is set in the object_type field for all records in this set and must be exactly the same for all records in this set. The Registered Format Name is matched to the format specified by the EDD file name. For example, the EDD file names 20160321-0832.SPRINGFIEND.EQEDD_FIELD.zip and 20160321-1445.SPRINGFIEND.EQEDD_LAB.zip specify the Registered Format Names EQEDD_FIELD and EQEDD_LAB respectively. While these Registered Format Names may refer to the same EDP Format they would refer to two different configurations of that format.

 

EQuIS Version: 7

 

Namespace: EarthSoft.EDP.

 

Products Affected:

oEnterprise

 

Requires Module:

oEnterprise Workflow Service

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

efdManagementConfiguration


Required

CONFIG_KEY

efd


Required

OBJECT_TYPE

<registered format name>


Name must match the Regular Expression

[a-zA-Z][a-zA-Z0-9_]*

OBJECT_VALUE

xsdFileName


Required

STRING_VALUE

<Path to Format Files>


Valid File System Path

xsdFileName Remarks:

The string_value must be a valid file system path for both the EQuIS Enterprise Web application and EQuIS Enterprise 6 Workflow windows service processes. Both processes must have read / execute permission on the file(s) that make up the EDP Format. If the format is packaged in a ZIP archive then this is the path and filename of the ZIP archive. If the format is expanded into a folder then this is the path to the .XSD or .XSE file in the format.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

efdManagementConfiguration


Required

CONFIG_KEY

efd


Required

OBJECT_TYPE

<registered format name>


Name must match the Regular Expression

[a-zA-Z_][a-zA-Z0-9_]*

OBJECT_VALUE

commitType


Required
Setting may alternately be identified as 'updateMode'

STRING_VALUE

None

Merge

Update

Replace

Format

None = Insert Only

Merge = Insert & Merge

Update = Insert & Update

Replace = Insert & Replace

Format = Format Specific (controlled by the custom handler)

Select One

commitType Remarks:

The object_value may be either ;commitType' or 'updateMode'. If both records exist the setting for 'updateMode' will take precedence.

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

efdManagementConfiguration


Required

CONFIG_KEY

efd


Required

OBJECT_TYPE

<registered format name>


Name must match the Regular Expression

[a-zA-Z_][a-zA-Z0-9_]*

OBJECT_VALUE

acceptWarnings


Required

STRING_VALUE

True
False


Choose One

acceptWarnings Remarks:
When set to False, EDP Warnings are treated as errors and will result in the EDD being rejected by Enterprise Workflow with an error log being returned to the data submitter.

 

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

efdManagementConfiguration


Required

CONFIG_KEY

efd


Required

OBJECT_TYPE

<registered format name>


Name must match the Regular Expression

[a-zA-Z_][a-zA-Z0-9_]*

OBJECT_VALUE

isDefault


Optional

STRING_VALUE

True

False


Choose One

isDefault Remarks:

This record is optional and defaults to False. When present, there should be only one Registered Format Name with this setting equal to True, In the event that an EDD is submitted without specifying a Registered Format Name, this entry specifies the format configuration that will be used.

 

 

Example:

 

The following example configures the EQEDD format for use by Field personnel and Labs. Field EDDs are limited to Insert Only operations while accepting warnings. Lab EDDs are set to Insert and Merge with warnings treated as errors.

 

config_section

config_key

object_type

object_value

string_value

efdManagementConfiguration

efd

EQEDD_LAB

xsdFileName

C:\EQuIS\Formats\EQEDD.zip

efdManagementConfiguration

efd

EQEDD_LAB

commitType

Merge

efdManagementConfiguration

efd

EQEDD_LAB

acceptWarnings

False

efdManagementConfiguration

efd

EQEDD_LAB

isDefault

True

efdManagementConfiguration

efd

EQEDD_FIELD

xsdFileName

C:\EQuIS\Formats\EQEDD.zip

efdManagementConfiguration

efd

EQEDD_FIELD

commitType

None

efdManagementConfiguration

efd

EQEDD_FIELD

acceptWarnings

True