Enterprise PeopleTools 8.51 PeopleBook: PeopleSoft Process Scheduler

Using Reporting Console

This chapter provides an overview of Reporting Console and discusses how to:

Set display preferences.
Use My Favorites.
Create new definitions.
Run a quick report.

Understanding Reporting Console

The Reporting Console provides a single interface for a user to manage and schedule reports. From the Reporting Console users can run a report, schedule a report, and organize reports.

Not all reports can be run from the Reporting Console, only reports that have Generic Prompting enabled will be available. Some reports require specific application run control pages for business logic and therefore should never be run from the Reporting Console.

The Reporting Console provides folders to organize and display requests and reports, as well as links to reporting tasks and functions.

Folders

The Reporting Console has 3 folders available:

My Reports

This folder has a link to all reports for the user. The reports displayed in this folder are based on the preferences for the user. This is the same list of reports as found in the Report Manager. From the Reporting Console, you can not filter reports, however there is a link to the Report Manager.

This folder is intended to alert users to newly shared reports, similar to an E-mail inbox. Entries to this folder are always made by the system. The reports a user has access to will display in chronological order.

My Processes Requests

This folder displays all the process requests the user has access to monitor with the current status. This is the same list of processes the user would see in the Process Monitor for their user ID. From the Reporting Console, you can not edit the process request, however there is a link to the Process Monitor.

My Favorites

This folder is used to add process bookmarks. You can create folders to organize your processes. From the bookmarks, you can edit a process , run a process or delete the process bookmark.

Links

The Reporting Console has links for the following:

Preference	This link allows the user to set the display preferences for the Reporting Console.
New	This link allows the user to create new process and report definitions.
Quick Run	This link allows the user to run a report or process.
Process Monitor	This link will open the Process Monitor.
Report Manager	This link will open the Report Manager.

Security for Reporting Console

In the Reporting Console, the access rights are assigned to users with PeopleSoft security roles and user IDs.

This table lists the actions available based on object type.

Tasks	Privileges
Bookmark	The actions associated with the bookmark depend on the user's security for the process. Edit: available if the user has access to the process definition. Run: available if Enable Generic Prompting is enabled for the process. Permissions for the generic prompting page are defined on the Runtime Parameters page for the process definition. Note. If Enable Generic Prompting is not selected in the process definition, the Run option is not available in the Reporting Console even if the user has rights to run the process. See Setting Runtime Parameters. Delete: always available.
My Process Requests	Displays the process requests the user has access to view.
My Reports	Displays the report instances the user has access to view, similar to Report Manager Administration page. Note. Report instances generated from a remote system are not included.

Setting Display Preferences

This section discusses how:

Set initial display preferences.
Edit display preferences.

Pages Used to Set Up Reporting Console

Page Name	Definition Name	Navigation	Usage
Reporting Console	PT_CONSOLE	Reporting Tools, Reporting Console	Organize, schedule and view reports.
View Preferences	PTRC_VIEWPREF	Reporting Tools, Reporting Console Click the Click here to setup display preferences link or Select Preference link	Set up initial preferences or edit preferences.

Setting Initial Display Preferences

To access the Reporting Console, select Reporting Tools, Reporting Console

The Reporting Console is set up for each individual user. The first time a user accesses the Reporting Console, a link is displayed to set up reporting preferences. The user can also change preferences at any time using the Preference link.

Editing Display Preferences

To access the View Preferences page after the initial set up, select Reporting Tools, Reporting Console and click the Preference link.

Default Folder

The default folder section allows you to determine which folders to display and the order or the folders.

Display Order

Enter the numerical sequence for the folders.

Active Flag

Select this check box if you want the folder to appear in the Reporting Console.

Note. At least one folder must be marked as active.

Process Link Display Option

Use this section to customize the display for My Favorites.

Name Only	Select this radio button to display only the process name.
Description Only	Select this radio button to display only the process description.
Name and Description	Select this radio button to display both the process name and process description.

Display Options for My Process Requests

Use this section to customize the display for My Process Requests.

User ID	Select the user ID to display.
Run Status	Select the run status to display. Leave blank to display all statuses.
Type	Select the process type to display. Leave blank to display all process types.
Name	Select a specific process name to display. The process names available are based on the type selected. Leave blank to display all names.

Display Options for My Reports

Use this section to customize the display for My Reports.

Distribution Status

Select the distribution status to display. By default, report instances with distribution status Posted are displayed.

Show Instances for

These settings apply to folders where report or process instances are displayed.

Last or Date Range

Specify an interval of time by which to limit the process requests that appear in the list.

Select Last to display only those reports that were created in the last number of days, hours, years, or minutes. Enter a custom numerical value in the field and then select a unit type: Days, Hours, Years, Minutes, or All.

If you select All, the time interval fields will be grayed out and all process requests will appear.

Select Date Range to display only those reports created between two specific dates. Enter a From date and a To date.

Display Latest

Enter the number of instances to display.

Process Request Notification

Enabled

Select this check box to receive a pop up confirmation message when a process is submitted.

Note. This notification setting does not apply to nVision process requests submitted from the Reporting Console.

