Scheduling Reports

Objective

After completing this lesson, you will be able to schedule reports in SAP SuccessFactors Learning.

Report Jobs Tab

The Report Jobs tab lists scheduled recurring report jobs. It is best practice to schedule large reports to run during the times of the day when the system may be less busy, such as evenings or weekends. The maximum time for reports to run is 24 hours and the maximum file size for each report is 5GB. The system returns a validation error if it determines that the report job would exceed either maximum value.

Jobs are listed on this tab when Administrators schedule reports to run on a recurring basis with specific criteria. Administrators can view their own scheduled report jobs, as well as those of their colleagues, by selecting the Owner Name in the search panel.

You can also view the results of the report jobs, edit their schedules, delete them, and add or change the email address.

The Reports Screen

Each selected report is divided into two main sections: formatting fields and search criteria.

The Formatting fields area is above the Search Criteria area. They are highlighted to show where they are located.

Formatting Fields

There are various formatting options available. These include:

  • Report Title, Header, and Footer: These fields allow you to modify the text and formatting of the report title, header, and footer sections.
  • Report Destination: This option determines where the generated report will be sent. You can choose between sending the report to the browser or saving it as a local file.
  • Determine the report format: The table lists the available report formats and their usage. When selecting CSV, you may also select Tab, Comma, Pipe, Semicolon, Carat, or Tilde from the dropdown for CSV Report Delimiter.
  • Report Format: This option allows you to select the desired format for the report.

When you select the Report Format picklist, the following options are available to you:

FormatUsage
XML – rarely used (May not be available for all reports)Import the data into a database and for trouble shooting a report.
CSVOpen the data in a spreadsheet format, in an application like Microsoft Excel, or import data into a database, such as Microsoft Access. Although CSV reports typically output as comma separated values, Administrators have the option to choose a different delimiter.
HTMLView results quickly in a browser window.
PDFPrint, save, and email the report.

Search Criteria

Each report displays its own specific criteria at the bottom of the Run Report screen. The Administrator may search for and select the values for the entities that the report uses to generate its results. Report screens filter the data that the report returns using its specific search fields.

Many reports also contain the following controls for filtering the data that you want to return:

  • Mask User IDs: For security reasons, the system can mask the user IDs so that they displays as a series of asterisks. Select the checkbox to hide user IDs.
  • Case sensitive search: You can choose to perform a case-sensitive search or a case-insensitive search. Case-sensitive searches return data elements only when the characters and case match. Case-sensitive reports run faster than case-insensitive searches.
  • Page Break Between Records: For longer reports, there is an option to insert page breaks between records.
  • Filter by Criteria: Some fields in the report screen contain a Filter by Criteria icon. When you select the icon, a pop-up window opens that contains multiple search fields in which you can select a set of data rather than a single data element.

Filter Criteria for Saved Reports

If you are saving a report to be run at a later time or scheduling a report to run on a recurring basis, search filters can make the process more efficient. Establishing filters allow the Administrator to specify what data should be included in the report. Once the data is added to the filter and the filter is submitted, the report can be scheduled.

Scenario:

Chase wants to get information on all the employees who report to Marcus Hoff. To do this, Chase searches for Marcus Hoff as the manager and manually adds each subordinate's ID to the filter. This means Chase is creating a fixed list of users for the report.

But what happens if Marcus gets a new subordinate next week? Chase would have to search again and add the new subordinate to the filter to include them in the report. This can become tedious and time-consuming.

A simpler and more efficient method, especially if you want to save the report or run it regularly, is to search for all the users who have Marcus Hoff as their manager and use Submit Criteria to capture this as a rule. This rule can be saved in the search or report, and it will automatically includes anyone who meets the criteria now and in the future. So, the next time the report is run, it will automatically include any new subordinates that Marcus has.

Scheduled Reports

Any report can be scheduled to run one time in the future or recur on a daily, weekly, or monthly interval. Scheduling a report can be especially useful in the following conditions:

  • You want to run a report that will return a large volume of records: by scheduling the report to run once at a later time during low usage, you reduce the report's strain on the system.
  • You need to run a report periodically: this can easily be achieved by scheduling the report to run on a recurring basis.

On the Run Report screen,schedule a report by selecting the Schedule Job button.

The Schedule Job button is located on the bottom of the screen between the Run Report and Save Report buttons. The button is highlighted.

After selecting the Schedule Job button, you will see the following different options for scheduling:

  • Run the job immediately: This is the same as choosing the Run Report button on the previous page.
  • Schedule the job to run once in the future.
  • Schedule the job to recur on a daily, weekly, or monthly basis.

If you want to receive an email notification when the report has finished running, you can select the Notify via email upon completion checkbox and enter one or more email addresses. If you also want the report to be sent as an email attachment to yourself or someone else, you can select the Email the Report checkbox.

You can enter multiple email addresses in the email address field, separating them with a comma, semicolon, or colon. Once the report has finished running, you can download it from the Report Jobs tab in the report interface. Reports that are scheduled to run only once display under System AdministrationBackground Jobs .

After the report has run as a background job, you can retrieve the Report Query data as a text file.

The “Schedule this job to recur as follows” checkbox and the “Notify via email upon completion checkbox” are selected and these areas are highlighted.

In this example, the report runs every Sunday at 12 AM, EST and sends copies of the report to Marcus Hoff and Lyndsey Abel.

When is Report Designer Necessary to Modify a Report?

There are many standard generic reports that may be useful to customers without modification to the report’s design. Most reports may be filtered by using advanced searching capabilities within existing search criteria fields.

However,if it is necessary to add additional search criteria or output fields to an existing report, an external tool called Report Designer may be used.

Report Designer (also known as Plateau Report Designer as powered by BIRT – Business Intelligence Reporting Tool) is a separate software program that may be installed on the computer of anyone who will be modifying reports. A report design Administrator will need access to certain permissions in SAP SuccessFactors Learning, such as the ability to import and export reports, publish reports, and view and run unpublished reports. An understanding of the tool, SQL, (Structured Query Language) as well as the various database tables of SAP SuccessFactors Learning are required in order to be an effective report developer.

Please note that SAP SuccessFactors People Analytics Story reports now include data from SAP SuccessFactors Learning. Some of the reasons customers needed to customize reports in the past (such as adding or removing certain data fields, for example) may be available as standard functionality in People Analytics Stories. Customers should consider learning and using People Analytics Story reports for their reporting needs and make an educated decision before investing time and effort customizing reports if it’s not necessary to do so.

Note

More information about this tool and the process is available in the Report Designer training course (HR868).

Summary

  • The Report Jobs tab enables administrators to schedule recurring reports, view report results, edit schedules, and manage email notifications for report completion.
  • Scheduled reports can be configured to run during off-peak hours (e.g., evenings or weekends) to optimize system performance and avoid exceeding limits (24-hour runtime or 5GB file size).
  • Formatting options for reports include customizing titles, headers, footers, output destinations, and file formats (CSV, PDF, HTML, etc.).
  • Search criteria and filters allow administrators to refine report outputs, either by manually specifying data parameters or applying dynamic rules for recurring reports.
  • Scheduling options include running reports immediately, one-time scheduling, or setting daily, weekly, or monthly recurrences, with optional email notifications for completion or attachments.
  • Report Designer may be used if more advanced modifications are needed.