...
From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.
Enter Reporting in the Start Search text box and click the Reporting Center link. Or click All Programs and select Reporting Center. You see the Client Reporting workspace.
Open the Client Reporting folder, and double-click the Administrative folder to see the Client Reporting options.
Double-click Batch Status.
You see the Batch Status window. The Batch Status window displays the name of the batch, advanced report profile, status, effective date, due date, create date, start and end dates, and duration.
To display summary and package level details for the selected batch in the Batch Status window, click the Show Batch Details link at the bottom of the Batch Status window. Or right-click and select Show Batch Details from the popup menu.
You see the batch details on the Packages tab.
To enlarge the batch details section, place your cursor on the horizontal scroll bar and drag the scroll bar to the correct height. Batch details for the selected batch are displayed on two tabs:
Packages tab: Displays the individual reporting packages in the batch in chronological order. Detail includes the entity/client name, status, number of runs, imaged report, Advanced Report Profile name, start and end dates, and duration.
Summary tab: Displays the batch status and number of entities/clients in the batch.You will see a link to an imaged report in the Report column when a package in the batch has progressed through the imaging stage of the workflow. Double-click the link to display the report in the Advanced Report Viewer. While reviewing the imaged reporting package, you have the option of converting it to another file format and changing the approval status.
Additionally, you can distribute one or more of the reporting packages ad hoc (manually). Select a package, right-click your mouse, and select Adhoc distribution from the popup menu.To update the package level information, click the Refresh Batch Details link at the bottom of the window. The Refresh link at the top of the window only refreshes batch level information.
...
To perform a text search, enter the text or string in the Search field, which is located to the right of the Search menu and click Enter. Client Reporting searches through the information on the Batch Status window for a match. If a match is found, the row is highlighted.
To use the Search menu, click the arrow next to the Search link. The Search menu displays the options described in the following table.
Option | Description |
Search for client batches | Searches for client batches that meet the specified criteria. The search is applied down to the package level. For example, if you are searching for all clients with a client type value of Contact, the Batch Status window will display batches that contain at least one client that meets the specified criteria. The drop down list at the top of the Search for Client Batches dialog box includes field attributes defined against the CLIENT table. If the selected field is associated with a reference code, the code values are displayed in the drop down list. Otherwise, the lower box is a standard data entry field. You can configure the search criteria to look for a specific value using the EQUAL connector, a string of values using the IN connector, or a near match on a specific value using the LIKE connector. |
Search for entity batches | Searches for entity batches. Displays the Search for Entity Batches dialog box, which searches for entity batches that meet the specified criteria. The search is applied down to the package level.For example, if you are searching for all entities with an Entity Type of Composite, the Batch Status window will display batches that contain at least one entity that meets the specified criteria. The drop down list at the top of the Search for Entity Batches dialog box includes field attributes defined against the ENTITY table. If the selected field is associated with a reference code, the code values are displayed in the lower drop down list. Otherwise, the lower box is a standard data entry field. |
Search for Clients | Searches the database for clients that meet the specified criteria. Click Define search result fields to display the Configure Fields dialog box. On this dialog box, you define the columns on the Clients dialog box which are displayed when you execute the search. You control the order of the fields using the Move Down and Move Up links. When you click OK, you return to the Search for Clients dialog box. |
Search for Clients - Advanced Search | Provides a more complex search for clients. The Name section displays field attributes that are defined against the CLIENT table. If the selected field contains a reference code, the lower right corner displays the code values. Use the fields, code values, and arguments in the keypad to define the client search criteria. |
Search for Entities | Searches the database for entities that meet the specified criteria. Use the fields, codes, and connectors on the dialog box to define the search criteria. Click Define Search Result Fields to display the Configure Fields dialog box and define the columns on the Entities dialog box, which is displayed when you execute the search. Click Define Advanced Search Criteria for a more complex search. |
...
Select a report and click Save As.
Select a format from the Save as type drop down list.
Change the Approval Status
...
Click the Approval Status link while reviewing a batch report in the Advanced Report Viewer.
Select one of the following options.
...
Click Review Batch.
You see the Review Batch dialog box.Select the Packages tab and select the completed batch that you want to distribute. Click Adhoc distribution.
You see the Batch Distribution dialog box.
Complete the fields on the Batch Distribution dialog box as described in the following table.
Option | Description |
Distribution Type | Select how you want the batch to be distributed from the options on the drop down list. |
Value | Specify a value. |
View Types | Determines who receives the distributed batch. |
Submit the Engine at Log Level | Allows you to override the batch log level. A more detailed log is generated without requiring the log level to be changed at the PACE Server level, or for the PACE Servers to be recycled to generate more detailed logs. The log level override value applies to any Advanced Reporting, Concentration, or Distribution engines submitted by the current instance of the Client Reporting batch engine. |
Submit as Scheduled | Submits the distribution as a scheduled event. When enabled, it allows the request to be run on a PACE Server dedicated to scheduled events and an ADHOC PACE Server in a cluster to be avoided. |
Submit
...
a Batch
Users who are not granted permission to use the Maintain Batches window can be granted permission to submit batches using the Batch Status window.
...
Select a batch on the Batch Status window and click Submit Batch.
You see the Submit Batch dialog box.
Complete the following fields on the Submit Batch dialog box.
Option | Description |
Report Start Date Report End Date | Select the check box and specify a value for the Report Start Date and Report End Date. Or use the default Report Start Date. The Report Start Date check box is designed to support off-period report processing. The specified report start/end dates determine which package is submitted. It works with any date rule that is specified in the underlying Advanced Report and Advanced Report Profile to determine the start and end date of the reporting package. |
Select a Due Date | Specify the date the batch should be completed. |
Submit the Engine at Log Level | Allows you to override the batch log level. A more detailed log is generated without requiring the log level to be changed at the PACE Server level, or for the PACE Servers to be recycled to generate more detailed logs. The log level override value applies to any Advanced Reporting, Concentration, or Distribution engines submitted by the current instance of the Client Reporting batch engine. |
Submit as Scheduled | Submits the ad hoc batch as a scheduled event. Two edit checks are included in the submission process. If the batch has already been submitted with the same effective date a warning message appears. You can ignore the warning and submit the batch again with the same date. |
Run this event at High Priority | Runs the event at a higher priority. |
To Re-Submit a Batch:
Open the Batch Status window.
Click the Re-Submit Batch link.
You see the Re-Submit Batch dialog box.
Select a batch to submit for a subsequent run. If a batch was created for more than one entity or client, you can re-submit it based on the status of the detail records. If there are approvals associated with the batch being resubmitted, a new approval record is not created. Clear the All check box to re-select package status values.
Click OK.
Cancel a Batch
Cancel You can cancel a batch on the Batch Status window by selecting a batch and clicking Cancel Batch. You see the Cancel dialog box, where you can cancel the selected batch, at the batch level, or package level regardless of its current status or stage.
...
Cancel Batch Dialog Box
To cancel a batch:
Open the Batch Status window.
Click the Cancel Batch link.
You see the Cancel Batch dialog box.
The STATUS of the selected batch is updated to L. This instructs the Client Reporting engine to stop processing the batch record. The batch, its packages, and related jobs are all cancelled.
The Cancel Batch dialog box displays a tree structure that models the contents of the batch. The top branch represents the batch record and the lower branches represent the packages in the batch. The batch level branch reflects the CR_BATCH record and the package level branches reflect the CR_BATCH_DETAIL records related to the batch.
...
To cancel a
...
batch at the Batch Level
...
: Select a “top branch” package on the Cancel Batch dialog box. This cancels the entire batch, including all of the packages contained within the batch.
...
To cancel at batch at the Package Level
...
: Select a “lower branch” package on the Cancel Batch dialog box. This cancels that package only. The remainder of the packages in the batch are processed.
...
The package level records are displayed in the Cancel Batch dialog box only after the package has reached the imaging stage. This is because until the imaging stage, when the Advanced Reporting engine has been submitted, there is no engine related to the package that can be terminated. Once a package has reached a status of Completed, that package no longer appears eligible for cancellation. No check box within the Cancel column is displayed on the Cancel Batch dialog box for that package.
Kill Requests
When a cancel batch request is submitted to the PACE Server, the Client Reporting engine uses the CR_BATCH and CR_BATCH_DETAIL records to resolve back to related SCHEDULE_DEF and SCHEDULE_QUEUE records. A Kill Engine request is submitted to stop the processing of the packages, and the PARENT_QINSTANCE value within the SCHEDULE_QUEUE record is used to find any related engines spawned by the parent record. These processes are also terminated. The CR_BATCH and CR_BATCH_DETAIL records are modified to a status value of Cancelled (L).
...
The following table describes how the Client Reporting related engines handle Kill requests.
Engine | Kill Request Descriptions |
Advanced Reporting | Checks for the request each time the system writes to the log file. Changes the log level. Does not affect the frequency of checking the kill flag. |
Client Reporting | Checks for request each time the system writes to the log file. Changes the log level. Does not affect the frequency of checking the kill flag. |
Distribution Engine | Checks for request each time the system writes to the log file. Changes the log level. Does not affect the frequency of checking the kill flag. |
Client Reporting Pre-Processor | Checks for requests each time the system writes to the log file. Changes the log level. Does not affect the frequency of checking the kill flag. |
Concentration Reports | Fetches the SECURITY_DICTIONARY_LINK table for Dictionary based concentration reports. Matrix fetch (such as Analytics/Price/Rating/Schedule). Various points in the tree build process. Begin/End Position data fetch. Cash Adjustments fetch. The following modules check for the kill request: Entity Characteristic fetch FX Rates fetch Issuer Info fetch |
Client Reporting Engines and Kill Requests
Delete a Batch
...
To delete a batch:
Open the Batch Status window
...
.
Click the Delete Batch link.
You see the Delete Batch dialog box.Click Delete Batch. The CR_BATCH and CR_BATCH_DETAIL records associated with the selected batch is deleted.
If you selected an active batch, a message appears notifying you that an active batch will be cancelled as part of the
...
delete process.
...
...
View Batch Approvals
The View Batch’s Approvals option on the Batch Status window displays details about the approvals that are associated with the selected batch or the entities or clients within the batch. To use this option, select a batch, right-click your mouse, and select View Batch’s Approvals from the popup menu. You see the Approval Status dialog box.
...
Approval Status Dialog Box
...
You can update the approval status using the ellipses button and filter the data. Right-click your mouse and select a filter from the popup menu.
...
The View Batch’s Distributions option on the Batch Status window displays details on the selected batch distribution. To use this option, select a batch, right-click your mouse, and select View Batch’s Distributions from the popup menu. You see the Batch Distributions dialog box.
...
Batch Distributions Dialog BoxThis dialog box lists the distributions that have occurred for the selected batch, including the batch name, Advanced Profile name, client/contact ID, distribution category, communication type and value used, and distribution time stamp.
...
You can recall the distribution if at least one package within a batch status record has moved past the distribution stage and the Portal is the destination.
To recall one or more reports that have been distributed to the Portal:
Select one or more clients on the Batch Distributions dialog box.
Right-click your mouse and select Recall Distribution from the popup menu.
The reports that have been distributed for the selected clients are deleted from the Portal. Once the distribution is recalled, the status column on the Batch Distributions window displays Recalled. See Distribute Client Reports for details on the Batch Distribution window. If a batch was cancelled and some of the packages were distributed, the Recall Distribution option is still available.
To Recall All Report Distributions to the Portal
...
Right-click your mouse on the Batch Distributions dialog box
...
.
Select Recall All Distributions from the popup menu.
Evaluate Workflow Events
The Evaluate Workflow Events option on the Batch Status window evaluates all of the current batch and approval records in Client Reporting and, if necessary, updates the batch and approval statuses. To use this option, select a batch, right-click, and select Evaluate Workflow Events from the popup menu.
...
The Batch Log option on the Batch Status window allows you to quickly locate, save, and analyze the PACE Server logs related to a batch. To use this option, select a batch, right
To retrieve batch logs:
Select a batch on the Batch Status window,
Right-click, and select Batch Logs from the popup menu.
...
You see the View Batch Logs dialog box
...
View Batch Logs Dialog Box
. The View Batch Logs dialog box displays the current batch and its current status, as well as the status of the packages contained within the batch. The Advanced Reporting and Concentration logs are listed for each package within the batch, whether the batch is created at the entity or client level. If a certain package has not reached the imaging stage, no logs are displayed for that package. Similarly, if the selected package has not yet reached the distribution stage, or the related clients are not configured to received distributed reports, no distribution logs are displayed for that package.
To save the logs, right-click and select
...
Download from the pop-up menu.
Work With the Batch Status and Control Window
...