Tivoli: Workload Scheduler

Tivoli Workload Scheduler

Version 8.5
Application Programming Interfaces
SC23-9608-00
Note
Before using this information and the product it supports, read the information in “Notices” on page 17.
This edition applies to version 8, release 5, modification 0 of IBM Tivoli Workload Scheduler (program number
5698-WSH) and to all subsequent releases and modifications until otherwise indicated in new editions.
© Copyright International Business Machines Corporation 1991, 2008.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
About this publication . . . . . . . . v Java API for Tivoli Workload Scheduler . . . . . 4
What is new in this release . . . . . . . . . v Overview . . . . . . . . . . . . . . 4
What is new in this release for application Resources . . . . . . . . . . . . . . 5
programming interfaces . . . . . . . . . . v Naming conventions. . . . . . . . . . . 5
What is new in this publication . . . . . . . . v API specifications and description . . . . . . 5
Who should read this publication . . . . . . . v Examples . . . . . . . . . . . . . . 5
Publications . . . . . . . . . . . . . . vi
Accessibility . . . . . . . . . . . . . . vi Chapter 3. Web services interface . . . 11
Tivoli technical training . . . . . . . . . . vi Further information . . . . . . . . . . . 12
Support information . . . . . . . . . . . vi
Appendix. Java API Resources . . . . 13
Chapter 1. Introduction . . . . . . . . 1
Notices . . . . . . . . . . . . . . 17
Chapter 2. Integration Workbench . . . 3 Trademarks . . . . . . . . . . . . . . 18
Installing Integration Workbench . . . . . . . 3
Using Integration Workbench . . . . . . . . . 3
© Copyright IBM Corp. 1991, 2008 iii

iv IBM Tivoli Workload Scheduler: Application Programming Interfaces
About this publication
IBM® Tivoli® Workload Scheduler: Application Programming Interfaces provides an
overview of the application programming interfaces (API) available to you to
customize the interfaces of IBM Tivoli Workload Scheduler.
What is new in this release

For information about the new or changed functions in this release, see Tivoli
Workload Automation: Overview.
For information about the APARs that this release addresses, see the Tivoli
Workload Scheduler Download Document.
What is new in this release for application programming interfaces

This section describes what has changed in this release with regard to application
programming interfaces since version 8.4 Fix Pack 01.
The major item is the introduction of the new Tivoli Workload Scheduler
Integration Workbench (occasionally referred to as "SDK"). See Chapter 2,
“Integration Workbench,” on page 3.
In addition, the Java™ application programming interface has been modified to

include the classes and other objects required for the new functions available in
this release.
What is new in this publication

This is a new publication.
Who should read this publication

This publication provides information about how to create alternative interfaces to
Tivoli Workload Scheduler than those provided with the product.
The reader of this book should be an expert application programmer, who has a
reasonable understanding of the Tivoli Workload Scheduler infrastructure and its
inter-component interactions, or the manager of such a person, who wants to better
understand what you can achieve using the application programming interfaces.
The publication assumes that the application programmer is experienced at

creating these types of interface. It also assumes that any product knowledge that
is required to program the API is obtained from the product documentation. This
publication does not attempt to explain any of the Tivoli Workload Scheduler
concepts, procedures, and practices to which it refers.
This book also contains information useful to the IT administrator and the Tivoli
Workload Scheduler IT administrator, for planning purposes.
© Copyright IBM Corp. 1991, 2008 v

