Specifies the behavior of the test connection operation.

Possible Values

READ_FILE, LIST_FILES, NO_OPERATION, AUTHENTICATE, LIST_OR_READ_FILES

Data Type

string

Default Value

"LIST_OR_READ_FILES"

Remarks

Changes how the provider responds to a test connection operation based on the integration scenario.

LIST_OR_READ_FILES

List and read files from the storage source until at least one is parsed. Fails if none of the files can be parsed (are invalid). Fails if the directory contains no JSON files. Note: this mode will not read files in sub-directories. This is the most flexible option and works with both directory and file URIs.

READ_FILE

Validates that the URI points to a readable JSON file. The URI must point to an existing JSON file, not a directory. This behavior will fail if the file does not exist or contains invalid JSON content.

LIST_FILES

Validates that the URI points to a directory and lists its contents. Fails if the directory contains no JSON files.

NO_OPERATION

Performs basic URI validation without accessing files or verifying their existence. This is useful for quickly validating configuration without network or file system operations.

AUTHENTICATE

Validates connection credentials and URI accessibility. For cloud storage, this verifies authentication. For local files, this checks URI format and basic accessibility.

Notes

• The provider is read-only. Unlike write-capable drivers, empty directories will cause failures for LIST_FILES and LIST_OR_READ_FILES behaviors since a connection with no readable files is unusable.
• The MetadataDiscoveryURI property specifies a representative JSON file for schema detection. When set, this file is validated during connection testing with READ_FILE and LIST_OR_READ_FILES behaviors.
• You can omit the URI entirely if you provide customized RSD schema files in the driver's Location directory. In this case, the driver validates that at least one .rsd file is valid.
• When using NO_OPERATION, only basic URI syntax validation is performed. The connection test will succeed even if files don't exist, but will fail if no URI is provided and no RSD schemas are available.

Behavior by URI examples

URI	NO_OPERATION	READ_FILE	LIST_FILES	LIST_OR_READ_FILES	AUTHENTICATE
Directory with JSON files	Success	Failure: URI must point to an existing file	Success	Success	Success
Empty directory	Success	Failure: URI must point to an existing file	Failure: URI must point to a non-empty directory	Failure: Unable to find any valid JSON resource for supplied URI	Success
Non-existing directory	Success	Failure: URI must point to an existing file	Failure: URI must point to an existing directory	Failure: URI must point to an existing file or directory	Success
Valid JSON file	Success	Success	Failure: URI must point to an existing directory	Success	Success
Non-existing file	Success	Failure: URI must point to an existing file	Failure: URI must point to an existing directory	Failure: URI must point to an existing file or directory	Success
Invalid JSON format	Success	Failure: Parsing error	Failure: URI must point to an existing directory	Failure: Parsing error	Success
Cloud storage, invalid credentials	Success	Failure: Authentication error	Failure: Authentication error	Failure: Authentication error	Failure: Authentication error