previous

Export Data Definitions

When viewing the Export Data Definition Topics, the following items are referenced throughout them. This list defines the Term and the Definition for that term.

FILE_TYPE

The name of the export.

FILE_GROUP_ID

Group that the export is a part of.

RESORT

Property for which export is set up. If resort is null then it is a template record.

FILE_TYPE_DESC

The long description of the export.

SOURCE_VIEW_CODE

This field is only editable when configuring new exports. Select the down arrow and select the view used for this export from the list of values.

FILE_NAME

The file name formula is the name of the ASCII export file which will be created when the export is generated.

FILE_EXTENSION

Used to create any file extension for the daily export. This field can accept SQL statements so that the extension can include dates or other program specific export information (Current System Month + Day MM||DD). Examples for the file extension name would be TXT or EXP. The single quotes are necessary.

FILE_LOCATION

Location where the export will be saved.

COL_SEPERATOR

This field appears when the Compress Data check box is selected. Select the down arrow and select the delimiter used to separate the columns from the list of values. The available options are:

Space

Tab

Comma

Enter (CRLF or carriage return line feed) "

WHERE_CLAUSE

The condition for the export. By default, depending on the view, all data will be exported. But if only certain information is required to be exported, then users can enter a value in this field.

Technically, this is the where clause in the select statement. For example, if only certain market codes statistics are required in the market codes statistics export, such as FIT, COM and IND, then the condition Market code IN (FIT,COM,IND) can be entered, where market code would be one of the column names in the Export source view/table.

When clicking OK, the export setup is saved and now the columns can be defined. When the export setup is saved, the button option Export Columns will now be available.

To define the export columns, select the Export Columns button. Once selected, the Export Columns Details screen appears, displaying the columns available in the view.

RUN_IN_NA_YN

Indicates if the export is run as part of the night audit procedure or not.

ZIP_FILE_LOC

Location where the Zip file of the export will be saved.

COMPRESSDATA_YN

Is the data included in the export compressed or not.

ZIP_FILE_NAME

Name of the export Zip file.

PRE_EXP_PROC

The pre-export procedure is an internal setup procedure which will be executed prior to the data export. The pre-export procedure is a pre-processor that populates and filters views, and sets variables.

The procedure extracts the data and stores it in a temporary table. The view (defined in the Export Source field) reads from this table and creates the export data. The temporary table is deleted once the export is complete.

If a pre-export procedure is not specified, the export will look at the value(s) defined in the Parameter Form field.

POST_EXP_PROC

An internal setup procedure which will be executed after the data export is done. The post-export procedure is a post-processor that truncates temp tables following export generation and may also reset parameters that were set for the export.

PARAMETER_FORM

The Parameter Form field is used for exports that can be manually generated. This field contains the name of the parameter form which is used to generate a manual export.

Note: When automatically generating exports via End of Day processing (the Night Audit Export check box is selected), the parameter form should not be used, because the export is generated automatically and there is no opportunity for manual input.

Typically, this field is not required if the pre-export procedure is defined, however this can vary depending on the definition of the export. Each pre-export procedure has a unique parameter form, as the procedure is hard-coded within the form.

If a value is not defined in the Parameter Form field, the procedure will look at the view utilized for the export (defined in the Export Source field).

BATCH_SEQ

Batch Sequence number assigned to the export.

ADD_NEWLINE_YN

Select this check box to have each record displayed on a separate line in the ASCII text file.

NA_FREQUENCY

Frequency that the export will run in the night audit procedure.

ALWAYS_HDRFOOTER_YN

Based on the export setup, if no data has been generated within the export and if a header and footer is defined, and a file name is given in the export setup, OPERA will always generate the export file that contains no information other than the header and the footer.

FTP_UPLOAD_YN

Export file has to be uploaded automatically by OXI to FTP site.

UPLOAD_TYPE

Type of FTP upload. Can be DCO, REV, FOLIO, PA, or PS.

OXI_INTERFACE_ID

Interface ID from OXI, required if upload_type is not available. A valid OXI interface is required to upload to FTP.

HTTP_UPLOAD_YN

Export file has to be uploaded automatically by IAS to HTTP site.

HTTP_ADDRESS

URL address of HTTP server which received export file.

NA_WHEN_TO_EXPORT

Day of the week, when the export routine is run in the night audit and the NA_FREQUENCY is set to 'Day of Week'.

COMPONENT_EXPORT_YN

Indicates if this export contains export components.

PARENT_ID

If this export is an export component, this column will contain the exp_file_id of the parent export.

EXPORT_SEQUENCE

Sequence of running the export.

APPEND_TO_FILE_YN

Indicates if the data should be appended to an existing file.

TRANSFER_METHOD

Protocol used to upload the export file to HTTP server.

SOAP_ACTION

Soap Action information if SOAP protocol is used to upload the export file.

XML_YN

Indicates if the export is an XML file.

XML_DOC_NAME

Main tag for the xml document.

AUTO_EXPORT_YN

Configure Auto Export Y/N.

SFTP_YN

SFTP Y/N.

ENCRYPT_TYPE

Encryption Type.

ENCRYPT_KEY

Encryption Key.

LOG_LEVEL

Internal.

EXPORT_TYPE

Internal Column. Used to map this export to the iteration export type in the exp_iterations table.

LARGE_REC_LENGTH_YN

Indicates if this export contains records where the data length can exceed 4k.

XML_ENCODING

For XML exports, this allows adding the encoding attribute to the <?xml?> file header.

XML_PROCESSING_INSTRUCTIONS

For XML exports, this allows for additional processing instructions to the XML file header if needed.

XML_DOCUMENT_TYPE_NAME

For XML exports, this defines the optional document type name (<!DOCTYPE _doc_type_name SYSTEM "_system_id_" PUBLIC "_public_id_">).

XML_DOCUMENT_TYPE_SYSID

For XML exports, this defines the optional document type name (<!DOCTYPE _doc_type_name SYSTEM "_system_id_" PUBLIC "_public_id_">).

XML_DOCUMENT_TYPE_PUBID

For XML exports, this defines the optional document type name (<!DOCTYPE _doc_type_name SYSTEM "_system_id_" PUBLIC "_public_id_">).

MULTI_PROPERTY_YN

Multi-property Export Y/N.

EXPORT_CHARACTER_SET

The Character Set used to write the export files. It must be a valid Oracle Character Set, such as UTF8 or US8PC437.

See Also