FileCatalyst Integration

FileCatalyst is a transfer accelerator which enables you to quickly upload batches of large files to Ooyala Flex.

The key difference between the Ooyala Flex Web Uploader and the FileCatalyst Transfer Agent is as follows:

  • Ooyala Flex Web Uploader: uses HyperText Transfer Protocol (HTTP) and Transmission Control Protocol (TCP).
  • FileCatalyst Transfer Agent: uses User Datagram Protocol (UDP).
Note: The FileCatalyst integration is only compatible with Ooyala Flex 6.2.1 and higher.
Note: Currently our integration with FileCatalyst works with FileCatalyst version 3.6 or higher.

Prerequisites

Please take into account the following prerequisites:
  • You must have a FileCatalyst license.
  • You must have the FileCatalyst Transfer Agent installed locally on your machine.
  • You must have both an Ooyala Flex user and a FileCatalyst user.
  • The storage location of the FileCatalyst Server needs to be shared with Ooyala Flex. In other words, each user of FileCatalyst must have a storage location linked to their username. The storage location must then be shared with Ooyala Flex, in order for the files to be ingested by Ooyala Flex.
Note: For further information on FileCatalyst, please see the official FileCatalyst documentation.

Setting Up FileCatalyst

Creating a Storage Resource

Firstly you must create a storage resource.

To create a storage resource, follow these steps:

1) On the toolbar, click New.

2) From the drop down menu, select Resource.

3) In the Create new Resource... screen, enter a name and an optional description.

4) From the Visibility field, select a visibility. These are accounts, sub-accounts, workspaces, and groups that can see this storage resource.

5) From the Plugin drop down, select Storage Resource.

6) From the Polling Interval drop down, select a polling interval.

7) Click Save.

8) Click the Configuration tab.

9) Click Edit .

10) From the Protocol drop down, select either SFTP or FILE. Currently SFTP and FILE are the only supported protocols.

Note: If you select the SFTP option, you must add a private key file in the Private Key File field.

Note: The Hostname field is optional. This field accesses the location (mandatory except for FILE, S3, Google, or Dropbox protocols).

11) In the Path field, enter the path to the storage resource. This path must point to the physical storage location.

12) Click Save.

13) Click Enable.

14) Click Start.

Creating an Inbox

Next you must create an Inbox.

To create an inbox, follow these steps:

1) On the toolbar, click New.

2) From the drop down menu, select Resource.

3) In the Create new Resource... screen, enter a name and an optional description.

4) From the Visibility field, select a visibility for your Inbox. These are the accounts, workspaces, and groups that can see this inbox resource.

5) From the Plugin drop down, select Inbox.

6) From the Polling Interval drop down, select a polling interval.

7) Click Save.

8) Click the Configuration tab.

9) Click Edit.

10) From the Storage Resource drop down, select the storage resource you have created for use with FileCatalyst.

11) In the Transfer Accelerator field, enter a name for the transfer accelerator. Example: FileCatalyst.

12) Click Save.

13) Click Enable.

14) Click Start.

Creating a HTTP Transfer Resource

Regardless of whether you wish to use FileCatalyst or use the oridinary Ooyala Flex Web Uploader application, you must create and configure a HTTP transfer resource. The HTTP transfer resource is required for every type of transfer related scenario.

To create a HTTP transfer resource, follow these steps:

1) In the Ooyala Flex console, on the right-hand side of the screen, click the Settings tab.

2) From the toolbar, click Resources.

3) On the Resources screen, click New.

4) In the Create a New Resource... screen, enter the details for your HTTP transfer resource.

5) In the Name field, enter a name.

6) In the Description field, enter an optional description.

7) In the Visibility field, enter a visibility for your Resource. These are the accounts, sub-accounts, and groups that can see the resource.

8) From the Plugin drop down, select the HTTP Transfer Resource option.

9) From the Polling Interval drop down, select a polling interval.

10) Click Save.

11) On the Transfer Resource screen, click the Configuration sub-tab.

12) Click.

13) In the Public End Point field, enter the URL of the Web Uploader instance associated with this resource.

14) In the Internal End Point field, enter the URL used by Enterprise to communicate the Web Uploader instance associated with this resource (For example: when starting / stopping the resource).

15) Click Save.

16) Click Enable.

17) ClickStart.

Logging In

Note: You must have the FileCatalyst TransferAgent installed on your machine. For more information, please contact your FileCatalyst server administrator.

1) On the toolbar, click Upload.

2) In the Web Uploader window, click the FileCatalyst tile.

3) In the User Name field, enter your FileCatalyst username.

4) In the Password field, enter your FileCatalyst password.

5) In the Transfer Agent Port field, enter the FileCatalyst TransferAgent port. This is the port on which the FileCatalyst Transfer Agent runs.

Note: The default port for this field is 12680. You can change this on the official FileCatalyst TransferAgent configuration page.

6) Click Confirm and the file selection page loads.

Uploading Files Using FileCatalyst

Note: At present, you must log in using your FileCatalyst credentials whenever you use the FileCatalyst uploader.
Note: If you close the uploader window and then open a new one, you must re-enter your FileCatalyst username and password.

1) On the Add Files page you can see the local storage on your machine, such as the Desktop, Documents, and Downloads folders. Double-click on a directory to open it.

2) Select one or more files you wish to upload.  When a file is selected, a tick appears in the check box next to it.

3) Click Confirm.

4) From the Inbox drop down, select an existing inbox.

Note: You will only see FileCatalyst inboxes once you have clicked the Inbox drop down.

5) From the Workspace drop down, select an existing workspace.

6) Click Select.

7) On the Upload page, you may be required to enter metadata for the assets you have chosen. If the metadata contains mandatory fields, you must fill them in before the files can be uploaded.

8) Click Upload and the files upload to Ooyala Flex.

Note: You can check the progress of an upload by viewing the progress bar.
Note: You can cancel the upload by clicking Cancel.
Note: You cannot pause an upload.
Note: To return to the file selection page during an upload, click in the top-right corner of the window.

Was this article helpful?