Administration Guide

Scheduled Reports

On this page

A reporting job runs one report on a schedule and delivers the output. Each job combines a report, a destination, and an export format: the job either saves the report to a file or sends it by e-mail. Reporting jobs are one job type of the Automation Server, the Reporting job type.

You manage reporting jobs in the Admin Center and in the Settings App; both edit the same job (see Admin Center and Settings App). The Admin Center cannot set or change an output file, so a job created there can only e-mail its report.

Before you begin

  • The Automation Server must be set up and running for a job to run.
  • A job that sends its report by e-mail only puts the message in the Automation Server's outgoing notification queue. The report arrives only while that queue is enabled and a mail system is configured in the outgoing e-mail settings (see Notifications Overview).
  • A job that saves its report to a file writes the file under the Automation Server's service account, so the folder must be writable by that account.

Scheduled reports in the Admin Center

Open Scheduled Reports

In the Admin Center, go to Services and Integrations > Scheduled Reports. The page is available to administrators who hold its permission (see Permissions Reference). It has two sub-pages: Reports, which opens by default and lists the reporting jobs, and Logs, the Reporting log.

The job list is not refreshed on a timer. Click the Refresh icon to read it again; the list is also read again after Enable, Disable, and a Run request that succeeds. The page checks the Automation Server's status every 60 seconds. The list's next run value shows whether a job is waiting to run as soon as possible, being terminated, disabled, or not yet started, before it shows a date.

While no active Automation Server is reported, the job form shows "Warning. For this job to be executed, the Automation Server must be set up and running."

Create or edit a reporting job

  1. On the Reports sub-page, click New, or select a job and click Edit. The job form opens on its Settings tab; an existing job's form also has a Sessions tab.
  2. Enter a name for the job.
  3. Choose the report. The list offers the summary reports, ordered by name. Detail reports, which are printed from a record (see Printable Reports), are not listed.
  4. Choose the export format.
  5. In the Destination section, choose Send report via e-mail, then fill in To, Subject, and Message. To is required while e-mail is chosen. Use its placeholder picker to insert a placeholder, or its clear action to empty the field.
  6. Set the schedule. See Set the schedule in the Admin Center.
  7. To set the report's parameters, click the pencil icon of Additional Parameters. The form shows one control per parameter, by its type: a check box, a checklist, a list, a text box, a number field, a date and time field, or a date range preset with its own from and to dates. Every parameter is required; an empty one shows "Field <title> is mandatory, it can't be left blank." The from and to dates of a date range are editable, and required, only while its preset is "custom". When you save the parameters, Additional Parameters shows them as space-separated /name=value entries.
  8. Submit the form.

Save report to file is available only for a job that already has a file name, and the File Name field is always unavailable. Clicking the File Name field, or clicking Save report to file while it is unavailable, shows "This feature is not yet available in the Admin Center. Please use the desktop Settings App". A job that already has a file name can keep, or return to, file output with the name it has. When you change the format or the report of such a job, the form changes the file name's extension to match the format.

If you change the report while Additional Parameters holds values, submitting the form shows "You have selected the new report, but the original report parameters remain unchanged. Old parameters may not be valid for the new report. Are you sure you want to save the job?" The question does not stop the save: the form checks the parameters against the new report and, when they do not fit, names the first required parameter that has no default value; otherwise it saves the job at once. Answering Yes saves the same values again, and No only closes the question.

Set the schedule in the Admin Center

The Schedule field shows the schedule as a sentence, for example "Occurs every 1 day(s), at 12:00 AM, started 9/12/2026". A new job starts monthly, on day 1 of every month, once at 12:00 AM, from today.

  1. Click the pencil button of the Schedule field. The Schedule drawer opens.
  2. Under Occurs, choose Daily, Weekly, Monthly, or Yearly, and fill in the panel beside it:
    • Daily: Every n day(s), n from 1 to 366.
    • Weekly: Every n week(s) on:, n from 1 to 52, and at least one weekday; with none, the drawer shows "You must choose at least one day of the week".
    • Monthly: Day n of every n month(s), or The with first, second, third, fourth, or last, then a day of the week, Day, Week day, or Weekend day, of every n month(s). The day runs from 1 to 31, the months from 1 to 99.
    • Yearly: Months, then Days (1 to 31 and Last) or On (week numbers and weekdays). The months and the days, or both lists under On, are required; an empty one shows, for example, 'The "Months" field is mandatory, it can't be left blank' or 'The "Days" field is mandatory, it can't be left blank'.
  3. Under Daily frequency, choose Occurs once at: and a time, or Occurs every: a count of Minute(s) or Hour(s) with Starting at and Ending at. On premises, the count runs from 1 to 1440 minutes or 1 to 24 hours. In Alloy Navigator Cloud, the minimum interval of a reporting job is 24 hours: the count is unavailable, while Occurs every:, its unit, and the time window can still be chosen (see Administering Alloy Navigator Cloud).
  4. Under Duration, set the Start date, and an End date: or No end date.
  5. Click OK.

