Report Runner Job Tasks

Report Runner job tasks in ACE can be used to automate running and delivering reports.

• Report Runner: Run as User – Generates reports based on a selected ACE user’s permissions and data access.

• Report Runner: Client – Generates reports for specified client(s) or all clients if none are specified.

Both job tasks can be used to email reports to ACE users or external recipients. Reports can also be delivered via SFTP by adding a “Document: Transfer To” job task.

For general information on creating and managing jobs, see About Jobs.

Configuring a Report Runner Job Task

Follow the steps below for the one you need to set up.

Report Runner: Run as User

1. Create the Job

   1. Navigate to Utilities → Jobs.

   2. Click New.

   3. Enter a Label (descriptive name) and optional Description.

   4. Choose a Schedule (On Demand or Scheduled).

   5. Complete other fields as needed. See About Jobs for full job setup details.

2. Add the Task

   1. In the Add Task section, select Report Runner: Run as User.

   2. Click Add.

3. Configure the Task Fields

   1. Report Template – Select the report to run.

   2. Run As User – Choose the ACE user for permissions and data access.

   3. (Optional) Email to Users – Check to send to ACE users.

   4. (Optional) Email to Addresses – Enter additional email recipients (comma-separated).

   5. Format – Select the output format (required before saving).

   6. Output File – Enter the file path and mask.

   7. (Optional) Email Template – Choose a template with ${body} for inline HTML delivery.

   8. Enable Active to allow the task to run.

Report Runner: Run as Client

1. Create the Job

   1. Navigate to Utilities → Jobs.

   2. Click New.

   3. Enter a Label (descriptive name) and optional Description.

   4. Choose a Schedule (On Demand or Scheduled).

   5. Complete other fields as needed. See About Jobs for full job setup details.

2. Add the Task

   1. In the Add Task section, select Report Runner: Run as Client.

   2. Click Add.

3. Configure the Task Fields

   1. Report Template – Select the report to run.

   2. (Optional) Clients – Specify client(s) or leave blank to run for all clients.

   3. (Optional) Email to Users – Check to send to ACE users.

   4. (Optional) Email to Addresses – Enter additional email recipients (comma-separated).

   5. Format – Select the output format (required before saving).

   6. Output File – Defaults to *.zip (internal files match format extension).

   7. (Optional) Email Template – Choose a template with ${body} for inline HTML delivery.

   8. Enable Active to allow the task to run.

Email Delivery

• Send reports to ACE users or any valid email address.

• The Email to Addresses field supports sending to non-user email addresses.

• Reports in HTML format are delivered inline in the email and as an attachment, unless size limits are exceeded (in which case, they are sent as attachments only or result in an error).

• To include the report inline, the email template must contain the ${body} parameter.

• The ${subject} field is not context-aware for this task.

• Reports will still send successfully without a selected template or without the ${body} parameter.

Output File Naming & Behavior

The Format and Output File fields work together. The format you select determines the default extension in the Output File field.

Report Runner: Run as User

Default file mask: *.txt

Order of operations:

1. Select the desired report format in the Format field.

2. Click Apply to save.

   1. The Format field automatically updates the Output File field so the file extension matches the selected format.

3. If you want the resulting file to have a different extension from the format of the file (per the Format dropdown):

   1. Click in the Output File field.

   2. Manually edit the file extension in the folder path.

   3. Click Apply again to save.

• If you later change the Format and save the job task, the Output File extension will be updated to match the latest selected format. At that point if the extension needs to be different than the format then you need to change it again in the Output File field.

• The Output File name is also used as the email attachment name when sent via email.

Report Runner: Run as Client

• Default file mask: *.zip

• File mask remains *.zip even if the format changes.

• Inside the ZIP, files have the extension for the selected format.

• Renaming the mask extension has no effect.