Publications
Publications
Full details of Tivoli Workload Scheduler publications can be found in Tivoli
Workload Automation: Publications. This document also contains information on the
conventions used in the publications.
A glossary of terms used in the product can be found in Tivoli Workload Automation:
Glossary.
Both of these are in the Information Center as separate publications.
Accessibility
Accessibility features help users with a physical disability, such as restricted
mobility or limited vision, to use software products successfully. With this product,
you can use assistive technologies to hear and navigate the interface. You can also
use the keyboard instead of the mouse to operate all features of the graphical user
interface.
For full information with respect to the Tivoli Dynamic Workload Console, see the
Accessibility Appendix in the Tivoli Workload Scheduler: User's Guide and Reference,
SC32-1274.
For full information with respect to the Job Scheduling Console, see the
Accessibility Appendix in the Tivoli Workload Scheduler: Job Scheduling Console User’s
Guide.
Tivoli technical training

For Tivoli technical training information, refer to the following IBM Tivoli
Education Web site:
http://www.ibm.com/software/tivoli/education
Support information
If you have a problem with your IBM software, you want to resolve it quickly. IBM
provides the following ways for you to obtain the support you need:
v Searching knowledge bases: You can search across a large collection of known
problems and workarounds, Technotes, and other information.
v Obtaining fixes: You can locate the latest fixes that are already available for your
product.
v Contacting IBM Software Support: If you still cannot solve your problem, and
you need to work with someone from IBM, you can use a variety of ways to
contact IBM Software Support.
For more information about these three ways of resolving problems, see the
appendix on support information in Tivoli Workload Scheduler: Troubleshooting Guide.
vi IBM Tivoli Workload Scheduler: Application Programming Interfaces

Chapter 1. Introduction
This publication provides an overview of the following application programming
interfaces that you use to create your own interfaces for Tivoli Workload
Scheduler:
Chapter 2, “Integration Workbench”
Use the Integration Workbench to extend the Eclipse IDE for Java
Developers to do the following:
v Simplify the creation of plug-ins
v Use a Java-based application programming interface to create your own
GUI or command-line interface to control Tivoli Workload Scheduler.
You can perform all the functions of the command-line programs
composer, conman, and planman
See Chapter 2, “Integration Workbench,” on page 3.
Chapter 3, “Web services interface”
Use the Web Services access mechanism to create your own web client
application to perform a subset of Tivoli Workload Scheduler functions to
manage jobs and job streams in the plan.
See Chapter 3, “Web services interface,” on page 11.
© Copyright IBM Corp. 1991, 2008 1

2 IBM Tivoli Workload Scheduler: Application Programming Interfaces
Chapter 2. Integration Workbench
Use the Integration Workbench to extend the Eclipse IDE for Java Developers to
simplify the creation of the following:
v Event and action plug-ins that extend the capabilities of the event-driven
workload automation (EDWA) feature of Tivoli Workload Scheduler.
v Java applications that use Tivoli Workload Scheduler Java application
programming interfaces to do the following tasks:
– Modify objects in the database
– Submit workload
– Monitor and take actions on the plan
The information about Integration Workbench is organized as follows:

v “Installing Integration Workbench”
v “Using Integration Workbench”
v “Java API for Tivoli Workload Scheduler” on page 4
Installing Integration Workbench

The Integration Workbench (occasionally referred to as SDK) runs under Eclipse.
The installation, which is fully described in the Tivoli Workload Scheduler: Planning
and Installation Guide, gives you the opportunity to install Integration Workbench
and a bundled, supported version of Eclipse in one action, or to install Integration
Workbench as an Eclipse site using an existing supported version of Eclipse
available in your network.
In both cases, at the end of the installation, on the panel where you click Finish,
there is an option to display the file readmefirst.html, which contains information
about the workbench, and how to run it. This information is also given here, in
“Using Integration Workbench.”
For more information about Eclipse, go to http://www.eclipse.org/.
Using Integration Workbench

To use the Integration Workbench, do the following:
1. Launch the workbench, as follows:
Integration Workbench installed with Eclipse
UNIX®
Launch the following file: <TWS_home>/TWS/
IntegrationWorkbench/eclipse/eclipse
Windows®
Go to Start → Tivoli Workload Scheduler → Integration
Workbench
Integration Workbench installed as Eclipse site
Open your version of Eclipse, as you normally do.

