File Metadata Customization

Enterprise has the functionality to create, edit, and view file objects. These file objects will contain information about the file (i.e., the file metadata) as well as the file itself or if the file is externally linked, the location or address of the external file. Files and file metadata are accessed in Enterprise by the Document and Photo Browser widget and the Explorer widget.

The file metadata are stored in the DT_FILE table. The default file metadata fields include:

•FILE_NAME

•TITLE

•AUTHOR

•FACILITY_ID

•FILE_DATE

•REMARK

•CONFIDENTIAL_YN

•PLACE_TYPE and PLACE_CODE (to associate with a location)

Additional file metadata fields can be added to all file objects in EQuIS by defining the additional parameters in the RT_FILE_PARAM_TYPE table. Once defined, the values for file-specific custom parameters are stored in the DT_FILE_PARAMETER table. The actual value will be stored in the DT_FILE_PARAMETER.PARAM_VALUE column, which is a text column. Thus, the value will be stored as text regardless of the type of data.

To define custom file metadata, create a new record in the RT_FILE_PARAM_TYPE table using EQuIS Professional. The following table provides guidance on defining the new custom file metadata parameter.

RT_FILE_PARAM_TYPE Column	Required/ Optional	Description
PARAM_CODE	Required	Code that identifies this file metadata field.
PARAM_NAME	Required	Display name of this file metadata field.
PARAM_DESCRIPTION	Optional	Field description. This is not utilized in the Enterprise User Interface.
STATUS_FLAG	Required	Set to 'A' to make this field active. Set to 'R' to disable this field.
EBATCH	N/A	This may be used when new fields are created when new data are submitted via EDD. Not applicable to Enterprise user interface.
REMARK	Optional	Internal note for this field.
EUID	N/A	Not utilized at this time, unless this table is audited.
DATA_TYPE	Optional	This column will indicate what type of value is being saved, since the actual value is saved as text. Values for this column are constrained to those found in ST_PARAM_DATA_TYPE.DATA_TYPE. The only data type with special handling is "Date/Time". Fields set to "Date/Time" will have these custom file metadata fields be date inputs using the calendar tools in Enterprise widgets.
DATA_SOURCE	Optional	Setting a value for this column can enable a field to become a lookup field with a drop-down list of possible values in the Upload File, Edit File, and Advanced File Search windows in the Explorer widget. The value for this column must be a valid SQL select statement that returns the possible lookup values. More than one column can be returned. The first column returned by the SQL statement will be the the saved value. Adding the lookup values to the RT_LOOKUP table is recommended. For example, set RT_LOOKUP.LOOKUP_CODE as the value, RT_LOOKUP.LOOKUP_DESC as a description of the value (if necessary), and set RT_LOOKUP.LOOKUP_TYPE to a key word for this custom file metadata field. Then the SQL select statement might look something like "SELECT lookup_code, lookup_desc FROM rt_lookup WHERE lookup_type = '<custom metadata field key word>';"
REQUIRED_YN	Optional	Setting the value for this column to "Y" will cause this custom file metadata field to be required in the Upload File and Edit File windows in the Explorer widget.

In the Document and Photo Browser widget and the Explorer widget, these custom file metadata fields will be displayed below the default file metadata fields in descending order according to RT_FILE_PARAM_TYPE.PARAM_CODE.