Go to README

What does this plugin do?

This plugin will allow users to select a single item, or multiple items, input metadata (or use metadata fields already set on the item(s)) to be passed to an external platform, i.e. Telestream's Vantage Encoder, Post to a web url, and/or export a sidecar file.

How to trigger:

Using Page Gear to trigger on multiple items or single item

Screenshot 2025-03-11 at 8.19.02 AM.png

Using Item Gear to trigger on single item

Screenshot 2025-03-11 at 8.19.16 AM.png

User Experience:

Workflow that will trigger a Vantage workflow on two items and pass metadata as variables

After selecting which Execute Workflow to run, setting any metadata fields that are configured for the Workflow, enabling/toggling which items to send through the Workflow, and clicking Submit, that will trigger the Workflow configured in the following screenshot.
Items that go through this Workflow will trigger our Vantage plugin to send the item to the Vantage transcode profile configured, along with variables set with metadata from the users input

Screenshot 2025-03-10 at 12.09.30 PM.png

Workflow that will trigger a POST to a Web URL and pass metadata as variables

After selecting which Execute Workflow to run, setting any metadata fields that are configured for the Workflow, enabling/toggling which items to send through the Workflow, and clicking Submit, that will trigger the Workflow configured in the following screenshot.
Items that go through this Workflow will trigger a POST to a Web URL to send the item(s), along with variables set with metadata from the users input

Screenshot 2025-03-11 at 9.12.50 AM.png

README

What it adds:

Execute Workflow... item and search gear

Portal Permissions

Users must have the 'cinesys_execute_workflow' permissions flag to use this plugin.

Requirements

cs_player_markers handles the in/out point marking.
cs_vantage_transcoder must be installed for execute workflow to work.

Configuration

Workflows will always run in the following order: Transcode(s), then Create Sidecar(s), and finally Request(s) [requests run in the order that they are configured]

{
    "workflows": [
        {
            "title": "Example",
            "transcode_profile": "rubberduck",
            "sidecar_type": "example",
            "request": {
                "url": "https://utility-api.cinesys.io/pulse-it",
                "headers": {
                    "Authorization": "Basic YWRtaW4="
                }
            },
            "role": "portal_administrator",
            "gear": false,
            "variables": {
                "cs_select_variable": {
                    "title": "Select",
                    "type": "dropdown",
                    "options": {
                        "some_value": "Some Value"
                    }
                },
                "cs_input_variable": {
                    "title": "Input",
                    "type": "text",
                    "optional": true
                }
            }
        },
        {
            "title": "Select",
            "transcode_profile": ["rubberduck", "another"],
            "sidecar_type": ["select", "select_trailer"],
            "request": [
                {
                    "url": "https://utility-api.cinesys.io/pulse-it",
                },
                {
                    "url": "https://webhook.site/a697f017-4b86-4ae2-8bcf-55fc8da1db19",
                    "method": "PUT",
                    "body": {"message": "test"}
                }
            ]
        },
        {
            "title": "PulseIT",
            "pulseit_template_id": "145"
        }
    ],
    "sidecar_delay_seconds": 15,
    "gear_title": "Optional",
    "pulseit_url": "https://pulseit.example.com",
    "pulseit_user": "",
    "pulseit_password": ""
}

Main Options

Key	Required	Description
`workflows`	required	See below.
`sidecar_delay_seconds`	optional	How long to wait between the transcode and create sidecar steps to prevent files not appearing in the sidecar due to vidispine not yet being aware of them. Defaults to 0.
`gear_title`	optional	Set the item and search gear title, defaults to "Execute Workflow...". This requires a portal restart to change.
`pulseit_url`	required if using PulseIT	Base url of PulseIT server
`pulseit_user`	required if using PulseIT	User to authenticate with PulseIT
`pulseit_password`	required if using PulseIT	Password to authenticate with PulseIT

Workflow Options

Key	Required	Description
`title`	required	The title for this workflow. Must be unique.
`transcode_profile`	optional	References one or more transcode profiles, either vantage or vidispine. It can be a string (one profile) or a string array (multiple profiles).
`sidecar_type`	optional	References a `cs_create_sidecar` sidecar type. It can be a string (one sidecar) or a string array (multiple sidecars).
`variables`	optional	A record of variables that will be passed to the transcode job. In the vantage config, use the syntax `_job:cs_select_variable`. (see below for options)
`request`	optional	Make a network request. (see below for options)
`pulseit`	optional	Use a PulseIT form. (see below for options)
`role`	optional	Restrict this workflow to a role
`gear`	optional	(boolean) Put this workflow directly in the item gear instead of in the generic Execute Workflow modal

Variable Options

Key	Required	Description
`title`	required	The title for this variable shown in the UI
`type`	required	`dropdown` or `text`
`options`	optional (required if dropdown)	A record of variable values. The key is what will be passed to the workflow steps, the value is what will be shown in the UI.
`optional`	optional	(boolean) Make this input optional

Request Options

Key	Required	Example	Description
`url`	required		The request URL.
`method`	optional		Defaults to POST. The request method.
`headers`	optional		A record of headers to pass to the request.
`body`	optional		A record that allows you to add additional parameters to the default json body (provided below). The record key will be added to the json body. The value can be any of the following:
		`_value:Constant`	A constant value `Constant`
		`portal_mf808696`	some metadata field
		`Group Name/portal_mf808696`	some metadata field in a sub group

Default request body:

{
  "cs_some_variable": "some_value",
  "entityId": "VX-1392",
  "entityType": "item"
}

PulseIT Options

Key	Required	Description
`template_id`	required	The PulseIT sequence template ID with a form
`custom_css_id`	optional	PulseIT CSS to use
Other options	optional	You can set any PulseIT `create_and_start` body options and they will be passed. `deadline`, `allocation_date` and `input_context` are automatically set but can be overwritten.