2. Select the location to save your Eclipse workspace. Eclipse requests this every
time you run it or the workbench within it, unless you check the option to save
a particular location as the default.
3. When the Eclipse window opens, select Help → Help Contents → IBM Tivoli
Workload Scheduler Integration Workbench
4. Select Tasks → TWS API Projects and read the information on how to create
and run a project
Note: The above information can also be read by opening the following document
in a Web browser: <TWS_home>/TWS/IntegrationWorkbench/readmefirst.html
Each function that you can perform in the workbench is fully documented, but it
will help you to understand how to work with the API to read the overview
provided here, in “Java API for Tivoli Workload Scheduler.”
Java API for Tivoli Workload Scheduler

This section describes the Java-based Application Program Interface (API) that you
use to create your own interface, command line, or GUI, for many of the functions
of IBM Tivoli Workload Scheduler.
It is divided into these sections:

v “Overview”
v “Resources” on page 5
v “Naming conventions” on page 5
v “API specifications and description” on page 5
v “Examples” on page 5
Overview
Tivoli Workload Scheduler is provided with a J2E API that uses Enterprise Java
Beans to interface with the product for many of the most commonly-used tasks.
You can perform the tasks performed by the Job Scheduling Console and the Tivoli
Dynamic Workload Console (both use the API for their tasks). This includes all
tasks performed by the command-line programs composer, conman, and planman.
To find out more about how to program this type of API, see the following IBM
Redbooks®:
IBM Redbooks: EJB 2.0 Development with WebSphere Studio Application Developer,
SG24-6819
This IBM Redbook provides detailed information on how to effectively use
WebSphere® Studio Application Developer for the development of
applications based on the Enterprise JavaBeans™ (EJB) architecture, and
deployment of such applications to a WebSphere Application Server.
To access this publication, follow this link: http://www.redbooks.ibm.com/
abstracts/sg246819.html.
IBM Redbooks: Programming J2EE APIs with WebSphere Advanced, SG24-6124
This IBM Redbook has examples of programming the new J2EE APIs using
VisualAge® for Java and deployment on WebSphere Advanced.

Resources
The classes and methods you use are indicated in the Integration Workbench, but
if you need to understand more about how they are distributed within the jar files
supplied with the Integration Workbench, see “Java API Resources,” on page 13.
Naming conventions
The naming conventions for the objects are quite straightforward. The only
important one to remember is that an object in the database is differentiated from
an object in the plan by the suffix "InPlan" to the object class name.
API specifications and description

The full specification for the beans can be consulted by opening the following
HTML file: <TWS_home>/TWS/doc/Javadoc/index.html
To obtain a description of the use of the different panes of the API panel, click
Help.
Classes in the Deprecated category should not be used.
Examples
The following examples help you to understand how the beans are used. The
examples are annotated with explanatory comments. They are available in these
groupings:
v “Examples: working with objects in the database”
v “Examples: Working with objects in the plan” on page 6
v “Examples: Working with event rules in the database” on page 7
Examples: working with objects in the database

The following examples indicate how you use the classes to work with objects in
the database:
Example 1: Adding a workstation to the database:

//Object definition
String wksName = "MYWS";
Workstation wks = new Workstation();
wks.setName(wksName);
wks.setType(WorkstationType.FTA);
wks.setOs(OperatingSystem.UNIX);
wks.setAutoLink(true);
wks.setNodeName("node.ibm.com");
wks.setSecurityLevel(SecurityLevel.NONE);
ConnModel myModel;
//Get an instance of ConnModel interface...
...
//Add the object

try
{
myModel.addTWSObject(wks, null);
}
catch (ConnException e)
{
//Do something to recover...
}
Chapter 2. Integration Workbench 5

