Wiki: REPORT RUN OPTIONS

Before you launch a report or an update process, you may provide run options to redirect the output. You may also provide scheduling parameters.

Run Options#

The RUN OPTIONS tab is organized into three sections - Report Options, Processing Options and Report Scheduling (containing Run When and Repeat Options) details.

The content of the Report Options section varies by function and it may not even be present. The other two sections are standard.

Processing Options#

The Processing Options section allows you to specify the format of the output and where the output will be directed. All report processing takes place on the report server.

Execution: The system automatically assigns a unique number to every execution of a process. This is referred to as the Execution ID or the MEX ID.

Destination Type: This field identifies where to send the output. Destination Type is an optional field based on the fixed lexicon X_DESTYPE. The Destination Type is normally set to CACHE. Your options are:

CACHE Output goes to the report server, managed by Queue Manager
File Output is written to a flat file on the report server
Email Output is emailed to a recipient
Preview DO NOT use this option with the report server
Printer Output is printed on a printer configured for the report server

Destination Format: This field indicates the format of the output at the destination. Destination Format is an optional field based on the fixed lexicon X_DESFORMAT. The most common formats are

Default The system will send the report to the default printer
HTML Used to view reports in a browser
PDF Used to view reports in Adobe Acrobat

Report Mode: This field identifies the style of the report. Report Mode is an optional field based on the fixed lexicon X_REPORT_MODE. Leave the Report Mode as ‘Bitmap’. Very few reports use ‘Character’.

Destination Name: This field depends on the Destination Type.

CACHE Destination name - defaults to Function+Execution ID+Format Suffix
File File name - defaults to Function+Execution ID+Format Suffix e.g. RDJB#162852.pdf
Email Email recipient - must be entered
Printer Printer name - leave blank - system will provide

Job Name: This field names this specific report execution. It defaults to the Function+Execution ID. e.g. RDJB#162852

Pagestream: This field indicates whether page streaming is enabled for HTML or HTMLCSS output. Page streaming will allow you to view one page at a time using controls to step you through the report.

Report Scheduling - Run When#

These Report Scheduling Run When options may be used to schedule the process to run at a designated time. If there are no options specified, the process will run immediately.

Run Start Time: This field specifies the time the process will run (on the 24hr clock). e.g. 20:00

Schedule Options: This field specifies when the process will run. e.g. Today, Tomorrow, Jan, Feb, Mar, ... Schedule Options is an optional field based on the fixed lexicon X_DATE_OPTIONS.

Run Start Day: This field specifies the date that the process will run. e.g. Jun 30, 2006

Report Scheduling - Repeat Options#

These Report Scheduling Repeat Options may be used to automatically repeat the report or update process on a designated frequency. If there are no options specified, the process will run only once.

Frequency: This field specifies how often the process will run. Each run will use the same parameters. e.g. Hourly, Daily, Weekly, Monthly, Every n Frequency is an optional field based on the fixed lexicon X_REPORT_FREQUENCY.

Frequency Amount: This field specifies the interval of time between runs if the Frequency is “Every”. It is expressed in the time basis of the Frequency Option. e.g. a value of 2 with a basis of ‘Days’ means ‘Every 2 Days’

Frequency Option: This field specifies the time basis of the Frequency Amount. e.g. Minute(s), Day(s), Hour(s), Week(s), Month(s) Frequency Option is an optional field based on the fixed lexicon X_REPORT_SUFFIX.

Day Repeat: This field specifies which Weekday of the month the process should be run on. e.g. First, Second, Third, Fourth, Fifth Day Repeat is an optional field based on the fixed lexicon X_DAYREPEAT.

Weekdays: This field identifies which day of the week the process should run on. e.g. Mon, Tues, Wed, ... Weekdays is an optional field based on the fixed lexicon X_WEEKDAYS.

Expires Options: This field specifies when the process will expire. e.g. Today, Tomorrow, Jan, Feb, Mar, ... Expires Option is an optional field based on the fixed lexicon X_DATE_OPTIONS.

Expires When: This field is a 16-character optional alphanumeric field that specifies how long output will be retained until it is deleted. e.g. 1 day, 2 days, 3 weeks, 1 month, ...

Run Report#

Once you have specified all of your parameters, you are ready to execute the report or update process. To launch the process, click the Run Report button at the top of the parameter form. If there are no scheduling options specified, the report starts the execution immediately on the report server. CLEANUP