File Storage Component

Canvas Label Text                                                                        

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

File Storage 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.

Service                                                                        

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.

Method                                                                        

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.

Inputs                                                                        

Whether your API (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.

Get From                                                                            

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.

Property ID                                                                            

Enter the Property ID for the request type.

Watch                                                                            

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

Required                                                                            

Selecting this checkbox requires entering input data before the logic component fires.

Disable Execution                                                                        

Once activated, the logic tied to this component doesn't execute. Use this if you want to keep the component's settings, but want to disable the operations it performs.

By default, the Disabled is (OFF).