Example 2: Retrieving a workstation from the database:
Workstation wksRead = new Workstation();
//Get the same workstation from the DB
try
{
wksRead = (Workstation) myModel.getTWSObject(Workstation.class,
new FlowTargetKey(wksName), false, null);
}
{
}
Example 3: Removing a workstation from the database:

//Remove a workstation from the DB
try
{
myModel.removeTWSObject(Workstation.class, wksRead.getId(), null);
}
catch (ConnException exc)
{
}
Examples: Working with objects in the plan

The following examples indicate how you use the classes to work with objects in
the plan:
Example 4: Submitting a job stream instance into the current plan: This
procedure requires several actions:
1. Obtain the required job stream definition from the database and transform it
into a JobStreamInPlan:
ConnPlan myPlan;
//Get an instance of ConnPlan interface...
...
String alias = "SBJBF1_1";

JobStream js = null;
JobStreamInPlan jsip = null;
//If you already have a JobStream in the DB with Identifier jsDbID...
try
{
//get it from the DB
js = (JobStream)(myPlan.getTWSObject(JobStream.class,jsDbID,false,null));
//Transform it in a JobStreamInPlan.
//TODAY is a variable representing the scheduled time
jsip = myPlan.makeJobStreamInPlan(jsDbID, TODAY, alias, null);
}
{
//Something went wrong...
}
catch (ConnEngineNotMasterException e)
{
//Since the makeJobStreamInPlan is available also on FTAs
//(it's on the Plan interface), an exception must be thrown
//if it is called on an engine that is not the master
}
2. Add the JobStreamInPlan to the plan:
List idList = new ArrayList();
try
{

//Add the job stream to the plan.
//This method returns a list of Identifiers because the job stream can be
//defined on a Workstation class, so you have an ID for each workstation
//of the class
idList = (ArrayList)myPlan.addJobStreamInstance(jsip, null);
}
{
//...
}
catch (ConnEngineNotMasterException e)
{
//...
}
Example 5: Making a query on the plan: The following example lists the first
five jobs that begin with the letter "A":
String nameFilter = "A*";
int howMany = 5;
QueryFilter qf = new QueryFilter();

qf.setFilter(JobInPlanFilters.JOB_NAME, nameFilter);
QueryResult qr = null;
try
{
qr = myPlan.queryPlanObject(JobInPlan.class, qf, howMany, null);
}
{
//...
}
Examples: Working with event rules in the database

The following examples indicate how you use the classes to work with event rules
in the database:
Example 6: Adding an event rule to the database: Follow these steps:

1. Define the event rule:
String eventRuleName = "SampleEventRule";
String eventRuleDescription =
"Define Event Rule; test MessageLoggerPlugIn and TWSObjectsMonitorPlugIn";
Date today = new Date(System.currentTimeMillis());
Date tomorrow = new Date(System.currentTimeMillis() + 86400000L);
//EventRule definition
EventRule er = new EventRule();

er.setName(eventRuleName);
er.setDescription(eventRuleDescription);
er.setRuleType(EventRuleType.FILTER);
er.setDraft(false);
er.setValidFrom(today);
er.setValidTo(tomorrow);
2. Define the event condition. In this case the condition is a job submission:
EventCondition evCond = new EventCondition();
evCond.setPluginName(TWSObjectsMonitorPlugIn.PLUGIN_NAME);
evCond.setEventType(JobUtil.EVENT_JOB_SUBMIT);
3. Define the conditions that the event condition has to satisfy to trigger the rule
action (the filtering predicate):
String filterPred = "<attributeFilter name=\"JobStreamWorkstation\"
operator=\"eq\">"
+ "<value>MYWS</value>"

+ "</attributeFilter>"
+ "<attributeFilter name=\"JobStreamName\" operator=\"eq\">"

+ "<value>JS1</value>"
+ "<attributeFilter name=\"JobName\" operator=\"eq\">"

+ "<value>JOB1</value>"
+ "<attributeFilter name=\"Workstation\" operator=\"eq\">"

