Database property names for web service jobs

Some parts of the system and messages about web service jobs refer to properties by their database names.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that RICOH ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the notification has been created.
  • No means that you cannot change the value.

Web service job properties

Database name Notebook tab: field name Brief description Internal values Editable
Job.WebService.Header Call Web Services: Request header Specifies the HTTP header field that the step includes in a web service request to send a request to an application.   Yes
Job.WebService.Parameter Call Web Services: Request parameters Specifies the parameters that the step includes in the web services request to an external application.   Yes
Job.WebService.Payload Call Web Services: Request payload Specifies the body of the web services request that the step submits to an application.   Yes
Job.WebService.PayloadType Call Web Services: Request payload type Specifies whether the value in the Request payload property is a path to a file or a string.
  • File
  • Text
Yes
Job.WebService.PosPassword Call Web Services: Password Specifies the password that the step uses to authenticate with a web service.   Yes
Job.WebService.Proxy Call Web Services: Use proxy Specifies whether the step communicates through a proxy server and if so, specifies the proxy server to communicate through.
  • Proxy server 1
  • Proxy server 2
Yes
Job.WebService.RequestMethod Call Web Services: Request method Specifies the method that the step uses to send the request to the application.
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Yes
Job.WebService.RequestURL Call Web Services: Request URL Specifies the URL that the step uses to submit the request to an application.   Yes
Job.WebService.ResponseFile Call Web Services: Response file Specifies the full file path and name that RICOH ProcessDirector uses to store the response from the application.   Yes