Scheduling Assistant Management

Menu Path: System Administration Images\bluerarw.gif Scheduling Assistant Images\bluerarw.gif Scheduling Assistant Management

Purpose

View and manage Scheduling Assistant tasks.

Overview

Use Scheduling Assistant Management to perform various functions for Scheduling Assistant tasks. This window allows you to reschedule tasks, change printers for tasks, cancel tasks, put tasks on hold, and view task history. You can view tasks for all or a specific system ID, user, task type, and task status. You can also select to view tasks or task history for all dates, or a range of submitted, scheduled, or completed dates. Additionally, this page allows you to print out these results to a report and to schedule to run on a regular basis as needed.

If you are using Scheduling Assistant for sending email, you can view email tasks on the Emails tab.

Cancelling Tasks

To cancel a pending task, select the task, and click the Cancel Task button on the toolbar. To cancel multiple tasks, select a check box in the grid's Select column, and click the Cancel Selected button on the toolbar.

Putting Tasks On Hold

To put a task on hold, select the task, and click the Toggle Task Hold button on the toolbar.

Change Printers

To change the printer for a task, double-click the printer in the Printer Queue column for the task, and select a printer.

Resending Emails

To resend an email that failed to send, select an email task on the Emails tab, and click the Retry button on the toolbar.

Buttons

Button

Description

Show Data

Click this button to display task information on the Results tab based on the selected criteria on the Select or Emails tab.

Refresh

Click this button to refresh task information on the Results tab based on the selected criteria on the Select or Emails tab. This button appears after the Show Data button is clicked.

Task History

Click this button in the At a Glance panel to display Task History, which allows you to view history information for the selected Scheduling Assistant task. This button is only available if the Results tab is displayed, and the Task Definitions radio button is selected.

Schedule Options

Click this button in the At a Glance panel to display Task Schedule Options, which allows you to update a selected Scheduling Assistant task. This button is only available if the Results tab is displayed, and the Task Definitions radio button is selected.

Cancel Task

Click this button on the toolbar to cancel the selected task. This button is only available if the Results tab is displayed, and the Task Definitions radio button is selected.

Cancel Selected

Click this button on the toolbar to cancel tasks for which the check box is selected in the Select grid column. This button is only available if the Results tab is displayed.

Toggle Task Hold

Click this button on the toolbar to put the selected task on hold, or release a selected on hold task. This button is only available if the Results tab is displayed, and the Task Definitions radio button is selected.

Retry

Click this button on the toolbar to resend an email (for a selected email task) that failed to send. This button is only available if the Emails tab is displayed.

Select Tab Fields and Buttons

Field or Button

Description

Display Option

Select whether to display tasks or task history.

All System IDs

Select this check box to display tasks or task history for all system IDs. This check box is cleared by default.

System ID

Enter a system ID for which to display tasks, or click the Lookup button to select a system ID. This defaults to the system ID you are using. This field is only enabled if the All System IDs check box is cleared.

Company Name

Enter a company name for which to display tasks, or click the Lookup button to select a company name. This defaults to the company name for the system ID you are using. This field is only enabled if the All System IDs check box is cleared.

List (System IDs)

Click this button to display System ID List, which allows you to select specific system ID's for which to display tasks. This button is only enabled if the All System IDs check box is cleared. If you click this button and select system IDs, the check box to the right of the button is selected.

All Queues

Select this check box to display tasks for all Scheduling Assistant queues. This check box is selected by default.

Queue Name

Enter a Scheduling Assistant queue for which to display tasks, or click the Lookup button to select a Scheduling Assistant queue. This field is only enabled if the All Queues check box is cleared.

List (Queues)

Click this button to display Queue Name List, which allows you to select specific Scheduling Assistant queues for which to display tasks. This button is only enabled if the All Queues check box is cleared. If you click this button and select Scheduling Assistant queues, the check box to the right of the button is selected.

All Submitted by Users

Select this check box to display tasks submitted by all users. This check box is cleared by default.

User

Enter a user ID of a user for whom you want to display tasks, or click the Lookup button to select a user ID. This defaults to your user ID. This field is only enabled if the All Submitted by Users check box is cleared.

User Name

Enter a user name of a user for whom you want to display tasks, or click the Lookup button to select a user name. This defaults to your user name. This field is only enabled if the All Submitted by Users check box is cleared.

List (Users)

Click this button to display User List, which allows you to select specific user ID's for which to display tasks. This button is only enabled if the All Submitted by Users check box is cleared. If you click this button and select users, the check box to the right of the button is selected.

All Submitted Dates

Select this check box to display tasks for all submitted dates. This check box is selected by default.

From (Submitted Date)

Enter a submitted date for which to display tasks, or click the drop-down arrow to select a submitted date. If you want to display tasks for a range of submitted dates, enter the first date in the range. This field is only enabled if you clear the All Submitted Dates check box.

To (Submitted Date)

