This section describes how to use the Maintain Batches function to create, edit, view, copy, delete, and submit batches.
Contents on this page (confluence macro)
About Batches
Work With the Maintain Batches Window
Create a Batch
Configure Batches
Overview of Distribution Logic
About Batches
Batches associate entities and clients with Client Reporting packages. You can schedule batches to run on a daily, weekly, monthly, or periodic basis. You can also run batches ad hoc (manually). If you want, you can select a different package for each month of the year. This allows you to distinguish between monthly, quarterly and annual reporting packages in a single batch.
Batch information is stored in the CR_SCHEDULES, CR_SCHEDULE_DETAIL and CR_SCHEDULE_LIST tables in the Rules database.
To distribute batches, you define custom distributions using the Custom Distribution options and then assign batches to clients. See Distribute Client Reports for more information.
Work with the Maintain Batches Window
The Maintain Batches window contains options you use to create and maintain batches.
To open the Maintain Batches window:
From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.
Enter Reporting in the Start Search text box.
Click the Reporting Center link to access the Reporting Center component.
You see the Client Reporting workspace.Open the Client Reporting folder, and double-click the Administrative folder.
You see the Client Reporting options.Double-click Maintain Batches.
You see the Maintain Batches window.
Complete the options on the Maintain Batches window.
Create a Batch
To create a new batch, you define the entities and clients you want in the batch, schedule the batch, and select the reporting packages you want to run for each month of the year.
To create a batch:
Click the Create New Batch link on the Maintain Batches window
You see the Create New Batch dialog box. The Batch Definition tab is displayed by default.
Complete the options on the Batch Definition tab.
Click Next to display the Scheduler tab and schedule the criteria based batch.
You see the Scheduler tab.
Select the Schedule this batch check box.
Complete the options on the Scheduler tab.
Complete the following fields.
Field | Description |
How do you want to schedule this? | Schedules the batch on a daily, monthly, or periodic basis. Select one of the following options: Daily On. Select the days you want the batch to run. Weekly On. Select the day of the week on which you want the batch to run. Monthly On. Select a month. Every. Select how often you want the batch to run in minutes. |
At what time do you want to schedule this? | Enter the start and stop times for the batch. |
Use Business Calendar with source | Select this check box and then select a business calendar. Select a business calendar to use if you do not want to submit the batch on weekends or holidays. |
Use Date Rule for Effective Dates | Select this check box and then select Click here to select date rule to define the effective date of the batch. This allows you to submit a batch with a create date that is different than the effective date. For example, a batch that is scheduled to run at the start of the month, but run with an effective date of the prior months end. The date that the batch is scheduled to run becomes the create date of the batch. That date is passed through the selected date rule to determine the effective date of the batch. To add business calendar logic to the effective date calculation, select a business calendar in the date rule. This allows you to adjust the effective date for holidays and weekends. |
Due Date | Click this link to specify a due date for the batch. This allows you to set up a due date for scheduled batches and send notifications when the batch is past its specified due date. Enter the number of days, time, or number of minutes and click OK |
Define Dependent Events | Click this link to schedule batches as dependent on other PACE events. |
Use default time zone as on server | Click this link to select a time zone. For example, a user in the Boston office can edit a batch created and scheduled in the London office. The batch looks the same to the user in each location. The time zone is stored in the user_data column of the PACE_MASTERDBO.SCHEDULE_DEF record. Client Reporting recognizes Date Rules with a non default time zone setting configured in the underlying PACE Concentration Report. When overriding or passing the effective date from the Advanced Reporting engine to the Concentration engine, it considers the time zone selected in the Date Rule of the PACE Report Profile. For example, if the underlying PACE Report Profile contains a Date Rule with a time zone of GMT plus ten hours and a batch is submitted at 4:00 p.m. on the first of the month from an environment where the PACE Server is configured with a time zone of GMT minus two hours, the Concentration report will be submitted for the second of the month. The profile_from_date and profile_two_date values in the pcre_rpts table of the package will contain the adjusted effective date. The eff_date value in the pcre_pkg table, however, will contain the effective date before the time zone adjustment. This is because the pcre_pkg table represents the package as a whole and situations may exist where not all of the underlying reports contain a time zone adjusted Date Rule. The effective date of the batch itself does not reflect any time zone adjustments. |
Table 4: Fields - Create New Batch Dialog Box - Scheduler Tab
Click Next to display the Reports tab to specify which reporting packages you want to run for each month of the year. The Reports tab appears.
Create New Batch Dialog Box - Reports Tab
Complete the following fields.
Field | Description |
Advanced Profile | Click to select a reporting package. You can specify a reporting package for one or more months in the calendar year, create and edit an Advanced Report Profile or Advanced Report Profile variation, override an Advanced Report Profile for one or more recipients in the batch, and preview batch distributions. Advanced Report Profiles are typically created in General Reporting. If you do not want the batch to run for a particular month, do not select a reporting package. Compound Business Group users can see which Advanced Profiles are owned or published to the regular Business Groups in their Compound Business Groups. |
Categories | Click to specify a distribution category. The Distribution Category dialog box appears. Select one or more distribution categories. Your selections apply to all of the clients or entities assigned to the batch. If you do not select a distribution category, the batch is distributed to all distribution categories for clients associated with the batch. Distribution categories are determined by an internal code. The internal code used has an instance value of 10023. The short description of the code is iDISTRTYPES. This set of code values is also displayed in Category drop down in the Clients Distribution tab. If one or more clients in the batch does not have a distribution method created for the selected distribution category, the reporting package is not distributed to the client. The event is noted in the batch engine log. |
Archive Folder | Select an archive folder. Enable this option for each month that you select an Advanced Report Profile. This allows batch results to be stored on the network using a Custom Archive Rule. By default, a batch does not have an archive folder selected. Selecting an archive folder is optional. If you do not select one, the default archive folder is used. |
Override | You can create and edit a batch variation on the Advanced Report Profile. An Advanced Report Profile variation is a batch override that consists of one or more Advanced Report rules. You can apply the variation to one or more of a batch’s recipients using the Override column. |
Define Batch Notifications | Click to define batch notifications. Batch notifications allow you to define a list of contacts and contact them by email when batch status changes. The Define Notification List dialog box appears. Click Add User to add a contact to the Notification List section. Select the check boxes in the Notify upon section: Starting Execution. Notifies a contact when the batch has been submitted via the Scheduler or on an ad hoc basis and picked up by the batch engine. Completed. Notifies a contact when the batch has completed processing. Failed. Notifies a contact when at least one package in the batch has failed processing. Starting Distribution. Notifies a contact when the batch has completed imaging and is waiting for an After Run approval update. Due Date. Notifies a contact when the batch moves past its specified due date. |
Define Approval Dependencies | Click to define approval dependencies. Approvals are tasks that help you automate client statement production. See Define Approval Dependencies for more information. |
Table 5: Fields - Create New Batch Dialog Box - Reports Tab
Click Finish.
The entities or clients that match the criteria are automatically included in the batch details when the batch is submitted for processing.
The following sections describes how to preview the entities and clients specified in a criteria based batch. If the list is not what you expect, you can modify the criteria until the clients or entities are included.
Preview the Entities and Clients
Select the Evaluate Custom Filter link on the Create New/Edit Batch dialog box to preview the entities and clients you specified for a criteria based batch. The Clients dialog box appears if you created a criteria based client batch. If you created a criteria based entity batch, the Entities dialog box appears. The Entities/Clients dialog box lists the clients/entities that meet the criteria you defined in the criteria based batch.
To sort the clients or entities on the dialog box in ascending order, single click the column heading. To sort the clients or entities in descending order, double click a column heading.
You can customize the columns on the Clients/Entities dialog box using the Configure Fields link. Click Configure Fields to display the Configure Fields dialog box.
Configure Fields Dialog Box
If you created a criteria based batch at the client level, the Configure Fields dialog box displays the field attributes defined against the RULESDBO.CLIENT table. If you created a criteria based batch at the entity level, it displays the field attributes that have been defined against the RULESDBO.ENTITY table.
To select a field for display on the Entities/Clients dialog box:
Double-click the field in the left pane of the Configure Fields dialog box or select the field and click the right arrow button. To select all fields, click the right double arrow button.
Click OK to save the field selections.
To remove a field from display on the Entities/Clients dialog box:
Double-click the field in the right pane of the Configure Fields dialog box or select the field and click the left arrow button. To remove all fields, click the left double arrow button.
Click OK to save the field selections.
To re-order fields:
Select the fields in the right pane and use the Move Down and Move Up links to change the order of the selected fields.
Click OK to save the field selections.
The selected columns are displayed the next time you display the Clients/Entities dialog box.
Define Approval Dependencies
Approvals are tasks that help you automate production of client reports. Complete the following procedure to define approvals:
To define approval dependencies:
Click Define Approval Dependencies on the Reports tab of the Create New/Edit Batch dialog box. The Approval Dependencies dialog box appears.
Approval Dependencies Dialog Box
Click Fetch Associated to add approvals assigned to the batch directly, or to the clients or entities in the batch.
Click Fetch All. For a client level batch, approvals assigned to the entities owned by the clients contained in the batch are retrieved. For an entity level batch, approvals assigned to the clients that own the entities contained in the batch are retrieved.
Selected approvals and the order in which they are to be approved are displayed in the Selected Approvals section. You can change the values in the Order column, making one approval dependent on another in the same stage. An approval with a greater order value is dependent on an approval with a lesser order value.
The approval with the greater order value is not available for an approval status change until the approval with the lesser order value is marked as approved.
When creating a batch, the Selected Approvals section is populated by default. When editing a batch, use the Fetch buttons to populate the Selected Approvals section. This allows the process to function more quickly since most users do not add approvals when editing a batch.
Batch level approvals that are not assigned to the current batch are displayed in the Available Approvals section.
To add other batch level approvals, drag them from the Available Approvals section to the Selected Approvals section.
You can create more than one approval with the same Order value. There are no dependencies between approvals with the same Order value, but they act the same with respect to larger and smaller Order values.
For example, if two approvals in a batch are created with Order values of 2, then both of those approvals are dependent on any approval with an Order value of 1. Similarly, any approval with an Order value of 3 is dependent on the approvals with an Order value of 2. However, there are no dependencies between the two approvals with an Order value of 2.
Select the Ignore check box if a particular approval should not be part of the workflow for the current batch.
Internal dependencies exist in the batch process. After Run approvals are not available for approval until the batch has progressed past the imaging stage. Similarly, Post Distribution approvals are not available for updates until the batch has completed the Distribution stage.
Approval Dependency Shortcuts
When you right-click, the Define Approval Dependencies dialog box displays a popup menu containing options that make the approval dependency set up process easier. See Figure 8: Define Approval Dependencies Right-Click Menu.
Define Approval Dependencies Right-Click Menu
A description of each option follows.
Option | Description |
View approval | Displays the View Approval dialog box. On this dialog box, you view information for the selected approval. |
View Approval Users | Displays the View Approval Users dialog box. On this dialog box, you view approval definitions and users/business groups assigned to an approval. This allows you to preview the users who are responsible for the approvals in the current batch. You cannot make changes to the approval assignments here. Make changes on the Maintain Approvals window. |
Remove Approval | Removes the selected approval from the dependency structure of the batch. This sets the Order value of the selected Approval to zero so that there is no dependency between this approval and other approvals in the dependency structure. The approval record is still generated for this approval when the batch is submitted. The approval is removed from the Selected Approvals section of the Approval Dependencies dialog box and can be retrieved using either the Fetch Associated or Fetch All button. |
Remove All Approvals | Removes all the approvals from the dependency structure of the batch. This sets the Order value of all of the approvals to a value of zero so there is no dependency between the approvals, but the approval records are still generated when the batch is submitted. The approvals are removed from the Selected Approvals section of the Approval Dependencies dialog box and can be retrieved using either the Fetch Associated or Fetch All button. |
Ignore All Approvals | This option selects the Ignore check box for all the approvals in the Selected Approvals section, and removes them from the dependency structure of the batch. This speeds up the dependency structure definition process. Individual approvals can then be activated in the dependency structure by deselecting the Ignore check box. |
Enable All Approvals | This option deselects the Ignore check box for all of the approvals in the Selected Approvals section, making them part of the dependency structure of the batch. Individual approvals can be removed from the dependency structure by selecting the Ignore check box for the Approval. This feature speeds up the dependency structure definition process. |
Fetch Associated Approvals | Approvals assigned to the batch directly, or to the clients or entities in the batch are retrieved. |
Fetch All Approvals | For a client level batch, approvals assigned to the entities owned by the clients contained in the batch are retrieved. For an entity level batch, approvals assigned to the clients that own the entities contained in the batch are retrieved. |
Table 6: Options - Define Approval Dependencies Right-Click Menu
Create and Edit an Advanced Report Profile Variation
To create and edit an advanced report profile variation:
To edit an Advanced Report Profile, select an Advanced Profile, right-click, and select Edit Advanced Report Profile.
The Creating/Editing an Advanced Report dialog box appears. On this dialog box, you can add entities or clients, date rules, date settings, and distribution settings. You can also submit an Advanced Report Profile. Like other Advanced Report Profiles, most of these settings do not impact Client Reporting, as the batch settings override the Advanced Report Profile level parameters.
Editing an Advanced Report Dialog Box
Click the Batch Overrides tab.
The Batch Overrides tab appears. See Figure 10: Batch Overrides Tab.
Batch Overrides Tab
Right-click and select New Override from the popup menu.
The Advanced Report Override dialog box appears.
Advanced Report Override Dialog Box
Right-click on the Selected Rules pane and select Add from the popup menu.
The Select Advanced Rules dialog box appears. On this dialog box, you can add an Advanced Report rule as an override in the variation. See Figure 12: Select Advanced Rules Dialog Box.
Select Advanced Rules Dialog Box
Click the Advanced Rules and click OK.
The rules are displayed on the Advanced Report Override dialog box.
Enter a name for the variation in the Name text box.
Each variation in a single Advanced Profile must have a unique name. However, two separate Advanced Profiles can have variations with the same name.
The Comments text box is optional.
Click OK.
The variation you created is displayed on the Batch Override tab of the Editing an Advanced Report Profile dialog box.
Editing an Advanced Report Profile Dialog Box - Batch Override Tab
Click Next.
The Scheduler tab appears. Complete the fields on this tab.
Click Next.
The Reports tab appears. Complete the fields on this tab. Click No if you do not want to submit the report.
Click Finish.
The Override column on the Reports tab of the Edit Batch dialog box is enabled. See “Creating a Batch Override” to apply the override to one or more of the recipients in the batch.
Variation data is stored in the ADV_PROFILE_VARIATION table in the PACE_MASTER database.
Create a Batch Override
To create a batch override for one or more of the batch’s recipients:
Click the ellipses button in the Override column.
The Batch Override dialog box appears. See Figure 14: Batch Override Dialog Box.
Note: | If you do not want the Batch Override dialog box to display contacts of the clients in a client level batch, you can enable the Hide Contacts from Batch Override screen check box on the Configure dialog box. |
Batch Override Dialog Box
Apply the variation to the recipients in the batch, including entities, clients, or contacts, using the Variation drop down list. Click OK.
The Override Column on the Edit Batch dialog box displays YES to indicate that there is a batch override.
Click Finish.
View Advanced Report Variations
You can view Advanced Report variations by name for each recipient on the Batch Status window, which is used to monitor batch information. When you select an Advanced Profile, the name of the Advanced Report variation is displayed in the batch details section of the Batch Status window for package level recipients who have a batch override configured in the batch. The Batch Status window in Hybrid mode contains a field for the hybrid entity type. See Figure 15: Batch Status Window - Hybrid Mode.
The batch details section of the Batch Status window contains the Entity (Hybrid Mode) column heading, which displays the entity long name followed by the client name of the client that owns the entity. The content of the client name is configured using the client identification option on the Configure dialog box. This dialog box is available when you click the Configure link. See Configure Batches for additional details.
Batch Status Window - Hybrid Mode
This information is also displayed on the Review Batch dialog box. See Monitor Batches for details on the Batch Status window and Review Batch dialog box.
Edit Advanced Report Profiles with Overrides
If the Advanced Profile setting on the Reports tab of the Edit Batch dialog box is changed for a month with an override value set, you are prompted with a warning.
Batch Override Warning Message
The warning indicates that changing the Advanced Profile setting removes the overrides established for the corresponding month in the batch. You can either cancel the Advanced Profile change request or accept the impact and proceed with the changes.
Preview Distributions
You can preview batch distributions by right clicking on the Advanced Report Profile in the Reports tab of the Edit Batch dialog box. You see the Batch Distribution Preview dialog box.
Batch Distribution Preview Dialog Box
Information includes client/contact names, advanced report profiles, variations, communication types and values, file formats, distribution categories, and entity names. You can also preview batch distributions from the Maintain Batches window. Select the batch and click the Preview Distributions link.
Configure Batches
The Configure link on the Maintain Batches window displays the Configure dialog box. See Figure 18: Configure Dialog Box - Maintain Batches Tab.
Maintain Batches Tab
The Maintain Batches tab on the Configure dialog box allows you to configure settings for the batches you create and edit on the Maintain Batches window.
Configure Dialog Box - Maintain Batches Tab
A description of the options on the Maintain Batches tab follows.
Option | Description |
Use this Custom View | Select a custom view for display, if defined. |
Filtering Batches by Type | Filters batches by entity, client, and hybrid batch mode. |
Show Only My Batches | Displays only your batches on the Maintain Batches window. |
Group by Categories | Groups batches on the Maintain Batches window by category, such as annual, monthly, or quarterly. Any category that does not contain a batch is hidden. If a batch does not have a category assigned to it the category column displays <unknown>. To set up a code value for the category, see Set Up the Code Values for the List.. |
Hide Contacts from Batch Override Screen | The Batch Override dialog box is used to override an Advanced Report Profile for one or more recipients in a batch. When you enable the Hide Contacts from Batch Override screen check box, the Batch Override dialog box does not display contacts of the clients contained in a client level batch. |
Filter Batches by Update Date | Filters all batches by an update date such as today’s date. |
Adhoc Batch submission default to prior month end | The Adhoc Batch submission default to prior month end check box allows you to default the submission of an ad hoc batch to the prior month end date. See “About Defaulting Ad Hoc Batch Submissions” for details on this feature. |
Page size | Specifies how many items you want to display per page. |
Change Visual Settings for this View | Saves any filter settings that you changed. If you do not select this option, changes you make to filters will not be saved when you next log in. |
Table 7: Options - Configure Dialog Box - Maintain Batches Tab
Set up the Code Value for the Category List
To set up a code value for the category list.
Click Create New Batch or Edit Batch. Select a category from the Category drop down list.
Create New Batch Dialog Box - Category Drop Down List
Click Finish to close the Batch dialog box.
Click the Go to another component drop down list on the Maintain Batches window.
Select Maintenance/Codes.
Click the Add Code link.
The Codes dialog box appears. See Figure 20: Codes Dialog Box.
Codes Dialog Box
Complete the fields on the Codes dialog box and click Add.
You need to set the Type field to “X” for the code to function properly in the Client Reporting windows.
Make sure that an Inventory of Fields record is created for the new CATEGORY column in the RULES.DBO.CR_SCHEDULES table.
Click the Go to another component drop down list and select Meta Data/Inventory of Tables/Fields. Select a table to review the inventory of fields.
Inventory of Fields Window
Additionally, you need to create a field attribute that points to the Category column in the RULES.DBO.CR_SCHEDULES table.
The field attribute should refer to the code you created. See Figure 22: Editing Regular Field Dialog Box.
Editing Regular Field Dialog Box
General Tab
The General tab on the Configure dialog box has a number of settings that apply to all Client Reporting functions.
Configure Dialog Box - General Tab
The following table describes the options on the General tab.
Option | Description |
Use this as a Startup View | Select which window you want to view on start up. |
Client Identification | Select the Client ID and Client Display Name check boxes to display the client ID and client name on windows for identification purposes. |
Display contacts using this color | Select this link to display contacts in a different color for easy identification |
Select an additional Client column | Select additional client related columns to display. |
Save most recent settings when closing | Select this check box to automatically save your most recent settings when you log out of Client Reporting. |
Enable the diagnostics feature for troubleshooting | Select to access the Diagnostics menu. When you select this check box, the Diagnostics menu appears next to Quick Links. See Use the Diagnostics Options for more information. |
Reset All Settings | Click this button to reset your saved preferences, including window filters and sort settings, grid control settings, and default view settings. |
Table 8: Options - Configure Dialog Box - General Tab
Diagnostics Options for Troubleshooting
If you selected the Enable the Diagnostics Features for troubleshooting option, a Diagnostics menu appears next to Quick Links. The Diagnostics area contains the following options.
Option | Description |
Enable Logging | Select to enable application server logging. After you select this option, the View the Log File option becomes available. Select View the Log File to check details of the log. |
Common Components Options | Options in this section include Show Application Components & Files, Show System Items & Values, and Show Stored User Preferences & Values. |
Application Server Options | Options in this section include Show Configured Servers, Show Connected Server Detail, Disable SQL Logging for this Connection, and View Current Log File. |
Data Engine Server Options | Options in this section include Show Configures Servers, Show Event Configuration, and Show Events Configured by Active Server. |
Table 9: Options – Diagnostics Menu
Submit an Ad Hoc Batch
The Submit Batch link on the Maintain Batches window allows you to submit the selected batch on an ad hoc basis for the specified report start and end dates. You can also specify a due date, override the batch log level, submit the ad hoc batch as a scheduled event, and run the event as a high priority.
To submit a batch on an ad hoc basis:
Select a batch on the Maintain Batches window.
Click the Submit Batch link. Or right-click and select Submit Batch from the popup menu.
You see the Submit Batch dialog box.
Submit Batch Dialog Box
Enable the Report Start Date 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.
Click the Select a Due Date link.
You see the Due Date dialog box.
Due Date Dialog Box
Specify the date the batch should be completed and click OK.
You see the Submit Batch dialog box.
Click the Submit the Engine at Log Level check box and select a log level from the drop down list. This option 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 also applies to any Advanced Reporting, Concentration, or Distribution engines submitted by the current instance of the Client Reporting batch engine.
Click the Submit as Scheduled check box. This option allows you to submit the ad hoc batch as a scheduled event. Two edit checks are included in the submission process.
You are warned if the batch has already been submitted with the same effective date (report start/end dates). See Figure 26: Submit Batch Warning Message.You can ignore the warning and submit batch again with the same date.
Submit Batch Warning Message
You are prevented from submitting a batch for a future effective date (report start/end dates). See Figure 27: Submit Batch Warning Message. You cannot override this edit check.
Submit Batch Warning Message
Click the Run this event at High Priority link to run the event at a high priority.
Click OK to submit the report for processing.
Default Ad Hoc Batch Submissions
When the Adhoc Batch submission default to prior month end check box on the Configure dialog box is enabled, and the default Report Start Date on the Submit Batch dialog box defaults to the prior calendar month end date.
Configure Dialog Box – Ad Hoc Batch Submission Option
If the prior month does not specify an Advanced Profile, Client Reporting will use the most recent month with an Advanced Profile selected. For example, if a batch with an Advanced Profile configured for each month of the year is submitted on an ad hoc basis on January 1 and the Adhoc Batch submission default to prior month end check box is enabled, the Report Start Date on the Submit Batch dialog box defaults to December 31 of the previous year.
If a batch with an Advanced Profile configured on a quarterly basis, for example, January, April, July and October, is submitted on an ad hoc basis on January 1 and the Adhoc Batch submission default to prior month end check box is enabled, the Report Start Date on the Submit Batch dialog box defaults to October 31 of the previous year.
This setting only affects the default Report Start Date on the Submit Batch dialog box. You can enable the Report Start Date check box and enter a value for the Report Start Date and Report End Date. This feature is designed to support off-period report processing. You can configure Client Reporting to enable the Report Start Date check box by default when you display the Submit Batch dialog box. Refer to “Appendix A: Configuring PACE for Client Reporting.”
Process Batch Submissions
When a submitted batch contains a client, the Client Reporting engine determines the entities owned by the selected client and submits the underlying Advanced Report for that entity.
When a submitted catch contains an entity, Client Reporting submits the underlying Advanced Report for that entity. The Client Reporting distribution engine determines the clients that own the entity in the batch. See Distribute Client Reports for more information about this logic.
Evaluate Client Relationships to Entities
Client Reporting fails batches if they are run for a client with no Client Reporting eligible relationships to entities. When the Advanced Reporting engine evaluates the selected client for its relationship to entities, it queries the CR_FLAG value in all CLIENT_RELATIONSHIPS records for the selected Client. If all of the CLIENT_RELATIONSHIPS records have a CR_FLAG value of zero, which indicates that the relationship should be ignored by the Client Reporting process, the Advanced Report fails with an error message indicating that the report cannot run without entities.
Pass Client Info Setting
Client Reporting also recognizes the Pass Client Info check box in Advanced Report rules. This check box, originally intended to forward client level information from an Advanced Report down to the underlying standard PACE Report, is also used by the Advanced Reporting engine when run in Client Reporting mode.
Advanced Report Rule – Pass Client Info Setting
The Pass Client Info check box determines which client relationships are recognized and used by Client Reporting. It controls the clients returned by the underlying concentration reports. When the Pass Client Info check box is enabled in the Advanced Report Rule, the client from the batch is retained. Client fields included in the concentration report only include data from the client submitted in the batch. When the Pass Client Info check box is not enabled, the client in the batch is examined to determine the entities owned by the client. The Advanced Report is then run for these entities, and if the underlying concentration report contains any fields from the CLIENT tables, data is returned for all clients that own the entities.
Print Options Tab
Use the options on the Print Options tab as described in the following table.
Option | Description |
Orientation | Select either Portrait or Landscape |
Margin | Set the margin. |
Print Gridlines | Select this check box to print gridlines. |
Print Column Heading | Select to print column headings. |
Show Printer Selection Dialog | Select to make the printer selection dialog box visible. |
Table 10: Print Options
Overview of Distribution Logic
This section contains an overview of the distribution logic maintain batches functionality.
When you create a batch via the Maintain Batches function at the client level, the report packages are run for all of the entities owned by the selected clients. In Figure 30, client Jones owns two accounts, or entities A and B, in PACE. When a batch is run for client Jones, the selected Advanced Report profile is run for both entities A and B, and client Jones receives, assuming valid distribution information, a package of reports containing both entities.
A copy of this package is also delivered to all of client Jone’s contacts. In Figure 30: Client-Level Batch Distribution, the contact type feature in the Client Reporting configuration has been used so that the contact receives a different version of the report package in terms of the reports contained in the package, but the package is still run for all entities owned by client Jones.
Client-Level Batch Distribution
When you create a batch via the Maintain Batches function at the entity level, the report packages are run for each entity separately. If a client owns two entities contained in a batch, that client receives two separate packages via client reporting distribution, each containing one of the entities.
In the Entity Level Batch Distribution example shown above, batch 1 contains entities A and B. Clients Jones and Smith both own entity A, so they each receive a copy of the package containing entity A. Client Jones also owns entity B. Therefore, client Jones receives two separate packages via the distribution engine.
The contact distribution logic differs in an entity level batch. A contact receives a copy of the package if they are connected to the client at the client/entity relationship level. This feature allows you to associate different contacts with each entity owned by the client. In: Figure 31: Entity-Level Batch Distribution, contact Brown is related to client Jones at its relationship to entity A and, therefore, receives a copy of the package that contains entity A.
Contact White is related to client Jones at its relationship to entity B and, therefore, receives a copy of the package that contains entity B.
Entity-Level Batch Distribution
Add Comment