Database property names for web service notifications

Some parts of the system and messages about web service notifications 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 notification properties

Database name Notebook tab: field name Brief description Internal values Editable
WSNotification.WebService.AuthContentType Authentication: Authentication response content type Specifies the response format the web service notification receives for authentication.
  • JSON
  • XML
Yes
WSNotification.WebService.AuthRequestHeader Authentication: Authentication request header Specifies the HTTP header field the web service notification uses to authenticate to another application.   Yes
WSNotification.WebService.AuthRequestMethod Authentication: Authentication request method Specifies the method type the web service notification calls for authentication.
  • GET
  • POST
Yes
WSNotification.WebService.AuthRequestParams Authentication: Authentication request parameters Specifies the parameters the web service notification sends to an external application. Examples of these parameters are the user ID and password.   Yes
WSNotification.WebService.AuthRequestPayload Authentication: Authentication request payload Specifies the payload to be passed to the specified web service.   Yes
WSNotification.WebService.AuthRequestPwd Authentication: Authentication request password A password that is used to get a single-use credential for a session. You reference the password in the Authentication request payload property as a symbol. The web site returns a token when authentication is successful.   Yes
WSNotification.WebService.AuthRequestURL Authentication: Authentication request URL Specifies the URL that Ricoh ProcessDirector uses to authenticate with a web site or application.   Yes
WSNotification.WebService.AuthResponseAttribute Authentication: Authentication response attribute Specifies the XPath or JSONPath to the element in the response to the authentication request that contains the credential for the session. This value is stored as the Static credential for the session.   Yes
WSNotification.WebService.Proxy Request: Use proxy Specifies whether the web service notification communicates through a proxy.
  • Yes
  • No
Yes
WSNotification.WebService.RequestHeader Request: Request header Specifies the HTTP header field the web service notification uses to request data.   Yes
WSNotification.WebService.RequestMethod Request: Request method Specifies the method type the web service notification calls for processing.
  • GET
  • POST
Yes
WSNotification.WebService.RequestParams Request: Request parameters Specifies the parameters the web service notification sends to an external application.   Yes
WSNotification.WebService.RequestPayload Request: Request payload Specifies the payload the web service passes to an external application.   Yes
WSNotification.WebService.RequestURL Request: Request URL Specifies the URL of the web service that the web service notification communicates with.   Yes
WSNotification.WebService.StaticCredential Authentication: Static credential The authorization code that Ricoh ProcessDirector uses to connect to an external application that requires multiple-use authentication.   Yes
WSNotification.WebService.Username Authentication: HTTP authentication user name Specifies the user name that Ricoh ProcessDirector uses to connect to an external application.   Yes
 
Copyright © 2016, 2018