PARAMETER Statement—Specify Input Parameters (Application Services Jobs)

C-LANG Statements › PARAMETER Statement—Specify Input Parameters (Application Services Jobs)

PARAMETER Statement—Specify Input Parameters (Application Services Jobs)

The PARAMETER statement specifies input parameters in an Application Services job.

Supported Job Types

This statement is required for the JMX-MBean Attribute Set job type.

This statement is optional for the following job types:

Syntax

This statement has the following format:

For all job types except the HTTP job type:

PARAMETER {TYPE(type) VALUE(value)}
          {TYPE(type) ARRAY(value,value,...)} 
          {URI(uri)}

For the HTTP job type:

PARAMETER KEYWORD(variable) VALUE(value)

TYPE(type)

Specifies the Java class of the parameter.

Limits: Up to 1024 characters; case-sensitive

Examples: String, java.lang.String, Integer

Note: If the package is not specified, java.lang is assumed.

KEYWORD(variable)

Specifies the variable that the agent passes to the program the job invokes.

Limits: Up to 1024 characters; case-sensitive

VALUE(value)

Specifies the parameter value. In most job types, it specifies the String value of the parameter. In an HTTP job, it specifies the value for the variable.

Limits: Up to 1024 characters; case-sensitive

ARRAY(value,value,...)

Specifies a set of string values for the method parameter.

Limits: Up to 1024 characters per array value; case-sensitive

Note: If you specify the ARRAY operand, the statement value cannot exceed 3588 characters.

URI(uri)

Specifies the location (URI) of the binary output produced by a payload producing job. A payload producing job is a job that produces binary output that is persisted as a serialized Java object. The serialized Java object is stored as a file on the agent computer. The URI can be passed as input to a payload consuming job.

Limits: Up to 255 characters; case-sensitive

Example: 'FS:c:\Program Files\Common Files\System\ADO\input.txt'

Note: For more information about retrieving the URI of a payload producing job, see the documentation for your scheduling manager.

Notes:

Enclose values that contain delimiters (such as spaces) in double quotation marks.
To specify multiple parameters, use multiple PARAMETER statements. Order is important. For example, if the method contains three parameters, specify the first parameter in the first statement, the second parameter in the second statement, and the third parameter in the third statement. The job fails if the parameters are listed in the wrong order.

JMS Publish Notes:

To construct a text message, you require a single parameter (String). To construct an object message, the number of parameters that you require depends on the object's constructor. For example, an Integer object requires a single constructor (String). Some objects require no parameters or multiple parameters for construction.
Leading and trailing spaces are not supported in JMS Publish messages.

Example: Specify Input Parameters in a JMS Publish Job

This example publishes the message "this is my message" to the queue named Queue. The Java class of the message is String. The initial context factory supplied by the JNDI service provider is com.ibm.websphere.naming.WsnInitialContextFactory. The service provider's URL is iiop://172.24.0.0:2809, where 172.24.0.0 is the IP address of the WebSphere MQ server and 2809 is the ORB port. The job uses the cyberuser JNDI user ID to gain access to the connection factory named ConnectionFactory.

AGENT APPAGENT
INITIAL_CONTEXT com.ibm.websphere.naming.WsnInitialContextFactory
LOCATION iiop://172.24.0.0:2809
CONNECTION_FACTORY ConnectionFactory
DESTNAME Queue
TOPIC N
MSGCLASS String
JNDIUSER cyberuser
PARAMETER TYPE(java.lang.String) VALUE('this is my message')

Note: The agent does not support JMS messaging on IBM WebSphere. If you have IBM WebSphere MQ, your agent administrator can set up the agent plug-in to run JMS Publish and JMS Subscribe for JMS queues. JMS topics are not supported on IBM WebSphere MQ.

Example: Specify Input Parameters in a Session Bean Job

Suppose that you want to access a stateful session bean for an online shopping cart. The createaddbook method creates the Shoppingcart stateful bean for the duration of the job. The addbook method adds books to the shopping cart using the book's ISBN number. In this example, the Session Bean job adds two books to the shopping cart with ISBN numbers 1551929120 and 1582701709. When the job runs, two books are added to the shopping cart.

AGENT APPAGENT
INITIAL_CONTEXT com.ibm.websphere.naming.WsnInitialContextFactory
LOCATION iiop://172.24.0.0:2809
BEAN Shoppingcart
CREATEMETHOD createaddbook
METHOD addbook
CREATEPARAMETER TYPE(String) VALUE(ISBN)
PARAMETER TYPE(Integer) ARRAY(1551929120,1582701709)

Example: Specify Input Parameters in a JMX-MBean Attribute Set Job

Suppose that you want to set the value of the State attribute of the cdc.jmx.SimpleDynamic MBean to the serialized Java object located in a path on the agent computer.

AGENT APPAGENT
URL service:jmx:rmi:///jndi/rmi://agenttest:5099/jmxserver
MBEAN 'DefaultDomain:index=1,type=cdc.jmx.SimpleDynamic'
ATTRIBUTE State
PARAMETER URI('FS:C:\Program Files\CA\WA Agent +     
R11.3_B129\spool\CM_QABC\MAIN\LLR113.7\JMXATT.GET.12587292392520')

Example: Specify Input Parameters in an HTTP Job

Suppose that you want to define a job to perform a Google search and have the results returned to the job's spool file. You also want to refine your search results by specifying a filter. In this example, the job uses the HTTP GET method to perform the Google search on "ca workload automation". When the job runs, the job's spool file includes all matches that contain the filter AE.

AGENT APPAGENT
INVOCATIONTYPE GET
SERVLET_URL http://google.com/search
PARAMETER KEYWORD(q) VALUE('ca workload automation')
AUTHORDER (BASIC, DIGEST, NTLM)
FILTER .*AE.*