File Storage Component

The File Storage component is compatible with the following file types:

• SFTP: Secure File Transfer Protocol (SFTP) lets you transfer data over a secure server. An SFTP server transfers data over an encrypted server.

• FTP: File Transfer Protocol (FTP) lets you upload or download files from an external computer. These files transfer without encryption.

The default setting is SFTP.

You can select the following methods:

• GET: Retrieves files from the remote server and stores the binary files to the inbound path.

• LIST: Returns a list of the files from the remote server and stores the list to the inbound path.

• PUT: Sends files from your server to the outbound path on the remote server.

• DELETE: Deletes files from the remote server.

The default setting is GET.

This drop-down displays all services configured in Services Administration.

You must set up your service in Services Administration before you can configure the File Storage component.

The directory path or property ID to place or access the file.

Enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. for the request type.

Selecting this checkbox fires the component on each new entry made or action taken on the component.

When the Method is set to PUT The PUT method is an HTTP request method used in REST APIs to update an existing resource or create a new resource if it does not already exist., you must specify the property ID or file location to update.

Enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. for the request type.

The File Storage component is compatible with the following file types:

• SFTP: Secure File Transfer Protocol (SFTP) lets you transfer data over a secure server. An SFTP server transfers data over an encrypted server.

• FTP: File Transfer Protocol (FTP) lets you upload or download files from an external computer. These files transfer without encryption.

The default setting is SFTP.

This drop-down displays all services configured in Services Administration.

You must set up your service in Services Administration before you can configure the File Storage component.

You can select the following methods:

• GET: Retrieves files from the remote server and stores the binary files to the inbound path.

• LIST: Returns a list of the files from the remote server and stores the list to the inbound path.

• PUT: Sends files from your server to the outbound path on the remote server.

• DELETE: Deletes files from the remote server.

The default setting is GET.

Whether your API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. (application programming interface) call is an Inbound or Outbound call depends on your Method selection. The following settings let you input the file path, file object, and request type. You can also select if you want the component to watch for an action or make it required.

For Outbound FTP requests, both the Path and File Object are required. The first row of your Inputs table displays the file name to pull from the server. The second row tells the File Storage component how to pass the data from the source. When the file returns, it's received by the File Storage component and stored for later use.

This field populates with Path and/or Object depending on your Method selection. This is the path or object of your inbound or outbound request.

You cannot adjust this setting.

Enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. for the request type.

Selecting this checkbox fires the component on each new entry made or action taken on the component.