Web Plug-in

<< Click to Display Table of Contents >>

RayQC > 8.0 > User Guide > Plug-ins > Internal Plug-ins 

Web Plug-in

The Web plug-in deals with the functionality required for the interaction with online resources.

 

Function Summary

RunWebRequest

TestConnection

Function Details

RunWebRequestMulti-OptionCheckpoint

Executes a web request of the defined type to the given URL.

Usable in combination with elements of type Checkpoint and Multi-Option.

 

Input parameters

Name

Type

Description & Examples

URL

formatted string

 
 

The URL for which the connection should be tested.

 

Example:

https://www.myrayflowserver.org

Method

formatted string

The method that is used for the web request.

 

Options:

Get

Head

Post

Put

Delete

Content type

formatted string

The content type of the web request

Optional

 

Options:

application/json

application/xml

text/css

text/csv

text/html

text/plain

text/html

Custom headers

string

A custom header for the web request.

Optional

Request body

string

The request body of the web request.

Optional

Timeout

Integer

Default value: 120

The timespan (in seconds) to wait before the test connection requests times out.

 

TestConnectionMulti-OptionCheckpoint

Tests if a connection to a specific URL is available.

Usable in combination with elements of type Checkpoint and Multi-Option.

 

Input parameters

Name

Type

Description & Examples

URL

formatted string

 
 

The URL for which the connection should be tested.

 

Example:

https://www.myrayflowserver.org

Timeout

Integer

Default value: 120

The timespan (in seconds) to wait before the test connection requests times out.