Enter the last submitted date in a range of submitted dates for which to display tasks, or click the drop-down arrow to select a submitted date. If you want to only display tasks for a single submitted date, you can leave this field blank. This field is only enabled if you clear the All Submitted Dates check box.

All Scheduled Dates

Select this check box to display tasks for all scheduled dates. This check box is selected by default.

From (Scheduled Date)

Enter a scheduled date for which to display tasks, or click the drop-down arrow to select a scheduled date. If you want to display tasks for a range of scheduled dates, enter the first date in the range. This field is only enabled if you clear the All Scheduled Dates check box.

To (Scheduled Date)

Enter the last scheduled date in a range of scheduled dates for which to display tasks, or click the drop-down arrow to select a scheduled date. If you want to only display tasks for a single scheduled date, you can leave this field blank. This field is only enabled if you clear the All Scheduled Dates check box.

All Completed Dates

Select this check box to display tasks for all completed dates. This check box is selected by default.

From (Completed Date)

Enter or select a completed date for which to display tasks. If you want to display tasks for a range of completed dates, enter the first date in the range. This field is only enabled if you clear the All Completed Dates check box.

To (Completed Date)

Enter or select the last completed date in a range of completed dates for which to display tasks. If you want to only display tasks for a single completed date, you can leave this field blank. This field is only enabled if you clear the All Completed Dates check box.

Recurring Tasks

Select this check box to display recurring tasks. This check box is selected by default.

Non-Recurring Tasks

Select this check box to display non-recurring tasks. This check box is selected by default.

After Parent Tasks

Select this check box to display tasks that are set up to process after other tasks. This check box is selected by default.

Pending Tasks

Select this check box to display tasks with Pending status. This check box is selected by default, and is only available if the Task Definitions radio button is selected.

Completed Tasks

Select this check box to display tasks with Completed status. This check box is cleared by default, and is only available if the Task Definitions radio button is selected.

Cancelled Tasks

Select this check box to display tasks with Cancelled status. This check box is cleared by default, and is only available if the Task Definitions radio button is selected.

Failed Tasks

Select this check box to display tasks with Failed status. This check box is selected by default, and is only available if the Task Definitions radio button is selected.

Tasks In Progress

Select this check box to display tasks currently in process (tasks with Starting and In-Progress status). This check box is selected by default, and is only available if the Task Definitions radio button is selected.

Tasks on Hold

Select this check box to display tasks that are on hold. This check box is selected by default, and is only available if the Task Definitions radio button is selected.

Others

Select this check box to display tasks with Killed status.

NOTE If an SA task with In Progress status for more than 48 hours or with Starting status for more than 15 minutes, it will be killed and assigned with the Killed status. This check box is cleared by default, and is only available if the Task Definitions radio button is selected.

Pending Tasks Never Run

Select this check box to show tasks with Pending status that are never run in the selected date range. When this check box is selected, all Tasks Status check boxes are disabled and only the Pending Tasks check box is selected. This check box is cleared by default, and is only available if the Task Definitions radio button is selected.

Tasks with Exceptions

Select this check box to display tasks with exceptions. This check box is selected by default, and is only available if the Task History radio button is selected.

NOTE When any of the date filters (Submitted Date, Scheduled Date and Completed Date) are used, the system looks at the latest task run status in the selected date range and the task will be displayed if its status is Failed.

Tasks Without Exceptions

Select this check box to display tasks without exceptions. This check box is selected by default, and is only available if the Task History radio button is selected.

NOTE When any of the date filters (Submitted Date, Scheduled Date and Completed Date) are used, the system looks at the latest task run status in the selected date range and the task will be displayed if its status is Completed.

Results Tab Fields and Buttons

Field or Button

Description

Tasks

This grid displays Scheduling Assistant tasks or task history that meet the criteria selected on the Select tab after you click the Show Data button in the ribbon. You can change the description for a task in the Task Description grid column. You can also change the printer for tasks.

If you want to cancel multiple tasks, select the check box in the Select grid column, and then click the Cancel Selected button in the toolbar.

Tasks

This field displays the total number of displayed Scheduling Assistant tasks.

Emails Tab Fields and Buttons

Field or Button

Description

Status

Select a status of email tasks to display or select the All radio button to display all email tasks.

All Submitted by Users

Select this check box to display email tasks for all users. This check box is selected by default.

User

Enter a user ID for which to display email tasks, or click the Lookup button to select a user ID. This field is only enabled if you clear the All Submitted by Users check box.

All Submitted Dates

Select this check box to display email tasks for all submitted dates. This check box is selected by default.

From Date (Submitted)

Enter a submitted date for which to display email tasks, or click the drop-down arrow to select a submitted date. If you want to display email tasks for a range of submitted dates, enter the first date in the range. This field is only enabled if you clear the All Submitted Dates check box.

To Date (Submitted)

Enter the last submitted date in a range of submitted dates for which to display email tasks, or click the drop-down arrow to select a submitted date. If you only want to display email tasks for a single submitted date, you can leave this field blank. This field is only enabled if you clear the All Submitted Dates check box.

All Sent Dates

