Overriding RA Web Service Agent Job Attributes

You can read and set the specific attributes of RA Web Service Agent Jobs by using the script elements GET_ATT and :PUT_ATT. This topic lists the available attributes for Web Service Jobs by Job type. Additionally, instructions are included on how to display XML names for Job fields in tooltips. For documentation on using GET_ATT and :PUT_ATT commands, see your Automation Engine documentation.

Job attributes are case-sensitive.

REST RA Web Service Agent Job Fields

General Panel

Field XML Name Available Values
Connection restConnection Text
Write Response to Job Log responseToJobLog
  • true
  • false
Create Request Reports requestReports
  • true
  • false
Create Response Report responseReport
  • true
  • false
Connection Timeout connectTimeout Text
Read Timeout responseTimeout Text
Trace Performance Metrics tracePerformance
  • true
  • false
Execute cURL Command isCurl
  • true
  • false
The cURL statement curl Text
URI Override uriOverride Text

Definition Panel

Field XML Name Available Values
Resource resource Text
Method method
  • GET
  • PUT
  • POST
  • DELETE
  • HEAD
  • OPTIONS
Multi-Part Request multiPart
  • true
  • false
Media Type request_part_0_mediaType Text
Choose File/Enter Data Here request_part_0_requestDataSource
  • true
  • false
File request_part_0_file Text

Headers & Query Parameters Panel

Field XML Name Available Values
Use Job Headers Only jobHeaders
  • true
  • false
Use Job Query Parameters Only jobQuery
  • true
  • false

Definition & Parsing Panel

Field XML Name Available Values
Multi Part Response multiPartResponse
  • true
  • false
Path/File Name response_part_0_file
  • true
  • false

SOAP RA Web Service Agent Job Fields

General Panel

Field XML Name Available Values

Connection

webConnection Text

Operation

methodName Text

Connection URL Endpoint

connectionUrlField Text

URL Endpoint

urlEndpoint Text

Output Request and Response to Log

printResponseRequestDebug
  • true
  • false

Create Raw XML SOAP Request Report

printSOAPRequest
  • true
  • false

Create Raw XML SOAP Response Report

printSOAPResponse
  • true
  • false

Attachment Handling

attachProcessingType
  • None
  • Inline - base64 encoded
  • SWA - Soap with attachments
  • SWA Attachments
  • MTOM - Inlined soap with attachments

Output Type

respAttachOutputType Text

Output Prefix

respAttachOutputPrefix Text

Connection Timeout

connectionTimeout Text

Read Timeout

responseTimeout Text

Trace Performance Metrics

tracePerformance
  • true
  • false

Marshal the SOAP Response

marshalSoapResponse
  • true
  • false

Displaying Job Attributes for GET_ATT and :PUT_ATT Commands in the User Interface

You can display Job attributes names for Job fields to use in GET_ATT and :PUT_ATT commands in tooltips from the Automation Engine's user interface. You do this by editing -DshowXmlNames=true in the ucdj.ini file for your user interface as shown in the example below.

;command how to start the client

cmd="C:\Program Files (x86)\Java\jre7\bin\javaw" -Xmx1024m -Dsun.locale.formatasdefault=true -DshowXmlNames=true com.uc4.ucdf.UCDialogFactory -U%User%

When you displayed Job attributes for field names in the user interface, and you hover your mouse over any Job field name, the XML name is displayed. If the field already has a tooltip, the tooltip text is displayed, followed by a dash and the Job attribute name. If the field does not have an existing tooltip, the tooltip text only displays the dash and Job attribute name.