Ping
Tests whether a specific component of BIRT iHub is operational and retrieves other diagnostic information about the component.
Request elements
Destination
String. The component to test. Valid values are:
MDS
A Message Distribution service
EE
An Encyclopedia engine
FS
A Factory service
VS
A View service
OSD
An open server driver
AIS
An Actuate Integration service
ACS
An Actuate Caching service
Action
String. The optional action to take. Valid values are:
Echo
Echoes the data specified in Payload.
ReadFile
Opens the specified Encyclopedia volume file, reads the file’s contents, then closes the file. Applies only if the value of Destination is EE, FS, or VS. Ping returns the timing of the read operation. Specify the file name in FileName.
WriteFile
Creates a temporary file on a partition, writes a specified number of bytes to the file, closes the file, then deletes the file. Applies only if the value of Destination is EE or FS. Ping returns the timing information for each step. Specify the partition in PartitionName. Specify the number of bytes to read in NumBytes.
Connect
Connects to a data source. Specify the connection parameters in ConnectionProperties.
Mode
String. The level of detail to return. Valid values are:
Normal
Returns the names of components in the test path and the timestamps of the request entering and leaving each component. This is the default mode.
Trace
Returns the timestamp of the request entering and leaving major subcomponents of the component being tested.
Concise
Returns the elapsed time between a component’s receipt of the request and the time the component sends a reply.
Server
String. Specifies which instance of a Factory service or View service to test. Applies only if the value of Destination is FS or VS. Use Server in conjunction with the ProcessID element. To test all available instances of the Factory or View service, specify an asterisk (*). If not specified, the BIRT iHub load‑balancing mechanism allocates an available instance of the requested service to respond to the request.
ProcessID
String. Specifies the process ID of the Factory or View service to test. Use in conjunction with the Server element. Applies only if the value of Destination is FS or VS.
FileName
String. If the value of Action is ReadFile, indicates the Encyclopedia volume file to read. If the value of Destination is OSD, specifies the executable file to prepare for execution.
PartitionName
String. Specifies the name of the partition on which to create the temporary file. Applies only if the value of Action is WriteFile.
NumBytes
Long. Specifies the number of bytes to read or write. Applies only if the value of Action is ReadFile or WriteFile. If NumBytes is not specified or 0, the default value of 10 KB is used.
ConnectionProperties
ArrayOfParameterValue. An array of property name and value pairs that specify the parameter values for establishing a data source connection. Applies only if the value of Action is Connect. To establish a connection, you must specify a property with a name DBType and a value that specifies the type of database. You must also specify any other properties that the specific database interface requires. Table 11‑2 lists the valid property names.
Table 11‑2 Valid connection properties
Property name | Applicable database interface | Description |
DBType | All | The type of database. Valid values are: DB2, Informix, MSSQL ODBC, Oracle, Sybase, Progress, Progress SQL92 |
DllPath | DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase | The name of the DLL providing the client database. |
UserName | DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase | The database user name. |
Password | DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase | The database password. |
DataSource | DB2, ODBC | The name of the data source. |
ConnectionString | ODBC | Any additional text that ODBC needs to establish the connection. |
HostString | Oracle | The Oracle server name for the connection. |
DatabaseEnvironment | Informix | The name of the database server, the database, or both database server and database to which to connect. |
DatabaseList | Progress | The name of the database. |
StartUpParameters | Progress | The Progress Open Interface Broker parameters. |
Database | Progress SQL92 | The name of the database. |
Host | Progress SQL92 | The host computer name for a remote database. Not used for a local database. Required if you are connecting to a database running on a database server. |
ServiceOrPort | Progress SQL92 | The database service name or port number on the database server. Not used for a local database. The port number is an unsigned 16‑bit integer in the range 1–65535. |
Payload
String. Specifies the payload data. Applies only if the value of Action is Echo. Payload is binary data attached to the request.
Response elements
Reply
String. The Ping reply, in plain text format. The information depends on the value of Mode.
Payload
String. If a value is specified for Payload in the request, the payload data as a string.