Rest Plugin Setup for Vantage Integration 👩‍🔬

Introduction

Media will be sent through our Vantage integration via the REST plugin. This is a guide to creating a new workflow that will send data to and receive data from Vantage.

Overview

Stage One

The first stage of this workflow is to retrieve media from a storage profile supported by Vantage. This should be the 'Original Video' profile by default.

Vantage supported file types

Stage Two

Imagen REST plugin will be added to the workflow to call the Vantage Azure function application. The function will then poll for progress.

Stage Three

The final stage is to take the Vantage outputs from the REST plugin and route the data to relevant storage profiles. The store and update plugins will be used to finish the workflow

Workflow Screenshot

Setting up REST plugin properties

Submitting Jobs

To allow the plugin to submit jobs set the HTTP method to POST and call

 /api/vantage/v1/job/

The function requires the Imagen Job ID, so it is passed as a parameter .

will be replaced by the REST plugin with the Imagen job id

For example, you would set the URL to:

https://your_Azure_function_url/api/vantage/v1/job/?code=azure_access_code

Cancelling Jobs

To enable job cancellation, use exactly the same URL but with HTTP method set to DELETE.

For example, you would set the URL to:

https://your_Azure_function_url/api/vantage/v1/job/?code=azure_access_code

Progress Polling

To enable job progress polling, set HTTP method to GET and call the /api/vantage/v1/job/progress function passing in as the final parameter as before.

For example:

https://your_Azure_function_url/api/vantage/v1/job/progress/?code= azure_access_code

‘Output result as media objects’ checkbox should always be checked for Vantage workflows.

‘Delay initial progress call’ should be set to several seconds for Vantage as there is often a delay between a job being accepted by Vantage and the same job appearing in job search results from Vantage.

Setting up the job body

<?xml version="1.0" encoding="utf-8"?>
<Job>



    <Variables>
                    <Variable>
                                    <Name>File Name</Name>
                                    <Value>myfile.mp4</Value>
                    </Variable>
    </Variables>
</Job>

will insert the input Imagen media object XML into the job body.

⚠️ Warning: Jobs will fail if this is not present as it's required by the azure function app

💡 Pro Tip: The Variables section is optional and should only be used if the Vantage workflow requires input variables.

In this case, the Vantage workflow has a variable enabled on it named ‘File Name’.

We recommend specifying a filename which includes the job ID so that files don’t overwrite or clash with each other Vantage Jobs running simultaneously

<Variable>
     <Name>File Name</Name>
     <Value>.mp4</Value>
</Variable>

Setting up headers

Click the ‘Setup’ button next to ‘Headers’ on the main interface, this will display the Header form

X-API-Key is the standard Vantage API key header.

X-Workflow-ID is used for setting which Vantage workflow to call.

X-Workflow-Revision is optional and is used only if a specific workflow revision is required.

X-Container-Root is the root container path for expected output files. The Azure function will use this in combination with workflow job filename results when outputting results back to Imagen.

X-SAS-Params should be set to SAS params with READ and DELETE access to the output container, the Azure function will add these params to the output URLs when outputting results back to Imagen.

Setting up expected outputs

Click on the ‘Outputs’ tab on the main interface

The Imagen workflow needs to know what the expected outputs are in the exact order they will return from the Vantage workflow job.

It can then set up output pins on the REST properties (Right) which in turn can be connected to Store and Update properties, so the resulting files are stored to the correct Imagen Storage Service profile.

For each expected output, specify the media type (Video/Audio/Image etc) and optionally the expected container format, video codec and audio codec (if appropriate for the media type).