Scheduling Reports

Scheduling is a feature in the Dashboard that allows admin users to automatically (and repeatably) define, run, and deliver reports to multiple recipients. Access to the feature is through the Administrator view's Messaging and Scheduled Tasks option on the Dashboard menu.

Interface

The Messaging and Scheduled Tasks interface is an interactive grid comprised mainly of Tasks Groups.

Task Groups are containers that can house one or many of the tasks. They also serve a means to test a scheduled report.
Tasks define the scheduled report parameters, data source, source Cleo application, as well as notification settings for email, and notification content information.

The interface contains two other main menu pages:

Scheduled Tasks: Used to define scheduling details, such as data dictionary, task group, and frequency.
Message Queue Setup: Used to define scheduling details when delivering reports to a file system.

All menu pages can be navigated to by using the Messaging Menu, located at the top of the interface.

Pre-configured Scheduling resources (Task Groups and Messages)

The Scheduling interface contains the following pre-configured schedule tasks allowing you to easily schedule report scheduling:

Transfers
SLAs
CIS Transfers
Connection
Interchange
Group
Message
Message Inquiry Inbound
Message Inquiry Outbound

While you may find that these existing resources are all that are needed to schedule your reports, new resources can be created.

Getting Started

Scheduling Dashboard reports follows a basic process described here.

Configure the Data Source.
Select the report to schedule.
Define the scheduled report parameters.
Schedule the report.
Test the scheduled report.

Configure the Data Source

From the Dashboard installation location: /mrc/development/m-power/mrcjava/WEB-INF/classes/CIS, edit the mrc_servlet_config.xml file.
Change the data source property value to the database id; this is needed by Scheduler during runtime. For example, if configuring the data source to oracle1, it would appear like this:
```
<Others id="5" tabDescription="Others">
<datasource pdesc="datasource" value=" oracle1"/>
…
…
</ Others >
```

Restart Tomcat.

Select (and copy) the report to schedule

The Scheduling interface differs from the Dashboard in that tasks and groups are displayed for all Cleo application types. There are Message reports that apply to CIS, Clarify, EEI, and EBI v2. You must know which application-specific report you wish to schedule before completing these steps. For example, if you are going to schedule an Interchange report based on your EEI data source, then the EEI Interchange report in the EEI Interchange Task Group would be selected, and not the EBI2 Interchange Task Group. All tasks have the Cleo product acronym identified in the name.

It’s recommended to copy a task instead of editing the original; this way you can always revert back to the intact original.

From the Messaging and Scheduled Tasks menu page, under the Message Description column for the report you have selected, click the Copy Message Definition button.

Define the Parameters

This set of steps involves the set up of several message definitions - some necessary, some optional - that will be used to define the report criteria, as well as output type and delivery options. These steps take place in the Update Message Definition section, which is where you should be after copying the message definition in step 1 above.

The Update Message Definition section now displays, with a four-tabbed set of options. Make sure you are on the Message Type tab. You'll see that several of the fields are pre-populated, and there is no additional configuration required - with the exception of Additional Parameters.
It is this string of parameters must be correctly defined:
- status: a choice between error or success. Indicates the status of the transaction.
  An example: status=error
- numberOfDays: indicates the number of days prior to the current moment that data is to be included in report.
  An example: numberOfDays=1
- dataSource ID: identifies the data source.
  An example: dataSource=as400_remote1
  Note: If you don't know your data source ID, go to the Maintain Data Source option in the Administrator view's Security menu to locate.
  The entire string is delimited with an ampersand(&), and would look like this:
  status=error&numberOfDays=1&dataSource=as400_remote1
Please refer to required parameters and allowed values for each report.
If the scheduled report will be delivered using email, take the steps list below:
Note: Your SMPT server must first be configured.
From the Dashboard installation location,/mrc/development/m-power/mrcjava/job_streams, edit the messaging.properties file and add these properties:
```
sms_from=<leave blank> 
```
```
enable_scheduler=true
```
```
mpower_server=<dashboard server ip and port>
```
(Example: http\://localhost\:80)
```
sms_password=<leave blank>
```
```
email_user=<user email-id>
```
(Example: [email protected])
```
email_server=<smtp server ip or dns>
```
(Example: smtp.extol.comcastbiz.net)
```
sms_user=<leave blank>
```
```
email_sender=<sender email-id> 
```
(Example: [email protected])
```
email_other=<leave blank>
```
```
email_password=<smtp server password>
```
Once completed, save file and restart Tomcat. Proceed to the steps below,
- Go to the Message Format tab.
- For Message Type, choose the Email radio button.
- Select if report to be included in message or as an attachment.
- Select Output Format (default is HTML) and provide filename (if sending as attachment)
To manage email recipients and email content, use the Recipients and Message Text tabs.
If the scheduled report will be written to a file system.
- Go to the Message Format tab.
- For Message Type, choose the File radio button.
  Once selected, the Queue field now appears. This identifies the name and file path location the report will be delivered to.
  Note: (If you have not already created a Queue, you will need to do now. Make sure to Save and Return to Messaging and Tasks Groups)
- Select Output Format (default is HTML).
- Because you selected File as the message type, the Queue field now appears. A Queue must be selected; this identifies the name and file path location the report will be delivered to. (If you have not already created a Queue, you will need to do now. Make sure to Save and Return to Messaging and Tasks Groups).
Save and return the Task and Message Groups.

Schedule the Report

Select Scheduled Tasks from the Messaging Menu.
Click Create New Scheduled Task.
Select the Data Dictionary. Options include CIS, Clarify4, EBI3, EBI2, and EEI.
Select the Task Group that your report belongs to. If you've copied an EEI Interchange report, then select EEI Interchange Group from the drop-down menu.
Define how often you want to schedule this task group (which can contain many reports) to be produced by using the Frequency drop-down menu. Options include minute, hour, day, week, month, and year.
Save and return to Scheduled Tasks. The newly created scheduled Task Group should appear as a record.
Note: Changes made to the scheduled jobs will not take effect until the Dashboard server is reloaded, or by reloading tomcat by clicking Reload tomcat now with these user credentials user:mrcuser and password:mrcuser.

Test the scheduled report

Return to the Task and Message Groups.
Go to the Task Group that contains the report you wish to test.
Click the Test Task button.
You should receive notification that the selected task group has been processed. You may also confirm notification and output details.