Element | Description |
Destination | The destination to test. This element is required. Valid values are:  MDS (Message Distribution service)EE (Encyclopedia engine)FS (Factory service)VS (View service)OSD (open server driver) |
Action | An optional element specifying the action to take at the destination. Valid values are: Echo—Echoes data specified in the Payload parameter.ReadFile—Opens a specified Encyclopedia volume file, reads its content, and closes the file. Destination must be EE, FS, or VS.WriteFile—Creates a temporary file in a partition, writes a specified number of bytes, closes the file, and deletes it. Destination must be EE or FS.Connect—Connects to a data source. If you do not specify a value, the destination component responds to the request without taking another action. |
Mode | An optional element specifying the level of detail in the Ping response. Valid values are: Concise—Returns the elapsed time between a component’s receipt of the request and the time the component sends a reply.Normal—Returns the names of components in the test path and the timestamps of the request entering and leaving each componentTrace—Returns the timestamp of the request entering and leaving major subcomponents of the component being tested. For example, a request to a node running the Encyclopedia service can provide a timestamp for when the request enters and leaves the process queue.A Ping request in Trace mode also can return diagnostic information other than timing. For example, a request to test writing a temporary file to a partition can return the amount of free disk space on the partition. |
Server | An optional element specifying which instance of a Factory service or View service to test. Works with the ProcessID parameter. To test all available instances of the Factory or View service, use an asterisk (*). If you do not use Server, the iHub load balancing mechanism allocates an available instance of the requested service to respond to the Ping request. |
ProcessID | With Server, this optional element specifies the process ID of the Factory or View service to test. |
FileName | If the Action is ReadFile, this element is required to indicate the Encyclopedia volume file to read. If you ping an open server driver, FileName specifies the executable file to prepare for execution. |
ConnectionProperties | If the Action is Connect, ConnectionProperties specifies properties required to connect to a data source, such as user name and password. ConnectionProperties must define the DBType. Valid values are: DB2InformixMSSQLODBCOracleProgressProgress SQL92SybaseA database can require the Ping request to define additional properties. |
Payload | A Ping request can include binary data that returns in the response. This binary data is called the payload. If the Action is Echo, you can specify the length of the payload data. |
PartitionName | If the Action is WriteFile, this optional element specifies the name of the partition on which to create the temporary file. |
NumBytes | If the Action is ReadFile or WriteFile, specifies the number of bytes to read or write. If you do not specify NumBytes or the value is 0, the Factory uses the default value of 10 KB. |