Page tree
Skip to end of metadata
Go to start of metadata

This topic describes the purpose of the REPORT_SYSTEM system properties file. The REPORT_SYSTEM file contains basic information about the running of reports. To make bigger configuration changes to your reports, you must work within the Report Framework.

System Admin > Configuration > System Configuration > REPORT_SYSTEM

 

Administrator Report Preference

This topic describes the properties in REPORT_SYSTEM that control the search and browse functionality of administrators' report search system. 

Property       Description

reportLazyPersistence

The reportLazyPersistence property controls whether Administrators' search preferences are "sticky" in SuccessFactors Learning Administration. If sticky, the application remembers what the administrators last searched on and persists it into the database. The next time the administrators open the Reports pages, their search settings are defaulted to their last search. Set to false to make the search preferences sticky.

reportPerferencesHandler

The reportPerferencesHandler property contains the class that handles "sticky" report preferences. Do not change unless you have written a new class to handle preferences. Check with a SuccessFactors representative for more information.

 

Asynchronous Reports

This topic describes how you can control asynchronous report behavior in REPORT_SYSTEM.

With SuccessFactors Learning 6.4 and later, all reports are asynchronous; therefore, any changes you make to these settings affect all reports. When administrators run a report as a background job, the system generates the report at the scheduled time and stores it in the database. Even though all reports are asynchronous, administrators still click Run Report, which gives the impression that it’s a synchronous report. When administrators try to run a report immediately in this way, the system schedules it for immediate background execution, but with the timeout specified by the onlineTimeoutPeriod property. If they schedule the report, then the system uses the timeout specified by the backgroundTimeoutPeriod property.

PropertyDescription

asyncStorageMaxSize

The asyncStorageMaxSize property contains the maximum size (in bytes), after which the system aborts attempts to store the report in the database.
Suggested Value: 10048576
Maximum Value: Email being send from the LMS system has a maximum limit of 10 MB. If you are NOT using Email to send the report, then you can technically increase asyncStorageMaxSize.
Example:
asyncStorageMaxSize=10048576

asyncStorageTTLDays

The asyncStorageTTLDays property contains the number of days after which the system removes a report that is stored in the database.
Suggested Value: 30
Maximum Value: You can increase this value, but be aware that your database-table size may increase
Example:
asyncStorageTTLDays=30

asyncEmailedReportFileName

The asyncEmailedReportFileName property contains the default file name when the report is sent as an e-mail attachment. The format of the report is appended (.xml, .html, .pdf, or other extensions).
Suggested Value: Report
Example:
asyncEmailedReportFileName=Report

scheduleOnlyReports.*

The scheduleOnlyReports properties contain reports that can only be run as scheduled reports. The reports still appear in the Reports section, but users cannot execute them concurrently; they must schedule them. If you know that some reports always take a long time to run, you can force users to schedule them. Each report that you want to force as schedule only is a suffix to the scheduleOnlyReports property. For example, scheduleOnlyReports.UserCurriculumStatus makes the curriculum status report schedule only. The report name is stored in the database, within the PA_REPORT table, in the REPORT_NAME column.
Suggested Value: All huge reports, Audit reports
Example:
scheduleOnlyReports.UserCurriculumStatusCSV=false
scheduleOnlyReports.CustomerUsageData=true

onlineTimeoutPeriod

The onlineTimeoutPeriod property contains the time limit on all reports run online (by users clicking the report in SuccessFactors Learning). If the report takes longer than the timeout, execution stops, an error is logged if logging is set to DEBUG, and users see an alert that tells them the report has taken too long to generate. Additionally, the next time users try to run a report that has timed out, they see a message telling them that previous attempts at the report did not run due to timeout settings.
When a PDF format report times out, the user can see a “poorly formed PDF document” error.
Suggested Value: 300
Maximum Value: This should be less than your LMS session-timeout (30 Minutes).
Example:
onlineTimeoutPeriod=300

backgroundTimeoutPeriod

The backgroundTimeoutPeriod property contains the time limit for all background reports. If a report exceeds the timeout, Learning stops the report and logs a message about the failure. SuccessFactors Learning logs the message if the logging level is set to DEBUG.
Suggested Value: 1000
Maximum Value:  Background Timeout Period is independent of session-timeout. Technically you can set it to >1800
Example:
backgroundTimeoutPeriod=1800

 pdfMaxPageCountThe pdfMaxPageCount property defines the Maximum page count for a pdf document. If the report exceeds this length, the report generation will be aborted and the user will be informed.
Suggested Value: 2000
Maximum Value:  
Example:
pdfMaxPageCount=2000
reportSpecificPDFMaxPageCount.*The reportSpecificPDFMaxPageCount property defines the optional set of maximum page counts for specific reports that will override the global setting above. The report name is stored in the database, within the PA_REPORT table, in the REPORT_NAME column
Example:
reportSpecificPDFMaxPageCount.PerformanceReviewStatusByStatus=250

 

Link: http://wiki.scn.sap.com/wiki/x/bJDSFw

 

 

 

  • No labels