The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This section provides an overview of the Tidal Entersprise Scheduler Web Services SOAP API by describing the operations in the API. Tidal recommends that you review the WSDL and schema files for details of each operation and its parameters.
The addrule operation defines a new job rule (job definition). It can be followed by the modrule operation to further define other job parameters.
After addrule has been issued, use the submit operation to add the job to the production schedule.
<input message="tns:addrule"/>
The agent operation enables or disables a connection to an agent provided you have the correct security privileges for editing this connection.
The alerts operation displays all the operator alerts presently in the production schedule in table format. The columns included are:
The alertset operation lets you manually set the status of an alert specified by the alert ID. To obtain the job number alert ID, use the alerts operation.
<input message="tns:alertset"/>
The calendars operation displays a list of calendars accessible to the current user.
<input message="tns:calendars"/>
The calrecalc operation recalculates all calendar dates.
<input message="tns:calrecalc"/>
The compile operation compiles the production schedule for the dates specified.
<input message="tns:compile"/>
The delrule operation deletes a job or job group definition. You can either specify the alias or the ID of the job or job group.
<input message="tns:delrule"/>
The depadd operation adds a new job dependency or file dependency.
The depdel operation deletes job dependencies and file dependencies. It then replaces that job's predone instances in the production schedule.
Refer to the submit operation.
The getmasterstatus operation provides the operational status of the UNIX master being used.
<operation name="getmasterstatus">
<input message="tns:getmasterstatus"/>
The getmasterversion operation displays the version of the UNIX master being used.
<operation name="getmasterversion">
<input message="tns:getmasterversion"/>
The grpupd operation updates inherit attributes for jobs in the specified group. You can obtain the group’s Job ID by using the grpupd operation.
The historypurge operation will delete the job history that is stored in the database.
<operation name="historyPurge">
<input message="tns:historyPurge"/>
The hosts operation lists information about all Scheduler hosts defined in Scheduler.
The inactrule operation inactivates or disables a job or job group. When a job or job group is inactivated, its occurrences (if any) are pulled from the production schedule.
<input message="tns:inactrule"/>
The jobadd operation lets you add a job or job group to the production schedule. You can add a job either by alias or by ID. You can obtain the job occurrence ID and/or alias by using the listrule operation. Unlike the submit operation, the job is submitted adhoc. An adhoc job is not dependent on a calendar because a new instance is submitted manually into the schedule.
The jobcancel operation cancels a job occurrence with the specified job ID from the production schedule. You can also specify whether canceling the job affects other dependent jobs. You can obtain the ID by running the jobmon operation.
<input message="tns:jobcancel"/>
The jobdep operation displays all the dependencies of the specified type belonging to a job or job group.
The jobgo operation overrides all dependencies for a job or job group, allowing the job or job group to launch. Obtain job run IDs by running the jobmon operation.
The jobhold operation prevents a job occurrence with the specified job occurrence ID from running in the production schedule. Obtain the job occurrence ID by running the jobmon operation.
<input message="tns:jobhold"/>
The jobmod operation modifies a Job Occurrence. You can obtain the job run ID by using the jobmon operation.
The jobmon operation enables you display job occurrence information. Command options allow you to filter the information displayed.
The
jobrelease
operation resumes a job occurrence that was held with the
jobhold
operation and releases a job in a
Waiting on Operator
status. You can obtain the job run ID by using the
jobmon
operation.
<input message="tns:jobrelease"/>
The jobremove operation removes job occurrences from the production schedule. The job must have a prelaunched status. Once a job reaches Launched, Active, or one of the Completed statuses, it cannot be removed from the schedule. You can obtain the job rule ID by running the listrule operation.
<input message="tns:jobremove"/>
The jobrerun operation lets you manually rerun a completed job or job group. You can obtain the job run ID by using the jobmon operation.
<input message="tns:jobrerun"/>
The jobset operation lets you manually set the completion status of a job. You can obtain the job run ID by using the jobmon operation.
The listrule operation lists information about job and job group rules. You can choose the information to list. You can also select which records to display.
<input message="tns:listrule"/>
The liststat operation lists all possible job statuses and their associated status number in a two column format.
<input message="tns:liststat"/>
The mastershutdown operation shuts down the UNIX master.
<operation name="masterShutDown">
<input message="tns:masterShutDown"/>
The modrule operation modifies a job or job group definition (rule). To modify the rule, either the job ID or an alias must be specified.
<input message="tns:modrule"/>
The pause operation temporarily halts the production schedule thereby preventing jobs, even those whose dependencies have been met, from being launched. To restart the production schedule, use the resume operation.
The qlimit operation lets you manually set the limit of an existing queue.
The resume operation resumes the production schedule, allowing jobs to be launched after using pause to temporarily stop the production schedule. This does not apply to jobs that are waiting on dependencies.
The status operation displays the status of a job or job group instance.
Status is the condition or state of a job occurrence throughout its life cycle. When a job has entered the schedule and is waiting to run or is actively running, possible statuses include:
When a job completes, possible status values are:
If the status of a job occurrence is Externally Defined, then Scheduler is waiting for an external status update.