TestDataSourceConnection

Test to see if a data source’s connection is operational.

Note: This procedure is different from the web services operation of the same name, which is in the resource tree under /services/webservices/system/admin/resource/operations/.

Location

/lib/resource/

Input

path: The path to the data source to be tested.

Outputs

status: If SUCCESS, the data source is operational. If FAIL, the test failed. These values are available on the Constants tab of the /lib/util/System SQL definition set.

messages: A list of the messages generated during the test. Messages may be present both in SUCCESS and FAIL conditions. Messages are separated by newline characters.

Exceptions

IllegalArgumentException: If path is malformed.

NotFoundException: If the data source does not exist.

SecurityException: If the user does not have READ access on all items in path.