Transfer Agent

The Transfer Agent is a desktop application for managing the transfer of large media files and metadata to and from the Ooyala Flex platform. The Agent supports both traditional File Transfer Protocol (FTP) as well as Fast File Transfer protocols (FFTP). A Ooyala Flex Transfer can occur in one of two directions (Upload or Download). Hence the Transfer Agent can be used to upload files for the purpose of Ingest, and also download files that are stored in Shared Folders.

As soon as a Source Asset has completed uploading, Ooyala Flex will automatically ingest the Asset, and begin processing it. The Transfer agent is more powerful than plain FTP for the followings reasons:

• It will automatically recover from, and retry, failed transfers.

• It supports partial file transfer, including pause and resume.

• It has built-in file acceleration for faster file transfer.

• It allows for metadata pre-entry so that Assets and metadata can be transferred at the same time.

• It can be configured to support file validation, so that only technically compliant Assets can be delivered.

• It supports encryption.

• It is integrated into the Ooyala Flex platform, so transfer can be logged and tracked from Ooyala Flex even before a transfer has completed.


•You can also upload files using the Web Upload button on the Toolbar in the Desktop Screen or the Asset Dashboard.

• The Transfer Agent can also be configured to run as a command line application.

Installing and Running the Transfer Agent for the First Time

To install the Transfer Agent:

1) To begin, log in to the Ooyala Flex Web Console.

2) From the Desktop tab , click on the Transfer Agent link on the Toolbar. This link can also be found in the Asset tab.

3) After clicking on Transfer Agent, a message box will appear asking you to open a client.jnlp file.

4) Make sure the Open With – Java Web Start Launcher option is ticked. Then and click OK to continue the installation of the Transfer Agent.

5) The Transfer Agent will install and open immediately.


The look and feel of the Transfer Agent and the desktop icon will be the same as the Theme set up for your Account.

• The exact process for installing the Transfer Agent varies slightly between web browsers and operating systems.

Logging in to the Transfer Agent

Once the Ooyala Flex Transfer Agent has finished installing or updating, the Login window will appear. To log in, use the same Username and password credentials that you used from the Ooyala Flex Web Console (your Ooyala Flex login and password).

Checking Connectivity Status

You can see whether the Transfer Agent on your desktop is connected to the remote Ooyala Flex Transfer server, by looking at the status indicator at the bottom right-hand side of the main Transfer Agent window:

Uploading Media Files to Ooyala Flex using the Transfer Agent

To add a file for upload, simply drag and drop single or multiple files into the Transfer Agent window. Alterely, you can click on the Upload button located on the Action Bar.

1) Select File(s) you wish to add.

2) Click the Upload button, or drag and drop files into the Transfer Agent window.

3) The Upload Files window will then display.

4) To add a new file or to upload additional files, click the Add Files button.

5) Click the Inbox drop down, and select an Inbox.

6) Click the Workspace drop down, and select a Workspace.

An Inbox is a type of Ooyala Flex Resource that acts as a drop-off point for new Assets and Metadata into Ooyala Flex. Once dropped into an Inbox, Ooyala Flex will automatically scan Assets and ingest them.

Depending on how the Inbox is configured, the Inbox may also automatically start a Workflow. When there is only one Inbox available, Ooyala Flex will select that Inbox by default. A Workspace is a project area where you can securely share Assets with Groups of Users and collaborate. The Transfer Agent will always attempt to use accelerated transfer first. If this is not available or not possible, it will use plain File Transfer Protocol (FTP) instead. By default your default Workspace will be pre-selected.

Scheduling a Transfer

From the Upload Files window, the Transfer Agent gives you the option of scheduling when your file transfers will begin transferring to Ooyala Flex.

1) Once you have added files for uploading to Ooyala Flex, tick the Defer transfers until check box.

2) Click on the Calendar icon and select a date and enter the time to begin the transfer in 24-hour format.

3) A pop-up screen will confirm the date and time you have scheduled to begin the file transfer(s).

Note: Ensure that you leave the Transfer Agent running at the time the transfer is scheduled to begin, and that your computer is not set to go into standby or recovery mode. If the computer is not running when a Transfer is scheduled, it will run the next time that you start the Transfer Agent on your local desktop.

Note: The Transfer Agent has its own internal database. It stores the state of any transfer. As a result of this, you can safely stop, pause, and resume Transfers. You can also exit the Transfer Agent or restart your desktop without losing the scheduled transfers.

File Validation

Ooyala Flex can be configured to validate source files to ensure they meet the technical requirements of a particular Inbox.

