File Storage Component
Overview
The File Storage component handles file transfers in a module. Use this component to send and retrieve files from outside of Unqork. These files can be private customer data or confidential employee records that you need to keep somewhere other than on your company network. The File Storage component uses an SFTP (Secure File Transfer Protocol) and FTP (File Transfer Protocol) service to send and receive these files.
Common uses for the File Storage component include:
-
Retrieving a file from a remote file service and returning an object with file contents.
-
Uploading data to a remote server.
You can find the File Storage component in the Data & Event Processing group to the left of the Module Builder.
What You'll Learn
After completing this article, you’ll know when to use a File Storage component and how to configure its settings.
About the Configuration Window
General
Setting |
Description |
---|---|
Property ID |
A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and 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. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation. |
Notes |
Select this tab to display the component's Notes area. You can use notes to keep your teammates informed. The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component. |
Display |
Select this tab to manage your component's display settings. |
Data |
Select this tab to manage your component's data settings. |
Advanced |
Select this tab to manage your component's advanced settings. |
Permissions |
Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. settings of the component. |
Field Tags |
Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panel components. The Field Tags identify the data type of parameters included in the 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. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry. |
Shortcuts |
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
Documentation |
Select this tab to access the component documentation in Unqork's In-Product Help. |
Cancel |
Click this button to undo any unsaved configuration changes and return to the Module Builder canvas. |
Save & Close |
Click this button to save all setting configuration changes and return to the Module Builder canvas. |
Display Panel
Field Text
Setting |
Description |
---|---|
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. |
Data Panel
Service Selection
Setting | Description |
---|---|
File Storage Type |
The File Storage component is compatible with the following file types:
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:
The default setting is GET. |
Inputs |
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. |
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 A Property ID is the unique field ID used by Unqork to track and link components in your module. 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. |
Advanced Panel
Setting | Description |
---|---|
Disabled 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). |
Resources
-
Modify the File Storage component using the toolbar settings
-
What's the different between the File and File Storage components?
-
What are the different authentication types to use for SFTP with the File Storage component?