Skip to main content

Create a Job

Select Create Job on the Jobs tab of the Reporting Framework Management Console to create a job. You must choose a Job Type - either Report or Notification type.

Report Job Type

For a report job type, the entire report is transferred through email or sent to a configured location.

  1. Select the Report Type.

  2. Specify a Name and a short Description for the job.

  3. Select Compress All Extract Files if you want the report to be compressed.

  4. Select a report instance from the menu. The Report Name is a combination of the report title and the saved parameters separated by a colon (:). A report instance with saved parameters must be available to create a job.

  5. Select a Destination from the menu.

  6. Specify a Path, if necessary, where the report should be saved.

  7. Provide a Filename (without an extension) for the report that will be generated when the job runs.

  8. Optionally, select the Enable checkbox if you want users to receive a notification when this job runs.

    • Fill in the Recipients, From, and Subject fields for the email.

    • Select the Attach report to email checkbox to attach the report file to the email.

  9. Specify the scheduling options for the report by choosing the Time and Days to run or by entering a Custom Cron Expression.

  10. Select Submit to save your job.

  11. Select Enable on the menu next to the job's name to enable the job.

Notification Job Type

For a notification job type, for each row in the report, an email is merged to a template and sent to a recipient.

  1. Select the Notification Type.

  2. Specify a Name and a short Description for the job.

  3. Select a report instance from the menu. The Report Name is a combination of the report title and the saved parameters separated by a colon (:). A report instance with saved parameters must be available to create a job.

  4. Enter a Recipient and optional CC and BCC email addresses.

  5. Enter a From email address.

  6. Enter a Subject for the email.

  7. Enter an email Message.

    This email will be sent for each record in the query result set. You can substitute column data from the row and merge it with fields in the email template. All the email template fields can be dynamically set using a token with the format $columnname and will be replaced with real data at runtime. Column names should be referenced in lowercase and you should avoid column names containing "#" or "$" characters.

  8. Select the Tracking Notifications box to track who has been sent each email, and only send the notification once.

  9. Enter a value when the Tracking Notifications box is checked. This should be a column name that uniquely identifies a record in the query result.

  10. Optionally, select the Enable report delivery via email checkbox if you want users to receive a notification when this job runs.

    • Fill in the Recipients, From, and Subject fields for the email.

    • Select the Attach report to email checkbox to attach the report file to the email.

  11. Specify the scheduling options for the report by choosing the Time and Days to run or by entering a Custom Cron Expression.

  12. Select Submit to save your job.

  13. Select Enable on the menu next to the job's name to enable the job.