+ "<value>MYHOST</value>"
+ "<attributeFilter name=\"Priority\" operator=\"range\">"

+ "<value>10</value>"
+ "<attributeFilter name=\"Monitored\" operator=\"eq\">"

+ "<value>TRUE</value>"
+ "<attributeFilter name=\"EstimatedDuration\" operator=\"ge\">"

+ "<attributeFilter name=\"Login\" operator=\"eq\">"

+ "<value>TWSUser</value>"
+ "<attributeFilter name=\"EveryFrequency\" operator=\"ge\">"

+ "</attributeFilter>";
4. Complete the event condition:
evCond.setFilteringPredicate(filterPred);
5. Add the event condition to the event rule:
er.getTriggerEvents().add(evCond);
6. Define the rule action. In this example, the rule action logs a message in the
database:
RuleAction action = new RuleAction();
action.setPluginName(MessageLoggerPlugIn.PLUGIN_NAME);
action.setActionType(MessageLoggerPlugInConstants.ACTION_TYPE_MESSAGE_LOG);
action.setDescription("Adding the Message logger Plugin");
action.setResponseType(RuleResponseType.ON_DETECTION);
7. Define the value for the rule action parameter:
Map parameterMap = new HashMap();
parameterMap.put(MessageLoggerPlugInConstants.MESSAGE, "message");
parameterMap.put(MessageLoggerPlugInConstants.OBJECT_KEY, "object key");
8. Complete the rule action:
action.getParameterMap().putAll(parameterMap);
9. Add the rule action to the event rule:
er.getActions().add(action);
10. Add the event rule to the ConnModel interface:
ConnModel myModel = null;
//Get an instance of ConnModel interface...
//...
//Add the object
Identifier erId = null;

try
{
erId = myModel.addTWSObject(er, null);
}
{
}
Example 7: Retrieving an event rule:
Example 7.1: Retrieve an event rule from the database by ID: Follow these steps:
1. Obtain the event rule ID to be retrieved by any means appropriate to your
interface
2. Retrieve the event rule:
EventRule eRuleRead = new EventRule();
try
{
eRuleRead =
(EventRule) myModel.getTWSObject(EventRule.class, erId, false, null);
}
{
}
Example 7.2: Retrieve an event rule from the database by key (name): Follow these
steps:
1. Obtain the event rule key (name) to be retrieved by any means appropriate to
your interface
2. Retrieve the event rule:
EventRule eRuleRead = new EventRule();
try
{
eRuleRead =
(EventRule) myModel.getTWSObject(EventRule.class,
new EventRuleKey(eventRuleName), false, null);
}
{
}
Example 8: Deleting an event rule:
Example 8.1: Delete an event rule from the database by ID: Follow these steps:
1. Retrieve by ID the event rule to be deleted, as shown in example 7.1
2. If the event rule has been successfully retrieved, delete it:
{
myModel.removeTWSObject(EventRule.class, eRuleRead.getId(), null);
}
{
}
Example 8.2: Delete an event rule from the database by key (name): Follow these steps:
1. Retrieve by key, the event rule to be deleted, as shown in example 7.2
2. If the event rule has been successfully retrieved, delete it:

{
myModel.removeTWSObject(EventRule.class,
new EventRuleKey(eventRuleName), null);
}
{
}

Chapter 3. Web services interface
Use the Web Services access mechanism to create your own client application to
perform a subset of Tivoli Workload Scheduler functions to manage jobs and job
streams in the plan.
Whenever you install a Tivoli Workload Scheduler component that includes the
Embedded Version of WebSphere Application Server, the following WSDL files:
SchedulingFactory.wsdl
JobService.wsdl
JobstreamService.wsdl
are automatically installed in the following path:

