Previous Topic: PARAMETER Statement—Specify Input Parameters (SNMP Jobs)Next Topic: PORTNAME Statement—Specify the Port Name Within the Namespace

C-LANG Statements › PARAMETER Statement—Specify Input Parameters (Web Service Jobs)

PARAMETER Statement—Specify Input Parameters (Web Service Jobs)

The PARAMETER statement specifies input parameters in a Web Service job.

Supported Job Type

This statement is optional for the Web Service job type.

Syntax

This statement has the following format:

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

Specifies the XML schema type of the operation parameter. The agent supports the following types:

  • xsd:string
  • xsd:anySimpleType
  • xsd:integer
  • xsd:duration
  • xsd:int
  • xsd:gYearMonth
  • xsd:long
  • xsd:gYear
  • xsd:short
  • xsd:gMonthDay
  • xsd:decimal
  • xsd:gDay
  • xsd:float
  • xsd:gMonth
  • xsd:double
  • xsd:normalizedString
  • xsd:boolean
  • xsd:token
  • xsd:byte
  • xsd:language
  • xsd:unsignedInt
  • xsd:Name
  • xsd:unsignedShort
  • xsd:NCName
  • xsd:unsignedByte
  • xsd:ID
  • xsd:QName
  • xsd:NMTOKEN
  • xsd:dateTime
  • xsd:NMTOKENS
  • xsd:date
  • xsd:nonPositiveInteger
  • xsd:time
  • xsd:negativeInteger
  • xsd:anyURI
  • xsd:nonNegativeInteger
  • xsd:base64Binary
  • xsd:unsignedLong
  • xsd:hexBinary
  • xsd:positiveInteger

    Limits: Up to 1024 characters; case-sensitive
VALUE(value)

Specifies the value for the operation parameter.

Limits: Up to 1024 characters; case-sensitive

ARRAY(value,value,...)

Specifies a set of values for the operation 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:

Example: Pass Parameter to Web Service for Getting Stock Quotes

Suppose that you want to invoke a web service that returns a company stock quote. The URL for the WSDL that describes the web service and its location is http://www.webservicex.com/stockquote.asmx?WSDL. The WSDL port name within the target namespace http://www.webserviceX.NET is StockQuoteSoap. The target endpoint address URL is http://www.webservicex.com/stockquote.asmx. The job calls the operation GetQuote within the StockQuote web service. When the job invokes the web service, the company's stock symbol is passed to the operation. The GetQuote operation returns a java.lang.String object, which maps to the XML type string in the return namespace http://www.webserviceX.NET/. When the job completes, the stock quote for CA is stored as a serialized Java object in the job's spool directory.

AGENT WSAGENT
TARGETNAMESPACE http://www.webserviceX.NET/
SERVICENAME StockQuote
PORTNAME StockQuoteSoap
OPERATION GetQuote
WSDL_URL http://www.webservicex.com/stockquote.asmx?WSDL
ENDPOINT_URL http://www.webservicex.com/stockquote.asmx  
PARAMETER TYPE(xsd:string) VALUE(CA)
RETURNCLASS java.lang.String
RETURNXML string
RETURNNAMESPACE http://www.webserviceX.NET/