FTP Watchfolder

This features lets you edit or publish audios or videos that have been copied to your ftp account.


Process and workflow

4 batch folders are available on your ftp account :

  • 1_ToBeProcessed
  • 2_BeingProcessed
  • 3_ProcessedOk
  • 4_ProcessedError



You only need to deposit your videos (along with a json descriptor file if need be) in the 1_ToBeProcessed folder. The json file will be moved from folder to folder along the process.


The application makes sure that the upload is complete (the last modification must be over 5 minutes old) before a video is processed. It is then moved to 2_BeingProcessed.


If a json file will be used, it must be deposited before any processing starts. In other words, it must be in the batch folders five minutes before the upload of the video is complete. Hence, we strongly advise you to upload any json before the corresponding video. Note that a json alone (without a video) will not trigger any processing.


If the encoding completed succesfuly, the video moves to the next folder: 3_ProcessedOk.

Upon error, the video is moved to 4_ProcessedError and its name is prefixed to reflect the error:

  • _UNAUTHORIZED_EXTENSION_ if the video extension is not recognized (see documentation)
  • _PERMALINK_ALREADY_USED_ERROR_ if the permalink you indicated already exists
  • _DESCRIPTOR_JSON_ERROR_ if the json file is not valid or if the values it contains are not valid
  • _USER_ERROR_ if the video is linked to a user that could not be found within your company
  • _ENCODING_ERROR_ if the encoding went wrong
  • _DESCRIPTOR_FORMAT_ERROR_ if json file cannot be decoded (UTF8 or BOM problems)


For example, sample.mp4 will be moved and renamed to:
4_ProcessedError/_PERMALINK_ALREADY_USED_ERROR_sample.mp4 in case of a duplicate permalink.



FTP batch processing using a json descriptor

The descriptor is used to publish or update a media.

If the media already exists (as revealed by the permalink), its metadata will be updated.


Here is a sample descriptor :

    "media_name":"Media name",
    "media_description":"The media description",
    "media_keywords":"keywordA, keywordB",


Some fields are mandatory and some are not. If an optional field is left empty, it will not be updated.
The mandatory fields are :
  • media_name : media title
  • media_status : authorized values = online, offline, archived
The optional fields are :
  • media_description : the description of the media
  • media_permalink : the permalink of the media
  • media_credits : the credis of the media
  • media_keywords : the keywords of the media
  • ext2_html5 : HTML5 encoding option, if applicable. Authorized values = true, false 
  • user_login : the login of the user to associate with the media. If left blank, the media will be associated with one of the highest level users within the company account.

The size limits of the fields are described in the MEDIA section of the API.
The descriptor must have the same name as the associated media. Only the extension will differ. If your video is named sample.mp3 or sample.mp4, its descriptor will be named sample.json.

If you used a permalink that exists on another account, an error will be generated. If you did not indicate any permalink, one will be randomly generated.

FTP batch processing without a json descriptor

Without a descriptor, an existing media cannot bne modified .

The media name is built from the video file name after a cleanup and removing its extension.

The permalink is built from the media name. If the resulting chain of characters already exists as a permalink, a new one is randomly generated.

The media is set to online status.

If the option is activated on your account, HTML5 encoding is performed.

The media is associated with one of the highest level users within the company account.




Batch processing now applies to audio files.

If you need more metadata updating, please refer to the API documentation..

Created: 06/19/2013  -  Last updated: 12/11/2013