<TWS_home>/eWAS/profiles/twsprofile/installedApps/DefaultNode/
TWSEngineModel.ear/PlanServicesWeb.war/WEB-INF
Open these WSDL files with a Web Services development tool. They provide you
with:
v The server part interfacing the master domain manager to perform the
supported subset of scheduling operations against jobs and job streams in
production.
v A means of creating your own client interface from where service requesters can
request to perform a subset of operations from any system in your environment
by accessing the following location:
https://localhost:31116/PlanServicesWeb/services/<service_name for distributed environment>
https://localhost:31126/PlanServicesWeb/services/<service_name for z/OS environment>
where localhost must be replaced manually with the hostname of the master
domain manager, and service_name for xxx environment is the name of the service
you invoke, that is SchedulingFactory, JobService, or JobStreamService.
v Full documentation on how to use the Java methods in the files
You can also modify the port number to use when binding to the master domain
manager, 31116 for distributed environment or 31126 for z/OS® environment.
Service requesters can create job streams and jobs in the plan by submitting actions
(submitJobStream, submitJob, submitJobAdHoc), to monitor the submitted
objects by getting actions (queryJobStreams, queryJobs, getJobsList, getProperties,
getJobOutput), and to manage them by setting actions (setProperties, cancel, kill,
releaseAllDependencies). Neither database actions nor other plan actions can be
implemented and invoked using this interface.
Table 1 on page 12 shows, for each of the three services provided, the messages
implementing the JAVA methods invoked when performing actions and an
explanation of the action you need to perform.

Web services interface
Table 1. Available messages in the Web services interface

Services Messages Actions performed
SchedulingFactory submitJobStream Submits job streams.
submitJob Submits jobs.
submitAdHocJob Submits jobs in production.
queryJobs Lists all job instances matching the
filtering criteria.
queryJobStreams Lists all job stream instances matching
the filtering criteria.
JobStreamService getProperties Displays job stream properties.
setProperties Sets specified properties for a job
stream instance.
getJobsList Lists all jobs contained in a job stream.
cancel Cancels a job stream instance.
releaseAllDependencies Releases all dependencies for a job
stream instance.
JobService getProperties Displays job properties.
setProperties Sets specified properties for a job
instance.
getOutput Gets a job instance output.
kill Kills a job instance.
cancel Cancels a job instance.
releaseAllDependencies Releases all dependencies for a job
instance.
Further information
For more information on how to manage WSDL files to create your own Web
Services-based user interface refer to the IBM redbook IBM Redbooks: WebSphere
Version 5.1 Application Developer 5.1.1 Web Services Handbook, SG24-6891, which has
the following description:
v This IBM Redbook describes the new concept of Web services from various
perspectives. It presents the major building blocks Web services rely on. Here,
well-defined standards and new concepts are presented and discussed.
v Whereas these concepts are described vendor-independent, this book also
presents IBM’s view and illustrates with suitable demonstration applications
how Web services can be implemented using IBM’s product portfolio, especially
WebSphere Application Server Version 5.1 and WebSphere Studio Application
Developer Version 5.1.1.
v This book is a major update to the IBM Redbook Web Services Wizardry with
WebSphere Studio Application Developer, SG24-6292, and to WebSphere Version
5 Web Services Handbook, SG24-6891-00.