Once you click OK to begin or schedule a file transfer, the Transfer Agent may validate your source video file to ensure it meets the technical requirements specified by the remote Inbox. If the file is valid, it will be represented by a green tick in the validation screen.

If there are any errors in the validation process, a red X will appear in the valid column next to the invalid file. If everything is OK, a green tick will be shown.

To view the validation errors for a file, double click on the file’s row in the validation table. The Panel will show a list of all validation errors along with the required specification for each file characteristic being validated.

You should be able to use the details provided in the Validation Errors screen to correct the source file you are trying to upload.

Entering Metadata

Once a file has validated successfully in the Metadata window, the Metadata screen may be visible (based on whether the Inbox selected has been configured to request entry of metadata for a particular Schema). To enter the required metadata for a file to be uploaded, click on the Edit button.

The Edit Metadata window will show all metadata fields to be completed as part of the file upload process. Fields marked with a red star are mandatory fields that must be filled to begin transferring.

Shared Folders

A Shared Folder is special type of Storage Resource that can be used for shared delivery, and retrieval of files via multiple Users within Ooyala Flex. Through Shared Folders, Users can use the Transfer Agent to download files to a local hard-drive as well as upload them from a hard-drive.

Managing Transfers

Transfer Controls

Once a Transfer has been created, it can be controlled in a number of ways. You can pause, cancel, and delete a transfer, as well as start and reschedule a scheduled transfer.


Pausing or Cancelling a Transfer

If a transfer in progress, you can easily pause it. A transfer that has been paused can be resumed at a later date, at the same point the transfer was paused. The great thing about this, is that losing any data). To pause a Transfer, select and highlight the file that needs to be paused and click the Pause icon.

A paused Transfer or Transfer in progress can also be cancelled by pressing the Cancel icon. Once a transfer has been cancelled, it can no longer be resumed.

Deleting a Transfer

To delete a transfer, simply click the Delete button.

Resuming or Scheduling a Paused Transfer

To resume a paused transfer, click on the Resume icon in the toolbar.

To schedule a paused transfer to resume at a later time, click on the Clock icon. A dialogue window will then open, allowing you to select a date and enter a time for the transfer to resume.

Right-Click Options

If you right-click you can control file transfers. Right-clicking is exactly the same as selecting the options from the Toolbar. The options available in the right-click menu will depend on the current status of the transfer, and which transfers you have selected.

Bulk Options

To select multiple file transfers, right-click a transfer and hold down the Ctrl key. Then right click on any additional transfers. When you select more than one transfer, the options available will be the options that can be applied to all of the selected transfers.

Rescheduling and Starting a Scheduled Transfer

A Transfer with a status of Scheduled has not yet begun to transfer. By highlighting a scheduled transfer, you can either choose to start the job immediately, or reschedule it for an altere date and time. To immediately start a transfer of a previously scheduled file, select the file and click the Start icon. To re-schedule the Transfer to an altere date and time, highlight the file(s) you wish to re schedule in the list, then select the Schedule icon from the toolbar. You can also choose to cancel a scheduled transfer by clicking the Cancel button.

Viewing Transfer Logs

You can view the logs for each Transfer to get a detailed insight into its progress, as well as to look for errors when Transfers fail.

If the Transfer Agent reports an Error or Retrying status, you can view the log to get more information about the cause of the problem.

To view logs for a particular transfer, select and highlight the file you wish to view and click the Log icon on the Toolbar.

Note: You can also inspect the logs for a Transfer by double-clicking on the transfer in the Transfers table.

Command Line Use

Ooyala Flex's Transfer Agent can be used on the command line (non-UI mode) to transfer media and metadata to Ooyala Flex. The benefit of this approach is the transfers can be initiated by other remote systems, rather than simply a User.

The following mandatory parameters must be used when running the Transfer Agent from the command line:

• mediaFolder: Folder containing the files (if there are spaces in path, use quotes eg: My Documents should be "My Documents")

• fileName: Name of the file to upload (no spaces allowed, any illegal characters will be replaced with underscores on server)

• hostName: Host name of the Ooyala Flex Transfer Server.

• port: Port of the Ooyala Flex Transfer Server.

• accelerated: True or false (depending on whether acceleration is needed or not)

• UserName: Username of the Ooyala Flex User to send to the Ooyala Flex Transfer Server.

• password: Password of the Ooyala Flex User to send to the Ooyala Flex Transfer Server.

• inbox: Inbox on the Ooyala Flex Transfer Server to upload file to (no spaces allowed)

Illegal Characters

The following characters cannot be used on the command line:

' ', '*', '?', ':', '"', '\'', '<', '>', '|', '#', '{', '}', '%', '~', '&', ';', '/', '@', '=', '+', '$', ','

Was this article helpful?