Select this check box to display email tasks for all sent dates. This check box is selected by default.

From Date (Sent)

Enter a sent date for which to display email tasks, or click the drop-down arrow to select a sent date. If you want to display email tasks for a range of sent dates, enter the first date in the range. This field is only enabled if you clear the All Sent Dates check box.

To Date (Sent)

Enter the last sent date in a range of sent dates for which to display email tasks, or click the drop-down arrow to select a sent date. If you only want to display email tasks for a single sent date, you can leave this field blank. This field is only enabled if you clear the All Sent Dates check box.

Tasks

This grid displays email Scheduling Assistant tasks that meet the criteria selected on the Emails tab after you click the Show Data button on the toolbar. If an email fails to send for a task, select it, and then click the Retry button on the toolbar.

Output Options

Field or Button

Description

Download

Output to an Excel file in the folder entered in the Report Working Directory field for your user ID in User Profile Maintenance.

Email

This option is only available if you print via Scheduling Assistant. You are prompted to select recipients of an email, and Scheduling Assistant sends an email with the report attached as an Excel file.

File Types

Only Excel file type is available for selection.

Specify File Name

Select this check box to specify the file name of the output report.

Output File Name

Enter a location and file name for the output report. The file extension of the file name should match the selected download type. This field is only available if you select the Specify File Name check box.

Excel Format Name

Enter an Excel format name, or click the Lookup button to select an Excel format name. Excel formats can be set up to specify which fields are output to Excel, and the order and sort order of the fields. This field is only available if you select the Excel radio button.

Format Maintenance

Click this button to display Excel Format Maintenance, which allows you to set up Excel formats. This button is only available if you select the Excel radio button.

Email Address

Enter an email address, or click the Lookup button to select an email address. This field is only available if you select the Email radio button.

Subject

Enter a subject for the report email. This field is only available if you select the Email radio button. If you leave this field blank, the subject is the report title.

Report File Prefix

Enter a prefix for the report file name. This field is only available if you select the Email radio button.

Add Additional Comments

Select this check box if you want to include additional comments with the emailed report. If you select this check box, the Additional Comments window appears after you click the Print button, and allows you to enter the comments. This check box is only available if you select the Email radio button.

Time

Enter the time to output or process, and select AM or PM.

These fields are only enabled if the Schedule radio button is selected, and only available if the Once or Every radio button is selected.

Date

Enter the date (or first date) to output or process. This field is only enabled if the Schedule radio button is selected, and only available if the Once or Every radio button is selected.

Frequency

Select one of the following options:

  • Once - Output or process at a specified date and time.

  • Every - Output or process on a recurring basis. You can select to output/process at a specific time:

  • every week on specified days

  • after a specified number of days

  • on the first or last day of each month

  • after a specified number of minutes

  • After - Output/process after a specified task is completed.

These radio buttons are only enabled if you select the Schedule radio button.

When

Select one of the following:

  • Day of Week - Output or process every week on the selected days.

  • Days - Output or process after a specified number of days, starting on a specified date.

  • Month - Output or process on the first or last day of each month, starting on a specified date.

  • Time - Output or process after a specified number of minutes, starting on a specified date.

These radio buttons are only available if you select the Every radio button.

Day of Week

Select the day(s) of the week to output or process.

These check boxes are only enabled if you select the Schedule tab, and select the Every and Day of Week radio buttons.

Repeat Every X Days

Enter a number of days after which to output or process. This field is only available if you select the Days radio button.

Repeat On

Click the Lookup button and select whether to output or process on the first or last day of the month. This field is only available if you select the Month radio button.

Repeat Every X Minutes

Enter a number of minutes after which to output or process. This field is only available if you select the Time radio button.

Triggering Task Id

Click the Lookup button to select a task ID that will trigger the task. This field is only available if the After radio button is selected.

Triggering Task Name

This field displays the name of the triggering task. This field is only available if the After radio button is selected.

Triggering Task Description

This field displays the description of the triggering task. This field is only available if the After radio button is selected.

Task Description

Enter a description of the task. This can help users understand the purpose of a recurring task.

Scheduling Assistant Queue

Enter an active Scheduling Assistant queue for the task, or click the Lookup button to select a Scheduling Assistant queue. This defaults to the default queue for your user ID. This field is only enabled if you select the Schedule tab, and you are assigned to a queue other than the Default queue.

External Email

Select this check box to send an email (outside of Apprise, using SMTP) when the task is completed.

Screen Alert

Select this check box to display an alert when the task is completed.

Internal Email

Select this check box to send an internal Apprise email when the task is completed.

Report Files

This grid displays report files set up for the report, and is only available if report files are set up for the program in Report File Maintenance. This grid includes the following columns:

  • Print - Select the check box in this column to output the report file.

  • Number of Copies - Enter the number of copies of the report file to print. This column is only available if you select the Printer radio button.

  • Report Description - This column displays the description of each report file.

  • Report Filename - This column displays the .rpt file name for each report file.

  • Report Name - This column displays the name of each report file.