Appendix. Java API Resources
The Java API classes are in the following jar files in the directory:
<TWSUser>/TWS/appserver/profiles/twsprofile/installedApps/DefaultNode/
TWSEngineModel.ear. They can also be found on the product CD for each platform
in the directory<CD_drive>/API/bin/. The files are the following::
CommonServices.jar
Contains base utility classes used by all other jars, such as TWSException
and the implementation of trace and message loggers.
Main packages:
v com.ibm.tws.util.exception
CommonObjects.jar
Contains the definition of common classes shared by: model, plan, and
event rule objects, query filters, and syntax validators.
Main packages:
v com.ibm.tws.objects.types
v com.ibm.tws.objects.filter
v com.ibm.tws.objects.validator
ModelObjects.jar
Contains the definition of Tivoli Workload Scheduler model objects,
together with their query filters and syntax validators.
Main packages:
v com.ibm.tws.objects.model
v com.ibm.tws.objects.model.types
v com.ibm.tws.objects.model.validator
v com.ibm.tws.objects.model.rules
v com.ibm.tws.objects.model.rules.types
PlanObjects.jar
Contains the definition of Tivoli Workload Scheduler plan objects, together
with their query filters and other utilities related to plan objects.
Main packages:
v com.ibm.tws.objects.plan
v com.ibm.tws.objects.plan.types
v com.ibm.tws.objects.plan.utils
EventRuleObjects.jar
Contains the definition of Tivoli Workload Scheduler event rule objects,
together with their query filters and syntax validators.
Main packages:
v com.ibm.tws.objects.rules
v com.ibm.tws.objects.rules.filter
v com.ibm.tws.objects.rules.types

