Some of the content described in this article is available in meshIQ Manage versions 12.1 and greater.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.
Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier
Version 12.x and Later
When you schedule actions for objects, those actions can automatically take place at a later time, such as during a change or testing window.
Actions you can schedule include creating, deleting, modifying, starting or stopping objects. Message actions such as loading messages to a file or clearing a queue can also be scheduled.
Before you can schedule actions, your workgroup server must have the Job Scheduler Expert. Please see How do I install the Job Scheduler Expert for requirements and setup instructions.
Jump ahead |
Viewing an Object's Scheduled Jobs
There is a clock icon next to the name of each object. The color represents the status of the object's scheduled jobs.
– no scheduled items found
– all scheduled items found are complete
– scheduled items are present and none are pending
– scheduled items include some pending approval
– some scheduled items failed
To view an object's scheduled jobs, click on its clock icon. A window similar to the following screenshot opens, displaying the object's past and future jobs.
The Status field displays the status of the job; potential statuses include Pending, Ready, Retrying, Cancelled, Success, or Failure. The Tags field displays the tag (job name) that you specified when the job was created.
Scheduling a Job
- Select an object to open its Selected menu, then choose the action you want to schedule.
In the screenshot below, the Start All WMQ Objects action is being scheduled for two queue managers. - On the action dialog, click the Schedule button.
- The Scheduler dialog opens. Enter the date and time. Specify a name for the scheduled job in the Tag for scheduled job field. Click Ok. The action is now scheduled.
- The object's clock icon will now appear yellow, signifying that the object has a job scheduled but that it has not yet been approved. See the following section for more information.
Approving Scheduled Jobs
Ensure that the Require approval for job schedules option is enabled in the WGS properties. This setting is mandatory to display the Approve button and to enable the Approve All button for scheduled job approval.
- To view all scheduled jobs across all objects, click the Schedules
icon located on the top-right toolbar.
- Jobs that are pending approval show a status of Pending and are listed with an Approve button.
- Choose one of the following:
- To approve a single job, click the Approve button that corresponds to that job. A Job Approval Action message is displayed. Click Yes to confirm the approval.
- The job Status is updated to Ready.
- To approve all Pending or Retrying jobs, click the Approve All button. A Job Approval Action message appears. Click Yes to confirm.
The job statuses for all jobs are updated to Ready.
- To approve a single job, click the Approve button that corresponds to that job. A Job Approval Action message is displayed. Click Yes to confirm the approval.
- The clock icons for the ready jobs are now green:
Viewing All Scheduled Jobs
All past and future scheduled jobs for all objects can be found by clicking the Schedules icon, located on the top-right toolbar. The Schedules window opens.
You can choose which columns to display on this dialog by clicking Columns button. See Choosing Scheduler Columns.
Use the Search field to locate a scheduled job by entering its tag name and clicking the Search for tag button.
Select a scheduled job to open the Scheduled job info screen where all of the job's details are displayed.
Scheduled job details (EXCMD_INQUIRE_JOB) also return EXCA_RESPONSE_TEXT. Response Text will only have a value if the scheduled request was an Escape command.
The amount of data displayed in the Response Text row is limited to 2 KB.
You can then click the Response Text details to expand the row to include the full response.
Cancelling a Scheduled Job
Scheduled jobs can be cancelled from the Scheduled Job Info dialog. Click the Cancel Schedule button at the bottom of the dialog to cancel the job.
Choosing Scheduler Columns
To choose which columns you want to include on the table of scheduled jobs on the Schedules window, click Configure columns button at the top of the dialog. Select the checkboxes of the columns you want to display, and clear the checkboxes of the columns you do not want to display. Click Ok.
Delete Scheduling Job
Use the Delete option to remove scheduled jobs.
You must have Purge Schedule Job right to perform this action.
Click Delete
button to open the Schedule Data Deletion dialog.
Only jobs with the statuses Success, Failure, Cancelled, or Deleted can be removed.
Select the date and time. All items older than the selected date will be permanently deleted.
Select the required Workgroup Servers or keep All Workgroup Servers selected.
Click Delete to confirm.
______________________________________________________________________________________________________________
Version 11.3 and Earlier
When you schedule actions for objects, those actions can automatically take place at a later time, such as during a change or testing window.
Actions you can schedule include creating, deleting, modifying, starting or stopping objects. Message actions such as loading messages to a file or clearing a queue can also be scheduled.
Before you can schedule actions, your workgroup server must have the Job Scheduler Expert. Please see How do I install the Job Scheduler Expert for requirements and setup instructions.
Jump ahead |
Viewing an Object's Scheduled Jobs
There is a clock icon next to the name of each object. The color represents the status of the object's scheduled jobs.
| In version 11.0 | In version 11.1 and later |
– no scheduled items found
– all scheduled items found are complete
– scheduled items are present and none are pending
– scheduled items include some pending approval
– some scheduled items failed
To view an object's scheduled jobs, click on its clock icon. A window similar to the following screenshot opens, displaying the object's past and future jobs.
The Status field displays the status of the job; potential statuses include Pending, Ready, Retrying, Cancelled, Success, or Failure. The Tags field displays the tag (job name) that you specified when the job was created.
Scheduling a Job
- Select an object to open its pop-up menu (Selected menu from version 11.2 onwards) and select the desired action you want to schedule.
In the below screenshot, the Start all WMQ objects action is going to be scheduled for two queue managers. -
On the action window, click the Schedule button.
-
The Scheduler window opens. Enter the date and time. Specify a name for the scheduled job in the Tag for scheduled job field. Click Ok. The action is now scheduled.
-
The object's clock icon will now appear yellow, signifying that the object has a job scheduled but that it has not yet been approved. See the following section for more information.
In version 11.0 In version 11.2 and later
Approving Scheduled Jobs
You must have the Approve Scheduled Job right to perform the actions below.
The 'Approve All' button will be enabled only when the 'Require approval for job schedules' option is activated in the WGS properties. You must click this button to approve and run the scheduled jobs.
- To view all scheduled jobs for all objects, click the clock
icon, located in the top-right toolbar (located in the left toolbar from version 11.1 onwards).
- Jobs that are pending approval show a status of Pending and are listed with an
button.
- Choose one of the following:
- To approve a single job, click the
button that corresponds to that job. A Job Approval Action message is displayed. Click Yes to confirm the approval.
The job Status is updated to Ready. - To approve all Pending or Retrying jobs, click
in the upper right corner of the dialog. A Job Approval Action message is displayed. Click Yes to confirm the approval.
The job statuses for all jobs are updated to Ready.
- To approve a single job, click the
-
The clock icons for the ready jobs are now green:
In version 11.0 In version 11.2 and later
Viewing All Scheduled Jobs
All past and future scheduled jobs for all objects can be found by clicking the clock, located in the top-right toolbar (located in the left toolbar from version 11.1 onwards).
The Schedules window opens.
You can choose which columns to display on this dialog by clicking Columns. See Choosing Scheduler Columns.
Use the Search field to locate a scheduled job by entering its tag name and clicking the Search for tag button.
Select a scheduled job to open the Scheduled job info screen where all of the job's details are displayed.
In version 11, scheduled job details (EXCMD_INQUIRE_JOB) also return EXCA_RESPONSE_TEXT. Response Text will only have a value if the scheduled request was an Escape command.
The amount of data displayed in the Response Text row is limited to 2 KB.
You can then click the Response Text details to expand the row to include the full response.
Choosing Scheduler Columns
To choose which columns you want to include on the table of scheduled jobs on the Schedules dialog, click Columns at the top of the dialog. Select the checkboxes of the columns you want to display, and clear the checkboxes of the columns you do not want to display. Click OK.
Cancelling a Scheduled Job
Scheduled jobs can be cancelled from the Scheduled job info screen displayed above. Click the Cancel Schedule button at the bottom of the screen to cancel the job.
Delete Scheduling Job
Starting from version 11.2.4, the Delete button is available to remove scheduled jobs.
You must have Purge Schedule Job right to perform this action.
Click the Schedules
icon on the left toolbar to view all scheduled jobs.
Click Delete to open the Schedule Data Deletion dialog.
Only jobs with the statuses Success, Failure, Cancelled, or Deleted can be removed.
In the dialog:
Select a date and time: All items older than this will be permanently deleted.
Choose Workgroup Servers: Apply to specific servers or leave as All Workgroup Servers.
Click Delete to confirm.