Created on 2/4/2010 9:13:00 AM
COPYRIGHT & TRADEMARKS Copyright 1998, 2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are commercial computer software or commercial technical data pursuant to the applicable Federal Acquisition Regulation and agencyspecific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services.
Table of Contents Training Guide...1 Using Process Scheduler... 1 Running Campus Solutions Reports... 2 Page iii
This module demonstrates how to generate Campus Solutions reports using PeopleSoft Process Scheduler. Running a report culminates in a printable list of results. You can also submit a process request to run programs to edit, update, delete, or otherwise manipulate in mass, the data in your database. Upon completion of this module, you will be able to run a report in Enterprise Campus Solutions 9.0. The steps for submitting a request to run a report are the same as for submitting a request to run a program. You can use Process Monitor to monitor the progress of either reports or programs. With reports however, you also use Report Manager to view the report. Using Process Scheduler Process Scheduler is used to run PeopleSoft system processes. Processes are programs that add, update, or retrieve data. In some cases a process retrieves data and generates a printable report, called "running a report." In other cases, a process posts or adjusts data in mass, called "in batch," either in real time or at the times that you schedule the process to run. More specific examples of Campus Solutions processes include running transcript reports, posting grades, loading test scores, and calculating financial aid. All of these are performed behind the scenes of your online system. There are several advantages to using Process Scheduler to generate reports and run batch programs. Process Scheduler advantages include: System Efficiency: Data-centric processes can run close to the database on high-powered servers. Non-data-centric processes can run anywhere. Low Administration Overhead: User accounts on servers are unnecessary. Users don't need to know additional passwords to run processes. End-User Productivity: Users don't need to know the syntax of running a report, or any process, for that matter. Workstations remain available for other tasks while a process runs in the background on a server. Process Scheduler enables you to run reports and programs one at a time per your request. For example, you may want to run a report that generates a class attendance report. You might want to schedule that report to run daily at 6:00 PM. You might also want to run a program to update personal data, including address and phone number changes. You might schedule it as a recurring report to run at specified recurring times, such as every Friday at 11:00 PM. Process Scheduler enables you to run reports and programs easily and efficiently without interruption to your workstation. A report or program may be running at the same moment that you are reconciling financial data in a spreadsheet or entering personnel data into a database-- whatever the case may be for your particular position. In short, you can continue your daily work routine while Process Scheduler takes care of running your reports and programs. Page 1
Before beginning, it is important to understand a few basic Process Scheduler terms. Process Request: A single "run request," such as an SQR or Crystal report, or batch program. Run Control ID: A unique ID, associating each operator with his or her own run control table entries. Process Instance: A unique number that identifies each process request. This value is automatically incremented and assigned to each requested process when the process is submitted to run. Upon completion of this lesson, you will be able to run a report using Process Scheduler. Running Campus Solutions Reports You can run a process to retrieve data from your database and generate a report. Each process requires you to specify the criteria to use to determine the data to retrieve. Some processes may require more setup than others. After you specify parameters and submit the request to Process Scheduler, you can use Process Monitor to monitor the status of your request. Monitoring the status is optional. After a process reaches the status of Success, you can use Report Manager to view the report. Remember, the steps are the same to run a program to update, edit, or delete data in your database, it's just that a request to run a report culminates in a printable list of results. In this topic, you will run a sample report. Procedure Page 2
1. For this example, you will be using the Academic Requirement Group report. Begin by navigating to the run control parameters page. Click the Academic Advisement link. 2. Click the Academic Requirement Group link. 3. You can run this report/process by searching for an existing Run Control ID or you can add a new value. Creating a Run Control ID that is relevant to the report may help you remember it for future use. Page 3
4. Use the Run Control search page, in this example, the Academic Requirement Group run control search page, to enter a Run Control ID. A Run Control ID is an identifier that, when paired with your User ID, uniquely identifies the process you are running. The Run Control ID allows for important parameters to be available for a process when the process runs. This ensures that when a process runs in the background it does not have to prompt you for any additional values. All parameters are stored within the system and associated with Run Control IDs and User IDs. 5. By creating your own Run Control ID, you can save it and all of the assigned parameters so that you can easily access this report again in the future. For this example, assume that your name is Quinn and you want to create a Run Control ID using your name. Click the Add a New Value tab. 6. Enter the desired information into the Run Control ID field. Enter "Quinn". Page 4
Training Guide 7. Add the new value and access the run control parameters page, for this example the Advisement Group Summary page. Click the Add button. 8. Use the run control parameters page, for this example the Advisement Group Summary page, enter the request parameters. These parameters will be used to define the processing rules and data to be included when the report/process is run. 9. Run control pages and their parameters will vary depending on the report that you are running. For example, other reports might have fields where you specify instructor name, campus, and to/from date values before running the report. 10. Enter parameters for generating an Academic Group Summary report for the undergraduate liberal arts group. Click in the Academic Career field. 11. Enter the desired information into the Academic Career field. Enter "UGRD". 12. Click in the Academic Program field. Page 5
13. Enter the desired information into the Academic Program field. Enter "LAU". 14. Click the Honor Blank Values option. 15. Access the Process Scheduler Request page to begin to run the process. Click the Run button. 16. Use the Process Scheduler Request page to enter, update, or view general process parameters, such as server name and process output format. 17. You must select a Server Name to identify the server on which to run the process. If you use the same Run Control ID for subsequent processes, the server name that you used last will default in this field. Click the Server Name list. 18. Click the PSNT list item. Page 6
Training Guide 19. Use the Recurrence field to specify the recurring time intervals for a process request to run. For instance, if you need to run a process every week day at 6 PM. that resolves all the transactions managed by your website, you could select the run recurrence definition of M-F at 6 PM. to schedule this process to run at the appropriate time. 20. Use the Time Zone field to select the time zone in which the process will run. For example, you might be in Eastern Standard Time (EST) and schedule a process to run in Pacific Standard Time (PST). 21. Use the Run Date field to view or specify the date when you want the process to run. This gives you the ability to set a report to run on a future date. 22. Use the Run Time field to view or specify the time you want the process to run. This gives you the ability to set a report to run at a future time. 23. Use the Reset to Current Date/Time button to set the Run Date and Run Time to the present date and time. 24. The Description field helps to uniquely identify a process. You should be familiar enough with the processes that you run as part of your daily tasks to identify them by this description. 25. The Process Name field displays the name of the process as it appears in the definition. 26. The Process Type field displays the type of process, such as SQR, Crystal, and so on. 27. Use the Type field to select the type of output that you want the process to produce. The four output Types are: File: This enables you to write the output to a file that will appear in the Output Destination. Printer: You can enter a custom printer location if you have the appropriate security access. Email: You can enter the destination information to send to a particular email recipient(s) Note that Email is available only for SQR, PS/nVision, and Crystal. Web: Sends all output of the process to the report repository, including log and trace files. 28. Use the Format field to define the output format for the report. The values are dependent upon the Process Type that you select. For example, the default format for Web is PDF, and the default for Crystal and PS/nVision is HTML. 29. Accept the values you entered and navigate back to the run control page, for this example, the Advisement Group Summary run control page. Click the OK button. Page 7
30. Notice that your report has been assigned a Process Instance number. This indicates that the process has been submitted to Process Scheduler. It is a good idea to make a note of the Process Instance number for process monitoring. 31. After the process is submitted to Process Scheduler, use the Process Instance number and Process Monitor to monitor the process status. You can use Process Monitor to: Check the status of your submitted process requests. Cancel process requests that have been initiated or are currently processing. Hold process requests that are queued, and queue process requests you have put on hold. 32. Access the Process List page, which is the first page of Process Monitor. Click the Process Monitor link. 33. Use the Process List page to view the status of submitted process requests. 34. Use the fields in the View Process Request For section to display specific processes based on the criteria entered in these fields. Page 8
Training Guide 35. Use the User ID field to view the processes submitted by a user ID. Usually, you view your own user ID. Leave this field blank to view all of the processes that you are authorized to view. 36. Use the Server field to view processes that are run on a particular server. 37. Use the Run Status field to view processes by a specific status, such as Completed or Error. Leave the field blank view to all processes regardless of Run Status. 38. Use the Type field to view only processes of a specific type such as Application Engine, Crystal, COBOL, SQR, or Application Engine processes. Leave the field blank to view all processes regardless of Type. 39. Use the Name field to view all processes for a specific process name. Leave the field blank to view all processes regardless of Name. 40. Use the Distribution Status field to view processes by distribution status, such as Posted or Error. Leave the field blank to view all processes regardless of Distribution Status. 41. Use the Last fields to specify an interval of time by which to limit the process requests that appear in the list. Enter a custom numerical value in the field, and then select a unit type: Days, Hours, or Minutes. 42. Use the Instance fields if you want to display results for a range of process instance numbers. Leave the fields blank to view all processes run that day, regardless of Process Instance number. 43. The process Instance number helps you identify the process that you submitted, which is the process whose status you want to check. 44. The current status of this report is Queued. The report is finished running when it has a status of Success. 45. Knowing the status of your job helps you to see where it is in the queue or identify a problem if the process has an error. Page 9
46. You must click Refresh to update the Run Status for your process. How detailed a report is dictates how long it takes to obtain a status of Success. The report for this example is not long, so you will click Refresh only once to update the Run Status. You can continue with other work while your report is running in the background; there is no need to watch and wait. However, if you want to monitor the progress, can click Refresh as often as you want. Click the Refresh button. 47. The process is finished when the Run Status is Success. 48. Access the Process Detail page. Click the Details link. 49. Use the Process Detail page to view such details as request parameters and message logs. 50. 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 the process. Page 10
Training Guide 51. 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 you have selected appears in the Recurrence field. 52. The Update Process group box displays the actions you can take for this field depend on your user authorizations and the current status of the request. If you are authorized, you have the following options for your request: Hold, Queue, Cancel, Delete, or Restart. 53. The s group box contains links to other pages that provide additional details about the process parameters. 54. Click the Parameters link to view additional information about the process parameters, such as runtime definition variables, the path and program used to run the process, the location of the completed output, and additional information about the process status. 55. Click the Message Log link to view messages that are inserted into the message log by the program that is running. 56. 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 tune the system to gain better performance. This report relates specifically to PeopleSoft Application Engine program performance. 57. When you click the View Log/Trace link, a new browser window opens, displaying links that enable you 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: 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. The process has a run status of Successful. The process request ran from a PeopleSoft Process Scheduler Server Agent that was set up using the Server Definition page with a distribution node. Page 11
58. Click the OK button. Page 12
59. Now that your report has finished running, you are ready to use Report Manager to view your report. Return to the run control page, in this example, the Advisement Group Summary run control page. Click the Go back to Academic Requirement Group link. 60. Report Manager is like your own personal "in box" of reports and process output. It provides a secured means to view report content, check the posting status of your output, and see content detail messages. 61. Access the List page, which is the first page of the Report Manager component. Click the Report Manager link. Page 13
62. Use the List page to view a list of reports from multiple databases to which you have access. Unlike the Administration page, the List page lists reports when both of the following events occur. First, the Distribution Agent has successfully posted the report to the report repository. Once the report has posted, the Distribution Agent publishes a message to have an entry added to the report folder table for the new report. 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. 63. Use the Explorer page to see a hierarchical view of folders and reports. Unlike the Administration page, the Explorer page lists reports when both of the following events occur. First, the Distribution Agent has successfully posted the report to the report repository. Once the report has posted, the Distribution Agent publishes a message to have an entry added to the report folder table for the new report. 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. 64. Use the Administration page you 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. 65. Use the Archives page to view reports that have been archived. Page 14
66. For this exercise, you need to navigate to the Administration page to view the report. Click the Administration tab. 67. The reports are listed in the Report List section of the page. You can sort the list by clicking the headings in the columns. 68. The Group Advisement Summary report with your instance number, is at the top of the list, and the status is Posted. 69. In Report Manager, there are several status possibilities. Knowing what they mean will help you to understand the progress of your job without having to check the Process Monitor. Page 15
70. Because the status of your report is Posted, you can access the Report Detail page to view your report. Click the Details link. Page 16
71. The link for the report contains the process name followed by the process instance number. Access the report. Click the SRGRPADV_713.PDF link. 72. The system opens a new browser window to display the report. (You might need to expand the browser window to view a report). Review the report, in this example the Advisement Requirement Group Summary Report. You can print the report by using the browser's print button. Page 17
73. After viewing the report, return to the Report Detail page in the original browser window. Click the Close button. Page 18
74. Continue clicking to return to the Report Manager component. Click the OK button. 75. If you are authorized to delete a report, the Select check box is active. This enables you to select the report and then click the Delete button to remove the report from the list. Note that you 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. For this example, you do not have this authorization and you do not need to delete a report. 76. You have successfully set parameters to run a report, submitted the request to Process Scheduler, viewed the process status using Process Monitor, and viewed the report using Report Manager. End of Procedure. Page 19