9.2 Running HCM Reports

Purpose: Use this document as a reference to enter the request parameters used to define processing rules and data to be included when a report is run.  

Audience:  HR Administrators and HR Specialists

Navigation:  Workforce Administration > Workforce Reports > Employee Turnover Analysis

Running HCM Reports

  1. A user can run this report by searching for an existing Run Control ID or a user can add a new value.  Creating a new Run Control ID, that is relevant to the report may help you remember it for future use - Select the Add a New Value tab.
  2. A Run Control ID is an identifier that, when paired with a user's User ID, uniquely identifies the process a user is running.  The Run Control ID defines parameters that are used when a process is run.  This ensures that when a process runs in the background, the system does not prompt a user for additional values.
  3. Enter the desired information into the Run Control ID field.  
  4. Select the Add button.
  5. Use the Employee Turnover Analysis page to enter the request parameters.  These parameters will be used to define the processing rules and data to be included when the report is run.  The parameters will vary depending on which report you are running.  For example, when other reports might have field where a user specifies the SetID, Employee ID, or Department values before running the report.
  6. For this report, a user must identify the values for the From Date and Thru Date fields.  A user is running this report for the last five years.
  7. Select the From Date field - Enter the desired information into the From Date field.
  8. Select the Thru Date field - Enter the desired information into the From Date field.  
  9. Select the Run button.
Report Request Parameters section
  1. Use the Process Scheduler Request page to enter or update parameters, such as server name and report output format.
  2. A user must select a Server Name to identify the server on which the report will run.  If a user uses the same Run Control ID for subsequent processes, the server name that you last used will default into this field - Select the Server Name list.
  3. Select the PSUNX list item.
  4. Use the Run Date field to specify the desired date on which the process should run.  This gives a user the ability to set a report to tun on a future date.
  5. Use the Recurrence field to specify the recurring time intervals for a process request to run.  For instance, if a user needs to run a process every weekday at 5 PM that resolves all the transactions managed by a user's website, a user could select the run recurrence definition of M - F at 5 PM to schedule this process to run at the appropriate time.  
  6. Use the Run Time field to specify the time a user wants the process to run.  This gives you the ability to set a report to run at a future time.
  7. Use the Reset to Current Date/Time button to set the Run Date and Run Time to the present date and time.
  8. Use the Time Zone field to select the time zone in which the process will run.  For example, a user might be in Eastern Standard Time (EST), and schedule a process to run in Pacific Standard Time (PST).
  9. The Description field helps to uniquely identify a process.  A user should be familiar enough with the process that a user runs as part of their daily tasks to identify them in this description.
  10. The Process Name field displays the name of the process as it appears in the definition.
  11. The Process Type field displays the type of process, such as SQR report, BI Publisher, and so on.
  12. Use the Type field to select the type of output you want to generate for this job.  Your four choices are File, Printer, Email or Web.
    1. File:  This enables a user to write the output to a file that will appear in the Output Destination that a user specifies.
    2. Printer: You can enter a custom printer location if you have the appropriate security access.  
    3. Email: You can enter the destination information to send to a particular email recipient(s).  Note that Email is available only for a few process types, such as SQR, PS/nVision, and BI Publisher reports.
    4. Web:  Sends all output of the process to the report repository, including log and trace files.
  13. Use the Format field to define the output format for the report.  The values are dependent upon the process type a user has selected.  In this example, the default value is PDF.  
  14. Select the OK button.
  15. The report is now running.  Notice that your report has been assigned a Process Instance number.  It is a good idea to make note of the Process Instance number for future tracking.
Process Scheduler Request page
  1. Now that the Process Scheduler has run the report, a user can use Process Monitor to monitor the status of the report.
    1. Use Process Monitor to:
      1. Check the status of the submitted process requests.
      2. Cancel process requests that have been initiated or are currently processing.
      3. Hold process requests that are queued, and queue process requests a user has put on hold.
  2. Select the Process Monitor link (see arrow in first image above) - Process Monitor supplies a user with two pages, the Process List page and the Server List page.  Use the Process List page to view the status of submitted report/process requests.  
  3. Use the fields in the View Process Request For group box to display specific processes based on the criteria entered in these fields.
  4. Use the User ID field to view the processes submitted by a User ID.  Usually, a user views their own User ID.  Leave this field blank to view all the processes that a specific user is authorized to view.
  5. Use the Type field to view a process type, such as Application Engine, BI Publisher, COBOL, DQR, or Application Engine processes.
  6. Use the Last fields to specify an interval of time by which to limit the process requests that appear in the list.  Enter a numerical value in the field, and then select a unit type:  Days, Hours, or Minutes.
  7. Use the Server field to view processes that are run on a particular server.
  8. Use the Name field to view all processes for a specific process name.
  9. Use the Instance fields to display results based on the process instance number.  This number is automatically generated when a process is requested.  
  10. Use the Run Status field to view processes by distribution status, such as Completed, or Error.
  11. Use the Distribution Status field to view processes by distribution status, such as Generated, Posted, or Not Posted.
  12. The Process List group box itemized all the requested process for the user, in this example PS.