The schedule uses the application server's time zone. When the server's time zone is known, the drawer shows "The schedule uses the application server's time zone (UTC{timezone}). Please note that the server time is {hours} hours ahead of your local time." (or "behind"). When your local UTC offset differs from the server's, the collapsed field names the server's offset, unless it shows a validation error or another helper text in its place.

Run, enable, disable, or delete a job

Select jobs on the Reports sub-page and use the toolbar:

  • Run starts the one selected job and needs an active Automation Server. It shows "Your job will be started as soon as possible, typically within a few minutes. Please check the job status later." The Admin Center passes the request to the Automation Server, which acts on it at its next refresh, so the run can start with a delay. If the job is already waiting to run, Run shows "Please wait until the job has completed, and then check the session log to make sure that it runs as expected." and refreshes the list.
  • Terminate stops the one selected job; it also needs an active Automation Server and is available while the job's last run is executing. If the job is already being terminated, it shows "Please wait, the job will be terminated soon." and refreshes the list.
  • Enable and Disable act on the selected jobs.
  • Delete deletes the selected job.

The Automation Server page's job list also shows reporting jobs, among all other job types. It offers Run too, has no New or Delete, and opens a reporting job in the same form.

Check results in the Admin Center

The Logs sub-page lists every reporting job's runs, newest first, with the columns Run Date, Job Name, Report Name, Comments, Duration, and Errors. You can search and delete entries. Click an entry's Run Date to open it.

An existing job's Sessions tab lists that job's entries, newest first, with the same six columns and a delete. Each Run Date opens the entry.

Scheduled reports in the Settings App

Create or edit a reporting job

In the Settings App, reporting jobs are listed in the Automation Server's job list, which also offers New. A reporting job, new or existing, is edited in the Scheduled Report dialog.

  1. In the job list, use New to create a reporting job, or select one and click Open. The Scheduled Report dialog opens. It has the tabs Settings, Processing, and Sessions; Sessions is unavailable for a new job.
  2. On Settings, enter the Name. Enabled is selected for a new job; clear it to keep the job from running on its schedule.
  3. Under Report, choose the Report Name and the Format.
  4. Under Destination, choose one:
    • Save report to file, then enter the File Name.
    • Send report via e-mail, then fill in To, Subject, and Message. The drop-down of To lists recipients shared by every reporting job and is updated from the field's list each time you save a job. Its ellipsis button inserts a field you choose in the field browser.
  5. Under Parameters ("Specify command line report parameters."), click Build.... When the report has parameters to show, the Report Parameters dialog opens; set the values and click OK. The parameters are written to the group's parameter box as space-separated /Name=Value entries. If you click Cancel, the values stay as they were. A date range preset, such as "Last month" or "All time", is stored as the preset rather than as fixed dates.
  6. Under Schedule, click Change... and set the schedule. See Set the schedule in the Settings App.
  7. Click OK.

Build... does nothing while no report is chosen. For a report in a format it does not support, it shows "This functionality is only supported for MS Reports." When the report engine is not installed, or its registration is broken, on the computer running the Settings App, Build... shows "This command is not available because RDLReportEng.dll is not installed or its registration is broken.", followed by a request to run the product's installer in Repair mode. On such a computer, the dialog also shows this message when you save, and it saves no reporting job, new or changed.

