Vantage Transcoding Action Plugin



Overview

This action plugin submits a file transcoding job to a Vantage server.

Saved Parameters Description

  • Name: The name used to identify a saved Vantage Transcoding configured instance.
  • Comments: The comments of the Vantage Transcoding template. Note that the comments field can be used to provide instuction on which category the action belongs too as an override.
  • Vantage Server Node: The remote node name of the server which hosts the Vantage Transcoding server
  • Vantage Server IP address (or hostname): The remote host name or remote IP of the server which hosts the Vantage Transcoding server
  • Vantage API port: The port number of remote server which hosts the Vantage Transcoding server. Default is 8676.
  • Source file: The absolute path to the file on the server's file system
  • API Method: This Vantage plugin supports SubmitFile and SubmitItems API methods along with logic to fetch only variables and items of the Vantage workflow
  • Vantage workflows: A dropdown of Vantage workflows available on Vantage server to transcode files
  • Workflow Id (hidden): Id of the Vantage workflow selected populated when a workflow is selected from dropdown
  • Workflow name (hidden): Name of the Vantage workflow selected populated when a workflow is selected from dropdown
  • Vantage Variables: Using the plugin users can submit values to variables used in Vantage workflow
  • Vantage Items: Using the plugin users can submit values to items used in Vantage workflow
  • Job name: The name for the transcode job. Defaults to orchestrator generated string.
  • Status Polling frequency: How often progress will be reported. Default is 5 seconds

Inputs Description

The list of inputs depends on the configuration of the VantageTranscoding action template.

All parameters are available as inputs at run time if not specified by the template. This plug-in does not support value overwrites: if a value is specified in the template it will not be available as input of the step at runtime.

These inputs are mandatory if you are submitting a File to Vantage without variables and items:

  • Vantage Server Node or Vantage IP Address: Either a remote node must be selected or a remote IP address must be provided.
  • Workflow Id: A workflow ID is mandatory while submitting a job, hence a workflow must be selected from dropdown.
  • Source file: Absolute path to the source file on remote server must be provided

Mandatory Inputs (When Submitting Variables and Items to Vantage):

  • Vantage Server Node or Vantage IP Address: Either a remote node must be selected or a remote IP address must be provided.
  • Workflow Id: A workflow ID is mandatory while submitting a job, hence a workflow must be selected from dropdown.
  • Vantage Variables: Provide values to the Vantage variables and Orchestrator will submit these to Vantage
  • Vantage Items: Provide values to the Vantage items and Orchestrator will submit these to Vantage. The file to transcode can be one of the items.

Optional Inputs:

  • Name: It is advisable that a name is entered to identify the template.
  • Comments: Information about the template which will help identify the template.
  • Vantage API Port: The port is optional as a default value is used if not specified.
  • Job Name: The name for the transcode job. Defaults to orchestrator generated string.
  • Status Polling frequency: Specify if progress needs to be reported within a time other than default.

Outputs Description

  • Input_file: The input file path involved in the transcode operation
  • Output_file(s): The output file(s) obtained as a result of the transcode operation
  • Job_Id: The ID of the job triggered by the transcode operation
  • Job_Name: The name of the job triggered by the transcode operation
  • Errors: Errors reported by transcode server during transcode operation
  • Vantage_Steps_Info: Details about the Vantage sessions/steps that were executed in Vantage workflow
  • Vantage_Items: Items part of the Vantage workflow
  • Vantage_Variables: Variables part of the Vantage workflow

Example of a Transcode Job Using the SubmitFile API Method

A single source file can be specified. The target can be specified during the workflow setup on the Vantage server.

  1. Provide remote node or remote server IP and port (example: 10.0.103.85 or transcode.lala.com) .
  2. Click the button Get Vantage Workflows. This provides a dropdown with workflows from the provided Vantage server.
  3. Select a workflow from the dropdown. Beside each Variable and Item a text box is provided to enter values. Ignore these and enter the source file.
  4. Provide a source file name, for example, C:\InputFiles\Wildlife.wmv.

    The workflow ID is submitted along with source file path to the Vantage server. Vantage server takes these inputs and performs the transcode and generates an output a file.

Example of a Transcode Using the SubmitItems API Method

Multiple items and variables can be submitted. The target can be specified during the workflow setup on the Vantage server.

  1. Provide remote node or remote server IP and port (example: 10.0.103.85 or transcode.lala.com) .
  2. Click the button Get Vantage Workflows. This provides a dropdown with workflows from the provided Vantage server.
  3. Select a workflow from the dropdown. For the workflow you selected, its variables and items will be displayed, if they exist.
  4. In the text boxes next to each of the variables and items, enter valid values. The workflow ID is submitted along with the items and variables to the Vantage server. Vantage server takes these inputs and performs the transcode and generates an output file.

Example of a Transcode Using the SubmitItems API Method (With Details Submitted at Run Time)

  1. Provide a Vantage server name or Vantage server node as a runtime parameter.
  2. Provide a workflow ID or workflow name as a run time parameter.
  3. Provide Vantage variables in JSON format as a run time parameter. For example, {"Network(String)":"Aspera","Video Height(Int32)":"480","Video Width(Int32)":"720"}
  4. Provide Vantage variables in JSON format as a run time parameter. For example, {"Metadata(Store)":"//server-name/foldername/filename.xml","Original(Media)":"//server-name/foldername/filename/filename.mov"}
    Note: The variable name and the variable class are needed in the format shown.
  5. Save and publish the workflow.

When a work order is created, the workflow ID is submitted along with items and variables to Vantage server. Vantage server takes these inputs and performs the transcode and generates an output file.

Note: in some cases, a vantage workflow can be used to do something other than just transcoding: if for reporting reasons it is important to reflect what the step truly does, it is possible to instruct the plugins to report itself as being from a different category.

This is done by adding to the comments field of the action configuration category: [The custom category]. For example: 
category: Quality Control