File Store - Upload File

The File Store - Upload File task uploads the current Job File to the OL Connect File Store.

Input

The task always takes the current Job File as input file. If you want to upload an external file, first use the Load External File plugin to load that file as the Job File.

Processing

The task tries to upload the current job file to the OL Connect File Store by making a call to the /rest/serverengine/filestore/DataFile REST endpoint; see File Store Service: Upload File in the REST API Cookbook.

Output

When a file is uploaded to the Connect File Store, it is automatically assigned a File Store ID. The task stores the returned File Store ID in the specified variable.
This task does not modify the Job File.

Task properties

General Tab
  • Filename: Enter the file name or a JobInfo, local or global variable that contains the file name, to use when saving the file in the OL Connect File Store. The default is %f, the name of the job file. Right-click the field to select another variable. When you specify %o as the file name, the file in the OL Connect File Store will have the same name as the original file.
  • Save File Store ID in variable: Select the variable in which to store the File Store ID that is returned after a file has been successfully uploaded to the File Store. This ID can be used to download or delete the file from the OL Connect File Store.
  • Mark as permanent: When this option is checked, the file will never be removed automatically by Connect's Clean-Up Service. Non-permanent files may be removed if there are no remaining references to them in the Connect Database. (See: Clean-Up Service preferences.)
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.