When you click OK, the dialog checks the job and stays open on an error:

  • A blank To is refused with 'The "Email" field is mandatory, it can't be left blank.' A To value whose placeholders are not valid is refused too.
  • A parameter name that is reserved is refused with a message that includes "Change invalid values in report parameters. These words cannot be used:" and the names.
  • The parameter values are checked against the report, and any error is shown.
  • If you chose another report for an existing job but did not change its parameters, the dialog asks "You have selected the new report, but the original report parameters remain unchanged. Old parameters may not be valid for the new report. Are you sure you want to save the job?"

Set the schedule in the Settings App

Change... opens the Schedule dialog on the job's schedule. A new job starts monthly, on day 1 of every month, once at 00:00, from today.

  1. Under Occurs, choose Daily, Weekly, Monthly, or Yearly, and fill in the page beside it:
    • Daily: Every n (1 to 366) day(s).
    • Weekly: Every n (1 to 52) week(s) on: with the check boxes Mon to Sun.
    • Monthly: Day n (1 to 31) of every n (1 to 99) month(s), or The First to Last with one of Sunday to Saturday, Day, Weekday, or Weekend Day, of every n (1 to 99) month(s).
    • Yearly: Months: (with <Select all months>), then Days: (1 to 31 and Last) or On: (week numbers and weekdays, with <Select all days>).
  2. Under Daily frequency, choose Occurs once at:, or Occurs every: n Minute(s) or Hour(s) with Starting at: and Ending at:. For a reporting job, the count runs up to 2880, whatever the unit. On premises, the count starts at 1. In Alloy Navigator Cloud, it starts at 1440 for Minute(s) and at 24 for Hour(s) (see Administering Alloy Navigator Cloud).
  3. Under Duration, set the Start date:, and an End date: or No end date.
  4. Click OK. The Schedule group shows the schedule's description.

OK refuses the schedule with one of these messages:

Message When
"You must choose at least one day of the week." A weekly or On: schedule has no weekday.
"You must choose at least one month." A yearly schedule has no month.
"You must choose at least one week number." A yearly On: schedule has no week number.
"You must choose at least one day." A yearly Days: schedule has no day.
"A schedule's End Date cannot be earlier than its Start Date." The end date is before the start date.
"You have selected a day that is not in any of the specified months. You must include at least one month that has all of the selected days." The schedule has no next run date.

Run and manage jobs in the Settings App

The Automation Server's job list offers New, Open, Delete, Enable, Disable, Run, and Terminate.

  • Run is available for one selected job while the Automation Server is reported running, and starts the job. If the Settings App cannot reach the Automation Server directly, it marks the job to run at the Automation Server's next refresh, refreshes the list, and shows a message.
  • The list reloads changed rows every ten seconds by default while its page is the active one. Refresh reloads the job, server, tool, and e-mail queue lists at once and reads the Automation Server's status again.

Check results in the Settings App

The Reporting log lists the runs of all reporting jobs. Open it from Logs > Reporting, or from Services > Scheduled Reports > Logs. The Logs > Reporting node requires the permission to browse logs; the Logs node under Services > Scheduled Reports requires the permission of the Scheduled Reports branch instead, so an administrator who may configure scheduled reports reaches the log without the permission to browse logs. For each run, the log holds the run date, the job name, the report name, the comments, the duration, the file name, and the errors. For logs in general, see Logs.

In a new 2026.1 database created with the Default Workflow (see Default Workflow Configuration), the Reporting log comes with these views, which an administrator may have changed or removed:

  • All Time: the run date, job name, report name, comments, duration, and errors.
  • Last 7 days: the same six columns, with the comments third, filtered on the run date.
  • Errors: the run date, job name, report name, duration, and errors, filtered on the errors.
  • by Job Name: the same five columns, grouped by job name, with the job name column hidden.

Each of these views shows the average duration and the sum of the errors in the grid footer; Errors and by Job Name also show them in each group footer. None of these views shows the file name.

The log loads at most 1000 runs and says "Last <n> records are loaded". It reloads what changed every ten seconds by default while its page is the active one. If loading the log times out, it shows the number of runs in the log and leaves Clear All available. It offers:

  • View Log, also Enter or a double-click on a row, opens the run's text in the program Windows uses for .log files. A second View Log of the same run reopens the same copy.
  • Delete deletes the selected runs after "Are you sure you want to delete the selected record?" (or "Are you sure you want to delete <n> selected records?") and reports "<n> records have been deleted."
  • Clear All deletes every entry of the log after "You are about to delete all entries from the Service Log. Are you sure you want to proceed?"
  • Settings requires the permission to manage logs. Without it, Settings shows "You do not have enough permissions to use this function."
  • Refresh, also F5, reloads the log.