v com.ibm.tws.objects.rules.validator
LogObjects.jar
Contains the definition of Tivoli Workload Scheduler event rule instance,
action run and message log record objects, together with their query filters.
Main packages:
v com.ibm.tws.objects.log
v com.ibm.tws.objects.log.types
ICalendar.jar
Contains a base library of objects that you use to supply scheduling rules
using the iCalendar standard (http://www.ietf.org/rfc/rfc2445.txt).
Main packages:
v com.tivoli.icalendar
v com.tivoli.jss
RunCycles.jar
Contains a set of classes that calculate the dates and times of scheduled job
stream instances from run cycle definitions.
Main packages:
v com.ibm.tws.runcycles
ConnInterfaces.jar
Contains common utility classes and exceptions used by Enterprise Java
Beans that realize connector interfaces.
Main packages:
v com.ibm.tws.conn.exception
v com.ibm.tws.conn.util
TWSConnInterfaces.jar
Contains the definition of Java interfaces implemented by Enterprise Java
Beans that realize engine, model and plan connector interfaces.
Main packages:
v com.ibm.tws.conn.engine
v com.ibm.tws.conn.model
v com.ibm.tws.conn.plan
ConnEventInterfaces.jar
Contains the definition of Java interfaces implemented by Enterprise Java
Beans that realize the event rule engine connector interface.
Main package:
v com.ibm.tws.conn.event.engine
EventPluginInterfaces.jar
Contains the definition of Java interfaces implemented by event and action
plug-in modules.
Main package:
v com.ibm.tws.conn.event.plugin
v com.ibm.tws.conn.event.plugin.action
v com.ibm.tws.conn.event.plugin.listener

ConnEngineEjb.jar
Contains the interface and implementation of the J2EEConnEngine
Enterprise Java Bean (EJB) for the distributed engine.
Main packages:
v com.ibm.tws.conn.engine
ConnModelEjb.jar
Contains the interface and implementation of the J2EE ConnModel
Main packages:
v com.ibm.tws.conn.model
ConnPlanEjb.jar
Contains the interface and implementation of the J2EE ConnPlan
Main packages:
v com.ibm.tws.conn.plan
ZConnEngineEjb.jar
Contains the interface and implementation of the J2EEConnEngine
Enterprise Java Bean (EJB) for the z/OS engine.
Main packages:
v com.ibm.tws.zconn.engine
ZConnModelEjb.jar
Contains the interface and implementation of the J2EE ConnModel
Main packages:
v com.ibm.tws.zconn.model
ZConnPlanEjb.jar
Contains the interface and implementation of the J2EE ConnPlan
Main packages:
v com.ibm.tws.zconn.plan
Appendix. Java API Resources 15

Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this publication
in other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this publication. The furnishing of this publication does not give you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785 U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation

Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS

PUBLICATION ″AS IS″ WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE.
Some states do not allow disclaimer of express or implied warranties in certain

transactions, therefore, this statement might not apply to you.
This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

Notices
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758 U.S.A.
Such information may be available, subject to appropriate terms and conditions,

including in some cases payment of a fee.
The licensed program described in this publication and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol (® or ™), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common
law trademarks in other countries. A current list of IBM trademarks is available on
the Web at ″Copyright and trademark information″ at http://www.ibm.com/legal/
copytrade.shtml.
Java and all Java-based trademarks and logos are trademarks or

registered trademarks of Sun Microsystems, Inc. in the United States,
other countries, or both.

Notices
Microsoft® and Windows are registered trademarks of Microsoft Corporation in the

United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Other company, product, and service names may be trademarks or service marks
of others.
Notices 19

Program Number: 5698-WSH
Printed in USA
SC23-9608-00

Tivoli: Workload Scheduler

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Tivoli: Workload Scheduler

Uploaded by

Copyright:

Available Formats

Tivoli Workload Scheduler

Application Programming Interfaces

© Copyright IBM Corp. 1991, 2008 iii

What is new in this release

What is new in this release for application programming interfaces

In addition, the Java™ application programming interface has been modified to

What is new in this publication

Who should read this publication

The publication assumes that the application programmer is experienced at

© Copyright IBM Corp. 1991, 2008 v

Both of these are in the Information Center as separate publications.

Tivoli technical training

vi IBM Tivoli Workload Scheduler: Application Programming Interfaces

© Copyright IBM Corp. 1991, 2008 1

The information about Integration Workbench is organized as follows:

Installing Integration Workbench

For more information about Eclipse, go to http://www.eclipse.org/.

Using Integration Workbench

© Copyright IBM Corp. 1991, 2008 3

Java API for Tivoli Workload Scheduler

It is divided into these sections:

4 IBM Tivoli Workload Scheduler: Application Programming Interfaces

API specifications and description

Classes in the Deprecated category should not be used.

Examples: working with objects in the database

Example 1: Adding a workstation to the database:

//Add the object

Chapter 2. Integration Workbench 5

Example 3: Removing a workstation from the database:

Examples: Working with objects in the plan

String alias = "SBJBF1_1";

6 IBM Tivoli Workload Scheduler: Application Programming Interfaces

QueryFilter qf = new QueryFilter();

Examples: Working with event rules in the database

Example 6: Adding an event rule to the database: Follow these steps:

EventRule er = new EventRule();

Chapter 2. Integration Workbench 7

+ "<attributeFilter name=\"JobStreamName\" operator=\"eq\">"

+ "<attributeFilter name=\"JobName\" operator=\"eq\">"

+ "<attributeFilter name=\"Workstation\" operator=\"eq\">"

+ "<attributeFilter name=\"Priority\" operator=\"range\">"

+ "<attributeFilter name=\"Monitored\" operator=\"eq\">"

+ "<attributeFilter name=\"EstimatedDuration\" operator=\"ge\">"

+ "<attributeFilter name=\"Login\" operator=\"eq\">"

+ "<attributeFilter name=\"EveryFrequency\" operator=\"ge\">"

//Add the object

Identifier erId = null;

8 IBM Tivoli Workload Scheduler: Application Programming Interfaces

Example 7: Retrieving an event rule:

Example 8: Deleting an event rule:

Chapter 2. Integration Workbench 9

10 IBM Tivoli Workload Scheduler: Application Programming Interfaces

are automatically installed in the following path:

https://localhost:31126/PlanServicesWeb/services/<service_name for z/OS environment>

© Copyright IBM Corp. 1991, 2008 11

Table 1. Available messages in the Web services interface

To access this publication, follow this link: http://www.redbooks.ibm.com/

12 IBM Tivoli Workload Scheduler: Application Programming Interfaces

© Copyright IBM Corp. 1991, 2008 13

14 IBM Tivoli Workload Scheduler: Application Programming Interfaces

Appendix. Java API Resources 15

IBM Director of Licensing