Process List tab and page
  1. A user can get details about a particular process request by clicking the Details link in the Details column.  This opens the Process Detail page where you can view such details as request parameters and message logs - Select the Details link.
  2. Most of the items on the Process Detail page are display-only; however, a user can use some controls to modify the process run, as needed.
  3. The Process group box contains general information to help you identify the process request.  This is a display-only group, showing basic descriptive information about this process.
  4. The Run group box shows specific run information, such as the run control ID and the run location.  If the process runs on the server, the server name appears in the Server field and any run recurrence that a user has selected appears in the Recurrence field.
  5. The Update Process group box displays the actions you can take for this field depending upon the user authorizations and the current status of the request.  If a user is authorized, the user has the following options for a request:  Hold, Queue, Cancel, Delete or Restart.
  6. The Actions group box contains links to other pages that provide additional details about the process parameters.
  7. Select the Parameters link to view additional information about the process parameters, such as run-time definition variables, the path and program used to run the process, the location of the completed output, and additional information about the process status.
  8. Select the Message Log link to view messages that are inserted into the message log by the program that is running.
  9. The Batch Timings link is only available for process requests with a process type of Application Engine.  The Batch Timings report contains a set of statistics that system administrators can use to tun the system to gain better performance.  This report relates specifically to PeopleSoft Application Engine program performance.
  10. When a user selects the View Log/Trace link, a new browser window opens, displaying links that enables a user to view the message log and trace file in a browser.  The View Log/Trace link appears on the Process Detail page when at least one of the following conditions is met:
    1. The output destination for the process request is Web, and the report and log files were successfully posted to the Report Repository by the Distribution Agent.
    2. The process has a run status of Success.
    3. The process request ran from a PeopleSoft Process Scheduled Server Agent that was set up using the Server Definition page with a distribution node.
  11. Return to the Process List page.
  12. Select the OK button.
Process Detail page
  1. The current status of the report is Success.  The report is finished running when it has a status of Success.  If report is not finished running, then status will be Processing.  How detailed the report is will dictate how long is takes to obtain a status of Success.  This report is not long, so a user will click the Refresh button after a few moments to update the run status.  For reports that take longer to run, it is a good idea to continue other work while the report is being run in the background; there is no need to watch and wait.
  2. Knowing the status of the job helps to see where it is in the queue or identify a problem if the process has an error.  The table below provides a list of run statuses and their descriptions.
  3. Now that the report has finished running, the user can run Report Manager to view the report.
  4. Select the Go Back to Employee Turnover Analysis link.
Process List
  1. Report Manager is like a user's own personal "inbox" of reports and process output.  It provides a secured means to view report content, check the posting status of the output, and see content detail messages - Select the Report Manager link.
Report Request Parameters section, Report Manager hyperlink
  1. The List page displays the reports from multiple databases to which a user has access.  Unlike the Administration page, the List page lists reports when both of the following events occur.  
    1. First, the Distribution Agent has successfully posted the report to the report repository.  Once the report has posted, the Distribution Agent published a message to have an entry added to the report folder table for the new report.  
    2. Second, the local message node has subscribed to the message that was sent by the Distribution Agent by adding an entry for the report in the report folder table.
List tab and page
  1. The Explorer page displays a hierarchical view of folders and reports.  Unlike the Administration page, the Explorer page lists reports when both of the following events occur.  
    1. First, the Distribution Agent has successfully posted the report to the report repository.  Once the report has posted, the Distribution Agent published a message to have an entry added to the report folder table for the new report.  
    2. Second, the local message node has subscribed to the message that was sent by the Distribution Agent by adding an entry for the report in the report folder table.  
Explorer tab and page
  1. Use the Administration page to view the report, view details about the report, and delete unwanted reports from the system.  New reports that have been scheduled or are in the process of being posted to the report repository are viewed only through the Administration page.The reports are listed in the Report list group box.  A user can sort this list by using the fields in the View Reports For section of the page.
  2. The Employee Turnover Analysis report is at the top of the list, and the status is Posted.
  3. In Report Manager, there are several status possibilities.  Knowing what they will mean will help a user understand the progress of the job without having to check the Process Monitor.  The table below lists the statuses and its description.  For example, Posted means the report has finished posting and it ready to be viewed, and/or deleted.
  4. Because of the status of the report is Posted, the user may now view the report.  Select the Details link.
Administration tab and page
Status of report, details hyperlink
  1. The link for the report contains the process name followed by the process instance number.
  2. Depending on the browser set up, a second browser window, or browser tab is opened to display the report in PDF format.
  3. Review the Employee Turnover Analysis report.  If desired, a user can also print this report by using the browser's print button.
  4. Return to the Administration page after you are done reviewing the report.  Select the Close button.
  5. Select the OK button.
  6. If a user is authorized to delete a report, the Select box will be active.  This enables a user to select the report and then select the Delete button to remove the report from the list.  Note that a user must be assigned the ReportDistAdmin (Report Manager Administrator) or ReportSuperUser (super user) role in PeopleSoft Security to be able to delete a report in Report Manager.
  7. End of procedure.
Report Detail page, PDF report link