Using My Favorites

This section provides an overview of My Favorites folder and discusses how to:

Add folders.
Add a process bookmark.
Run process.
Edit a process.
Delete a process bookmark.

Understanding My Favorites Folder

Within the My Folders folder, users can build their own hierarchy of sub-folders to organize, access and monitor frequently accessed processes. Folders are used for organizing the processes and bookmarks are used to edit or run processes or jobs. When you add a process bookmark, the system will automatically add the appropriate links based on your permission to the process or job.

This is an example of My Favorites configured with some sub-folders and bookmarks.

Folders

Plus or minus icons will appear next to a folder if it contains any sub-folders or bookmarks, use these icons to expand and collapse the folder. Collapsing and expanding the folder will also refresh the contents.

For each sub-folder that is added, an Add and Delete link is available.

Add	Use the Add link to add sub-folders or process bookmarks within the folder.
Delete	Use the Delete link to remove the folder. Only empty folders can be removed.

Bookmarks

Plus or minus icons will appear next to a bookmark if it contains any process instances, use these icons to expand and collapse the bookmark folder. The bookmark will display process instances run by the logged on user.

For each process bookmark, the system will display a Delete link. The Edit or Run links depend on the users permissions.

Edit

The Edit link will be available next to the bookmark if user has permission to edit the process definition.

Note. In PeopleTools 8.50, you can not create a private query and a public query with the same name in PeopleSoft Pure Internet Architecture, however if a query is created using the legacy window client PSQuery, this occurrence may still exist. If a public and private query exist with the same name, the Edit link for the query will open the private query.

Run

The Run link will be available next to the bookmark if user has permission to run this process.

Note. For process definitions, the process definition must have generic prompting enabled in order to run the report from the Reporting Console.

See RunTime Parameters.

Process Instance

After you run reports defined in My Favorites, the process instance is displayed in the bookmark folder, showing the current status.

View

For process instances, click this link to display the process instance details in the Process Monitor.

Note. For query-based reports, all process instances for a specific report type will be displayed. For example, if the report is a query-based XML Publisher report, you will see the Process Instance for all query-based XML Publisher reports.

Pages Used to Setup and Use My Favorites

Page Name	Definition Name	Navigation	Usage
Add New	PTRC_PRCSLIST	Reporting Tools, Reporting Console Click the Add link for My Favorites	Add a new folder or process bookmark.
Submit Request	PRCSGENRUNCNTL	Reporting Tools, Reporting Console Click Runnext to the process name	Run the process request.

Page Name

Definition Name

Navigation

Usage

Add New

PTRC_PRCSLIST

Reporting Tools, Reporting Console

Click the Add link for My Favorites

Add a new folder or process bookmark.

Submit Request

PRCSGENRUNCNTL

Reporting Tools, Reporting Console
Click Runnext to the process name

Run the process request.

Adding Folders

To add a folder:

From the Reporting Console home click the Add link for My Favorites.
Select the Folder radio button.
Enter the new folder name and click OK.

Adding Process Bookmarks for Processes

To add a process bookmark:

From the Reporting Console home click the Add link for next to the folder where you want to add the process bookmark.
Select the Process Bookmarks radio button.
Select the Process Type/Name radio button.
Select the Process Type.
Enter or select the Process Name.
Click the Search button and the Process List appears.
Select the check box for each process to bookmark.
Click Bookmark Selected.

The process bookmarks appear in the My Favorites folder.

In order run a process from the Reporting Console, the process must have Enable Generic Prompting selected in the Process Definition Runtime Parameters page. If any runtime parameters are required for the process, they also need to be registered in the process definition.

In the preceding page shot, the Run link is displayed for Data Designer/database Audit because generic prompting is enabled. System Audit does not have a Run link because generic prompting was not enabled for that process or the current user does not have permission to run the report.

See Setting Runtime Parameters.

Adding Bookmarks for PSQuery, Connected Query, XMLP Query-Based Reports or nVision Report Request

To add a process bookmark for a PSQuery, Connected Query, XMLP Query-Based Reports or nVision Report Request:

From the Reporting Console home click the Add link for My Favorites.
Select the Process Bookmarks radio button.
Select the radio button for the type of report (PeopleSoft Query , Connected Query, Query-Based XMLP Reports or nVision Report Request).

The Process Type and Process name will be displayed in read-only format for the selected process type:

Depending on the non-unique process an additional edit box is available to refine your report search as listed in this table:

Process Name	Additional Edit Box
PeopleSoft Query	Query Name
Connected Query	Name
Query-Based XMLP Report	Report Name
nVision Request	Report ID

Note. You could also use the Find link in the process list grid to further refine your search criteria.

Select the check box for each process to bookmark.
Click Bookmark Selected.

Running Requests

The Run link will be available next to the bookmarked process if the user has permission to run the process from the Reporting Console. The submit request page will differ based on the bookmark type and whether or not the process requires prompts. All of the submit pages will have the same buttons.

The submit request page appears. If the selected process has run control parameters defined, the parameters appear.

Use Saved Parameters

If you have previously run the process and saved parameters, you can select the saved parameters from the drop down list.