Without the permission to manage logs, the log opens read-only, without Delete and Clear All.

Export formats

A job exports its report in one of six formats. Every report can be exported in all six.

Format File extension
PDF .pdf
Excel .xls
Excel .xlsx
Word .doc
Word .docx
Image .png

How a job delivers its report

By e-mail

The job attaches the exported report, named <report name>.<extension>, to one plain-text message with the job's recipients, subject, and message text, and puts that message in the outgoing notification queue. The Automation Server, while it is the active one, checks the queue on a timer and sends the message through the mail system the outgoing e-mail settings select, from the From address of those settings. While outgoing e-mail sending is paused, the report waits in the queue.

  • Separate several recipients with commas, semicolons, or line breaks. The recipient text can contain placeholders, which are replaced with values from person records when the job runs (see Macros Reference).
  • If any recipient address has the domain example.com, nothing is sent and the message is deleted. The notification log reads "The recipients that have the domain name example.com in their e-mail addresses were ignored. The e-mail message was deleted."
  • The job's session reports the report as sent as soon as the message is queued: it reads Report sent to "<To>"., with the recipient text as entered and placeholders not replaced.
  • A delivery failure does not appear in the job's session. When a message cannot be sent, it stays in the queue and the error is written to the notification log and the System Log. A message with no recipient fails with "No recipient address is specified.", unless the installation is set to delete messages that have no recipient; then the message is deleted instead. A failed message is tried again when the Automation Server starts, or during a pass of the queue that also has a new message to send.

To a file

At the start of every run, the job deletes any file with the same name, then writes the new report, and the job's session reads Report exported to file "<path>". If the file cannot be created, the run reports Error creating file '<path>'. followed by the system message.

To give each run its own file, put date and name placeholders in the file name. They are replaced when the report is exported:

Placeholder Replaced with
%YYYY Year
%MM Month
%DD Day
%hh Hour
%mm Minutes
%ss Seconds
%REPORTNAME The report's name

For example, a job saving to D:\Reports\%REPORTNAME_%YYYY-%MM-%DD.pdf writes one file per day. Another run on the same day replaces that file.

When the report has no data

A report can be designed to skip an empty result. When the main data of such a report returns no rows, the run delivers nothing and its session reads "No data in report. Report not exported." or "No data in report. Report not sent." For a job that saves to a file, any file with the same name is still deleted, and no new file takes its place. Any other report is delivered even when it is empty.

A report that skips empty results and has parameters of its own offers a parameter that allows delivering the empty report: Allow exporting empty report in the Admin Center, Allow delivery of empty reports in the Settings App's Report Parameters dialog. The parameter is off by default, and the report is skipped while it is off. A report that skips empty results but has no parameters of its own never delivers an empty report.

Each application decides on its own whether a report offers the parameter, so a report that names several main data sets can offer it in one application and not in the other; the Admin Center can offer it for such a report even though the report is then never skipped. Of the reports supplied with Alloy Navigator, only SSP Search List is designed to skip an empty result, and it offers the parameter in both applications.

Disabled jobs

A disabled job does not start on its schedule, but Run starts it.

The supplied reporting job

A new 2026.1 database created with the Default Workflow contains one reporting job (see Default Workflow Configuration). An upgraded database need not have this job, and an administrator may have changed or deleted it.

  • The job is named Daily SSP Searches Report and is supplied disabled, so it does not start on its schedule (see Disabled jobs).
  • Its schedule is set to daily, once, at 23:00.
  • It is set to run the SSP Search List report, export it as PDF, and send it by e-mail rather than save it to a file.
  • Its subject is set to "Daily SSP Searches Report", and its recipient to the placeholder %[WFP System Administrator.Primary_Email]%.
  • Its report parameters are set to group the report by person, cover the current day, show the results the report labels Failed (the report's own default is All), and not deliver an empty report.