Adapter

ListDirectory

This task retrieves a list of files in a specified directory.

Parameter	Type	Description
Directory	File, String	The directory from which to return the list of files. This value this can be either a file type pointing to a directory, or a string. The string can contain Global Variables, allowing you to use the same values in a subsequent Read Adapter.
Filename Filter (regex)	String	The Regular Expression used to filter results.The default is .*; which matches everything.
Sort (ASC or DESC)	String	This is either ASC or DESC. Default=ASC.
Filenames (Array of String)	Array	Output. A sorted array of filenames in the directory matching the provided Filename Filter.
Array Size	Long	Output. The size of the returned array.
Iterator Variable (Sets Zero)	Long	Output. Sets an index variable to zero for use when looping over the returned array.

SFTPAdapterGet

This task supports the SSH File Transfer Protocol (SFTP) for securely transferring a file from an SFTP Server. All parameters are required.

Parameter	Type	Description
Storage Node	StorageNode	The internal storage location of the file retrieved from the server.
Server Username	String	The username for authentication on the remote server.
Server Password	String	The password for authentication on the remote server.
Server Hostname/IP	String	The remote location to connect to.
Server Port	String	The port number on the remote server to connect to.
Remote Path and Filename	String	The location and filename on the remote server of the file this task should attempt to retrieve the file from.
Delete Remote File	Boolean	Indicates if Clarify should delete the file from the server after successfully retrieving it.
Connection Timeout (Seconds)	String	The number of milliseconds to wait before timing out the connection attempt.

SFTPAdapterMGet

This task supports the SSH File Transfer Protocol (SFTP) for securely transferring multiple files from an SFTP Server.

Parameter	Type	Description
Storage Node	Array	The internal storage location(s) of the file(s) retrieved from the server.
Filenames		The filename(s) matched and retrieved from the server.
Server Username	String	The username for authentication on the remote server.
Server Password	String	The password for authentication on the remote server.
Server Hostname/IP	String	The remote location to connect to.
Server Port	String	The port number on the remote server to connect to.
Remote Path	String	The location on the remote server this task should attempt to retrieve the file(s) from.
Local Path	String	The location on the local server this task should place retrieved file(s).
Filename Filter		The regular expression that will filter files retrieved from the remote path.
Delete Remote File	Boolean	Indicates if Clarify should delete the file(s) from the server after successfully retrieving them.
Connection Tiimeout	String	The number of milliseconds to wait before timing out the connection attempt.

SFTPAdapterPut

This task supports the SSH File Transfer Protocol (SFTP) for securely transferring a file to an SFTP Server.

Parameter	Type	Description
Storage Node	StorageNode	The internal storage location of the file to be sent to the server.
Server Username	String	The username for authentication on the remote server.
Server Password	String	The password for authentication on the remote server.
Server Hostname/IP	String	The port number on the remote server to connect to.
Server Port	String	The port number on the remote server to connect to.
Remote Path and Filename	String	The location and filename on the remote server of the file this task should attempt to write the file to.
Connection Timeout	String	The number of milliseconds to wait before timing out the connection attempt.

SFTPAdapterMPut

This task supports the SSH File Transfer Protocol (SFTP) for securely transferring multiple files to an SFTP Server. All parameters in bold are required.

Parameter	Type	Description
Storage Node	Array	The internal storage location(s) of the file(s) to be sent to the server.
Remote Filename Array	Array
Server Username	String	The username for authentication on the remote server.
Server Password	String	The password for authentication on the remote server.
Server Hostname/IP	String	The remote location to connect to.
Server Port	String	The port number on the remote server to connect to.
Remote Path	String	The location on the remote server this task should attempt to send the file(s) to.
Connection Timeout	String	The number of milliseconds to wait before timing out the connection attempt.