When a user selects one of the run control IDs from the drop down list, the system retrieves and populates the parameters values from the run control record and fields according to the parameters registered on the process definition.

Note. For non-unique prompting (PSQuery, Connected Query and XMLP Query-based reports), keep in mind the saved run control may not apply to the report you are attempting to run and therefore will not display the appropriate prompts.

Parameter Value

Enter values for each parameter.

Save

Use this button to save the parameter values entered. You will be prompted to enter a name.

You can save the parameter values without submitting the process to run.

Note. All required parameter values must be completed in order to save the run control ID.

Schedule

Use this button to run the process through the Process Schedule. The Submit Process page will appear.

See Scheduling Process Requests.

Run Now

Use this button to submit the process to run using the default process output type and format (the Submit Process page will not be displayed)

Note. A real-time event notification (REN) server must be configured and running for this option.

See Defining Event Notifications and Configuring a REN Server.

Note. This option is not currently supported by XMLP reports.

Cancel

Use this button to cancel the request.

Generic Prompting

The Reporting Console uses generic prompting to submit a process request. Users will enter parameters or retrieve saved parameters before submitting the request. The process or job must have Enable Generic Prompting enabled in the process or job definition for the Run link to be available from My Favorites.

See Setting Runtime Parameters.

See Setting Job Runtime Parameters.

Non-Unique Prompting

Runtime prompts for PSQuery, Connected Query and XMLP Query-based reports are not registered on a process definition. All of these are query based, therefore, the runtime prompts are determined by the prompts created for the query.

When any of these types of processes are run from the Reporting Console, the user will be prompted for query parameters if they exist. If there are no query parameters, the query prompting dialog is skipped. The query prompting page will mimic the prompting associated with the specific process type selected.

Process Type	Prompting page
PSQuery	similar to Schedule Query page
Connected Query	similar to Schedule Connected Query page
XMLP Query-based Report	similar to XMLP Query Report Scheduler page

nVision Reports

All nVision reports can only be scheduled from the nVision Report Request page. When an nVision report is run from the Reporting Console, the nVision Report Request page is opened to submit the report.

Editing a Bookmark

Click the Edit link for the appropriate bookmark in My Favorites.

The appropriate definition is displayed to edit based on the bookmark type as shown in this table:

Process Type	Page Displayed
Process	Process Definition Runtime Parameters (PRCS_RUNCNTL_PARAM)
PSJob	Job Runtime Parameters (JOB_RUNCNTL_PARAM)
Query Definition	Query Manager (QRY_FIELDS)
Connected Query	Connected Query Manager (PSCONQRSBUILDER)
XMLP Report Definition	XML Publisher Report Definition (PSXPRPTDEFN)
nVision Report Request	NVision Report Request (NVS_REPORT_RQST)

Deleting a Bookmark

Click the Delete link for the bookmark in My Favorites. A message will appear to confirm the delete.

Creating New Definitions

Click the New link on the Reporting Console to create new report definitions.

Note. Theses actions are only available to users who have administrative rights to add the specified definitions.

You will be transferred to the appropriate page based on the radio button that is selected as shown in this table:

Process Type	Page Displayed
Process Definition	Process Definition Add page
Job Definition	Job Definition Add page
Connected Query	Connected Query Manager (PSCONQRSBUILDER)
Query Definition	Query Manager (QRY_SELECT)
XMLP Report Definition	XML Publisher Report Definition Add page(PSXPRPTADD)

Running a Quick Report

Click the Quick Run link on the Reporting Console to run a report that does not have a bookmark.

The Quick Run link provides an option for a user to submit a process to run without having to bookmark it. Enter the search criteria and click Search. The search results will only display jobs and processes that:

Have the generic prompting enabled.
The user has permission to run in Reporting Console.

Using My Reports Folder

The View link next to the report will display the report instance details.

If a report is posted to the report repository, the report name will provide a link to open the report.

Using My Processes Folder

Based on the preferences selected, processes will be displayed in the My Processes folder in the Reporting Console.

To view process details, click the View link for the process.

Use Saved Parameters	If you have previously run the process and saved parameters, you can select the saved parameters from the drop down list. When a user selects one of the run control IDs from the drop down list, the system retrieves and populates the parameters values from the run control record and fields according to the parameters registered on the process definition. Note. For non-unique prompting (PSQuery, Connected Query and XMLP Query-based reports), keep in mind the saved run control may not apply to the report you are attempting to run and therefore will not display the appropriate prompts.
Parameter Value	Enter values for each parameter.
Save	Use this button to save the parameter values entered. You will be prompted to enter a name. You can save the parameter values without submitting the process to run. Note. All required parameter values must be completed in order to save the run control ID.
Schedule	Use this button to run the process through the Process Schedule. The Submit Process page will appear. See Scheduling Process Requests.
Run Now	Use this button to submit the process to run using the default process output type and format (the Submit Process page will not be displayed) Note. A real-time event notification (REN) server must be configured and running for this option. See Defining Event Notifications and Configuring a REN Server. Note. This option is not currently supported by XMLP reports.
Cancel	Use this button to cancel the request.