WBS Extensions, Dodeca 8.3

General

RESTRequest

Makes an HTTP web request to a REST web service.

CredentialsPolicy

Controls the credentials used for authentication. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified UserName, Password, and Domain.

UserName

The user name associated with the credentials to be used for authentication."

Password

The password associated with the credentials to be used for authentication.

Domain

If needed, the domain associated with the credentials to be used for authentication.

EndPoint

The URI to which the request is posted.

SOAPAction

If required by the web service, the SOAPAction HTTP request header field value.

RequestXml

The XML posted to the web service.

RequestTimeout

The number of milliseconds allowed to elapse before the request is timed out. The default value of 0 indicates that no timeout is enforced.

ResponseXmlPropertyName

(Optional) The name of the workbook script property that receives the response XML returned by the web service.

ErrorMessagePropertyName

(Optional) The name of the workbook script property that receives the error message if the request fails.

BackgroundExecute

Controls whether the request is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the request is processed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the web service is called. If no value is specified, "CallWebService started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the response is received. If no value is specified, "CallWebService completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the request failed. If no value is specified, "CallWebService failed" is displayed as the progress text.

SaveRequestXmlToFilename

(Optional) The name of the file, including the path, to which the request XML is saved on the client. The argument is intended for use during development for debugging purposes.

SaveResponseXmlToFilename

(Optional) The name of the file, including the path, to which the response XML is saved on the client. The argument is intended for use during development for debugging purposes.

RequestMethod

The method of the request to the REST web service.

RequestHeaders

(Optional) A new-line delimited list of custom headers to send with the specified request. This property can be left blank to use the default request headers.

RequestPostData

The data posted by the request when using the POST, PUT, or PATCH RequestMethod.

RequestPostDataContentType

(Optional) The content-type of the data posted by the request when using the POST, PUT, or PATCH RequestMethod. This property can be left blank to leave the content-type unspecified.

RequestURL

The URL of the REST web service.

RequestTimeout

The number of milliseconds allowed to elapse before the request is timed out. The default value of 0 indicates that no timeout is enforced.

ResponsePropertyName

(Optional) The name of the workbook script property that receives the response returned by the REST web service.

ResponseHeadersPropertyName

(Optional) The name of the workbook script property that receives the response headers returned by the REST web service.

ResponseCodePropertyName

(Optional) The name of the workbook script property that receives the response status code returned by the REST web service.

ErrorMessagePropertyName

(Optional) The name of the workbook script property that receives the error message if the request fails.

CookieCollectionPropertyName

(Optional) The name of the workbook script property that sets and receives the cookies used by the web service.

FollowRedirects

(Optional) Specifies whether to follow redirects issued by the web service. The default value is TRUE.

BackgroundExecute

Controls whether the request is executed asynchronous.

CoverDuringExecute

Controls whether the view is covered while the request is processed. By default, the view is not covered.

ProgressTextStarted

(Optional) The text string displayed as the progress text in the status bar before the web service is called. If no value is specified, "CallWebService started" is displayed as the progress text.

ProgressTextCompleted

(Optional) The text string displayed as the progress text in the status bar after the response is received. If no value is specified, "CallWebService completed" is displayed as the progress text.

ProgressTextFailed

(Optional) The text string displayed as the progress text in the status bar if the request failed. If no value is specified, "CallWebService failed" is displayed as the progress text.

SaveResponseToFilename

(Optional) The name of the file, including the path, to which the response is saved on the client. The argument is intended for use during development for debugging purposes.

General

Open a specified DSMS application, using a full URL or application parameters.

Application

The ID of the Application to open.

Tenant

(Optional) The ID of the Tenant to open. By default, the current tenant is used.

View

The ID of the View to open on launch.

URL

The full URL of the DSMS application to open, which can be used instead of the application parameters.

Start

Starts a local process specified as an application or document name.

FileName

The name of the application or document to start. The document can be of any file type for which the extension has been associated with an application installed on the client system.

CommandLineArguments

Command-line arguments to pass when starting the application.