Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. 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.

    Create New Batch Dialog Box
  2. Complete the options on the Batch Definition tab.

  3. Click Next to display the Scheduler tab and schedule the criteria based batch.
    You see the Scheduler tab.

    Create New Batch - Scheduler Tab
  4. Select the Schedule this batch check box.

  5. 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

  1. Click Next to display the Reports tab to specify which reporting packages you want to run for each month of the year.

...


  1. You see the Reports tab

...

  1. .

...

  1. Create New Batch Dialog Box - Reports TabImage Added
  2. Complete the following

...

  1. options on the Reports tab.

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.

...

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.

...

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.

...

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.

...

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.

...

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.

...