File Store - Download File

The File Store - Download File task downloads a file from the OL Connect File Store, using either a file name or File Store ID.

Input

The task requires either the name of the file in the OL Connect File Store or its File Store ID.

Processing

The task tries to download the requested file from the OL Connect File Store by performing a call to the /rest/serverengine/filestore/file/{fileId} REST endpoint; see File Store Service: Download File in the REST API Cookbook.

Output

The downloaded file becomes the current job file and retains the file name that it had in the OL Connect File Store.

Task properties

General Tab
  • Filename or File Store ID: Enter the name of the file in the OL Connect File Store or its File Store ID. The ID is the ID
OL Connect Proxy Tab

This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.

Defaults are not used unless the configuration is sent to the Workflow service.
  • OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides.
  • Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340
  • User name: Enter the user name expected by the OL Connect Server.
  • Password: Enter the password expected by the OL Connect Server for the above user name.
On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in the Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see General appearance preferences), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.