Vantage User Guide
Vantage User Guide
8.1 UP5
User Guide
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Microsoft. Microsoft, Windows Server 2016|Server 2019|Server 2022, Windows 10,
Media Player, Media Encoder, .Net, Internet Explorer, SQL Server 2012|2016|2019|2022,
and Windows Media Technologies are trademarks of Microsoft Corporation.
NLOG, MIT, Apache, Google. NLog open source code used in this product under MIT
License and Apache License is copyright © 2014-2016 by Google, Inc., © 2016 by Stabzs,
© 2015 by Hiro, Sjoerd Tieleman, © 2016 by Denis Pushkarev, © 2015 by Dash Industry
Forum. All rights reserved.
SharpSSH2. SharpSSH2 Copyright (c) 2008, Ryan Faircloth. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer:
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
Neither the name of Diversified Sales and Service, Inc. nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS
IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Swagger. Licensed from SmartBear.
Telerik. RadControls for ASP.NET AJAX copyright Telerik All rights reserved.
VoiceAge. This product is manufactured by Telestream under license from VoiceAge Corporation.
x264 LLC. The product is manufactured by Telestream under license from x264 LLC.
Xceed. The Software is Copyright ©1994-2012 Xceed Software Inc., all rights reserved.
4
Other brands, product names, and company names are trademarks of their respective
holders, and are used for identification purpose only.
MPEG Disclaimers
MPEGLA MPEG2 Patent
ANY USE OF THIS PRODUCT IN ANY MANNER OTHER THAN PERSONAL USE THAT
COMPLIES WITH THE MPEG-2 STANDARD FOR ENCODING VIDEO INFORMATION FOR
PACKAGED MEDIA IS EXPRESSLY PROHIBITED WITHOUT A LICENSE UNDER APPLICABLE
PATENTS IN THE MPEG-2 PATENT PORTFOLIO, WHICH LICENSE IS AVAILABLE FROM
MPEG LA, LLC, 4600 S. Ulster Street, Suite 400, Denver, Colorado 80237 U.S.A.
MPEGLA AVC
THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE
PERSONAL USE OF A CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE
REMUNERATION TO (i) ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD
(“AVC VIDEO”) AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER
ENGAGED IN A PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER
LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR
ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C.
SEE HTTP://WWW.MPEGLA.COM.
5
MPEG4 SYSTEMS
THIS PRODUCT IS LICENSED UNDER THE MPEG-4 SYSTEMS PATENT PORTFOLIO LICENSE
FOR ENCODING IN COMPLIANCE WITH THE MPEG-4 SYSTEMS STANDARD, EXCEPT THAT
AN ADDITIONAL LICENSE AND PAYMENT OF ROYALTIES ARE NECESSARY FOR
ENCODING IN CONNECTION WITH (i) DATA STORED OR REPLICATED IN PHYSICAL MEDIA
WHICH IS PAID FOR ON A TITLE BY TITLE BASIS AND/OR (ii) DATA WHICH IS PAID FOR ON
A TITLE BY TITLE BASIS AND IS TRANSMITTED TO AN END USER FOR PERMANENT
STORAGE AND/OR USE. SUCH ADDITIONAL LICENSE MAY BE OBTAINED FROM MPEG LA,
LLC. SEE HTTP://WWW.MPEGLA.COM FOR ADDITIONAL DETAILS.
Warranty Remedies
Your sole remedies under this limited warranty are as follows:
Hardware and Media—The Company will either repair or replace (at its option) any
defective Hardware component or part, or Software Media, with new or like new
Hardware components or Software Media. Components may not be necessarily the
same, but will be of equivalent operation and quality.
Software Updates
Except as may be provided in a separate agreement between Telestream and You, if
any, Telestream is under no obligation to maintain or support the Software and
Telestream has no obligation to furnish you with any further assistance, technical
support, documentation, software, update, upgrades, or information of any nature or
kind.
Limitations of Warranties
THE EXPRESS WARRANTIES SET FORTH IN THIS AGREEMENT ARE IN LIEU OF ALL OTHER
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. No oral
or written information or advice given by the Company, its distributors, dealers or
agents, shall increase the scope of this Limited Warranty or create any new warranties.
Geographical Limitation of Warranty—This limited warranty is valid only within the
country in which the Product is purchased/licensed.
Limitations on Remedies—YOUR EXCLUSIVE REMEDIES, AND THE ENTIRE LIABILITY OF
TELESTREAM, LLC WITH RESPECT TO THE PRODUCT, SHALL BE AS STATED IN THIS
LIMITED WARRANTY. Your sole and exclusive remedy for any and all breaches of any
Limited Warranty by the Company shall be the recovery of reasonable damages which,
in the aggregate, shall not exceed the total amount of the combined license fee and
purchase price paid by you for the Product.
Damages
TELESTREAM, LLC SHALL NOT BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY
LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF YOUR USE OR INABILITY TO USE THE PRODUCT, OR THE BREACH OF
ANY EXPRESS OR IMPLIED WARRANTY, EVEN IF THE COMPANY HAS BEEN ADVISED OF
THE POSSIBILITY OF THOSE DAMAGES, OR ANY REMEDY PROVIDED FAILS OF ITS
ESSENTIAL PURPOSE.
Further information regarding this limited warranty may be obtained by writing:
Telestream, LLC
848 Gold Flat Road
Nevada City, CA 95959 USA
You can call Telestream during U. S. business hours via telephone at (530) 470-1300.
Regulatory Compliance
Electromagnetic Emissions: FCC Class A, EN 55022 Class A, EN 61000-3-2/-3-3, CISPR 22
Class A
Electromagnetic Immunity: EN 55024/CISPR 24, (EN 61000-4-2, EN 61000-4-3, EN
61000-4-4, EN 61000-4-5, EN 61000-4-6, EN 61000-4-8, EN 61000-4-11)
Safety: CSA/EN/IEC/UL 60950-1 Compliant, UL or CSA Listed (USA and Canada), CE
Marking (Europe)
California Best Management Practices Regulations for Perchlorate Materials:
This Perchlorate warning applies only to products containing CR (Manganese Dioxide)
Lithium coin cells. Perchlorate Material-special handling may apply. See
www.dtsc.ca.gov/hazardouswaste/perchlorate.
7
Contacting Telestream
Resource Contact Information
Vantage Technical Web Site: http://telestream.net/
Support telestream-support/vantage/support.htm
Support Email: [email protected]
Enterprise Telephone Support:
U. S. Toll Free: (877) 257-6245
U. S. from outside U.S.: (530) 470-2036
Europe | Middle East | Africa | Asia | Pacific:
+49 228 280 9141
Terms and times of support services vary, per the terms of
your current service contract with Telestream.
Vantage Information, Web Site: http://telestream.net/telestream-support/
Assistance, FAQs, vantage/support.htm
Forums, & Upgrades
Telestream, LLC Web Site: telestream.net
Sales and Marketing Email: [email protected]
International Web Site: telestream.net
Distributor Support See the Telestream site for your regional authorized
Telestream distributor.
Telestream Technical Email: [email protected]
Writers If you have comments or suggestions about improving
this document, or other Telestream documents—or if
you've discovered an error or omission, please email us.
8
9
Contents
This chapter provides general information about using Vantage client programs,
including starting and stopping, logging in to a Vantage domain, and best practices for
accessing Windows files in Vantage.
Note: You manage Vantage licenses in the Management Console. For details on
adding, updating, or activating licenses, see Enabling a Vantage License in the Vantage
Domain Management Guide. Depending on how you purchase Vantage features,
Telestream may send you additional license files or an updated license file. Follow the
instructions accompanying the license file for adding or updating license files.
Topics
■ Adding Demo Licenses
■ Windows Vantage Client Program Management
■ Web Application Management
■ Paths for Vantage Storage Overview
22 Vantage Client Programs Overview
Adding Demo Licenses
Note: Vantage Cloud Manager is not described in this guide. For details about using
Vantage Cloud Manager, see the Vantage Cloud User Guide.
Note: If you are launching Workflow Designer for the first time, you’ll be prompted to
select and log in to a Vantage domain. See Selecting Vantage Domains and Logging In
for details.
Note: If you encounter an error when launching the Workflow Portal, please see
Troubleshooting Workflow Portal for assistance.
If you are launching Workflow Portal for the first time, you’ll be prompted to select and
log in to a Vantage domain and choose a Workflow Portal configuration. See Selecting
Vantage Domains and Logging In for details.
Vantage Client Programs Overview 25
Windows Vantage Client Program Management
Help
button
If the topic is not available, you can search the entire User Guide for information.
Vantage Client Programs Overview 27
Windows Vantage Client Program Management
Man page
button
When the man page window is open as you proceed through a series of Inspector
panels, the man page changes as necessary, as you display each panel.
28 Vantage Client Programs Overview
Windows Vantage Client Program Management
2. If you know the domain’s identity or the domain isn’t listed during a search, click
Specify Vantage Domain Name/IP Address to expand the dialog.
a. Select the domain you want to connect to, and click OK.
If connection is successful and you’re prompted to enter a user name and pass-
word, see Logging In to a Vantage Domain.
When you change domains, the program closes its connection (if any) with the cur-
rent domain and connects to the new domain.
30 Vantage Client Programs Overview
Windows Vantage Client Program Management
Note: If your domain isn’t listed or you can’t connect, contact your Vantage domain
administrator and/or refer to Connecting to an Unlisted Domain. If you are required to
connect using a custom login, follow these steps:
The program displays the SQL Server login and password settings.
Enter the Vantage database SQL server account user name and password (obtained
from your Vantage administrator), and click OK to connect.
Note: Administrators can enable or disable user authentication. They can also choose
whether or not to use Windows user names by enabling or disabling Windows Active
Directory. Both settings are configured in the Vantage Management Console.
Note: If you don’t have a Vantage user name, ask your Vantage administrator to
create one for you or add your Windows user as an authorized Vantage user.
Enter your user name, and password if required, and click OK to connect.
In Workflow Designer, you may be prompted to create a new category—see Creating a
Workflows Category in Workflow Designer.
In Workflow Portal and Dublist Portal, you’ll be prompted to select a configuration
before you can continue—see Selecting a Configuration in Workflow Portal or Dublist
Portal.
Note: The configurations in the list include public configurations (usable by any
Vantage user), plus those that your Vantage user account is authorized to use. Access
to configurations is controlled by the Vantage domain administrator.
Enter your user name, and password if required, and click OK to log in.
Vantage Client Programs Overview 33
Windows Vantage Client Program Management
Enter a new password, confirm the password, and click OK to update the password for
this user. The next time you log in to the Vantage domain with this user, you’ll need to
use the new password.
2. Select the configuration you want to use or update, and click OK.
Workflow Portal opens the configuration, and displays the appropriate user interface
for this configuration.
34 Vantage Client Programs Overview
Web Application Management
1. Open your web browser and enter the Vantage web application home page URL:
http://<IISServerName>/Vantage/
where <IISServerName> is the DNS name of the IIS server (or its IP address)—by
default, the same as the Vantage domain server.
Note: If you do not know the name of the Vantage IIS server (by default, the same
server where the Vantage domain database is hosted), contact your Vantage
administrator or IT department.
2. If you are prompted to select a domain, select the domain name, and click OK.
The first time you connect to a Vantage domain from this computer (or you deleted
your browser’s cookies), select the domain from the list and click OK to continue.
Refer to Logging In or Changing Domains from Web Applications for more informa-
tion.
3. Enter your authorized Vantage user name and password.
Vantage displays the Vantage web app home page.
Listed apps vary depending on your domain settings and licenses. Click the web
application you want to use.
You can also launch each web application directly, by using its URL:
• Dashboard—http://<ServerName>/Vantage/Dashboard/
• Job Status Views—http://<ServerName>/Vantage/JobStatusViewer/
• Workflow Portal—http://<ServerName>/Vantage/Portal/
• Dublist Portal—http://<ServerName>/Vantage/DublistPortal/
• Live Capture—http://<ServerName>/Vantage/CapturePortal/
Vantage Client Programs Overview 37
Web Application Management
• Tape Capture—http://<ServerName>/Vantage/TapeCapture/capture/
• Settings—http://<ServerName>/Vantage/Administration/Settings.aspx
• External Links—http://<ServerName>/Vantage/ExternalLinks/ExternalLinks.aspx
1. In any web app where you want to change Vantage domains, select Change
Domain in the application title panel.
The web application displays the Select Vantage Domain dialog.
Vantage
domains on
your network.
2. To select a listed domain, select a domain in the domain list, and click OK.
When you change domains, your web application closes its connection and con-
nects to the new domain.
If your domain is not listed, or your connection attempt is unsuccessful, contact your
Vantage domain administrator and refer to the following topics:
■ Connecting to an Unlisted Domain
■ To connect using custom login settings:
2. If the domain is not in the list, click My Vantage Domain is not Listed to display the
Vantage domain server Name/IP field:
Select Use Custom Credentials, enter the Vantage database SQL server account user
name and password (see your Vantage administrator), and click OK to connect.
Logging In
If you are accessing a Vantage domain for which user login is required, Vantage displays
the Vantage Login dialog shown in this figure:
Note: If you do not have an authorized user name, contact your Vantage domain
administrator.
2. Enter your user name, and password if required, and click OK to log in.
Vantage Client Programs Overview 43
Web Application Management
2. Enter your new password, confirm the password, and click OK to change it.
The next time you log in to the Vantage domain, use your new password.
Version
Information
These menu items provide access to the following information and documents:
44 Vantage Client Programs Overview
Web Application Management
For each application, you can click on the User Guide, or click Web Help for the specific
application you’re interested in.
Vantage Client Programs Overview 45
Paths for Vantage Storage Overview
Note: If you are creating a store to hold proxy files viewed in Workflow Portal, be sure
to reference the store with a UNC path. Some SAN clients do not allow frame-accurate
representation of proxies when using shared drives.
46 Vantage Client Programs Overview
Paths for Vantage Storage Overview
47
Vantage Workflow Designer is the primary client program in Vantage: you use it to
design and configure workflows to meet your media transcoding requirements.
Workflow Designer combines a wide range of workflow design and media processing
capabilities into a single program, enabling you to create, construct, and configure
workflows to automate media processing tasks in your organization.
Workflow Designer also allows you to activate and deactivate workflows, submit media
for processing, and monitor the jobs that are created as workflows process the media.
EDNOTE:
Topics
■ Understanding the Types of Vantage Workflows
■ Starting Workflow Designer
■ Workflows Overview
■ Using the Workflow Design Workspace
■ Managing Workflows
■ Constructing Workflows
■ Configuring Actions
■ Specifying Action Settings
■ Implementing Processing Logic in Workflows
■ Managing Vantage Folders
■ Using Open Workflows
■ Processing Cloud-based Media in Workflows
■ Troubleshooting Workflow Designer
48 Designing and Managing Workflows
Understanding the Types of Vantage Workflows
Note: The different types of workflows that you can create are not formally typed in
Vantage. After importing a workflow into Telestream Cloud however, hosted
workflows are actually referred to as hosted.
Two types of workflows may be utilized with or without Vantage Cloud mode enabled:
• On-Premises Workflows—are hosted in an on-premises Vantage domain, and do
not include Cloud actions. These workflows may include cloud-capable actions
with Vantage Cloud mode disabled, and all actions are executed by on-premises
services.
Jobs are submitted to on-premises workflows, via Workflow Designer, or a Vantage
API-based client program.
• Telestream Cloud Workflows—are also hosted in a Vantage domain, but include
the Cloud Qualify action | Cloud Speech action | Location action, which execute
projects implemented directly in Telestream Cloud.
Jobs are submitted to Telestream Cloud workflows on-premises, via Workflow
Designer, or a Vantage API-based client program, though Cloud action execution
occurs exclusively in Telestream Cloud.
When you enable Vantage Cloud mode, the scope of Vantage expands to Telestream
Cloud, and these two types workflows may also be utilized:
• Hybrid Workflows—are hosted directly in an on-premises Vantage domain. In
addition to Vantage actions that only execute on-premises these workflows include
cloud-capable actions, which may execute in Telestream Cloud when in Vantage
Cloud mode.
• Hosted Workflows—are workflows that have been exported to Telestream Cloud
after being designed in Workflow Designer. They are capable of executing directly
in the Vantage domain as well, and are not referred to as hosted in the context of
Vantage. They are managed in the Telestream Cloud console after deployment in
Telestream Cloud.
Jobs to hosted workflows are either submitted via the Telestream Cloud’s Vantage
Cloud console or a Telestream Cloud API-based client program, and all action exe-
cution occurs exclusively in Telestream Cloud.
Note: For information about Vantage Cloud features and utilization, please refer to
the Vantage Cloud User’s Guide, available on the Telestream web site.
Designing and Managing Workflows 49
Starting Workflow Designer
Workflows Overview
A workflow in Vantage is a set of connected actions (each of which performs a specific
task). Vantage provides over four dozen different actions, which you use as the building
blocks of workflows. Workflows can be designed and configured to perform a
controlled, automated media processing application. Workflow Designer organizes its
actions by category (and incidentally, by the service which executes them), for ease of
use. While most workflows center around the process of decoding and encoding video,
you can also construct workflows that—while still media-centric—don’t flip media.
Instead, they might process metadata files, or perform other tasks.
These topics provide information about workflows you’ll find helpful before starting
the construction and configuration process.
■ Workflow Basics
■ Workflow Design & Configuration Overview
Workflow Basics
You construct and configure workflows in Workflow Designer using the Workflow
Design workspace, by adding various types of actions (Watch action, Flip action, Copy
action, etc.) and connecting them together to form a logical chain of successive tasks.
Workflows are stored in the Vantage domain database, and actions in the workflow are
executed by Vantage services.
A valid workflow must start with an origin action (for example, a Watch action or
Workorder action—those actions in the Monitor category, plus the Receive action). For
the Asset Monitor action and the Capture action, no additional actions are required for
a complete workflow. For other origin actions, an additional connected action is
required to complete the workflow.
Note: As mentioned above, the Capture action can be the single action in a workflow.
This action enables SDI live streaming capture on a Live Capture server.
Workflows may have more than one origin action, but each origin action will function
independently of the others. Multiple origin actions permit different methods (or
locations) in which to submit jobs to the same workflow.
Workflows are not required to end with a terminating action—an action without an
output pin. The only formal terminating action is the Forward action. The Forward
action permits you to pass control directly from one workflow to another workflow,
which must have a corresponding Receive origin action. This enables you to create
simpler, general purpose workflows, and chain them together to provide more
automation.
Designing and Managing Workflows 51
Workflows Overview
Workflows are executed by jobs, which are created whenever a new file is discovered by
the workflow’s Watch (or other origin) action, or when you submit a job manually
(Manually Submitting Files Directly in Workflow Designer).
Generally, you construct a workflow in stages: first, conceptualize and design the
workflow and then add the actions, connecting them together to control execution.
Finally, you configure each action in the workflow to perform exactly the way you want.
Now, you can test your workflow, and fine tune it as necessary.
Once you have constructed and configured a workflow, you click Activate so it can be
utilized. To edit it again—or just disable it—you just deactivate it. Then, click Edit, and
when you’re done, you click Release. When you are editing a workflow, others using
Workflow Designer can view—but not edit—the workflow. These buttons are all
displayed at the bottom of the main window.
To activate, deactivate, edit, or release multiple workflows at one time, see Performing
Batch Workflow Operations.
52 Designing and Managing Workflows
Workflows Overview
Workspaces
(tabs) for
each task.
Actions toolbar:
Open services
and drag
actions onto
the workspace
to create
workflows.
Zoom control
At the top of the Workflow Design workspace is the actions toolbar, categorized in
groups by action type. To sort them, right-click in the toolbar and select Sort by Name
or Sort by Behavior.
Click the arrow to open each action group and display the set of actions in this group.
Designing and Managing Workflows 55
Using the Workflow Design Workspace
Note: For SDK submission, you can select the GUID and then copy and paste it into
other applications as required.
Note: You can also manually generate a job report on any job in your job history (see
Generating Job Reports Manually).
Job reports are based on a job report configuration created in Workflow Designer or
the Vantage Management Console (see Managing Job Report Configurations).
To add an automatic job report for this workflow, do the following:
1. In the Workflow Details area (drop-down menu above the workflow), click Modify
to display the Automatic Reports dialog.
2. Click the New Report button in the toolbar.
3. Select the job report configuration you want to use from the Report menu. (Click
the Browse button to display the Job Report Manager to create a new report
configuration or edit an existing one (see Managing Job Report Configurations).
4. Browse or enter a Location where the job report file should be created or updated.
5. Optionally, click Filename Pattern to edit the pattern used to generate a name for
the saved report files.
6. Check Enable to allow this report to be automatically generated for each job that
you run using this workflow.
7. Click OK to save the automatic report.
To delete a report, select the report and click the red delete button.
To duplicate a report as the basis for a new report, click the duplicate button.
Designing and Managing Workflows 57
Using the Workflow Design Workspace
Note: Variables that have been added to a workflow—whether they are utilized by
any action in the workflow or not—are not displayed in this table.
To determine which actions use a given variable, right-click on the target variable and
select Highlight Actions. Workflow Designer displays the Workflow Design tab and
temporarily highlights each action where the target variable is used. Continue working
to cancel the highlighting. You can highlight the actions that use a specific variable in
other ways, too. See Identifying Actions that use a Specific Variable.
Right-click in the workflow design workspace to select Detailed Action View in the
context menu or press Ctrl+D in any of these tabs to toggle it on and off.
Input
nicknames
Output
nicknames
Nickname View
To display nicknames, select View > Action Details > Nicknames or select Nicknames
from the menu in the bottom right corner of the Workflow Design panel. In Nicknames
view, each action displays a list of file nicknames and metadata labels (in italics), plus
attachments, that are available to the action before it executes (on the left), and those
that are emitted by the action and available downstream when the action completes
(on the right).
Nicknames (and labels) that are too long to display in the action display an ellipses (...).
To view the full nickname, hover over it on the action.
Nicknames/labels displayed in bold indicate that they are utilized in that action; as
input files on the left or output on the right. Nicknames in italic are not used, either as
input or output, as indicated. Nicknames that are not used, either as input or output,
are not displayed, although they are passed through.
In the example above, the Original nickname in the IPTV Flip action has been specified
as an input file and is passed out. Likewise, the TIFO file has been specified as an output
file in the IPTV Flip action. In Copy, Original is not used, but TIFO is specified as an input
file. Original and TIFO are simply passed out, but TIFOTOO is specified as the output file.
Items on an action change color based upon the validity of the workflow.
“Technology preview” actions display the action name in yellow. A technology preview
is essentially a beta version that you can test and use, but it is not yet released.
Nicknames displayed in red represent an error.
Note: Nicknames and labels that are used or affected by the action are highlighted.
Nicknames and labels also change color indicating whether or not the workflow is
valid.
For example, if you configure an action to utilize nickname Copy7 provided by an earlier
action and then delete the action that created Copy7, then Copy7 displays in red on the
now-invalid action.
Designing and Managing Workflows 59
Using the Workflow Design Workspace
Variables View
To display variables used in this action, select View > Action Details > Variables or select
Variables from the menu in the bottom right corner of the Workflow Design panel.
Unlike nicknames that are always displayed when available, variables are not displayed
if they are not utilized directly in the target action. When Variables View is enabled, you
can click on any variable and select Highlight Actions to see which variables use it in
the entire workflow.
Variables that are too long to display are truncated, ending with an ellipsis (...). To view
the full name of the variable, hover over it on the action.
Variables displayed in bold indicate that they are utilized in that action as input files on
the left or output on the right. Variables in yellow indicate variables added using Add
Variables in the action context menu. The yellow highlighting makes these added
variables easier to recognize when modifying workflows.
Perform On View
To display the Perform On selection in each action, select View Perform On or choose
Perform On from the menu in the bottom right corner of the Workflow Design panel.
The Perform On selection is made by right-clicking an action and selecting a Perform
On state in the context menu (see Setting Conditional Action Execution for details).
60 Designing and Managing Workflows
Using the Workflow Design Workspace
As you hover over the icon, a popup displays. It includes the action type, description
(editable), and a high level description of how the action is configured.
Deleting an Annotation
To delete an annotation, right-click the action, choose Annotation and click Clear. Then,
click OK.
Centering a Workflow
To center a workflow in your workspace, do one of the following:
• Right-click in the workspace and select Recenter Diagram (Ctrl+R)
• Select View > Recenter Diagram to center the workflow in the work area.
Note: When the Unable to Activate Workflow error message displays because of an
incorrectly configured action, after you dismiss the message, the Workflow Designer
automatically centers and selects the offending action in the workspace.
Zooming In—To zoom in on a workflow so you can better view details, do one of these
actions:
• Drag the zoom slider bar to the right
• Select an action, press Shift, and drag the zoom slider bar to the right to zoom in
directly on the selected action
• Select View > Zoom In
• Repeatedly press Ctrl++ (the Plus key)
• Press Control and roll the mouse scroll wheel up (forward)
Zooming Out—To zoom out on a workflow so you can see more actions, do one of these
actions:
• Drag the zoom slider bar to the left
• Select an action, press Shift, and drag the zoom slider bar to the left to zoom out on
the selected action
• Select View > Zoom Out
• Repeatedly press Ctrl+- (the Minus key)
• Press Control and move the mouse scroll wheel down (reverse)
Designing and Managing Workflows 63
Using the Workflow Design Workspace
Toolbar Display Size—To reduce the size of the Action toolbar at the top of the design
area, select Icons only. To display the action names (making the toolbar a bit larger),
select Icons and Text.
Action Group Display Order—To display the action groups in alphabetic order, select
Sort By Name. To display the action groups by functionality and (generally) in order of
utilization in a workflow, select Sort By Behavior.
Expand/Collapse Option—To open all action groups, select Expand All. To close all
action groups, select Collapse All.
Right-click in the Workflows panel to display the following context menus, depending
on where you click:
66 Designing and Managing Workflows
Using the Workflow Design Workspace
On a Workflow Category
When you right-click on a category, you can use this edition of the context menu to:
• Create a new workflow
• Rename or delete the category
• Import or export workflows to or from the category
• Perform Batch Workflow Operations.
Caution: When you delete a workflow category, all workflows in this category
are permanently removed from the Vantage domain’s database.
Each status has a unique icon (or combination), as shown below, in the table.
Note: With user administration enabled, only Vantage users with Administrator
authority can lock workflows in an idle or active state to prevent unauthorized
changes or deletion. To lock a workflow, select File > Lock Workflow or right-click on
the workflow and select Lock. Workflow Designer displays a lock icon beside the
workflow. Locked workflows can be activated and deactivated. However, they can’t be
edited, updated, or deleted. When user administration is disabled, anyone can lock or
unlock workflows.
Edit—Choose File > Edit Workflow or click the Edit button to modify the selected
workflow. If the workflow is currently active (a Watch or Receive action is running and
the workflow can process jobs), Vantage displays a warning dialog that it is about to
deactivate the workflow. Click OK to continue. To edit or release multiple workflows at
one time, see Performing Batch Workflow Operations.
The Actions toolbar displays at the top of the panel when in design mode, so that you
can add new actions to the workflow.
When you are editing a workflow, other Workflow Designer users can view the
workflow, but no one can edit, activate it or process jobs with it.
Release—When you’re done editing a workflow, select File > Release Workflow or click
the Release button. Released workflows can be activated, and can also be edited by
others. To edit or release multiple workflows at one time, see Performing Batch Workflow
Operations.
Activate—Select File > Activate Workflow or click the Activate button on a deactivated
workflow to start a Watch or Receive action so that jobs can be submitted and
processed by this workflow. To activate or deactivate multiple workflows at one time,
see Performing Batch Workflow Operations. To automatically display the Monitor Status
tab when you active a workflow, choose Options > Switch to Monitor Status on
Workflow Activation.
68 Designing and Managing Workflows
Using the Workflow Design Workspace
Managing Workflows
This topic describes how to organize, add, rename, and delete workflows and
categories, change their status, and perform batch operations and other workflow-
related operations.
Note: Whenever you are performing a workflow operation, you can select the
workflow directly from the Workflow panel or select File > Recent Workflows, and
select the workflow from the list.
Note: Administrators can prevent Vantage specific users from seeing (and therefore
using) workflows by category. To select workflow categories and specify which users
have access to them, use the Vantage Management Console.
Note: All workflows are stored in categories, so you must create at least one category
before you can create a workflow.
2. Enter the name of the category you want to create, and click OK.
Workflow Designer creates the category in the database, and displays it in the
Workflows panel.
Caution: This action deletes all workflows in the category, and cannot be
undone.
Category—Select the category for this workflow from the list at the top.
Name and Description—Enter the name of the workflow you want to create and an
optional description in the Name and Description fields.
Expiration—When checked, specifies (in hours) the time that elapses before job records
for jobs processed by this workflow that complete on SUCCESS are deleted from the
database. The time for expiration is based on the last updated time in the job record—
not the job submission time. Once the expiration period has elapsed, the jobs are
subject to automatic deletion by the system.
72 Designing and Managing Workflows
Managing Workflows
Note: Job that don’t succeed are not controlled by this setting, and do not
automatically expire. To expire FAILed jobs, in the Domain Management Console,
check Settings & Options > General > Expire Failed Jobs.
Renaming a Workflow
To change the name of a workflow, right-click on the workflow name in the Workflows
panel and select Rename. Workflow Designer makes the text editable so you can
change it. Press Enter or just click away from the field when you’re done.
Deleting a Workflow
To delete a workflow, select File >Delete Workflow or right-click on the workflow name
in the Workflows Panel and select Delete. Workflow Designer displays a warning that
you are about to delete the workflow and all job history for this workflow. Click OK to
delete the workflow and its history.
To delete multiple workflows at one time, see Performing Batch Workflow Operations.
Caution: This action deletes the workflow and its job history, and can’t be
undone.
For workflow filtering, select Workflows; select Categories to filter categories. Next,
enter a phrase or string, or select a previously-entered string. Workflow Designer
displays only those categories or workflows/categories that meet the filter criteria.
Click the filter icon again to clear filtering and display all of the categories and
workflows/categories in the domain.
To open a reference inspector, click the R button in the inspector’s title bar:
Click the R button to
open the action
inspector of another
action you want to
review, in read-only
mode.
Navigate to the workflow containing the action you want to inspect and then scroll
through the actions and choose the one you want to view and click OK.
Workflow Designer displays the action inspector in reference mode, as noted by the
orange text at the top. When you close the action you’re working on, the reference
action is closed as well.
Designing and Managing Workflows 75
Managing Workflows
Duplicating a Workflow
To duplicate a workflow, select File > Duplicate Workflow or right-click on the workflow
and select Duplicate. Workflow Designer displays a Category dialog. Select the
category you want to create the new workflow in, enter a name, and click OK.
Importing Workflows
You can import workflows which have been previously exported (as XML files) from this
or other domains.
You can import workflows into your domain that have the same name as another
workflow in a different category. However, if you import a workflow into a category
which already has a workflow with the same name, Vantage assigns the imported
workflow an incremental copy number. You can’t have two workflows of the same
name in the same category.
Importing a workflow can create a problem with duplicate variables: The variable
already exists, but the imported variable has a different default value. When this
happens, the original value remains intact.
76 Designing and Managing Workflows
Managing Workflows
Note: You cannot import a workflow that includes any action whose service is not
running in the domain.
1. Right-click on the category title in the Workflows panel, and select Import
Workflows.
2. Navigate to the directory where the previously exported workflows are located.
3. Select one or more workflows and click Open.
Workflow Designer imports the workflow into the selected category. You can now
rename and edit the workflow as appropriate.
Note: When importing workflows that have been created and exported from another
domain, you may end up with duplicate variables in your domain. For example, you
might end up with two Agency variables. This is typically not a problem. However, to
determine which workflows use a particular variable—so that you can correct them to
use only one definition of it—go to the Management Console > Workflow Design
Items > Variables. Select the variable you want to search workflows for, and click the
Find Workflows Using this Variable button in the toolbar (5th from left).
Printing Workflows
Select File > Print Workflow to print the selected workflow using the current workflow
settings. The workflow is scaled to fit on a single page (with landscape or portrait mode
preset based on workflow shape), unless the workflow is sufficiently large to make it
difficult to read when scaled to a single page. Then, Workflow Designer provides you
the option of printing across multiple pages.
Note: For complete details on using hosted workflows and Vantage Cloud in general,
read the Vantage Cloud User’s Guide.
After creating (or updating) your workflow and testing it for proper execution, choose
File > Export Workflow for Cloud or right-click the workflow and choose Export for
Cloud.
Workflow Designer automatically audits the workflow to determine if the actions and
their configurations are supported for use as a hosted workflow. If it discovers an error,
Workflow Designer displays an error message identifying the problem:
When the workflow passes the hosted workflow audit and is validated for hosting and
execution in Telestream Cloud, Workflow Designer displays a File Save dialog:
Browse to the local or network location you want the file exported to, name the file
(with the CWD) extension and click Save.
Note: When the export is complete, your work in Vantage is complete. Log into your
Telestream Cloud account to import the CWD file and prepare it for deployment and
utilization in Telestream Cloud.
80 Designing and Managing Workflows
Managing Workflows
Note: If your domain has User Administration enabled, this feature is enabled only by
users with Administrator privileges.
To change the status of (or operate on) multiple workflows, do the following:
1. Select File > Batch Workflow Operations.
Workflow Designer displays the Batch Workflow Operations dialog, which displays
every workflow in the domain.
2. Select one or more workflows (using Shift and Ctrl keys).
3. Click one of the buttons at the bottom of the dialog to perform the task. The
function of each button is listed in the following table.
4. When you’re done, click Close.
Buttons Functions
Edit Enables editing of the selected, released workflows.
Release Releases the selected workflows to idle.
Lock/Unlock Locks (or unlocks) the workflows to prevent editing.
Designing and Managing Workflows 81
Managing Workflows
Buttons Functions
Activate/Deactivate Starts (or stops) the workflows so that they can accept
jobs.
Delete Deletes the selected workflows.
CAUTION: When you click OK in the Continue? dialog,
the workflow is permanently deleted.
Move Moves the selected workflows to another category. A
Move Workflows dialog lets you select the category to
move to. You can also use a Create New Category button
to create a category and move the workflows into it.
Push Pushes the selected workflows to another Vantage
domain to make it easier to disseminate new or changed
workflows. Use Search in the Select Vantage Domain
dialog to find the target domain, or specify a domain
name or IP. Change Connection Settings if the database
login or password is customized; otherwise, use the
defaults. When ready, click OK to push the workflows.
CAUTION: When you click OK, the workflows are
immediately pushed to the specified domain, and
overwrite any workflows having the same workflow ID.
Notes:
1. Workflows in separate categories can be named the same.
2. A push overwrites the correct workflow (same ID), even
if it is renamed or moved to another category.
3. See the Workflow Details Panel for the ID. The ID
uniquely identifies a workflow.
Set Priority Specifies the priority for all origin actions in the selected
workflows to ensure higher priority workflows execute
first. Priorities can be changed only for workflows in Edit
mode. Enter or select a number, and click OK. Higher
numbers set a higher priority.
Expiration When checked, specifies (in hours) the time that elapses
before job records for jobs processed by this workflow that
complete on SUCCESS are deleted from the database. The
time for expiration is based on the last updated time in the
job record—not the job submission time. Once the
expiration period has elapsed, the jobs are subject to
automatic deletion by the system
Check for Upgrades Checks the selected workflows for available upgrades.
Click OK to perform the upgrade.
Close Click Close to close the Batch Workflow Operations dialog.
82 Designing and Managing Workflows
Managing Workflows
Workflow Designer, checks to make sure that the actions are current. If not, the action’s
title displays in italics to indicate that you can upgrade it.
Note: In addition, you can hover over an action to display the tooltip, which indicates
which ComponentPac version is being used.
Right-click the action and select Upgrade to upgrade it. Or, right-click outside of an
action and select Upgrade to upgrade all upgradeable actions in the workflow. Then,
open the Inspector and review your configuration, making changes as appropriate,
based on the action’s new or changed controls.
The Upgrade menu item is hidden when there are no upgrades available (for any
actions in the workflow). The Upgrade menu item is grayed out when upgrades are
available, but can’t be performed now (for example, when the workflow is not editable).
To upgrade multiple workflows at one time, see Performing Batch Workflow Operations.
Note: Once an action is upgraded it can't be directly downgraded. However, you can
restore workflows by importing the automatic backup copy that Vantage places in the
C:\VantageWorkflowBackup directory (local to the Workflow Designer client). A log file
describing the upgrades is also included in that directory.
Note: If you want to change the location of automatic ComponentPac backups, open
the Vantage Management Console, select Settings and Options, and browse for a new
Location for workflow backups.
Note: During service startup, if multiple ComponentPacs are present, the service uses
the highest-versioned ComponentPac to populate the action template in the
database. This process updates default action configurations and also ensures that
newly created actions always use the latest ComponentPac.
84 Designing and Managing Workflows
Constructing Workflows
Constructing Workflows
The following topics describe the operations you’ll use to construct workflows, which is
done by creating actions, arranging them in order of execution, and connecting them
together. One operation—exporting an action—can only be performed on Flip actions.
It is used in conjunction with implementing an SDK-based Vantage application.
Note: Before you can edit a workflow (work with actions or change configuration), it
must be deactivated and editable. When you first create a new workflow, Workflow
Designer places it in edit mode automatically.
■ Adding Actions
■ Controlling the Order of Action Execution
■ Deleting Actions
■ Removing Line Crossings
■ Re-ordering Actions
Adding Actions
There are several ways to add actions to a workflow, depending on the situation.
New action—to add an action, open the appropriate category in the Actions toolbar
and drag the desired action onto the design area. When you drag an action from the
toolbar, it must be configured before you can use the workflow.
Action template—Vantage allows you to create templates from your configured actions
so that repetitive action configurations can be saved and reused. For details, see
Creating Action Templates.
To add an action template to a workflow, click on the action in the action group, select
an action template from the list, and drag it onto the workflow.
Copy and paste—to copy and paste actions in a workflow, first right-click the action you
want to copy and select Copy. To select multiple actions, Ctrl+click and drag across the
desired actions in the design work space.
Next, right-click on the design area, right-click and select Paste to add the copied action
or actions to the workflow.
To paste an action’s configuration into an action of the same type, right-click and select
Paste—this configures the action identically with the copied action.
Designing and Managing Workflows 85
Constructing Workflows
Note: An origin action (Watch or Receive action) is required as the first action in a
workflow, even if you plan to manually submit jobs to this workflow.
When you drag an action onto the design area, Vantage may automatically align it near
where you dropped it (unless auto-arrange is off; see Automatically Arranging Workflow
Actions). Until you connect an action to other actions, you can move it anywhere you
want on the work area. If you bump the action you’re adding right next to an existing
action, Workflow Designer will automatically connect the two.
Generally, it’s easiest to drag and drop actions in a pattern similar to the flow of the
desired workflow, working from left to right (on each branch, if more than one).
However, you can drag actions anywhere, and connect them as desired later.
Vantage will tidy up actions—moving them and organizing them by column. Once an
action is connected, you can move it vertically (up or down) but it cannot be moved
from its column. Alternatively, Vantage can also attempt to optimize the workflow,
removing as many line crossings as possible.
Note: When you connect actions by clicking and dragging a connection, Workflow
Designer can display a popup message that provides connection details. To enable or
disable this feature, select Options > Show Connection Helper.
You can connect one action to multiple succeeding actions, creating logical branches,
as shown in the figure following. When you do, none of the actions you connect can
execute before the preceding action upon which they depend completes.
When you have branches in a workflow, you can optionally, use a Synchronize action as
a visual connector at either end of the branches, to better organize them. Synchronize
does not perform any special task, it merely aids in design. In this example, three Copy
actions execute in parallel after the Watch action completes.
These three Copy actions execute independently of each other, and their start time and
completion time relative to each other is indeterminate. They execute in parallel from
the perspective of the actions which precede and follow these actions.
You can also connect multiple actions (branches) back to a single succeeding action, as
shown. When you do, each of the actions you connect must execute before any
succeeding Common action can execute. In this example, all Copy actions must
execute before the Message action executes.
Designing and Managing Workflows 87
Constructing Workflows
You can also create multiple, independent action branches—each branch starting with
an origin action. Each origin action creates its own job. Although this is not generally
recommended, you may have situations where it is the best solution.
In this example, two independent sets of actions are in this workflow. As each origin
action detects new files to process, a separate job is initiated.
Deleting Actions
To delete an action, select it and press Delete or right-click the action and select Delete.
When you delete an action, Workflow Designer connects the preceding and
succeeding actions, unless you uncheck Fill connections after delete in the Delete
confirmation dialog.
To select multiple actions, Ctrl+click each additional action or Ctrl+click and drag across
them in the design work space. When the appropriate actions are selected, delete them
using one of the following options:
• Press Delete.
• Right-click one of the selected actions, and select Delete.
Re-ordering Actions
To re-order actions vertically, drag one or more of the actions up or down in the design
area to the location where you want it. To select multiple actions, Ctrl+click each
additional action or Ctrl+click and drag across them in the design work space.
Workflow Designer adjusts the other actions to accommodate the manual placement
of the other action.
Designing and Managing Workflows 89
Configuring Actions
Configuring Actions
Each action (except the Synchronize action, which is simply a common connecting
point for branches in a workflow, with no user configuration) has an action Inspector
for setting up the action to perform in a particular way in this workflow.
Most action Inspectors use the Wizard model; a series of one or more panels, with
standard Previous, Next, Finish, and Save buttons.
The Flip action is unique in its design because of its unique, transcode-centric
functionality.
The remaining media processing action inspectors—specifically, the Flip64 action, and
other Telestream Media Framework-based transcoding actions such as the Multiscreen
action—display the entire inspector in a single, multi-paneled window.
The panel’s organization and the layout of building blocks is pretty simple. The different
controls in editor panels is insignificant. What matters is that you use the panels to
select inputs, encoders, and outputs and configure filters, select nicknames, and make
other selections specific to the formats you've chosen.
■ Displaying the Action Inspector
■ Using the Flip Action Inspector
■ Using the Telestream Media Framework Action Inspectors
■ Using the Filename Pattern Editor
■ Binding Settings to a Variable
Note: Detailed, context-specific help (as shown above) is available on each inspector
panel: Click the icon to display its man page. Click the icon to display this topic
(the one you’re currently reading) in the Vantage User Guide. Once in the guide, you
can also search for other topics. You can also hover over any control for a tooltip.
90 Designing and Managing Workflows
Configuring Actions
Until an action has been configured correctly, the inspector button displays yellow; a
workflow cannot be activated until all actions have been configured correctly and no
yellow inspector icons display. When an action is correctly configured, the inspector
button disappears. When you hover over the top left corner, the inspector button
appears in blue with a summary of the action.
The inspector panels vary, depending on the type of action, and the configuration
choices you make. For example, here is a simple inspector—the inspector to configure
a Copy action:
However, the Inspector for a Watch action typically consists of about 7 or more panels,
depending on the file system you’re configuring it to monitor.
When you’re viewing an inspector of an action in a workflow that is activated or
someone else is editing it, the term Read Only displays in the inspector’s title bar. Also, if
Designing and Managing Workflows 91
Configuring Actions
you have changed the configuration, an asterisk (*) displays immediately before the
action name: For example, *Watch.
The general Flip action controls at the top of the inspector window enable you to select
an encoder and create a file name pattern for naming the encoded file (for details, see
Using the Filename Pattern Editor). You must specify an input and output media
nickname. You use the Output Location controls to specify where to write the output
media file. For details, see the man page.
92 Designing and Managing Workflows
Configuring Actions
The media file panel is comprised of building blocks, and a toolbar for adding other
streams and filters.
Video & Audio Codecs
Decoder Streams Toolbar Container
To add any supported type of stream for the encoder, select it from the toolbar. To add
a filter, select the video stream or audio stream and then add the selected movie, video,
or audio filter from the list.
Designing and Managing Workflows 93
Configuring Actions
If you directly click on the icon, it will add the next available filter at the top of the drop
down list. If you click on the menu arrow on the right side of the icon, the list will
displays and you can select the appropriate filter.
To remove any building block, select it and then click the Delete icon or just select it
from the list again.
Each type of action’s components vary. The categories are represented by a panel—in
this example there are four categories of components: Inputs, Converters, Transcoders,
and Outputs. You can add one or more components to each category, depending on
the action. For example, in the Multiscreen Flip action you can add several input
processes, an Audio Mixer Converter, one or more transcoders and one or more
outputs.
To remove any component, select it and then click the Delete icon.
94 Designing and Managing Workflows
Configuring Actions
Configuring Components
Each component you add displays its own panel, including the video and audio
streams, as appropriate.
To configure the component, click to select it (as shown above, with the white border).
The setting details panel displays on the right, enabling you to configure it.
Use the same process to configure each video and audio stream.
To configure the component, click the expander button to display its settings.
To produce the name generator pattern you require, you can include raw text (for
example, .xml) and any combination of the following tokens: base name, any supported
variable you want to select, plus date and time. The Date token includes variations of
96 Designing and Managing Workflows
Configuring Actions
month, day, and year. The Time token includes variations of hours, minutes, seconds,
AM/PM, and Time zone offset. Hover the cursor over each selection to see a tool tip
description. Once a token is added to the pattern, you can move it to a different
position within the pattern field by clicking and dragging it.
Note: In all transcoding actions, the Base Name element is the base name of the
source file without the extension (for example, myfile for a file named myfile.mpg). In
file operations actions (Copy and Move, for example), the Base Name is the full name
of the file, including the extension. For example, myfile.mpg.
Click the green Browse button to display the Select Variable dialog, shown here.
The list of variables includes those variables of the appropriate type (text, true/false,
etc.) in the domain. For example, the subject line only accepts text variables; the email
address only accepts email address variables.
Select the variable to bind to this setting, and click OK.
Note: Click Create New Variable to if you need to make a new one. For details, see
Creating New Variables. (You can also create variables in the Management Console.
Now, the setting displays with a green border, indicating that its value is derived from
the current value of the variable instead of the setting (in the case of a check box or
radio button) or a manually-entered or selected static value.
When you bind a setting to a variable, the value or state displayed is the default for the
variable definition in the domain and the value is read only. If you remove the binding,
the value returns to the setting’s original editable value.
Some actions can be configured to set the Ignore state. The next action inherits the
Ignore state and will likely not execute (unless it has been explicitly set to execute on
Failure). Most actions, such as Message, can be configured to perform on certain
states—this allows workflows to send an email if they detect a failure.
By default, actions only execute when the action state (as set by upstream actions) is
Success. Success means that the upstream actions have completed normally and the
incoming state is Success.
The Failure state indicates that at least one action has executed and failed to complete
normally or completed normally, but was explicitly set to Failure. If you have an action
configured to execute on Failure, it only executes if at least one upstream action has
reported a failure.
Post-execution states have priority: If an action receives states from two incoming
actions (at a merge of two branches), then:
• Failure has precedence over all action states—If at least one incoming state is Fail-
ure, regardless of other incoming states, the action will inherit the Failure state.
• Success has precedence over Ignore state—If there is no Failure, but at least one
Success state, then the action will inherit the Success state.
• Ignore is the lowest precedence—Only if all incoming states are Ignore, will the
action will inherit the Ignore state.
Variables Overview
In Vantage, a variable is a container for temporary job information—a symbolic name
(or identifier) which contains some data: a quantity, string, or element of information; a
value. You use the variable name to reference the current value; this separation of name
and content allows the name to be used independently of the information it references.
Each variable has a name (such as Number of Audio Channels), a type (Integer Number,
for example), and a default value, all of which are defined when the variable is created.
Note: To display variables used in your actions, in detailed action view, select View >
Action Details > Variables or select Variables from the menu in the bottom right corner
of the Workflow Design panel.
You can change variable values in a variety of ways. For example, a variable value can
be set by default. Or, it can be assigned a new value in actions that are designed to use
variables, such as the Analysis, Populate, Watch and Associate actions. Variable values
can also be changed when manually submitting a job or using Workflow Portal to
submit jobs.
Variables are passed from action to action according to the action connections. When
an action creates a given variable, all downstream actions that use variables can access
the variable and its current value.
Variables are used by some actions to control their functionality and execution—and
thus, implement workflow logic. (Variables are also used by Vantage services as defined
by the Vantage domain administrator.)
102 Designing and Managing Workflows
Specifying Action Settings
Note: If two branches merge to a Common action, and both have set a value for the
same variable, then the last upstream action to finish executing will set the variable for
the common action. The last action to finish can not be determined from job to job.
In the Add Variables window, you can add variables to the action prior to execution.
Values set in this window are available to this action, and all downstream actions
(including actions in connected workflows). Variables added using the Add Variables
context menu appear in yellow in the action variable list.
Click the Add Variables button in the toolbar to display a list of variables.
Designing and Managing Workflows 103
Specifying Action Settings
Note: Click Create New Variable to create a variable if you need a new one. For details,
see Creating New Variables.
Next, with the variable selected, modify its default static value if necessary, and click OK
to add it to the variable for use in the workflow.
For example, consider this Construction action, which is configured to create a specific
text string and store the result in a variable named JobNameVar.
After configuring this variable, you can copy it, making it available to paste into other
controls which utilize variables, in this or other actions. After adding a new item, and
pasting the copied variable into the text field, the inspector displays the variable,
bound to the original, as shown here:
Note: The variable is still in the Vantage (not system) clipboard, so that you can create
or open another action and perform the paste operation again.
Designing and Managing Workflows 105
Specifying Action Settings
Copying and pasting variables speeds the process of creating complex, large workflows
by reducing repeated manual configuration tasks.
106 Designing and Managing Workflows
Specifying Action Settings
Note: To display the current run on rules used in actions in your workflow, in detailed
action view (Ctrl+D) select View > Action Details > Run On Rules or select Run On
Rules from the menu in the bottom right corner of the Workflow Design panel.
Run on rules provide explicit control over which service can execute this action in a
workflow. As you design a workflow, you can indicate that you need to have the action
executed by a specific service (or set of services) based on workflow state criteria. To
implement this, you assign a True/False variable the value of TRUE to indicate that the
service must satisfy the requirement. Assign this variable to the Vantage service or
services that qualify, in the Vantage Management Console > Services > Variables.
For example, you are designing an HD transcoding workflow, and the Flip action must
be executed by a Transcode Service deemed HD-capable—that is, it is running on a
server with a processor set capable of adequately handling HD media transcoding. For
this example, it’s a server named Vantage_HD_Transcoder.
In Workflow Designer, open your workflow, right-click on an action and select Run On
Rules to display the Run On Rules dialog:
Click the Add Run On Rules icon in the toolbar to display the Run On Rules dialog:
Add one or more rules (selecting a variable or creating it if needed) and select an
operator and value to configure them.
OR
Click Copy From to display the Run On Rules Copy From dialog. Navigate to the
workflow you want and then select the action to copy from and click OK.
Next, click OK to create this rule, and click OK to save the Run On Rule.
In the Vantage Management Console, select Services > Variables and add the
variable(s) that you have used in your rules to each Vantage Service you need to query.
In an array, the same service may be hosted on multiple nodes.
Note: When a variable is added to a service, that variable is added to the job
automatically, if it contains an action that the service executes. Be careful about which
108 Designing and Managing Workflows
Specifying Action Settings
variables you use for run on rules, and which are used for decision-making; generally
you will want to use different variables.
Run on rules only analyze variables explicitly set by a service. They do not analyze
variables set in a job. This ensures that run on rules only execute actions on a service
that explicitly sets them.
Now, return to Workflow Designer and display the workflow again. Right-click on your
target action and select Run On Rules to display the Run On Rules dialog.
Click Check Services to verify that the service now responds correctly to variable
analysis. For example, HD-capable = TRUE.
Designing and Managing Workflows 109
Specifying Action Settings
Note: In Open Mode, Lightspeed fallback doesn't occur until the action completes.
This is by design. Fallback occurs only when Vantage determines that the action
cannot run, and this condition will not happen until the previous action completes in
this scenario. In this scenario, the action should be configured to explicitly use the
multi-core mode.
action type is used instead. If there are no override rules specified for an action, and no
default rules for its action type, then a failed action is not retried.
Each time an action is executed, it may be executed according to either task scheduling
rules or resource cost settings, depending on what type of load balancing is enabled in
the domain, and it may be assigned to a different service for execution.
If you restart a job that is in the Stopped by User or Failed state, the actions execute as a
first-time execution. For example, you have an action with retry after 4 hours. Restarting
this job results in immediate execution, because the action is executing on its first try.
Configuration Details
Right-click on an action and select Retry Settings to view or configure retry rules.
Workflow Designer displays the Automated Retry Settings dialog.
Note: When cost-based load balancing is disabled (the legacy, default setting),
Vantage uses session-based load balancing and resource cost settings are ignored. For
information on configuring load balancing, see the Vantage Domain Management
Guide.
When cost-based load balancing is enabled, each action has a default cost and a
custom cost. The default cost value is defined by the Vantage domain administrator.
The custom cost is defined by the workflow designer in the workflow itself. When you
define a custom cost, that cost overrides the default value.
Cost-based load balancing provides a way to control how action processing is
distributed among multiple services. During workflow processing, the action cost
defines the relative resources that must be available on a Vantage service to process
the action. If there are multiple services that can process an action, and if one service
does not currently have the resources to process that action, another service with
available resources will process the action.
The resource cost is an integer value that has an ordinal relationship to the other action
costs and to a target resource usage value defined by the domain administrator. A
higher resource cost in an action means that fewer actions can run simultaneously on
the same service. A lower resource cost allows more actions to run simultaneously. The
actual values you enter for a workflow action must conform to the service settings
defined by the Vantage domain administrator. To determine the range of resource cost
settings available to you, consult with your Vantage domain administrator.
112 Designing and Managing Workflows
Specifying Action Settings
• When tasks are queued, they may be preempted only by higher priority actions:
Certain high priority tasks will pause low priority tasks (executing on the same ser-
vice on the same machine) to free up sufficient resources across all metrics, to allow
that high priority task to execute. If doing so would exceed the maximum number
of paused jobs specified by the user, then the high priority task will wait until a dif-
ferent set of tasks are present which may be paused. Pauses will not occur across
multiple machines; they occur only for actions hosted by the same service.
Task Based Load Balancing allows you to define custom task scheduling rules which
allow jobs to be controlled/allocated based on criteria on a given machine or across an
entire domain.
Task Based Load Balancing is enabled via the settings panel in the Vantage
Management Console. As with other system level settings, when Task Based Load
Balancing is enabled (or changed), services must be restarted.
Task Based Load Balancing includes capabilities that replace and extend the Cost Based
Load Balancing. The capabilities replace the existing action cost mechanisms, and are
used in-conjunction with the existing service capacity to provide more granularity on
when and where an action may run.
114 Designing and Managing Workflows
Specifying Action Settings
b. If you select Configure Task Scheduling, the Task Scheduling Rules dialog opens.
Select Default to apply existing system rules, or select Custom and choose the
custom rules you’ve created that you wish to apply. Also specify a cost and click
Done.
For details about creating Task-Based rules using the Vantage Management Con-
sole, refer to the Vantage Domain Management Guide, “Managing the Vantage
Domain” chapter.
3. Click OK to save.
Designing and Managing Workflows 115
Specifying Action Settings
Check the metrics you want to collect, and assign each one to a variable. Then,
downstream you can access these variables for analysis.
All of the actions in this branch that precede the target action are temporarily
highlighted in yellow so that you can identify them.
Designing and Managing Workflows 117
Specifying Action Settings
The action template is added to the template list, and can be selected by clicking on
the action.
118 Designing and Managing Workflows
Specifying Action Settings
In this example, some metrics about the input file are being examined by the Watch
action—file modification date, for example. The Decide action determines if the date is
prior to or later than a given date, and sets Success or Failure, based on the answer.
The top branch’s Flip action only executes on Success (processing those files whose
modification date is prior to the test date), and the lower branch’s Flip action only
executes on Failure (processing those files whose modification date is later than the
test date).
120 Designing and Managing Workflows
Managing Vantage Folders
2. Select Vantage Store/Folder and then click the Browse button. Vantage displays the
Vantage Folder Address Book, shown here:
3. Click the Add Folder toolbar button (the new folder button at far left).
6. Select the file system where the Vantage files will be stored, then click Next.
122 Designing and Managing Workflows
Managing Vantage Folders
7. Configure each field or control in each panel to set up the folder address—panels
and controls vary by file system, of course.
8. To specify a Windows directory with a UNC path (recommended), do the following:
a. Click Browse to display the Browse for Folder dialog box.
b. Open Network, open the computer name, and then select the root directory for
the folder.
c. Click OK.
You can also type a UNC path in the Location text box. For example, \\Computer-
Name\Sharename.
9. To specify a Windows directory with a drive letter path, do the following:
a. Click Browse to display the Browse for Folder dialog box.
b. Select a local folder.
c. Click Select Folder.
You can also type a drive letter path in the Location text box. For example,
C:\folder\folder.
For a detailed discussion, see Paths for Vantage Storage Overview.
10. Click Finish to close the Folder Location Editor dialog. (You may have to click OK on
the local folder warning dialog.)
11. Click OK to add this new Vantage folder address to the domain and close the Add
New Folder dialog.
12. Description—Enter the description, purpose, or use of this folder address.
13. Collision Resolution (not supported on all file systems)—Specifies the action
Vantage takes when it saves a file with the same name of a file that already exists.
– Create Unique Name—Workflow Designer adds a suffix to the filename, making it
unique, then saves the file in the location.
– OverWrite—Workflow Designer deletes the current file and saves the new file in
the location.
– Set Failure State —Workflow Designer does not save the file; it sets the action
state to Failure so that downstream actions may detect the error and perform a
specified task under this condition.
14. To test your connection speed to this location and optimize the block size for file
transfer, click the Advanced button.
15. Click the Disk icon in the toolbar to save changes to this new Vantage folder
address.
16. Click Select to close the dialog and use the currently-selected folder address, then
press OK to save changes. Click Close to simply close the Vantage Folder Address
Book dialog with changes.
Designing and Managing Workflows 123
Using Open Workflows
Licensing Requirements
A license is required to utilize open workflows. Licenses may be enabled for an entire
domain, or for individual nodes within a Vantage array so that jobs requiring open
workflow processing can be submitted to these specific nodes.
Open Workflow
• Optional open capability • Actions may run concurrently
• Throughput is dynamic • Run time is greatly reduced
124 Designing and Managing Workflows
Using Open Workflows
In the figure above, the upper workflow is executing serially. While the Flip action is
executing, the second Copy action waits for it to finish. In the lower workflow, the open
Copy and Flip actions run concurrently. Once the media blocks have been written to
disk in the first Copy, the Flip action is able to read these media blocks and begin the
transcoding process. When the Flip action finishes processing and writes the resultant
transcoded media blocks to disk, the final Copy action moves them to the appropriate
destination.
In this example, the first Copy action takes 10 minutes. However, since the Flip action
and the final Copy action can begin processing the incoming file almost immediately,
the overall job will be completed in approximately 12 minutes. The figure below
illustrates the concurrent nature of this execution:
Open Actions
Many actions can execute in Open mode—but not all. Additionally, in some instances,
the inbound processing to the action may be open but the outbound is closed, and
vice versa. The following table summarizes the actions supported by open workflows.
Open Open
Service Actions Inbound Outbound Notes
Monitor Watch N/A Yes On Windows, the file being submitted
can be an open, growing file (one that
is being written). On other file
systems, the file must be complete
and closed before it can be submitted.
Transport Copy Yes Yes Input and output may be TIFO,
Transport Stream or Program Stream
files; only valid when using the
Windows File System.
Transcode Flip, Flip64 Yes Yes Input only for supported file formats
(below)
Note: In order to localize a file from a file system other than Windows in open mode, the file must
already be complete. For example, in the following workflow: Watch (FTP) > Copy (local Vantage
store) > Flip, the Copy and Flip actions will run in open mode when the source file on the FTP server
is a complete, closed TIFO file, since the Flip action only supports TIFO open inbound.
Multiscreen Multiscreen Flip Yes No Input only for supported file formats
(below).
IPTV IPTV Flip Yes Yes Input only for supported file formats
(below).
Edit Tempo, Conform No Yes Input only for supported file formats
(below).
Live Capture No Yes Outbound only.
Metadata Populate, Transform Yes No Instantaneous, no media dependency;
XML files are closed.
Common Compute, Yes Yes Instantaneous, no media dependency,
Construct, Decide, actions will not run until input
Delay variables are all available.
126 Designing and Managing Workflows
Using Open Workflows
Note: In order for a transcoding action to ingest media an input in open manner, the
decoder must be configured for a format that supports open workflows.
The following file formats are supported for both reading and writing in all open
transcoding actions listed in the preceding table:
• All actions that are Open Workflow-capable support open TIFO for inbound, out-
bound, or both depending on the action
• Open Transport Stream is only supported for IPTV Flip and Flip actions outbound
• Open Program Stream is only supported for Flip actions outbound
• Flip actions only support PCM audio for inbound
Choosing an appropriate file wrapper greatly enhances the speed of execution for an
open workflow. The Telestream Intermediary Format (TIFO) offers a good choice for file
wrapping as it supports open workflows and all codecs. When you are capturing live
content from a Telestream Pipeline HD Dual or the Lightspeed Live Capture server, the
media can be a TIFO wrapped file that can immediately be consumed by an open
workflow for extremely fast live content deployment.
If you need additional speed, adding a Telestream Lightspeed Server will further
increase processing speed and reduce the time to produce media assets.
Open workflows are ideal for scenarios where media residing on external systems (S3,
FTP and Aspera servers) is to be localized, processed, and delivered to external storage
locations. Files processed on S3, FTP or Aspera systems are limited to complete, closed
files in TIFO format.
Open workflows are also ideally suited for Vantage workflows in which one action is
creating a mezzanine file for the purpose of a second action creating a specific
rendition. For example, Post Producer might create a high resolution mezzanine file
followed by the Cable IPTV Flip to produce a vendor specific Transport Stream.
Designing and Managing Workflows 127
Using Open Workflows
Note: The Error state is only displayed when a service become aware of a critical error.
It is possible that a condition introduced during execution (full disk, network
interruption, etc.) may cause the service to encounter an error that is not reported to
Vantage until completion. However, if a critical error is propagated to the session log
during execution, the Error state is triggered to alert you.
2. Open the Workflow Designer and create a new workflow, such as this one.
128 Designing and Managing Workflows
Using Open Workflows
3. Select the workflow drop-down menu, and check Options: Open mode.
4. Right-click each action in your workflow, select Workflow Mode, and check Open.
This completes Open mode configuration. You can submit jobs and use the workflow
as you normally would. Notice that the Job Status shows some of the open actions
operating simultaneously.
Designing and Managing Workflows 129
Processing Cloud-based Media in Workflows
Note: Information about using Vantage Cloud is described in the Vantage Cloud User‘s
Guide, including an overview, configuring, and using Vantage Cloud to process cloud-
based media. For information about Vantage Cloud features and utilization, please
refer to the Vantage Cloud User’s Guide, available on the Telestream web site.
■ Licensing Requirements
■ Vantage Cloud Mode Transcoding Actions and Functionality
■ Enabling and Configuring Vantage Cloud Mode and File Lifespan
■ Specifying Output File Lifespan (Hosted Workflows Only)
■ Correcting Unsupported Action Configurations
Licensing Requirements
Using Vantage Cloud in your Vantage domain requires the following:
■ A license for Vantage Transcode (V-XCODE-SW) or higher.
■ A Telestream Cloud account (https://cloud.telestream.net). Cloud-capable actions
operating in the cloud include licensing in the per-minute execution price of Van-
tage Cloud.
■ A storage account with AWS, Azure, or Google.
130 Designing and Managing Workflows
Processing Cloud-based Media in Workflows
Cloud-capable actions display a Telestream Cloud badge when Vantage Cloud mode is
enabled:
To enable Vantage Cloud mode and configure the settings, right-click on the action and
select Vantage Cloud Mode > Configure Vantage Cloud Mode to display the Vantage
Cloud Setup dialog.
Note: The folder you create in the Vantage Folder Address Book must use exactly the
same name as the storage you identify in the Telestream Cloud account. This is
required to provide translation of the signed URL specifying the cloud-stored media’s
location to a URL usable by the subsequent action.
If matching entries are not included in the Vantage Folder Address Book, the URL
translation does not occur, and downstream actions may fail. See Managing Vantage
Folders for configuration details.
Reconfigure the action in a way (or using another plugin) to enable it to run in the
Cloud or process the media locally.
Designing and Managing Workflows 133
Troubleshooting Workflow Designer
Note: For customer service, see Contacting Telestream. You may use the Data
Collection Utility (Vantage Management Console > Support Utilities > Data Collection).
You may also use the Change Log or Error Log utilities to provide information during
your service call.
134 Designing and Managing Workflows
Troubleshooting Workflow Designer
135
Vantage Actions
This chapter describes each of the Vantage services (action groups) and their actions,
by the type of tasks being performed. Workflow Designer groups actions according to
the service that executes them (except for actions in the Common group which can be
executed by all Vantage services).
Some actions are optional and require a specific license.
Note: For detailed help describing specific settings for each action, open the action
Inspector and click the icon to display its manual page.
Topics
■ Tasks—What can you do in a Workflow?
■ Services and Actions
136 Vantage Actions
Tasks—What can you do in a Workflow?
Avid Platforms
• Asset Monitor action (Avid group option)—Monitors the specified Avid folder for
new or modified assets to ingest and generates a metadata and/or Telestream MP4
media file. The Asset Monitor action initiates a job each time a new media asset is
discovered and generates the required output.
Transcoding Media
Transcoding actions convert media between formats and manipulate media essences
(digital baseband video and audio). Various transcoding actions provide transcoding
for different applications, both on-premises and in Telestream Cloud:
• Conform action (Edit group option)—Renders multi-layer video compositions (as
defined in a Composition Markup Language (CML) file with transition and image
effects, graphic overlays, and conformed audio. The output is encoded in the speci-
fied CML media format.
• Flip action (Transcode group)—Mainline, industry standard transcoding of
decoded digital baseband media into another media encoding format. Includes
exporting configurations for use in SDK applications. Open Workflow capable.
• Flip64 action (Transcode group)—A 64-bit multi-core-optimized encoder that
transcodes media from SD to UltraHD and 4K in a broad range of file formats, from
QuickTime to MPEG-4 and TIFO, including encoding for x264, x265 (H.265 HEVC),
MXF, and more. Open Workflow capable except when executing in Vantage Cloud
mode.
• IPTV Flip action (IPTV group option)— Converts media files to formats for cable/
IPTV/VOD/set-top box applications. Open workflow capable.
• Multiscreen Flip action (Multiscreen group)— Generates Adaptive Bitrate packages
from media files. Optimizes and delivers multiple bit rates and/or multiple resolu-
tions that may be selectively displayed by the client of a streaming media server.
Open workflow capable.
• Tempo action (Edit group option)—Re-times file-based media and adjusts the run-
ning time of shows and segments while maintaining program quality. Newly-timed
media is encoded into the CML-specified output video format.
The mezzanine file contains the relevant episodic metadata information including
segment timing information. The mezzanine attachment can be utilized by Van-
tage Portal in Syndication mode (Syndication Workflow Portal) or consumed
directly by other Vantage components.
• Catch action (Traffic group option)—Monitors a target Traffic directory for media
associated metadata files and initiates a job when a new media file is discovered.
• Dublist action (Traffic group option)—Monitors the target Traffic directory on the
specified file system for new dublist files and initiates a dublist processing job each
time a new dublist file is discovered.
Captioning
The Cloud Speech action submits media from Vantage workflows via the Cloud Service
and the Telestream Cloud API to the Telestream Cloud for speech-to-text conversion. To
use the Cloud Speech action you must have a Telestream Cloud account and enter the
account credentials in the Vantage Management Console Settings to enable Vantage to
access the account. When the Cloud Speech action executes, the input file is uploaded
and processed according to the Cloud Timed Text Speech project chosen in the Cloud
Speech action, and the results are returned to the workflow for downstream use.
Analyzing Media
Use the actions in the Vantage Analysis Service to perform essence-level operations
(black detection, interlace, PSNR, Telecine, etc.), perform DPP validation, etc. and report
the results for QA and intelligent branching within a workflow to deal with media
essence non-conformity and other issues.
Manipulating Metadata
You can process metadata label to extracting, creating, and transforming them using
these actions:
• The Extract action identifies and extracts specific values from structured metadata
and populates variables for use in downstream actions. The Extract action enables
you to identify the location in the structured data where the value is located.The
workflow can ingest an XML or JSON file during job execution or by making web
service calls. The Extract action automatically generates XPATH or JSONPath refer-
ences from the structured metadata in these files to extract the data, and populates
a variable with the value. During execution, each extraction path is evaluated
against the input and the associated variables are populated for use in downstream
actions. This action is open workflow capable.
• The Populate action enables you to bring media and other files into workflows, cre-
ate metadata labels and variables from file names and labels. You can also transfer
metadata from job-related system information to variables.
• The Transform action enables you to transform metadata using XSLT, and to trans-
form metadata between attachments and Vantage labels.For example, you can
Vantage Actions 139
Tasks—What can you do in a Workflow?
transform a given XML file (attachment) with the specified XSLT to generate
another XML attachment. Or, you can convert a Vantage label from one form to
another.
Note: You can only use style sheets that have been implemented in the Vantage
domain database—you can't select an XSL style sheet from a file system. You manage
your XSL style sheets using the Vantage Management Console (Vantage Domain >
Workflow Design Items > Style Sheets). Before the Transform action can execute, it
must be configured using the Inspector. This action is open workflow capable.
Note: For detailed help describing the functionality in detail, and each setting for the
action, open the action Inspector and click the icon to display its man page.
■ Alchemist Service
■ Analysis Service
■ Aspera Service
■ AudioTools Service
■ Aurora Service
■ Avid Service
■ Baton Service
■ Live Service
■ Catalog Service
■ Cerify Service
■ Cloud Service
■ Common Group
■ Communicate Service
■ Edit (Post Producer) Service
■ emotion Service
■ FileCatalyst Service
■ IPTV VOD Service
■ MediaMate Service
■ Metadata Service
■ Monitor Service
■ Multiscreen Service
■ Nexidia Service
■ Publish Service
■ Pulsar Service
■ Signiant Service
■ Staging Service
■ Timed Text Service
■ Traffic Service
■ Transcode Service
■ Transport Service
■ VidChecker Service
142 Vantage Actions
Services and Actions
Alchemist Service
The Alchemist service contains the Alchemist File Action.
Analysis Service
Use these actions (executed by the Analysis Service on behalf of the Telestream
Transcode & Analysis Engine) in workflows when you want to perform measurements
on media files, compare media files, or identify the characteristics of media files, and
publish the results as variables or metadata labels, or set the state of the workflow
based on the results.
You can publish analysis results in a metadata label within the binder, or you can
publish results as variables so that they can be used for decision-making, or to supply
values to settings in other actions. In some cases, you can also set the action state of the
action based on the results of the measurement.
■ Analyze Action
■ Compare Action
■ DPP Validate Action
■ Examine Action
■ Identify Action
■ MediaInfo Action
■ Report Action
Analyze Action
Use the Analyze action to perform analysis on media using a variety of analysis tools,
and variables for use downstream, with the result of the analysis. This action is Vantage
Cloud-capable.
Compare Action
Use the Compare action to examine two media files and determine their differences.
the action downstream to change the workflow’s actions based on the validation
results. Optionally, you can also generate a report.
Examine Action
Use the Examine action to analyze the video and audio of a media file, by selecting a
given analyzer (black detection, macro-blocking analysis, slate detection, etc.).
Identify Action
Use the Identify action to examine and identify certain media characteristics, or extract
the properties of a media or attachment file (for example, file name, extension, size, or
path) or to generate an MD5 hash of a media or attachment file, which you can use to
compare two files downstream, or in other workflows.
You can also extract metadata (such as Author or Title) from media files.
In addition, you can extract a comprehensive set of properties from media files (for
example, frame size, frame rate, codec, bitrate, number of audio channels, etc.).
Extracted values are assigned to variables (which you create in Vantage Management
Console or directly in Workflow Designer), for use later in a workflow. You can also set
the workflow state as a result of execution conditions.
MediaInfo Action
Use the MediaInfo action to perform 2 tasks, based on its analysis of the media file and
its streams: Create variables from properties via the MediaInfo API, and create a report
of the properties and their values.
In each category, you can produce variables of selected metrics with the results the
analysis.
Report Action
Use the Report action to generate a report file which contains a list of variables and
their values.
Aspera Service
The Aspera service contains the Aspera Faspex Delivery Action.
The Faspex Delivery action is used to deliver media or other files to Aspera Faspex drop
boxes and users.
AudioTools Service
The AudioTools service contains the AudioTools Action.
AudioTools Action
The AudioTools action is an optional, licensed feature in Vantage. It uses the AudioTools
Service to enable Vantage workflows to utilize and interact with various AudioTools
products from Minnetonka Audio Software. The AudioTools Custom Workflow executes
a selected, pre-defined AudioTools Server workflow. AudioTools Loudness Control
executes the typical loudness processes, including hitting multiple target parameters
using an iterative processing pass.
Aurora Service
The Aurora service contains the Aurora Action.
Aurora Action
The Aurora action is an optional, licensed feature in Vantage. It uses the Vantage Aurora
Service to utilize and interact with various QC tests provided by the Digimetrics Aurora
software. The tests provide the ability to determine whether a particular input media
(specified by nickname) either passes or fails a particular QC check. Each test also
generates a report file that may be utilized during later stages of the workflow.
Avid Service
Use these actions (executed by the Vantage Avid Service) in Vantage workflows to
process media interactively with Avid servers:
■ AAF Action— Ingest incoming AAF files and process the MXF folder referenced in
the AAF file.
■ Asset Monitor Action—Ingest into Vantage new media stored on an Avid server.
■ Media Creation Action—Check in media created in a Vantage workflow to an Avid
server.
Vantage Actions 145
Services and Actions
Before you can use these actions in a Vantage workflow with a given Avid server, you
must first create and configure an Avid connection in the Vantage Management
Console > Settings & Options >Avid panel.
AAF Action
The AAF action ingests incoming AAF files and processes the MXF folder referenced in
the AAF file. Avid Media Composer then utilizes Persistent Media Record (PMR) files for
information about the online status of file Media Object information (MOB). Each PMR
file provides an index in a form that an editor can quickly load all the file MOBs and their
associated media files in the media directory in which the PMR file resides.
Baton Service
The Baton service contains the Baton Action.
Baton Action
The Baton action is an optional, licensed feature in Vantage. It uses the Baton Service to
enable Vantage workflows to utilize and interact with various QC tests provided by the
Baton software. The tests provide the ability to determine whether a particular input
media (specified by nickname) either passes or fails a particular QC check. Each test also
generates a report file that may be utilized during later stages of the workflow.
Live Service
The Live service contains the Capture and Tape Actions and the SubClip action.
146 Vantage Actions
Services and Actions
SubClip Action
The SubClip action allows for sub clip editing of high resolution files based on edit
decisions made from within the Live Edit web app user interface. The SubClip action is
used with media created by a Capture action. The Live Edit web app UI utilizes an HLS
proxy created by the Capture Action and served to the Live Edit UI via an Origin server.
This action is open workflow capable if the Open Workflows license is installed; right-
click the action and select Workflow Mode > Open. Open Workflows must also be
enabled for the current workflow and in the Vantage Management Console Settings.
Catalog Service
Catalog actions enable you to query a Vantage catalog to determine if a binder exists,
and also to register a binder in a catalog. These actions executed by the Vantage
Catalog Service:
■ Remove Action
■ Exist Action
■ Register Action
Remove Action
A Remove action is executed by the Catalog Service, and is used to permanently
remove a binder from the catalog and set the associated file resources to expired. If the
action succeeds, it emits an action state of Success; otherwise, Failure.
This action is Open Workflow capable if the Open Workflows license is installed.
Vantage Actions 147
Services and Actions
Exist Action
Use the Exist action to determine if a binder of the same name already exists, thus
indicating that a job has already run on the same media file.
This action is Open Workflow capable if the Open Workflows license is installed.
Register Action
The Register action adds the workflow binder generated by each job to a specified
Vantage catalog. This allows Vantage to preserve the binder—and all files it
references—even after a job expires (which deletes the associated binder by default).
This is also how binders become accessible to operators in Workflow Portal. For details
about Workflow Portal, see Using Workflow Portal.
This action is Open Workflow capable if the Open Workflows license is installed.
Cerify Service
The Cerify service contains the Cerify Action.
Cerify Action
The Cerify action is an optional, licensed feature in Vantage. The Cerify action enables
Vantage to interact with the Tektronix Cerify suite of QC components.
Cloud Service
The following actions utilize the Cloud Service and the Telestream Cloud API to provide
interactive processing with the Telestream Cloud.
■ Cloud Speech action
■ Location action
■ Cloud Qualify action
Location action
The Location action, part of the Cloud group and executed by the Cloud Service,
generates Boolean variables indicating a media file’s storage location in the cloud or on
148 Vantage Actions
Services and Actions
premises. This information may be used to execute a given branch based on location.
The Location action can also generate pre-signed URLs for files in cloud or object
storage.
Common Group
Common actions are light-weight, short duration, utilitarian actions that are
implemented in multiple Vantage services (Catalog, Communicate, Staging, and
Metadata) so that any of those available services can execute them quickly and
efficiently.
■ Compute Action
■ Construct Action
■ Decide Action
■ Delay Action
■ Forward Action
■ Multi-Decide action
■ Receive Action
■ Synchronize Action
■ Utilization action
Compute Action
A Compute action is a Vantage Cloud-capable action. It uses variables to set other
variables. For example, you can use Compute to add two numbers and assign the result
to the selected variable. Compute can perform mathematical operations such as
addition, subtraction, division and multiplication. It can also convert variables between
types (such as converting a time code to a string), string manipulation, such as
appending strings together into an output variable, and comparison functions.
This action is Open Workflow capable if the Open Workflows license is installed.
Construct Action
A Construct action is a Vantage Cloud-capable action. It enables you to construct
complex strings, paths, and math expressions from literals, variables, and tokens, for
use in downstream actions.
This action is Open Workflow capable if the Open Workflows license is installed.
Vantage Actions 149
Services and Actions
Decide Action
A Decide action is a Vantage Cloud-capable action. It sets the action state based upon
variables. It is commonly used to determine whether or not a branch in a workflow
should execute (it sets the Success state) or not (it sets the Ignore state).
For example, if one branch is for HD, it will start with a Decide action that will set the
state to Success for HD content, ignore otherwise; if another branch is for everything
else, it will start with a Decide action that performs the opposite behavior.
Delay Action
The Delay action provides the ability to delay the workflow for a fixed number of
seconds before continuing. The Delay action operates in Open Workflow mode; for
example, if you set a 60 second delay, the action will turn green, delay 60 seconds, then
propagate the Open signal to the next action.
Forward Action
A Forward action starts a new job for the target workflow, delivering a binder and all
current variables from the originating. A Forward action can only be added to the end
of a workflow, and requires that the target workflow has a Receive action as its first
action.
The Forward action is the only terminating action in Vantage—it does not have a
connecting pin on the right side. Thus, once you add a Forward action to a workflow (or
branch in a workflow), you cannot add any more actions, because control has passed to
another workflow with a Receive action as its origin action.
Typically, workflows are created with a Receive action when they are intended for
execution by another workflow that immediately precedes this one. This ability to chain
workflows enables you to create run-time customizable workflows consisting of smaller
workflow building blocks.
Multi-Decide action
The Multi-Decide action is a Vantage Cloud-capable action. It simplifies a branching
Vantage workflow by allowing multiple phases of Boolean logic called Decision Groups
to be implemented within a single action. One Multi-Decide action can evaluate many
150 Vantage Actions
Services and Actions
different groups of variables and set a Result variable to represent the evaluation result
for each group.
A key feature is that the Decide Groups defined in the action can be chained together,
similar to Compute and Construct actions, so that the Result variable of one group
within the action can feed the input conditions of a subsequent group within the same
action. This provides powerful internal logical processing within a single Multi-Decide
action. The variable values resulting from a Multi-Decide action can trigger any of
several branches in a workflow.
As an example, a Multi-Decide action can implement internal logic as follows to trigger
downstream workflow branches: IF the Video Format is MXF AND the Video Framerate
is 60, THEN IF the Bitrate is 35 MB/sec, trigger branch 1; IF the Bitrate is 50 MB/sec,
trigger Branch 2; otherwise, Trigger Branch 3. IF the Video Format is NOT MXF or the
Framerate is NOT 60, Trigger Branch 4. The Multi-Decide greatly reduces the number of
Decide actions required per workflow because many expressions can be grouped into a
single action.
Receive Action
The Receive action is a Vantage Cloud-capable action. It is similar to a Watch action in
that it starts jobs. Unlike a Watch action, it allows you to ingest a file from an external
program and submit it for processing.
Methods you can use to submit jobs to a Receive-based workflow:
• Another workflow
• A Vantage SDK-based program
• Workflow Portal
Like a Watch action, you can also drag and drop a file on it to start a job.
The ability to chain workflows enables you to create run-time, customizable workflows
consisting of smaller workflow building blocks. When you chain workflows, you can
also pass binders and variables between them.
Note: An origin action is required as the first action in a workflow, even if you plan to
only manually submit jobs to this workflow.
Synchronize Action
The Synchronize action is a Vantage Cloud-capable action. It is used in workflows
where multiple actions connect to multiple subsequent actions. Synchronize provides
a common connection point, where all upstream actions need to be connected to all
downstream actions.
Utilization action
A Utilization action enables users to determine the relative load on the domain as well
as transcoding services within the domain. Other downstream actions can then make
Vantage Actions 151
Services and Actions
Communicate Service
Communicate actions are used to communicate with external systems. They are
executed by the Communicate Service.
■ Automate Action
■ Message Action
■ Notify Action
Automate Action
The Automate action, which is executed by the Communicate Service, is similar to the
Notify action. It contains system-integration extensions which are relevant to
TrafficManager workflows, enabling you to save job or other metadata to a file and
interface/integrate with external automation systems. This capability ranges from
writing XML-based material to a file system to direct integration with specific
automation systems.
In TrafficManager applications, this action is useful to notify automation systems that a
commercial has been processed and is available for air. For example, a Notify action can
create text or CSV dublists and provide them to automation systems that are capable of
processing dublists in that format.
Each extension has specific features which are detailed in the manual page for the
extension.
Message Action
A Message action enables you to generate and transmit an electronic message—an
email, for example. You must configure Vantage to use an SMTP server before email can
be utilized; this can be done in the Vantage Management Console.
This action is Open Workflow capable if the Open Workflows license is installed.
Notify Action
A Notify action transfers job information to external systems via Web Services or other
methods to transfer data. The job information may also be transferred via an XML file or
files of other formats. You can also use the Notify action to invoke a command shell.
This action is Open Workflow capable if the Open Workflows license is installed.
152 Vantage Actions
Services and Actions
The Notify action is extensible, and can communicate with a wide variety of systems
and generate various files as well as invoke services. These are the available functions:
– Automation File Notifier—Creates a notification file based on specific criteria.
– BXF File Notifier—Creates a BXF file based on specific criteria.
– Cloud Notifier—Post notifications from Vantage workflows to cloud aggregation
endpoints.
– Dolby DP600 Notifier—Submit work orders to a Dolby DP600 via web services.
– Dump—Dump an XML file describing the current job.
– External Shell Notifier—Invoke an External Command Shell.
– HTTP Notifier—Invoke a command on a remote server via HTTP.
– Interplay Notifier—Invoke an Avid Web Service method.
– Invoke—Invoke external programs/scripts via command line while generating
new Vantage nicknames, custom file schemas, and variable values.
– Avid MOBID Generator Notifier—Generate MOB ID Variables.
– NexGuard Notifier—Invokes a NexGuard web service method.
– SeaChange MVL Notifier—Invoke the SeaChange MVL Notifier.
– Text/CSV Report Notifier—Generates text file reports from workflow variables.
– WebService Notifier—Invoke a web service method.
The TrafficManager-centric extensions are implemented in the Automate action, but
are also available in the Notify action for backward-compatibility.
Chronicle Action
The Chronicle action converts a post-rendered Composition XML file into formats for
use in other systems—ad-insertion systems, for example.
Colocate Action
The Colocate action converts a Composition XML file with non-file-based URLs (for
example, Amazon S3) and localizes the media and produces a modified CML file with
the URLs converted to the localized file paths.
Vantage Actions 153
Services and Actions
This action is Open Workflow capable if the Open Workflows license is installed.
Compose Action
The Compose action converts various media descriptor file formats: Anystream AN2,
Final Cut Interchange XML, Simplified Avid AAF, QuickTime Reference, Adobe FC7XML,
and Telestream TSEDL) into a Composition XML file so that it can be used by the
Conform action to compose media. This action is Open Workflow capable if the Open
Workflows license is installed.
Conform Action
The Conform action assembles and optionally transcodes multiple video and still
image files into a single output file, applying filters as specified by you. The input files
and related instructions for the output file are all defined in a Composition XML file.
This action is Open Workflow capable if the Open Workflows license is installed. The
Conform action is also Vantage Cloud-capable.
Tempo Action
The Tempo action is part of the Edit group. All actions in the Edit group are executed by
the Edit service. The Tempo action is included in Tempo, a time-adjusting encoding
solution built on the Vantage platform. The Tempo action uses the Edit Service for re-
timing file-based content and intelligently decreasing or increasing the running time of
shows and segments. This action is Open Workflow capable if the Open Workflows
license is installed. The Tempo action is also Vantage Cloud-capable.
emotion Service
The emotion service contains the emotion Action.
emotion Action
The emotion action is an optional, licensed feature in Vantage. The emotion action
enables Vantage to utilize and interact with Emotion Systems Emotion Engine audio
software.
FileCatalyst Service
The FileCatalyst service contains the FileCatalyst Action.
FileCatalyst Action
The FileCatalyst action is an optional, licensed feature, which enables Vantage
workflows to access and deliver files to FileCatalyst servers via integrated FileCatalyst
client software.
154 Vantage Actions
Services and Actions
MediaMate Service
The MediaMate service contains the MediaMate Action.
MediaMate Action
The MediaMate action enables you to implement screen subtitling. This is an optional,
licensed feature. The MediaMate action is used to provide screen subtitling, by utilizing
various subtitling systems from Screen.
Metadata Service
Metadata Action
Metadata actions are an optional, licensed feature available in certain Vantage editions.
They are used to extract or modify metadata values, and perform conversions between
attachment files, metadata labels, and variables. These actions are executed by the
Metadata Service.
■ Extract Action
■ Lookup Action
■ Populate Action
■ Transform Action
Vantage Actions 155
Services and Actions
Extract Action
The Extract action is a Vantage Cloud-capable action. It is used to extract specific values
from element attributes in XML or key-value pairs in JSON-formatted metadata files.
The Extract action identifies and extracts specific values from structured metadata and
populates variables for use in downstream actions. The Extract action enables you to
browse a sample file and identify the location in the structured data where the value is
located.
The workflow can ingest an XML or JSON file during job execution or by making web
service calls. The Extract action automatically generates XPATH or JSONPath references
from the structured metadata in these files to extract the data, and populates a variable
with the value. During execution, each extraction path is evaluated against the input
and the associated variables are populated for use in downstream actions.
This action is Open Workflow capable if the Open Workflows license is installed.
Lookup Action
The Lookup action performs a search operation on a set of key-value pairs in a master
CSV file, based on values extracted from the metadata file associated with a job
submission. Lookup is typically used in TrafficManager applications.
Populate Action
Populate actions transform data between variables, attachment files, and metadata
labels. During ingest, metadata labels can be added to ingested media and generally
include trim information, audio levels, file properties, and commercial metadata. The
metadata labels can then be reviewed and modified by operators using Workflow
Portal. At any stage of a workflow, Vantage can extract information from labels using
the Populate action, allowing Vantage to, for example, trim clips during a transcode or
use audio level limits to dampen audio when creating a broadcast asset.
This action is Open Workflow capable if the Open Workflows license is installed.
Transform Action
A Transform action transforms data between XML files (ingested into the job as
attachment files) and labels. XSL style sheets are used to perform these
transformations.
This action is Open Workflow capable if the Open Workflows license is installed.
Note: The Transform action is available in Metadata and Transcode Connect licenses.
You can only use style sheets that have been imported into the database; you cannot
reference XSL files directly. The Vantage administrator manages your XSL style sheets
using the Vantage Management Console (Vantage Domain > Workflow Design Items
> Style Sheets).
156 Vantage Actions
Services and Actions
Monitor Service
Monitor actions are used to identify and ingest files to be processed by a workflow, and
in the case of the Watch action, start jobs for this workflow. They are executed by the
Monitor Service.
■ Associate Action
■ Camera Ingest Action
■ Listen Action
■ Watch Action
■ Workorder Action
Associate Action
An Associate action uses the Monitor Service to poll a target location (a directory, for
example) on a device or file system (FTP, network folder, etc.) to discover new files in the
context of a job.
Often, an Associate action follows a Watch action, and utilizes the file name of an
existing media file or attachment as the basis for discovering new files; for example, if
media file Vantage.mpg is currently in the workflow, then the Associate action may look
for Vantage.scc. The Watch action can publish the file name as a variable, and pass it to
the Associate action to pick the corresponding file (the file extension must be dropped
to accomplish this). The required file match pattern can be configured in the Associate
action's Inspector.
When Associate actions are executing, subsequent actions must wait until a file is
found or a time-out occurs. When a new file is discovered, the Associate action ingests
the file, assigns a nickname, and makes the file available to other actions in the
workflow.
Note: An origin action is required as the first action in a workflow, even if you plan to
manually submit jobs to this workflow—Associate is not an origin action.
Note: Each Camera Ingest action is configured to detect a specific camera file format.
If the target contains both P2 AVC-Intra and XDCAM EX files, two Camera Ingest
actions are required.
When a new file or shot is discovered, the Camera Ingest action submits a job for the
workflow which it is part of, for processing.
Vantage Actions 157
Services and Actions
The Camera Ingest action has features including stitching individual shots (including
self-contained, split, and spanned clips), and controlling whether camera content is
broken into individual sections, or treated as a single unit.
You can check a box in the Inspector to turn on logging for such errors as watching a
non-existent directory or failure to submit a file.
Listen Action
The Listen action uses the Vantage Monitor Service to listen to a cloud-based message
queue and generate jobs from received messages. The Listen action uses a plugin
model for various cloud endpoints such as Amazon Simple Queue Service (SQS).
The content of these messages could be very simple and contain a single value such as
a file path or some sort of identifier to be used, or they could be more complex such as
a blob of json/xml to be processed by a downstream action such as Extract.
The Listen action automatically deletes messages from the queue as it processes them.
Any messages that are present in the queue when the Listen action starts up will be
processed.
Watch Action
A Watch action is an origin action, which uses the Monitor Service to continually (and at
regular periods) poll a target location (a directory, for example) on a device or file
system (FTP, network folder, etc.) to discover new files.
The Watch action submits a job to the workflow which it is part of, when:
• A new file is discovered in the target folder
• You manually submit a file to the workflow
• You drag and drop a file on the Watch action in the workflow
Note: An origin action is required as the first action in a workflow, even if you plan to
manually submit jobs to this workflow.
This action is Open Workflow capable if the Open Workflows license is installed.
You can check a box in the Inspector to turn on logging for such errors as watching a
non-existent directory or failure to submit a file.
Workorder Action
A Workorder action is an origin action; it uses the Monitor Service to regularly poll a
target Windows directory for new workorder files to process. The Workorder action
provides a simple and highly effective method of submitting multiple, similar jobs
without using the SDK.
When a new file is discovered, the Workorder action submits one job for each row in the
file.
158 Vantage Actions
Services and Actions
You can check a box in the Inspector to turn on logging for such errors as watching a
non-existent directory or failure to submit a file.
Multiscreen Service
Multiscreen actions, executed by the Multiscreen Service, are used to produce high-
quality, industry-standard, adaptive rate streaming formats, including digital rights
management.
■ DRM Action
■ Multiscreen Flip Action
DRM Action
The DRM action is part of the Multiscreen group, and is executed by the Multiscreen
Service. You use the DRM action to execute a script that utilizes input data and
generates a JSON string. The string contains the information required to encrypt
streaming media with DRM (digital rights management) in Multiscreen workflows.
Scripts are created externally in a supported language and added to a Vantage domain
via the Vantage Management Console > Workflow Design Items > Scripts. The specified
script is executed in the DRM action, generating the output into a text variable for use
in a downstream Multiscreen action. Multiscreen Flip uses the output of the script
when encoding the media.
Nexidia Service
The Nexidia group contains the Nexidia Action.
Nexidia Action
The Nexidia action is an optional, licensed feature in Vantage. It uses the Vantage
Nexidia Service to interact with Nexidia QC servers running Nexidia QC software. The
specified input files are passed to the Nexidia QC software where they are analyzed
using the test profile selected.
Vantage Actions 159
Services and Actions
Publish Service
The Publish group contains the Stanza Action and Frame.io Action.
Stanza Action
The Stanza action allows Vantage to create new projects within an installed server
instance of Stanza. For more information on Stanza server installations and
configurations, see the Stanza page on the Telestream website for details.
Frame.io Action
The Frame.io action is an optional, licensed feature which allows for the creation and
delivery of assets, between Vantage and the Frame.io online hub for organization and
collaboration around media assets.
Pulsar Service
The Pulsar group contains the Pulsar Action.
Pulsar Action
The Pulsar action is an optional, licensed feature which enables broadcasters to
integrate the Pulsar suite of content verification components directly in Vantage
workflows.
Signiant Service
The Signiant group contains the Media Shuttle Action and Signiant Delivery Action.
Staging Service
The optional, licensed Staging Service actions are responsible for file operations in
preparation for moving files to other systems/platforms with special packaging
requirements. They are executed by the Staging Service:
160 Vantage Actions
Services and Actions
■ Archive Action
■ Gather Action
Archive Action
Use the Archive action to convert the selected input file to another format, usually in
preparation for copying, moving, or deploying a file to a given system that has special
file format requirements. The Gather action is only enabled with the optional, licensed
Metadata option.
Gather Action
Use the Gather action to collect one or more files from a specified server and directory
(and optionally, its sub-folders), and bring them into the workflow as attachments. Use
of a file matching pattern allows you to select only certain types of files. The Gather
action is only enabled with the optional, licensed Metadata option.
Traffic Service
The following actions are executed by the Traffic Service and are a component of
TrafficManager, an optional, licensed feature. Catch and Dublist actions monitor catch
servers and dublist servers for new files. These actions are both origin actions. The
Syndicate action processes metadata files for syndicated media processing.
■ Catch Action
■ Dublist Action
■ Syndicate Action
■ Syndication Forward Action
Vantage Actions 161
Services and Actions
Catch Action
Use the Catch action (an origin action) to select a catch server, and configure the action
to monitor it for new commercials and syndicated content arriving from the publisher,
expose all relevant metadata, and submit the commercial for processing in
TrafficManager workflows. The Catch action is part of TrafficManager; an optional,
licensed feature of Vantage.
The Catch action submits a job to the workflow which it is part of, when:
• A new file is discovered in the target folder.
• You manually submit a file to the workflow.
Note: An origin action is required as the first action in a workflow, even if you plan to
manually submit jobs to this workflow.
You can check a box in the Inspector to turn on logging for such errors as watching a
non-existent directory or failure to submit a file.
Dublist Action
Use the Dublist action (an origin action) to perform dublist processing in
TrafficManager workflows. The Dublist action is part of TrafficManager, an optional,
licensed feature of Vantage.
In the Dublist action’s inspector, you can select a dublist system or server as the target,
and configure the action to monitor it for new dublists, which it resolves with the
standing dublist.
The Dublist action submits a job to the workflow which it is part of, when:
• A new file is discovered in the target folder
• You manually submit a file to the workflow
Note: An origin action is required as the first action in a workflow, even if you plan to
manually submit jobs to this workflow.
The Dublist action uses the binder name as the unique identifier for the commercial, so
it should be set to the Ad ID.
You can check a box in the Inspector to turn on logging for such errors as watching a
non-existent directory or failure to submit a file.
Syndicate Action
Use the Syndicate action in syndicated media ingest workflows to convert sidecar
metadata XML files to a mezzanine format for use in downstream actions in the
workflow, or for use in Syndicated Workflow Portal applications. The Syndicate action is
part of TrafficManager, an optional, licensed feature of Vantage.
162 Vantage Actions
Services and Actions
In the Syndicate action Inspector, you can specify the type of metadata file being
transformed, and configure the action to utilize specific templates for processing.
Transcode Service
The following actions are in the Transcode action group and are executed by the
Transcode Service:
■ Flip Action
■ Flip64 Action
Flip Action
The Flip action is a broadly-used, general-purpose transcoding action, executed by the
Transcode Service (which in turn utilizes the Telestream Transcode & Analysis Engine for
this particular action). Use the Flip action to create media of a new format, and save it as
a file, using a prescribed codec profile. How you configure the encoder depends on the
encoder you choose.
This action is Open Workflow capable if the Open Workflows license is installed.
Flip64 Action
The Flip64 action is a 64-bit multi-core-optimized encoder that transcodes media from
one or more input files into another format as specified by the output configuration.
Available resolutions extend from SD to UltraHD and 4K in a broad range of file formats,
from QuickTime to MPEG-4 and TIFO, and including encoding for x264, x265 (H.265
HEVC), MXF, and many more. This action is Open Workflow capable if the Open
Workflows license is installed. The Flip64 action is Vantage Cloud-capable.
Transport Service
Transport actions are executed by the Transport Service and perform file operations on
specified files.
■ Copy Action
■ Move Action
■ Delete Action
■ Deploy Action
Vantage Actions 163
Services and Actions
Copy Action
Use the Copy action to duplicate a file from one directory to another directory on a
given file system. The new file can be tracked by the workflow—that is, referenced in
the binder. As a result, the new file must be given a nickname.
This action is Open Workflow capable if the Open Workflows license is installed.
Move Action
Use the Move action to remove a file from one directory and place it in another. You can
optionally specify a different destination nickname during the move.
Delete Action
Use the Delete action to delete a file on the specified file system. This action also
removes the file reference from the binder.
Deploy Action
The Deploy action copies one or more files to a destination in a single step, and may
perform additional custom steps depending upon the type of deployment.
Deployed files are not referenced in the binder, and are not tracked after the action
completes.
VidChecker Service
The VidChecker group contains the VidChecker Action.
VidChecker Action
The VidChecker action is an optional, licensed feature which enables broadcasters to
integrate VidChecker, automated QC and intelligent automated correction, directly in
Vantage workflows.
164 Vantage Actions
Services and Actions
165
The topics in this chapter describe how to submit jobs, monitor workflows, and manage
jobs in Workflow Designer.
Topics
■ Submitting Jobs to Workflows
■ Monitoring Workflow Status & History
■ Monitoring and Managing Jobs
■ Generating Job Reports Manually
■ Managing Job Report Configurations
■ Viewing the Domain Summary
■ Viewing Binders and their Assets
■ Controlling Action Execution in Jobs
■ Viewing Action Status
Note: In addition to submitting jobs in Workflow Designer, you can also submit jobs
by dropping media files into target directories, or by using the Dublist Portal and the
Workflow Portal clients. You can also submit jobs from other programs using the
Vantage SDK.
Note: You can also monitor and manage jobs using the Job Status Views web
application. See Using the Job Status Views Web Application.
166 Monitoring Workflows and Managing Jobs
Submitting Jobs to Workflows
Note: The file(s) you submit aren’t always media files; though they commonly are. You
can manually submit any file that the workflow can process. It might be an XML file
(metadata, for example). Or, it might be a workorder file for a Workorder action
workflow, for submitting several jobs at once. It also may be some other form of file,
based on your workflow.
3. Select one or more files and drag them over the origin action in the workflow.
4. When the origin action highlights (displays a bright green border), drop them onto
the action to submit them for processing.
168 Monitoring Workflows and Managing Jobs
Submitting Jobs to Workflows
Vantage displays a confirmation dialog when all jobs have been submitted:
Click OK to dismiss the dialog; then display the Job Status workspace to track your jobs.
In a multiple origin action workflow, Workflow Designer displays a dialog that lists
the origin actions.
Monitoring Workflows and Managing Jobs 169
Submitting Jobs to Workflows
3. Select the action you want to start the job, then click Next to continue.
For a multi-file workflow (for example, a Receive-based workflow that expects more
than one file), Workflow Designer displays this Submit Job dialog:
Enter or browse and select the file for each nickname and proceed to Step 6.
For a single-file workflow, Workflow Designer displays the Submit Job dialog:
170 Monitoring Workflows and Managing Jobs
Submitting Jobs to Workflows
4. Select the type of file system (or a Vantage folder) where the input file or files are
stored, and click Next.
Workflow Designer displays the Windows Explorer window:
5. Navigate to the server and directory, and select one or more directories and/or files
for processing and click Open. Click Browse to add more files or click Clear to start
over. As you select files, they are added to the list:
Monitoring Workflows and Managing Jobs 171
Submitting Jobs to Workflows
6. When the list is correct and you’re ready to submit them, click Next.
7. Optionally, click Variables to manually add variables with values for this job. The
variables must be identified in actions. These variables are initialized to the default
value of the variable definition in the domain, and the value may be changed by
actions in the workflow. For details, see Utilizing Variables in an Action.
8. Click Submit to submit the file(s) for processing.
Vantage displays a confirmation dialog when all jobs have been submitted:
When you have submitted the job(s), you can view their progress in the Job Status
workspace (see Monitoring and Managing Jobs).
172 Monitoring Workflows and Managing Jobs
Submitting Jobs to Workflows
Each row is an active origin action, indicating status and other details.
Static information in the activation record includes the origin action, state and status,
source location, and several date/time stamps, including when the action will expire.
The state is real time information, indicating the state of the action: In Process
(currently executing), Completed, etc.
Click any column to make it primary, sorting it in ascending/descending order.
174 Monitoring Workflows and Managing Jobs
Monitoring Workflow Status & History
In the status column, you can determine the number of shots being processed—as well
as incomplete shots where the action is waiting for files before submitting the job. The
Source column identifies the location—for example, drive letters on a card reader.
Monitoring Workflows and Managing Jobs 177
Monitoring Workflow Status & History
For jobs in the post-execution Success, Ignore, and Failure states, the Status History
dialog displays the following buttons:
• Export—Click Export to display a File System dialog, and save the status/history
information as an XML file. You can send these files to Telestream for support issues,
or export them for processing in other systems.
• Session Log—To display a session log, select a session in the upper panel and click
Session Log.
Select
Click
The session log displays session activity entries for the action, including which
ComponentPac version was used and which variables have been provided to each
action. This information can be helpful when debugging the use of variable, or when
working on an issue with Telestream Customer Service.
Export Variables—Click to browse and export an XML file listing variables passed
through the action.
Monitoring Workflows and Managing Jobs 179
Monitoring and Managing Jobs
Note: The Domain Job Status panel displays only current jobs (Active | Failed |
Stopped | Waiting by default. To display completed jobs as well, check Include
Completed Jobs in Domain Job Status in the Vantage Management Console > Settings
& Options > General.
These workspaces are useful when you’re performing operator-related tasks or when
you’re managing or performing domain-wide production media processing. The only
difference between the two tabs is one of scope.
The Job Status workspace allows you to select a workflow in your user account and
display all of this workflow’s jobs. The Domain Job Status workspace displays all the
jobs currently executing in the domain, plus all completed jobs, if the Include
Completed Jobs in Domain Job Status is enabled (Vantage Management Console >
Settings & Options).
Job Status toolbar
Real-time view of transaction processing.
When an action is executing, it is displayed with a green border, and a progress bar
displays at the bottom of the action, indicating execution progress. This indicator
provides a relatively accurate prediction of how far along the total execution has
progressed.
The following topics provide additional information for using the job status
workspaces:
■ Viewing Workflows and Actions in Detailed Action View
■ Using the Jobs Table
■ Using the Job Status Table’s Toolbar and Context Menu
■ Stopping All Jobs in the Domain
Monitoring Workflows and Managing Jobs 181
Monitoring and Managing Jobs
During job execution, each action in the selected workflow displays a color-coded
border to identify its current state in real time:
• Green—In Process. The action is currently executing.
• Blue—Completed with Success. The action is complete, and performed the task
successfully. For actions whose state can be manually set, displays the appropriate
state based on the configuration specified.
• Red—Completed with Failure. The action is complete, and did not perform the task
successfully or an upstream action failed, and represents the failed state of the
workflow itself. For actions whose state can be manually set, displays the appropri-
182 Monitoring Workflows and Managing Jobs
Monitoring and Managing Jobs
ate state based on the configuration specified. This action has failed or an upstream
action failed, causing this action to not execute, and replicate the failed state.
• Black—Ignored | Waiting on License. This action completed without executing
because the incoming state did not equal the Perform On condition, thus prevent-
ing it from executing or it executed in some exception-processing way (action-
dependent) because a required license was not present.
• White—Idle. The action is ready to execute pending the assignment of a service to
execute it.
• Yellow—Pending or Waiting for Intervention. The action is ready to execute pend-
ing the availability of the required resources or execution was interrupted for some
other reason where the service requires intervention from a user. (Note that a yel-
low action title does not reflect the state but indicates a “technology preview.”
These actions can be tested and used but are not yet officially released or recom-
mended for use in production applications.)
• Light Gray—Paused or Suspended during execution. The action has been paused
by a user or suspended by a higher-priority action.
• Magenta—Stopped by User. The action was stopped by user intervention.
• Light Orange—Open Workflow Error. A failure is expected when the upstream open
actions complete.
• Orange—Waiting to Retry. The action attempted unsuccessfully to execute to com-
pletion, and is currently waiting to re-execute.
• Purple—Waiting on a Service. No service of the required type is running that can
execute the action. For example, no Transcode Service is running to execute a Flip
action.
• Light Green—Waiting execution due to Run On Rule. The action is waiting due to a
run-on rule that must be satisfied before it can execute. For example, a Flip action is
configure to execute on a Lightspeed server, but no Lightspeed servers are online.
Note: Completing without errors does not mean that the action performed the
task—an action may be configured to execute only when a previous action succeeded
or when a previous action failed—thus, an action may complete without errors, and
perform no task at all.
Monitoring Workflows and Managing Jobs 183
Monitoring and Managing Jobs
Note: Because the Domain Job Status workspace displays all of the jobs in the
domain, the Jobs table also displays two additional columns of information not found
in the Job Status workspace: Workflow and Category. It also displays an Emergency
Stop button in the bottom right-corner. For details, see Stopping All Jobs in the
Domain.
State—This column displays color-coded key words to identify the status of the job:
• In Process—the job is active (being processed).
• Paused—the actions in this job have been paused.
• Complete—all of the actions in this job have completed successfully.
• Error—indicates that an open mode action recognizes a critical error (that would be
shown in the session log view), and will fail when the open block completes.
• Failed—one or more of the actions in this job have failed.
• Waiting—the job is active, but is currently waiting for a resource (a service) to
accept and process one of the actions in the workflow.
• Stopped by User—the job was stopped by a user.
• Waiting to Retry—the job is active, but is currently waiting for one of the actions in
the workflow to re-execute.
Progress—The information displayed in the Progress column depends on the Detailed
Job Progress setting in the Vantage Management Console.
If Detailed Job Progress is disabled, the Progress column displays the percentage of
actions that are complete at the moment. For example, if you have a 10 action workflow
and the 4th action is currently executing, Vantage will report the workflow as 30%
complete.
If Detailed Job Progress is enabled, the progress column displays a percentage value of
the current amount of time consumed compared to the total estimated time for the job
to complete. Using the job’s start time to determine how long the job has been
executing, you can use the progress percentage to extrapolate the approximate
completion time, assuming the load on the domain remains relatively constant.
184 Monitoring Workflows and Managing Jobs
Monitoring and Managing Jobs
Note: To change the Detailed Job Progress setting in the Vantage Management
Console, start the console and click on Settings & Options > General Tab to set the
Detailed Job Progress check box.
time to completion is dependent on the volume of affected jobs in the database and
the consequent load on the computers in the domain.
To stop all running and queued jobs in the domain using this button, follow these steps
1. Click the Domain Job Status workspace.
2. Click on the Emergency Stop button in the bottom right corner.
Workflow Designer displays a warning dialog.
WARNING: The Emergency Stop button stops all active jobs in the domain, and
can not be reversed. This will lead to a potential loss of work and/or data. You
should only utilize this command in an emergency. (For example, mistakenly
submitting thousands of jobs.) Ideally all services should be in maintenance
mode before executing this command.
Note: You can also configure a workflow to automatically generate a job report each
time the workflow executes. See Enabling Automatic Reports in the Domain
Management Console.
Each job report is based on a job report configuration you select (see Managing Job
Report Configurations).
Note: If there are no job report formats, Workflow Designer displays a dialog that
enables you to create one. Click OK to display the Job Report Manager (Managing Job
Report Configurations).
3. Select a report format from the drop-down list. (Report formats are created in the
Vantage Management Console Report Configurations > Job Reports window).
You can also click the browse button to display the Job Report Manager window
(see Managing Job Report Configurations for details).
4. Choose Selected Jobs or Archived job history. For Archived job history, specify from
and through dates
Selected Jobs reports on jobs highlighted in the job list and provides a full report
including all fields specified in the report format. Archived job history reports on
historical jobs within the window of dates you specify, including expired jobs; only
the standard fields defined in the Management Console > Job Reports format are
included; no custom columns are included.
188 Monitoring Workflows and Managing Jobs
Generating Job Reports Manually
5. Select where you want to save the CSV report file for the selected jobs, as shown in
the following figure.
Vantage displays the File System dialog, which you can use to select the server and
directory where you want the CSV report file for the selected job or jobs stored, as
shown in the following figure.
Optionally, enter a new name for the job report file (or append a date or other
significant qualifier) and click Save to process the report and save the file as a CSV file.
When the report file has been generated, Vantage displays a dialog to indicate where
the file was saved. Click OK to close the dialog.
Monitoring Workflows and Managing Jobs 189
Managing Job Report Configurations
Note: Completed jobs in the Domain Job Status tab are visible only if the Include
completed jobs in Domain Job Status selection in the Vantage Management Console
Settings & Options General panel is checked (enabled).
Before you can generate job reports, you must create at least one job report
configuration. You can create multiple configurations; one for each type of job report
you want to generate.
You use the Job Report Manager to create, edit, and delete job report configurations.
(The Job Report Manager is also available in the Vantage Management Console.)
Note: Reports are set up in Workflow Designer’s Workflow Details panel using the
Automatic Reports: Modify button, or in the Job Status or Domain Job Status panel by
right-clicking jobs and selecting Create Report. When checked, the Include completed
jobs in Domain Job Status selection in the Vantage Management Console Settings &
Options General panel enables visibility of completed jobs in the Domain Job Status
tab; when unchecked, only current jobs are shown.
Note: Vantage domain administrators can also create report formats with the
Vantage Management Console.
1. To create a new job report configuration, click a job in the Job Status or Domain Job
Status window, and click the Create a report button.
Note: Completed jobs in the Domain Job Status tab are visible only if the Include
completed jobs in Domain Job Status selection in the Vantage Management Console
Settings & Options General panel is checked (enabled).
192 Monitoring Workflows and Managing Jobs
Managing Job Report Configurations
3. To edit a job report configuration, select it from the list, or to create a new
configuration, click the Create a new report configuration button .Enter a name
in the Name field.
4. Optionally, enter a report description in the Description field.
Monitoring Workflows and Managing Jobs 193
Managing Job Report Configurations
2. In the Labels panel, select a label for which you want to display parameters.
194 Monitoring Workflows and Managing Jobs
Managing Job Report Configurations
3. In the Parameters panel, check the checkbox for any parameter you want to display,
and clear the checkbox for any parameter you do not want to display.
To toggle between showing and hiding categories in which the parameters reside,
click the Category button .
4. Click OK to save the selected label parameters and close the dialog.
5. To change the displayed order of parameter labels in the Job Report, select a label
in the list and use the green up and down arrow buttons to move the label
up or down in the list.
The top listed parameter becomes the first column after the “standard” columns in
the job report, and the last item becomes the last column on the right.
Consider thinking of this as a general purpose or quick report that you can quickly
examine instead of having to set up and generate a jobs report. The display is static and
offers no control over workflows, but you can use the Open Selected Workflow button
or right click context menu to jump to a specified workflow in the Workflow Designer.
Monitoring Workflows and Managing Jobs 197
Viewing Binders and their Assets
Viewing Media
The Media Files tab displays a list of media files ingested or created in the job, including
the file’s path, nickname, and filename. To the right is a WMV player, where you can
preview the selected file provided that it is playable by Windows Media Player
(typically, WMV, AVI, and ASF files, depending on your configuration).
You can also right-click any file and Choose these options:
• Open Containing Folder—displays the Windows directory where the file is stored.
• Open With Default Program—opens the file in the program specified as the default
program to open these types of files, based on its extension.
• View Files List—displays the list of files submitted as part of the job.
• View Full URL—displays the full URL of the file submitted. See Using View Full URL to
Submit a Remote File via API for additional information.
The ability to play media depends on the operating system where the file is located:
Cloud storage and other file systems (FTP, Aspera, Pathfire, BML)
• You can not Open Container Folder or Open With Default Program
• The Player window does not display or play media.
Viewing Metadata
Use the Metadata Labels tab to display the labels associated with the job, their
parameters and values. (You cannot edit values in this viewer.)
Viewing Metadata
The Attachments tab displays a list of attachment files, including each file’s path,
nickname, and filename.
3. Right-click the job in the Job Status table, and select View Binder.
4. Right-Click the Original file in the binder and select View Full URL. The resulting
dialog is as follows:
The text of the dialog is exactly the text that you need to cut and paste directly into
an API submission message to submit the same file to another workflow via the API.
Refer to the Vantage Rest API Guide (available on the Telestream support website)
for detailed information about submitting files to a Vantage workflow.
To submit other files in this location to other workflows, change the name of the
remote file in the URL (boxed in red) while leaving all else in the URL the same. The
file name portion of the URL is NTSC_TC_CC.mpg. That is the only portion of the URL
that you need to change to a new file name.
2. Change the priority value (larger numbers equal higher priority), and click OK to
modify the action’s priority in this job. (Zero and negative numbers are allowed; for
example, a 0 priority pauses a -1 priority, and a -1 pauses a -2.)
Each line in the upper panel of the Status/History dialog provides a summary of some
aspect of action execution. To display more information related to a line in the upper
panel, click on the line. The detailed information appears in the lower panel.
The symbol to the left of the summary lines in the upper panel allow you to hide or
expose subordinate summary lines. Click a symbol to hide or display subordinate
summary lines.
Export—Click Export to display a File System dialog, and save the status/history
information as an XML file. You can send these files to Telestream for support issues, or
export them for processing in other systems.
Session Log—To display a session log, select a session in the upper panel and click
Session Log.
Click Done to dismiss the Status/History window.
202 Monitoring Workflows and Managing Jobs
Viewing Action Status
203
Use this chapter to learn how to use Workflow Designer to analyze workflows and job
history to identify problems and improve overall system performance.
Topics
■ Workflow Analytics Overview
■ Using the Workflow Analytics Panel
■ Performing Bottleneck Analysis
■ Performing Execution Analysis
Note: Features in editions for which you do not have a license are disabled, and
indicate that you need a license to use them.
204 Using Workflow Analytics
Workflow Analytics Overview
Note: Because workflows may be modified over time, jobs run in the selected
workflow prior to the last change are ignored.
Workflow analytics automatically includes new jobs that are submitted, as appropriate,
displaying them in the Jobs table and recalculating metrics.
Using Workflow Analytics 205
Using the Workflow Analytics Panel
Actions display the average execution time, and stack rank time relatively by color—
green (fastest) through red (slowest).
To select a workflow to view, use the Workflows list to the left of the Workflow Analytics
tab. Open the appropriate workflow category and click on any workflow to select it. You
can then view all of the job history records for the selected workflow in the Workflow
Analytics tab.
After making your job selection (see below), click the Run Analysis button to begin near
real-time display of the analytics data. To stop calculating and updating the data (or to
change the jobs you want to analyze), click Stop Analysis.
The following topics provide additional information:
■ Using the Jobs Table Toolbar
■ Using the Jobs Table
206 Using Workflow Analytics
Using the Workflow Analytics Panel
Managing Hosted
Workflows
The HostedWorkflow Manager window enables you to manage your Vantage domain’s
Telestream Cloud hosted workflows directly in Workflow Designer. Hosted workflows
typically exist in two locations: your Vantage domain, and in your Telestream Cloud
account. These two copies are one in the same workflow, and they are associated with
each other by their GUID.
Note: Use of HostedWorkflow Manager features requires that you have a Telestream
Cloud account, and that you have added the API key for the account in the Vantage
Management Console. When you’ve provided these credentials, Workflow Designer
can be configured to operate in Cloud mode, with the same capabilities that it
provides when a Cloud Developer license is installed.
Topics
■ Requirements
■ HostedWorkflow Manager Overview
■ Selecting Your Telestream Cloud Account & Store
■ Setting the Default Cloud Workflow Revision
■ Downloading Workflows from Telestream Cloud
■ Uploading New Workflow Revisions
■ Uploading Vantage Workflows to Telestream Cloud
■ Troubleshooting
Note: If you’re not familiar with using Telestream Cloud, see the Telestream Cloud
User Guide on the telestream.net web site.
210 Managing Hosted Workflows
Requirements
Requirements
Before you use HostedWorkflow Manager, be sure that you meet these requirements:
• You have a Telestream Cloud account.
If you don’t have a Telestream Cloud account, go to https://cloud.telestream.net/
console/signup and create one. If you already have an account and want to log in,
go to https://cloud.telestream.net/console/login.
• In Telestream Cloud, create one or more stores where you want to save workflows.
• If your domain is configured with user administration, your user must have Vantage
Administrator privileges.
In the Vantage Management Console, go to Settings & Options > General to verify
user administration is enable or disabled. To view/modify user privileges with user
administration enabled, go to Settings & Options > Users.
• You have created an account record in the Vantage Management Console.
Go to Settings & Options and display the Cloud tab—create a record for the
account and test it.
Managing Hosted Workflows 211
HostedWorkflow Manager Overview
Note: For basic information on using Vantage client programs, see Vantage Client
Programs Overview.
Here is a depiction of the HostedWorkflow Manager main window and its major
components:
Telestream Cloud Cloud Workflows Vantage Workflows
account toolbar toolbar
Cloud
Workflows
panel
Vantage
Workflows
panel
Previous |
Next and
Close
buttons
This window is comprised of two panels: Cloud Workflows and Vantage Workflows.
212 Managing Hosted Workflows
HostedWorkflow Manager Overview
You use this panel to operate on your workflows from the Cloud workflow perspective.
Default Revision—The revision number of the workflow that is used when this
workflows executes a job.
Jobs in Last 30 Days—The number of jobs that have been executed by this workflow
int he last 30 days.
Vantage Name—The name of the associated workflow in your Vantage domain.
Note: Telestream recommends that you use the same name for workflows that are
hosted both in your domain and in your Telestream Cloud account.
You use this panel to operate on your workflows from the Vantage workflow
perspective.
2. In the HostedWorkflow Manager window, click the Previous button at the bottom
right corner. (The first time you display Hosted Workflows Manager, this panel
displays first):
Workflow Designer displays the Account and Store dialog:
3. Select the account and store to use, and click Next to return to the main window.
Note: The store list is populated from your Telestream Cloud account. Make sure that
your stores are valid, or that you are aware of which stores are valid. Your account may
have stores whose buckets are no longer viable and is beyond control of Vantage.
216 Managing Hosted Workflows
Setting the Default Cloud Workflow Revision
Note: Telestream Cloud does not change the default (executable) revision without
specific action. As a shortcut, when you upload a revision, you can set the new revision
to the default (see Uploading New Workflow Revisions)—check Make this the default
version in the Upload Revision dialog.
If you don’t change the default revision when you upload it, the revision remains the
same until you change it in the Revision Management dialog.
Select the revision to set as the default revision and click OK.
Managing Hosted Workflows 217
Downloading Workflows from Telestream Cloud
Workflow Designer uses the Cloud workflow’s name as the name to apply to the
copy you create in your Vantage domain unless the workflow was given a different
Cloud Workflow name when it was originally uploaded. In this situation, the down-
loaded copy of the workflow uses the original Vantage Workflow name, not the
Telestream Cloud name.
As an example, if you upload a workflow named My Workflow and give it the Cloud
workflow name My Workflow (cloud), and then you delete the Vantage workflow (or
connect to a different domain) when that workflow is downloaded, the local Van-
tage copy will be named My Workflow, not My Workflow (cloud).
5. Select the workflow category that you want Workflow Designer to store the
workflow(s) in.
Note: If the workflow (or any workflow, in a multiple workflow selection) already
exists, Workflow Designer disables the Download button. Download is only permitted
218 Managing Hosted Workflows
Downloading Workflows from Telestream Cloud
when there is no workflow in the local Vantage domain with the same ID GUID as the
selected Cloud Workflow.
6. Click OK to proceed.
Workflow Designer displays a progress bar during the operation. When the transfer
is complete, Workflow Designer updates the workflow record in the Cloud Work-
flows table: It displays a icon in the Exists Locally column, and displays the syn-
chronized icon to advise you that the two revisions are identical.
Managing Hosted Workflows 219
Uploading New Workflow Revisions
Note: If the workflow (or any workflow, in a multiple workflow selection) already
exists, Workflow Designer disables the Download button. Download is only permitted
when there is no workflow in the local Vantage domain with the same ID GUID as the
selected Cloud Workflow.
To upload the new revision that you’ve modified in Workflow Designer back to
Telestream Cloud from your domain, follow these steps:
1. Verify your Telestream Cloud account and store—click Previous; change the
account and default store as required, then click Next to return to the main window.
2. In the Cloud Workflows panel, select the unsynchronized workflow(s) and click the
Upload New Revision button
OR
Right-click and select Upload New Revision to copy the workflow(s) to your
Telestream Cloud account as new revisions.
Workflow Designer displays the Upload Revision dialog for each selected workflow:
3. Check Make this the default revision if you want to use this revision. If unchecked,
the currently-specified revision remains unchanged unless you change it manually
(see Setting the Default Cloud Workflow Revision).
4. Click OK to proceed.
5. Workflow Designer displays a progress dialog as it performs the operation, and
updates the record in the Cloud Workflows table.
220 Managing Hosted Workflows
Uploading Vantage Workflows to Telestream Cloud
Note: Telestream recommends that you use the same name for both copies of the
workflow to avoid confusion. Even if you name them differently in Vantage and
Telestream Cloud, they are in fact, the same workflow with the same GUID.
To upload Vantage workflows to your account in Telestream Cloud, follow these steps:
1. Verify your Telestream Cloud account and store—click Previous; change the
account and default store as required, then click Next to return to the main window.
2. In the Vantage Workflows panel, select the workflow(s) and click the Upload
Vantage Workflows button
OR
Right-click and select Upload Vantage Workflow(s)... to copy the workflow(s) that
you want to upload from your Vantage domain to your Telestream Cloud account
as a new workflow.
Note: Workflow Designer does not check for associated Cloud workflows. If the
selected workflow(s) is in the account and store you’re working with, it displays an
error, advising that this workflow is already associated with a Cloud workflow.
Workflow Designer displays the Upload Revision dialog for each selected workflow:
3. Enter the name for the Telestream Cloud copy or accept the default value: the same
name. Telestream recommends using the same name in both Vantage and Cloud
domains. These two copies are one in the same workflow, and they are associated
with each other by their GUID and changing names can lead to confusion.
4. Click OK to proceed.
5. Workflow Designer uploads the new workflows, and displays a progress dialog as it
performs the operation.
Troubleshooting
Use these topics to help solve problems you may encounter.
Solution. You don’t have a Cloud account registered in Vantage or the account you
entered is incorrect.
In the Management Console navigate to Settings & Options and display the Cloud Tab.
Create a new Cloud account record using your Telestream Cloud credentials or update
the account API key. Now, back in Workflow Designer, display the Hosted Workflows
Manager window again.
If you don’t have a Telestream Cloud account, go to https://cloud.telestream.net/
console/signup and create one.
Problem: Workflow Designer displays a Does Not Exist error when I attempt to
upload a workflow to a store:
Solution. You have selected a store whose bucket is no long valid. This list is populated
from your Telestream Cloud account. Make sure that your stores are valid, or that you
know which stores are valid. Your account may have stores whose bucket is not longer
viable and is beyond control of Vantage.
222 Managing Hosted Workflows
Troubleshooting
Solution. You have configured your workflow in a way that is not functional when
executed in Telestream Cloud—thus, its not considered a valid cloud-hosted workflow.
Read the error details, correct the configuration, and retry.
Using Workflow Portal Configurations 223
This chapter describes how to operate each of the basic Workflow Portal
configurations. Workflow Portal configurations are created in the Vantage
Management Console. The functionality options and user interface components are
specific to each type of configuration and are enabled in Workflow Portal when it is
launched.
A Vantage administrator can make as many of each type of configuration as necessary,
each one configured to support a specific media processing application.
Configurations are developed in conjunction with a workflow designer, so that the
configuration performs correctly with the associated ingest and publication workflows.
Once you’ve used a configuration, the Workflow Portal opens to it automatically.
Note: When you are using a given type of configuration—for example, a VOD
configuration—it is common to think of and refer to Workflow Portal simply as the
VOD Portal. When you read about a portal by any name (VOD, DPP, etc.), just
remember—this particular Portal is Workflow Portal using its respective configuration.
Topics
■ Using Browse Catalogs Copy Binder and Forward Binder Portals
■ Using Windows Network Portals
■ Using EDL Portals
■ Using CML Portals
■ DPP Portal Overview
■ VOD | DAI Portal Overview
■ Tempo Portal Overview
■ Syndication Portal Overview
Note: Some of these configurations are described in their own product guides. Please
refer to those guides for additional details.
224 Using Workflow Portal Configurations
Using Browse Catalogs Copy Binder and Forward Binder Portals
In a Browse Catalog Copy Binder Portal, the operator browses a catalog and selects a
binder to prepare before submitting the job to a publishing workflow. A Copy Binder
configuration automatically duplicates the original binder and submits the duplicated
binder (with changes made by the operator) to the publishing workflow, leaving the
original binder intact in the catalog for future use or re-submittal. (If you may ever need
to use the copied binder later—in case of an error, for example—you should also use a
Register action in the publication workflow to register the new binder in a catalog).
In order to have a binder to submit, the operator clicks the Submit button to trigger the
duplication of the original binder. Now, using the copied binder as a template, the
operator can edit metadata and variables as required, (in the copied binder) and submit
it to the publishing workflow.
In contrast, in a Browse Catalog Forward Binder Portal, the original binder is modified by
the operator during metadata and variable editing, and submitted to the publication
workflow—without making a copy. (If you don’t need the binder after processing, you
can automatically or manually delete it.) The operator can edit metadata and variables
(in the original binder) directly in the main window and then click Submit to submit it
to the publishing workflow.
Here are the differences between Copy Binder and Forward Binder configurations:
• Copy Binder—the operator clicks the Submit button before editing metadata and
variables—to create a copy of the original binder.
• Forward Binder—the operator selects a binder and edits its metadata and vari-
ables—then click Submit to process the job.
Using Workflow Portal Configurations 225
Using Browse Catalogs Copy Binder and Forward Binder Portals
Depending on how the configuration has been set up, there will be variations in the
features that are enabled, and the related tasks you can perform. In both
configurations, the operator can review, edit, and update label-based metadata and
variables for the selected media prior to submission to a publishing workflow.
Alternatively, media can be submitted via a workflow, manually, or any other means.
In Workflow Portal, the operator browses catalogs and selects a binder, clicks Submit to
generate the copied binder, and performs operator tasks as appropriate. This may
include scrubbing a proxy, reviewing and editing metadata, and setting variable values
for the job.
Next, the operator submits the job to a publishing workflow, which can be designed to
perform any task required. The binder being processed is a copy of the original binder.
The original binder and its contents remain untouched.
3. Preview media in the Media Player (Previewing Proxy Media in the Media Player).
4. Check the workflow(s) you want to process the media with. This varies based on
how the configuration is set up.
5. Click the Submit button to display the Submit Jobs window and prepare the copied
binder’s assets for processing.
6. In the Metadata Labels tab (if displayed), review/edit metadata (Editing Metadata
Labels).
7. In the Variables tab (if displayed), enter values for each variable (Specifying Variable
Values).
8. Click the Submit button to submit a job for processing the media and its assets in
the target workflow(s).
Alternatively, media can be submitted via a workflow, manually, or any other means.
In Workflow Portal, the operator browses catalogs and selects a binder, clicks Submit,
and performs tasks as appropriate. This includes reviewing and editing metadata, and
setting variable values for the job as appropriate.
Next, the operator submits the job to a publishing workflow, which can be designed to
perform any task required. The binder being processed is the original binder.
Using Workflow Portal Configurations 227
Using Browse Catalogs Copy Binder and Forward Binder Portals
The Browse Windows Network Portal (Windows Network Portal for short) allows you to
select one or more media files from servers on a Windows network and submit them to
target workflows, depending on how the configuration is set up.
Like Browse Catalog configurations, Browse Windows configurations are also broadly-
focused. If the configuration permits, you can also add metadata to labels and edit
variables to be submitted with the media. Unlike Browse Catalog configurations, assets
normally associated with binders—pre-processed metadata labels, proxy files, etc.—
aren’t present.
In Workflow Portal, the operator browses a Windows file system and selects media, and
performs tasks as appropriate. This includes reviewing and editing metadata, and
setting variable values for the job as appropriate.
Next, the operator submits the job to a publishing workflow, which can be designed to
perform any task required.
Using Workflow Portal Configurations 229
Using Windows Network Portals
2. Use the Select media file(s) to submit dialog to select the file(s) to process.
230 Using Workflow Portal Configurations
Using Windows Network Portals
3. Click Open.
Each file that you open displays in the Select media file(s) list.
Repeat the Browse process as necessary, to select and add more files from any
directories.
If the file list is not correct, you can edit the list manually. For example, you can
select a given file path and delete it. Or, you can edit a path or filename, copy and
paste file paths, or add new ones. To delete the list entirely, click Clear.
4. If multiple publish workflows are displayed in the Target Workflows list, check any
target workflow to which you want to submit the media in the list.
If a checked box is not editable, this is a required workflow for this configuration.
5. Click Submit.
If the configuration does not provide any additional options, Windows Portal sub-
mits the selected media files to each of the selected publication workflows.
6. If the configuration supports metadata labels or variables, Windows Portal displays
the Submit Jobs dialog with tabs for these options. Some configurations display a
tab for metadata and variable editing.
7. When you are done preparing for submission, click Submit.
Using Workflow Portal Configurations 231
Using EDL Portals
The EDL Portal enables you to create an Edit Decision List (EDL) which you submit to a
publishing workflow to process the EDL. You select the media to use by browsing
catalogs and selecting binders created from previously-completed ingest workflow
jobs. You add clips to the clip list, update metadata and variables, and then stitch the
clips together, encoding them in the publishing workflow to which you submit the EDL.
The Telestream Edit Decision List (TSEDL) files created in EDL Portal can only be
processed by Flip action-based workflows.
■ Ingest Workflow for EDL Processing
■ Job Processing and Submittal Steps
232 Using Workflow Portal Configurations
Using EDL Portals
Note: Be sure to encode proxies at the same rate and timecode notation as your
production media. Clips that you mark use the proxy timecode—Workflow Portal
applies it to the Vantage EDL media.
Note: EDL Portal configurations expect binders to have media identified as Vantage
EDL, Vantage Proxy, and Vantage Thumbnail. If you don’t follow these guidelines, the
binders may not display in the catalog, you won’t be able to view the proxy to create
clips or view keyframes, and your publication workflow may fail.
Using Workflow Portal Configurations 233
Using EDL Portals
Note: Use of the Conform action requires a Post Producer license. For details on using
Post Producer and compositions, see the Post Producer Developer’s Guide.
The Workflow Portal Create EDL configuration also supports EDL processing—using
the Flip action—with similar functionality. However, the primary difference—and
advantage—of using a CML Portal configuration is that you can incorporate clips from
different media files with mixed essences. While the EDL Portal requires that all clips
have the same frame rate, frame size and video codec; the CML Portal does not have
this restriction. CML processing also improves VANC and caption processing.
The CML configuration is a create binder configuration—a new binder is automatically
created and submitted to the publishing workflow.
The composition (CML file) created by the CML Portal can only be processed by
Conform action-based workflows.
■ Prototype CML Configuration Workflows
■ Media Pre-processing, CML Creation, and Job Submittal
Using Workflow Portal Configurations 235
Using CML Portals
• Assign the output media the nickname Original so that the CML Portal can identify
which media file to use as the source media when it generates the CML file for pro-
cessing in the publishing workflow.
• If required, use a transcode action (the Flip action, typically—not shown in the
workflow above) to encode your media into one of the supported Post Producer
formats (which accepts a much broader set of video, audio, and container formats
than the Flip action does for EDL processing). See Post Producer Developer Guide For-
mats in the Post Producer Developer’s Guide or the Products > Post Producer >
Specs page on the Telestream web site.
If you are re-encoding your media, since you can’t use the same nickname on input
and output media in the same action, simply assign the input file a nickname other
than Original.
• Use a Flip action to encode your proxy media for previewing/clipping.
– QuickTime encoder, H.264 video codec, AAC audio codec, QuickTime 7.6.9
installed
OR
– MP4 encoder, x264 video codec, AAC audio codec, QuickTime 7.7.6 installed
• Assign the nickname Vantage Proxy, so that the media player can play it.
Note: Make sure that you encode the proxy at the same rate and with the same
timecode notation as your production media.
236 Using Workflow Portal Configurations
Using CML Portals
• Use a Flip action to create a single thumbnail for viewing in the browser.
– Encoder: Keyframe Encoder
– Video Codec: JPEG
– Container: JPEG File
Assign the nickname Vantage Thumbnail, to display them in Workflow Portal.
• Use a Register action to register the media in your target catalog to make it avail-
able in Workflow Portal.
Note: If you don’t follow these guidelines, the binders may not display in the catalog,
you may not be able to set mark-in/mark-out points, and your stitch workflow may fail.
Unlike the ingest workflow, the requirements for your publishing workflow are minimal.
In almost every case, in practice, your publishing workflow will be far more complex
than the prototype shown here.
• The publishing workflow must start with a Receive action, so that it can accept an
input file from Workflow Portal. The nickname of the input file is CML.
• Use a Conform action to stitch and encode your media using the specifications in
the auto-generated CML file you submitted. Configuration details are described in
the man pages in the Conform action.
These are the two required actions; all other actions and configurations depend on
your publishing workflow requirements.
Using Workflow Portal Configurations 237
Using CML Portals
The purpose of the DPP Portal is to enable operators to assemble and produce SD or
HD media files that conform to the current DPP standard, for broadcast in the UK
market.
This configuration can only be used in the Workflow Portal Windows client.
You use a DPP Portal to browse catalogs and select binders from completed ingest
workflows jobs, enter metadata and mark programme parts, then generate DPP-
compliant media which comprises the programme. A DPP configuration defines each
field of DPP metadata in the programme, which may be given a default value, and may
be marked as read-only.
Broadcast Operator
Binder
Set Trim Update
Points Metadata
Programme
Operator:
Clips
Select Media for Package Workflow
Set Trim Points Portal
Update Metadata
DPP Job
Metadata
XML
File
XML
CML File
On-Air
Server
DPP Package
Production
Workflow DPP Package
Note: You can add a DPP Validate action (located in the Analysis group) to your target
workflow to validate metadata in a DPP package.
After you have prepared the media you want to include in the package, you open
Workflow Portal with the proper DPP configuration to create your DPP package, enter
metadata as required, and submit it for processing.
The DPP Portal automatically generates a CML file that defines the media, unless the
operator provides a custom CML. The CML file and all related media files are submitted
to the target Vantage workflow for producing the package.
240 Using Workflow Portal Configurations
VOD | DAI Portal Overview
The purpose of the VOD | DAI Portal is to enable operators to prepare source media and
automate:
• CableLabs-compliant stream-conditioned media generation
• Canoe/BlackArrow-compliant dynamic ad insertion (DAI) location definition CSV
(comma-separated value) files for local and national ads
• Nielsen audio watermarking.
VOD Producer performs media encoding and conditioning and Nielsen watermarking,
along with automated delivery of programs and advertisements to MVPDs, and
metadata to ecosystem partners in supporting workflows.
This configuration can only be used in the Workflow Portal Windows client.
Note: You can also process CML and EDL files with automated VOD Producer and
VOD Producer DAI workflows to produce VOD assets, without using VOD Portal. These
are implemented using Vantage automation workflows, and are covered in the Post
Producer Developer's Guide.
Generating and delivering VOD assets in VOD Producer involves at least two Vantage
workflows. The diagram following illustrates the general process an operator follows to
prepare, generate, and deliver VOD assets.
Using Workflow Portal Configurations 241
VOD | DAI Portal Overview
First, an operator selects a single file or a set of source media files, and submits them to
an ingest workflow, supplying metadata as appropriate. The ingest workflow creates
frame-accurate proxies and processes the metadata. It registers each source media file
and its metadata, proxy, and keyframes in a catalog for access in VOD Portal.
Next, using VOD Portal, the operator selects and prepares source media for submission
to the publication workflow.
The operator then submits the job to a publishing workflow, which performs these
operations:
• Assembles the playlist composition
• Encodes the media as a CableLabs-compliant transport stream, optionally encod-
ing to adaptive bit-rate or mezzanine formats
• Optionally, watermarks the audio for Nielsen measurement, produces Nielsen
metadata and creates Nielsen documents
• Optionally, produces ad metadata and creates DAI location definition files for
Canoe/BlackArrow
• Simultaneously distributes the VOD asset to the MVPD and delivers the metadata
associated with the asset to ecosystem partners (Nielsen and Canoe).
Using Workflow Portal Configurations 243
Tempo Portal Overview
First, an operator selects a single file or a set of source media files, and submits them to
an ingest workflow. The ingest workflow creates frame-accurate proxies and optionally
re-encodes the media to meet Tempo-processing requirements. It registers each source
media file and its proxy and keyframe in a catalog for access in Tempo Portal.
244 Using Workflow Portal Configurations
Tempo Portal Overview
Next, using the Tempo Portal, the operator selects and prepares source media for
submission to the publication workflow.
Syndication Portal configurations can be used only in the Windows Workflow Portal
client, not in the web client.
The Syndication Portal enables operators to review and prepare syndicated (long-form/
episodic) media for submission to a publishing workflow to encode it for broadcast,
including these tasks:
• Metadata label review and update
• Segment list review based on a template, and update as required.
Generating syndicated assets in TrafficManager via Syndication Portal involves at least
two Vantage workflows. The diagram following illustrates the general process to
prepare, generate, and deliver syndicated assets to a broadcast server.
Broadcast Operator
Vantage
g Domain Syndication Catalog
Submit
Files
Media
Ingest
Workflow
Binder
Review Update
Segments Metadata
Synd. Media
Folder
Automation
Catch Server System
Syndicated Operator: Syndication
Select Media to review Workflow Portal Automationn
Media Publishing
Review Segments
Syndication Job
Workflow
Update Metadata
Metadata
XML
File
XML
CML File
On-Air
Server
On-air
Publishing
Workflow Syndicated Media
Broadcast File
246 Using Workflow Portal Configurations
Syndication Portal Overview
A typical Automation workflow uses the metadata file to perform these essential tasks:
• Uses the Automate action to convert the mezzanine metadata XML file into the for-
mat required for a given automation system (ASDB or Bxf, for example).
• Delivers the entire payload to the automation system.
A typical on-air server workflow uses the CML file to perform these essential tasks:
• Assembles the playlist composition into the broadcast media format required,
using a Conform action (which requires a Post Producer license).
• Delivers the encoded media to a broadcast server.
For more information on using the Syndication Portal, see Implementing Syndication
Portal Media Processing in this guide and also see the TrafficManager User Guide.
248 Using Workflow Portal Configurations
Syndication Portal Overview
The following figure shows Analyze and Populate configuration examples that enable
metadata visibility in the Logging Portal Metadata Labels tab.
The Analyze action can also automatically detect black segments used as spacers
between content segments and generate an Analysis Result attachment. As shown
below, the Logging Portal Segment List tab detects the Analysis Result attachment and
populates the segment list with the detected content segments.
250 Using Workflow Portal Configurations
Syndication Portal Overview
Vantage Workflow Portal is a client program (also available as a web app) designed for
customizable, operator-driven media processing. Several Workflow Portal
configurations are provided to implement specific operational needs. The
configurations allow you to customize functionality and the user interface and
generate a specific output (for example, DPP configurations).
You create and configure Workflow Portal configurations in the Vantage Management
Console, and load them in Workflow Portal when you launch it to perform specific
media processing tasks.
Note: Workflow Portal is an optional, licensed Vantage feature. For licensing details,
refer to http://www.telestream.net/telestream-support/vantage/vantage-
licenses.htm. These topics apply to both clients, except where noted. For information
on using each configuration type, see Using Workflow Portal Configurations.
The Windows client provides optimum performance and the full feature set. You can
use the Workflow Portal web app. on any computer with a supported web browser (see
Web Application Browser Requirements) and a network or Internet connection to your
Vantage domain. Not all configuration types are supported in the web app.
Topics
■ Workflow Portal Overview
■ Workflow Design Guidelines
■ Starting a Workflow Portal Session
■ Changing or Reloading a Configuration
■ Managing Workflow Portal Projects
■ Performing Workflow Portal Tasks
■ Windows Client Menus
■ Web Client Menus
■ Troubleshooting Workflow Portal
252 Using Workflow Portal
Workflow Portal Overview
Note: For basic information on using Vantage client programs, see Vantage Client
Programs Overview.
Note: On Windows Server 2008, you may have problems minimizing windows that
you maximize by dragging to the top of the monitor (AeroSnap). To disable AeroSnap,
go to Control Panel > Ease of Access Center > Change how your mouse works. Check
Prevent windows from being automatically arranged when moved to the edge of the
screen.
■ Key Applications
■ How Workflow Portal Works
■ Key Workflow Portal Features
■ Workflow Portal Configuration Types
■ Implementing Workflow Portal-based Media Processing
■ Implementing Syndication Portal Media Processing
Key Applications
Key applications of Workflow Portal include:
• Highlight Extraction From Archive Files—An operator marks in and out timecodes
and chooses the timecode for a thumbnail, and processes the media in a workflow
the creates the clip.
• Promo Preparation—An operator marks the voice-over and graphics entry points
on the timeline. A subsequent workflow reprocesses the promo for multiple mar-
kets, days, and languages, based upon this input.
• Clip Stitching—An operator can select media files of various metrics and define clips
within that media, then submit the EDL to a stitching workflow to combine the
clips and render them into a single output file.
• VOD Distribution—An operator creates a playlist of clips and enters metadata. A
subsequent workflow merges (stitches) the clips into a single media file and trans-
forms metadata for distribution.
• VOD Digital Ad Insertion—An operator defines national and local ad locations for
dynamic ad insertion by the cable vendor, and submits jobs for assembly of Cable-
Labs VOD content and provisions it for dynamic ad insertion (DAI).
Using Workflow Portal 253
Workflow Portal Overview
Operator-access to job variables and media metadata is a powerful feature that enables
operators to control the operation of the next workflow. For example, operators can
edit embedded and label metadata parameters, modify variables to control content
routing, or select other processing options in the next workflow.
254 Using Workflow Portal
Workflow Portal Overview
Note: Some configurations can only be used in the Windows client. Others are
available in both the Workflow Portal web client and the Windows client.
The Copy Binder and Forward Binder, as well as the Create EDL, CML, DPP, Tempo, and
VOD configurations allow operators to browse Vantage catalogs and select binders that
have been registered by a previous job for processing.
The Browse Windows Network configuration allows operators to browse a Windows
server (not a Vantage catalog) to select media files. (Binders only exist in the context of
a Vantage catalog.)
Each type of configuration causes Workflow Portal to operate differently, to achieve its
intended result. The operation of the basic configurations are explained in detail in
Using Workflow Portal Configurations. Configurations offered as Vantage editions are
described in a separate user guide.
Each of the configuration types are summarized in these topics:
■ Browse Catalogs Copy Binder and Forward Binder Configurations
■ Browse Windows Network Configuration
■ Create EDL from Catalogs Configuration
■ Create CML from Catalogs Configuration
■ Create DPP from Catalogs Configuration
■ Create VOD from Catalogs Configuration
■ Re-time Assets from Catalogs Configuration
■ Syndication Configuration
In contrast, in a Browse Catalogs Forward Binder Portal, the operator browses a catalog
and selects a binder—before clicking the Submit button. The selected binder (with any
changes the operator makes) is submitted to the workflow—without making a copy.
Forward binder mode allows the workflow to modify the contents of the original
binder, and those modifications will be visible the next time the user refreshes the
binder in the portal.
The Create CML from Catalogs configuration is supported only in the Workflow Portal
Windows client.
While the EDL Portal requires that all clips have the same frame rate, frame size and
video codec; the CML Portal does not have this restriction. CML processing by Conform
also improves VANC and caption processing.
The operator can review and edit label-based and embedded metadata for the selected
media, and also update variables as required for the workflow. The job creates a new
binder from assets in or more source binders and updates it during execution; it may or
may not be registered by the workflow into a catalog for further utilization.
Syndication Configuration
Use the Syndication Portal to browse catalogs containing syndicated media and select
the media that you want to review, update, and process in TrafficManager for
broadcast.
The Syndication configuration is supported only in the Workflow Portal Windows client.
The Syndication Portal displays the selected media in a segmented view, based on the
timing information obtained from the original syndication source (for example,
PitchBlue).
When your review and configuration of segments and their attributes is complete, the
Portal generates a new mezzanine metadata XML file as well as a composition (CML) file.
The operator selects a publishing workflow to process either the mezzanine metadata file
or the CML file for broadcast.
When using Pass-Thru mode, the Syndication Portal does not generate a CML. In Pass-
through mode, the Portal generates an XML (similar to the other modes), but in
addition passes the source media from the ingest workflow—which must be
nicknamed Original— to the publishing workflow, so that the program can be
transcoded without having to change the program's timeline.
Using Workflow Portal 259
Workflow Portal Overview
Note: Administrators who are responsible for creating Workflow Portal configurations
should refer to the Vantage Domain Management Guide for details.
Workflow designers use Workflow Designer to create and configure the required
workflows, including required metadata and variables, and activate them when you
want to use them in testing or production.
Typically, a given media processing application involves at least 2 Vantage workflows:
• An ingest workflow, which transcodes media as required and registers it in a catalog
• A publishing workflow, which processes the media the operator has selected and
forwarded to the workflow to encode it for publication.
260 Using Workflow Portal
Workflow Portal Overview
6. Open the Workflow Portal and use File > Change/Reload Application Configuration
to load the Syndication Portal configuration created earlier. Refresh the catalogs,
select the syndication catalog, and drag one or more binders into the Segment List.
Use the portal to preview and adjust segments manually.
7. Forward the updated show to the publication workflow by accessing the Forward
To Workflows tab, selecting the workflow, and clicking Submit.
Media and metadata files are delivered to your automation system in ready-to-use formats.
Note: After you fine-tune the segments of a show, you can save the template from
the portal using the Create Template button.
You also have the option when creating workflows to completely bypass the
Syndication Portal, combine ingest and publishing into a contiguous workflow, and
process all the files without human intervention.
262 Using Workflow Portal
Workflow Design Guidelines
While you can use a single workflow to produce and distribute media, there are some
media processing applications which require operator intervention using Workflow
Portal, thus dividing the media processing into multiple workflows. Operator
intervention tasks include QA, building clip lists, and for adding/editing metadata and
variables prior to job submission for further processing.
Workflows for use in conjunction with Workflow Portal typically fall into two categories:
ingest and publishing.
For example, an ingest workflow can automatically analyze source media and detect
media attributes and characteristics such as frame rate, dimensions, letter boxing, and
macro blocking. Ingest workflows often encode media into the required format for use
in the publishing workflow. You typically use Register actions in the ingest workflow, to
create binders in Vantage catalogs, which operators will browse for files to process.
Ingest workflows can also produce proxy media that you can view with the Workflow
Portal media player to evaluate quality issues and quickly define timecodes for trim
points or commercial insertion, for example.
A publishing workflow is a workflow designed to process media submitted by Workflow
Portal operators. Publishing workflows always start with a Receive action so that
operators can submit jobs to them (and they must be running). When your application
calls for an ingest workflow, you use Workflow Portal to evaluate the ingest workflow
results, take any action required, and then submit the job to a publishing workflow.
Frequently, a given application has more than one publishing workflow.
You can also chain publishing workflows, providing operator intervention at more than
one point in the process.
You might use Workflow Portal in a Browse Windows Network configuration, where
your process may not require an ingest workflow. You can use Workflow Portal to select
media, edit metadata and variables and submit jobs to a publishing workflow, rather
than just placing media files in a watch file for automated processing. The advantage to
operator submission is that you can set metadata and variables during submission,
providing more control over publishing workflow processing.
These topics provide guidelines for creating workflows for use with Workflow Portal:
■ Ingest Workflow Guidelines
■ Publishing Workflow Guidelines
Using Workflow Portal 263
Workflow Design Guidelines
Note: Projects are only valid for the domain they are created in and the Workflow
Portal configuration they were saved from. You can not save projects from one domain
and re-open the project for use in another domain. You also can not re-open a project
if the configuration from which it was saved has been deleted from the domain.
Saving a Project
To save work you are performing on a given set of media, select File > Save Project.
When you save a project, Workflow Portal displays a File Save dialog. You can name the
XML file anything you want, and save it where ever you want.
Each time you save the project after the first time, it just updates the project file.
You can re-open it later using the Open Project command.
Opening a Project
To open a project that has been previously saved, select File > Open Project. Workflow
Portal displays the Open File dialog. Navigate to the file and click Open.
Using Workflow Portal 269
Performing Workflow Portal Tasks
Note: The binder list doesn’t automatically update when binders are added or
deleted as workflow jobs execute. To update the list, click the Refresh button at the
top of the Binder table.
Selecting a Binder
To select a binder, do the following:
1. If the Catalogs panel (in the top left corner of the window) displays, select the
catalog or catalog folder you want to browse.
Note: The catalogs that you can access are specified in the configuration. The catalog
browser may be hidden, when the configuration only allows access to one catalog,
with no subfolders.
In the web client (see below), use the Filter menu (directly above the Binder Details
panel) to help you filter binders. To return to an unfiltered list and display all binders,
click the Filter icon again.
1. Select a binder. When a binder is selected, Workflow Portal display its contents in
the Binder Details panel directly below the Catalogs panel.
Filtering
Type text in the Filter field or select a previously-entered string from the menu to filter
the binders in the currently-selected catalog. Delete the text to display all binders in the
catalog.
Playing/Pausing Video
If enabled in the configuration, you can click the Play/Pause button in a binder row to
preview the media. Click Repeatedly to play or pause the video. (Windows client only;
the web client excludes this feature.)
272 Using Workflow Portal
Performing Workflow Portal Tasks
Submitting a Binder
If enabled in the configuration, you can click the Submit button to display the Submit
Jobs window.
Details/Thumbnails View
Select Details or Thumbnails from the menu.
Using Workflow Portal 273
Performing Workflow Portal Tasks
Note: Some configurations allow you to perform tasks and access player controls that
other configurations do not. This topic discusses the full functionality of the media
player, not all of which may be visible in your current configuration.
Open Folder
Open File
Expand Panel
Binder File List
(Select proxy file to
play)
Video frame
Speaker and
Volume Resizing Handle
Player Buttons:
Jump to Start
Bump Back
Play Audio meters (L/R)
Bump Forward
Jump to End
Clip Duration
When you select a binder, Workflow Portal displays any video file nicknamed
Vantage Proxy, if present. You can use the window, keyboard, and mouse
controls listed in Window, Keyboard, and Mouse Controls to control playback.
You can also preview other supported media in the binder.
Note: For Create EDL from Catalogs mode, EDL processing requires Program Stream
or Transport Stream MPEG-2 video, which must be included in the binder with the
nickname Vantage EDL. Vantage also supports for MXF DV, IMX, and XDCAM HD video
formats. All assets in the EDL must have the same frame size and frame rate.
navigate to and choose points of silence to create a new segment, to avoid audio
anomalies during the re-timing process.
The scrubber and timeline below the display enables you to scrub the media; and the
player buttons enable you to play, stop, bump forward and back, and go to the start
and end of the clip.
The two bottom center timecodes display the current scrubber location clock time
(HH:MM:SS.SSS) and timecode time (HH:MM:SS:FF@FPS). The timecode at the bottom
right of the display shows total duration of the clip (HH:MM:SS.SSS).
Tick marks and coloring displayed on the timeline indicate mark in and mark out points
and clip segments. (In Tempo only, overlapping segments are highlighted in red to
indicate that operator adjustment is required.)
Note: Clicking in the playback controls area or on the video focuses the preview
player controls (indicated by the blue border). Focusing this area enables “JKL” controls
instead of the shortcuts.
Function Controls
Play/Pause/Reverse Ctrl+P or Ctrl+Space
J (Reverse play—repeat for -1.5x, -2x, -5x, -8x)
K (Pause)
L (Play—repeat for 1.5x, 2x, 5x, 8x)
JK simultaneously (Reverse play slow motion -1/8x; repeat for
-1/4x, -1/2x)
KL simultaneously (Forward play slow motion 1/8x; repeat for
1/4x, 1/2x)
Stop Ctrl+S
Forward Frame Ctrl+F
Ctrl+Mouse Wheel, one frame per wheel click
K held down + L (Forward bump one frame)
L held down with K already pressed (Forward bump repeat
1/4 speed)
Left Arrow (Reverse bump one frame)
Right Arrow (Forward bump one frame)
Forward/Reverse 10 Up Arrow (Forward bump 10 frames)
Frames Down Arrow (Reverse bump 10 frames)
Forward/Reverse Mouse Wheel (no modifier keys)—one second per wheel click
One Second
Forward/Reverse Shift+Mouse Wheel—one minute per wheel click
One Minute
Forward/Reverse Ctrl+Shift+Mouse Wheel—one hour per wheel click
One Hour
Using Workflow Portal 277
Performing Workflow Portal Tasks
Function Controls
Reverse Frame Ctrl+B
Ctrl+Mouse Wheel, one frame per wheel click
K+J (Reverse bump one frame)
k+J held down (Reverse bump repeat
1/4 speed)
Mark In Ctrl+I or Ctrl+E (In points are indicated by tick marks on the
timeline.)
Mark Out Ctrl+O or Ctrl+R
Go to mark in frame Ctrl+Q
Go to mark out Ctrl+W
frame
Go to start Ctrl+Home
Go to end Ctrl+End
Audio Mute (toggle) Ctrl+M
Adjust Volume Drag volume button right or left to adjust volume.
Scroll media Drag media button right or left to scrub (scroll) media.
Duplicate selected Ctrl+T (Selects the new clip and sets its mark in to the original
clip clip’s mark out, if appropriate)
Jump to next Alt+Left | Right Arrow Jumps to the next or previous segment,
segment as noted by the white bars on the scrubber bar. Works even
when segment markers are not displayed.
Jump to next scene Shift-Alt+Left | Right Arrow Jumps to the next or previous scene
change marker change marker, as noted by the green bars on the scrubber bar.
Works even when scene change markers are not displayed.
278 Using Workflow Portal
Performing Workflow Portal Tasks
Note: The appearance of captions in the proxy may vary, depending on the browser
you’re using. Try supported browsers to find one that best suits your requirements.
Note: You can right-click on the video to display a context menu with many player
commands as an alternative to using the player controls or keyboard shortcuts. The
available controls vary with the browser.
To view a proxy, select a binder and use the controls in Web Workflow Portal Keyboard
Controls to control playback.
Note: An HTTP alias must be set up for the web portal. See Web Application Browser
Requirements.
• Use a Flip action to transcode the file using the MP4 x264 encoder with closed cap-
tions enabled.
• Use a Register action to add the job (for accessing the proxy and the WebVTT files)
in a catalog.
• Display the proxy with captions in the Workflow Portal web applications’ media
player. Be sure to set the player caption control in the gear menu to enable Closed
Captions.
Note: The HTML5 Video Viewer must be in focus (you must click in the video frame) in
order to use the player controls and keyboard shortcuts.
Function Controls
Play (appears in binder list)
Enabled in play mode (click Press L x 1—play 1x speed (normal).
Play button or press K key). Press L x 2—play 2x speed.
Press L x 3—play 3x speed.
Press L x 4—play 5x speed.
Press L x 5—play 8x speed.
(IE only) Tap the + (plus) key to accelerate the clip’s play
speed to the next level. Press the - (minus) key to
decelerate the clip’s play speed down the next level.
Reverse Play
Enabled in play mode (click Press J x—reverse play.
Play button or press K key). Press J x 2—reverse play 2x speed.
Press J x 3—reverse play 3x speed.
Press J x 4—reverse play 5x speed.
Press J x 5—reverse play 8x speed.
(IE only) Press the + (plus) key to accelerate the clip’s play
speed up to the next level. Press the - (minus) key to
decelerate the clip’s play speed down the next level.
Play/Pause
Press K—play forward or pause. Hold K down to step in
reverse.
Forward Frames
Press L—step forward one frame.
(IE only) Press the Right Arrow key—move forward 10
frames.
(Chrome and IE 11) Press the Right Arrow key—move
forward 1 frame. Press the Up Arrow key to move forward
10 frames.
The arrow keys on the numbers keypad function in the
same manner.
Using Workflow Portal 281
Performing Workflow Portal Tasks
Function Controls
Reverse Frames
Tap J—move reverse one frame.
(IE only) Press the Left Arrow key—move reverse 10
frames.
(Chrome and IE 11) Press the Left Arrow key—move
reverse 1 frame. Press the Down Arrow key to move
reverse 10 frames.
The arrow keys on the numbers keypad function in the
same manner.
Go to start
(IE only) Press the Home key.
Go to end
(IE only) Press the End key.
Mute audio
(IE only) Press the M key during play. Press again to
unmute.
Scroll media
Full screen mode
Press this button to expand to full screen mode.
Zoom mode (IE 11 only) Press Z to zoom in. Press Z again to zoom back
out.
Video-safe overlay
Click to display/hide the video safe overlay frame, for SD
and HD proxies.
Closed captioning
Click to display closed captions, when provided by
browser.
Audio track menu
Note: This feature is only supported in the Windows client and only when the binder
detail display is enabled in the configuration.
Media with a nickname other than Vantage Proxy may be played under certain
conditions. Select the media in the binder list (directly above the media player) and try
these methods:
1. For QuickTime (.mov) files, select the file and use the media player controls to play
the media file.
2. To play a QuickTime file outside the embedded media player, right-click the media
and select Open With Default Program or click the file icon directly above the
binder list to play the media file in the default program for MOV files.
3. If you don’t have a default program assigned to handle MOV files, right-click the
media asset, and select Open Containing Folder or click the folder icon directly
above the binder list. The Windows folder containing the media opens, so you can
right-click the file and play it using Open With to select a suitable program.
4. For files other than QuickTime, right-click the media and select Open With Default
Program or click the file icon directly above the binder list to play the media file in
the default program for the specified suffix of the file.
5. If you don’t have a default program assigned to play this file type, right-click the
media asset, and select Open Containing Folder or click the folder icon directly
above the binder list. The Windows folder containing the media opens, so you can
right-click the file and play it using Open With to select a suitable program.
Adding Clips
You can add multiple clips to a list, and you can add the same clip multiple times.
Note: If you do not want to combine clips in one file, you can clip the same file
multiple times. For example, if you are extracting multiple highlights from a single
media file, you can mark a highlight, select Submit, and then mark a new highlight
without affecting the first one.
To add a clip to the list from the media in the selected binder, click the Add button ,
or drag the binder to the list.
Note: EDL/Segment List clips must have the same frame size and frame rate. In a CML
configuration, this is not a requirement. When you add the first clip to an EDL, the
frame size and rate of the EDL are set to the metrics of that clip. Once the frame size
and rate are set for a list, Workflow Portal does not allow you to add an incompatible
clip. If you select a binder with a clip that is incompatible, the Add button is disabled to
indicate that the clip cannot be added.
Each clip you add creates a tick mark on the timeline where the Mark In point is located.
• Type time or frame values in the Mark Out time setting. The displayed format is:
HH:MM:SS;FF, where HH indicates hours, MM indicates minutes, SS indicates sec-
onds, and FF indicates frames.
• In the Mark Out time setting, click one of the numbers and use the up and down
controls to change the value.
• Adjust the duration timecode, which adjusts the mark out point relative to the mark
in point. This field indicates the duration of the media between the mark in/out
points of the currently selected clip.
If you specify a mark in, mark out, or duration timecode that makes one or more of the
timecodes invalid, the affected timecodes display a red background. For example if you
select a Mark In timecode that starts after the Mark Out timecode, the Mark In and
Duration timecodes display red. Also, if the duration timecode moves the mark out
timecode beyond the end of the clip timeline, both the Duration and Mark Out fields
display red to indicate the error.
The duration timecode can be dropframe or non-dropframe, depending on the setting
of the Use dropframe notation for duration when appropriate checkbox in the Vantage
Management Console Workflow Portal Configurations panel. By default (unchecked),
durations are always shown in non-dropframe. When checked, durations match the
dropframe setting of the in/out values. (The Web Workflow Portal uses non-dropframe
notation only.)
project, and allows you to choose to unjoin segments that were joined previously using
the portal.
Reordering Clips
To change the order of a clip in the list, click on the clip and click the up and down
buttons, or click and drag the clips, to change the clip position.
Deleting Clips
To delete a clip from the list, click on the clip and click the Delete button .
Using Workflow Portal 287
Performing Workflow Portal Tasks
Note: In a Forward Binder configuration, you edit metadata before submitting the
binder to a publishing workflow. Changes are made in the binder you selected in the
catalog.
In a Copy Binder and Logging configurations, you click Submit and then enter
metadata for the new binder you are creating. Your edits do not affect the original
binder you selected from the catalog—only the new, copied binder.
In a VOD/DAI configuration, a Metadata Label source clip check box specifies which clip
should be used as the source for metadata labels. The Metadata Labels tab then shows
the labels associated with the selected clip.
When you submit a binder, all metadata labels are included. If the configuration
supports metadata entry and editing, you can modify metadata labels before you
submit. All metadata labels are applied to all media files that are being submitted.
The following topics describe how to edit metadata labels:
■ Editing Metadata in the Windows Client
■ Editing Metadata in the Web Client
2. Select the label you want to edit in the Metadata Label list.
3. In the Parameter list to the right, edit the parameter values.
288 Using Workflow Portal
Performing Workflow Portal Tasks
4. If the metadata label you want to configure does not display in the list and the
configuration permits adding labels, click the new label button, select a label to
add, and click OK.
Note: This option is not available when submitting files in a Browse Windows
Network configuration.
Note: If a label parameter includes a valid URL, an Open button automatically appears
next to the parameter, allowing you to open to that URL by clicking the button.
4. To remove a metadata label configuration, locate the tab for the label, select the
tab, and click Remove Label.
5. Repeat metadata label selection and parameter configuration until all required
metadata labels are configured.
6. If you need to configure variables, see Specifying Variable Values.
7. When you are done preparing for submission, click Submit.
290 Using Workflow Portal
Performing Workflow Portal Tasks
Note: In Forward Binder configurations, you can edit variables in the main window; in
Copy Binder configurations, you can only edit variables after you click the Submit
button, in the Submit Jobs window. For details, see Browse Catalogs Copy Binder and
Forward Binder Configurations.
For each variable displayed, enter or update the run-time value as required.
Using Workflow Portal 291
Performing Workflow Portal Tasks
Check the workflows you want to submit this job to and click Submit. (These workflows
must be activated in Workflow Designer, or your jobs will fail to run.)
For details on submitted jobs, see Submitting Jobs in the Windows Client or Submitting
Jobs in the Web Client.
292 Using Workflow Portal
Performing Workflow Portal Tasks
Note: For customer service, see Contacting Telestream. You may use the Data
Collection Utility (Vantage Management Console > Support Utilities > Data Collection).
You may also use the Change Log or Error Log utilities to provide information during
your service call.
• When using the Workflow Portal Web Application on a Windows Server platform,
you must install the Desktop Experience feature in order to view proxy media in the
HTML5 Media Player.
• When playing to the end of a proxy in Chrome, versions 35 and 36, Telestream has
observed that the media player may display an incorrect duration as a result of a
round-up error. This anomaly is cosmetic. If you set this frame as a mark-out point,
the correct timecode is entered by Workflow Portal.
Note: Open the Vantage Management Console > Licenses and use the Licenses and
Portal Sessions tabs to determine how many servers can run Workflow Portal
concurrently, and how many sessions are currently active.
Job Status Views is a web application that enables basic Vantage job management via a
web browser. You can use Job Status Views to access job information and manage jobs
in your Vantage domain from anywhere on the LAN, or via the Internet if you provide
such access your Vantage domain.
Note: For information about Vantage web application requirements, starting and
stopping web applications, and other basic topics, see Vantage Client Programs
Overview.
Topics
■ About the Job Status Views Web Application
■ Job Status Views Web Application Overview
■ Using Public and Private Views
■ Sorting Jobs by Column
■ Paging Through Job Tables & Setting Page Size
■ Filtering the Job Table
■ Highlighting Job States Row by Row
■ Managing Jobs
■ Troubleshooting
300 Using the Job Status Views Web Application
About the Job Status Views Web Application
Note: If you don’t log in as a Vantage user, private views display None Available.
Note: Administrators should refer to the Vantage Domain Management Guide for
information on how to set up custom views.
Using the Job Status Views Web Application 303
Using Public and Private Views
Controls in Views
An administrator can configure the following controls in a view:
• Enable—Enables or disables use of the view.
• Show Only In Process Jobs—Displays only jobs that are currently running.
• Stop | Start | Delete—Enables or displays the ability of the operator to manage
jobs—stopping, restarting, and deleting them.
304 Using the Job Status Views Web Application
Sorting Jobs by Column
Managing Jobs
Job management, when enabled in a view, enables you to stop, restart, and delete jobs.
The following topics describe how to stop, restart, and delete jobs:
■ Stopping Jobs
■ Restarting Jobs
■ Deleting Jobs
Stopping Jobs
You might want to stop a job to make Vantage resources available for another job, or
you might stop a job in preparation for system maintenance.
To stop a job, do one of the following:
• Right-click on a job in the job list, and select Stop.
• Select a job in the job list, then click the Options menu in the toolbar, and select
Stop.
Restarting Jobs
Jobs can be stopped by service or network interruptions, or an operator might stop a
job to give another job priority. To restart a job, do one of the following:
• Right-click on a job in the job list, and select Restart.
• Select a job in the job list, then click the Options menu in the toolbar, and select
Restart.
Using the Job Status Views Web Application 311
Troubleshooting
Deleting Jobs
You might want to delete a job because the job has failed, or because the output file is
no longer needed, for example.
To delete a job, do either of the following:
• Right-click on a job in the job list and select Delete.
• Select a job in the job list, then click the Options menu in the toolbar, and select
Delete.
Troubleshooting
Job Status Views enables troubleshooting and correction at the job level. For more
comprehensive troubleshooting, use the Vantage Dashboard web application.
The first step in Vantage troubleshooting with Job Status Views is to identify the jobs
that are having problems. There are several ways to do this:
• Enable Highlight State Rows to indicate job status with colors. Failed jobs are high-
lighted in red, and other states have distinct colors. (See Highlighting Job States Row
by Row for more information.)
• Click the State column head to sort the jobs by the current state, then locate the
group of jobs you want to investigate.
• Use filters to display only the jobs in the state you are investigating. (See Filtering
the Job Table for more information.)
After you locate the jobs with issues, look for common traits among those jobs. The
following are some possible issues and suggestions for resolution:
• All jobs are failed or waiting. Look for network, database, or service issues. If all jobs
within a certain time period had problems, there might have been a temporary
issue that has since been corrected. Restart failed jobs as described in Restarting
Jobs.
• All jobs for a specific workflow have failed or are waiting. Look for issues with the
workflow. Has the workflow ever worked? Are all resources used by that workflow
available?
• All jobs for a particular watch folder or destination have failed or are waiting. If you
know that all the troubled jobs use the same watch folder or destination, it could
be that the location is not available.
After you resolve a problem, some jobs might restart on their own, and others might
require further action from you. If your view is so enabled, you can take the following
actions on jobs in the job list:
• Restart—Restart stopped jobs as described in Restarting Jobs.
• Delete—Delete jobs as described in Deleting Jobs.
• Stop—If a job seems unlikely to complete or stop, you can stop the job as described
in Stopping Jobs. Once a job is stopped, you can try to restart the job or delete it.
312 Using the Job Status Views Web Application
Troubleshooting
313
Shortcut Keys
Topics
■ Vantage Workflow Designer Shortcuts
■ Workflow Portal Shortcuts
■ Portal Player Shortcuts
■ Vantage Dublist Portal Shortcuts
■ Web Apps Shortcuts
■ Vantage Management Console Shortcuts
314 Shortcut Keys
Vantage Workflow Designer Shortcuts
Function Shortcut
Ctrl+A Selects all actions in the current workflow.
Ctrl+C, Ctrl+V Duplicates the selected action or text entry.
Ctrl+D Alternates between detailed and simple action view.
Ctrl+G Turns grid lines on or off.
Ctrl+O Display/hide action annotations in the workflow
Ctrl+Q Exit the program.
Ctrl+R Re-centers the workflow in the design space.
Ctrl+V Pastes cut or copied text.
Ctrl+W Creates a new workflow.
Ctrl+X Cuts the selected text.
Ctrl++, Ctrl+- Zooms in, zooms out.
F1 Opens the Vantage User Guide.
Alt+F4 Closes the Vantage User Guide.
F5 Opens the selected workflow.
F10 Selects the File menu for mouse-free operation. Use right and
left arrows to move to other top menus. Use up and down
arrows to navigate menu selections. Press Enter to select the
highlighted menu.
Arrow keys Used in various menus to navigate instead of the mouse.
Tab Moves through functions to enable mouse-free operation.
Shortcut Keys 315
Workflow Portal Shortcuts
Function Shortcut
Ctrl+A Selects all files in the current list.
Ctrl+G Opens the selected file in the Switch player.
Ctrl+G For Tempo Portal only when playing files in Switch, gets
timecode from Switch and copies it to the Tempo proxy player
Ctrl+C | Ctrl+V Duplicates the selected item or text entry.
Ctrl+Q Exits the program.
Ctrl+S For the Tempo Portal playing TIFO files only, opens the Switch
Player and sets the player’s timecode to Tempo timecode.
Ctrl+T Duplicates the selected segment (TrafficManager & Tempo)
Ctrl+V Pastes cut or copied text.
Ctrl+X Cuts the selected text.
Ctrl+0 (Zero) Half sized video (TrafficManager & Tempo)
Ctrl+1 Normal sized video (TrafficManager & Tempo)
Ctrl+2 Double sized video (TrafficManager & Tempo)
Ctrl+3 Scale video to fit (TrafficManager & Tempo)
F1 Opens the appropriate user guide for the portal configuration.
Alt+F4 Closes the user guide.
F10 Selects the File menu for mouse-free operation. Use right and
left arrows to move to other top menus. Use up and down
arrows to navigate menu selections. Press Enter to select the
highlighted menu.
F11 Save Project
F12 Save Project As...
Tab Moves through functions to enable mouse-free operation.
316 Shortcut Keys
Portal Player Shortcuts
Function Controls
Play/Pause/Reverse Ctrl+P or Ctrl+Space
J (Reverse play—repeat for -1.5x, -2x, -5x, -8x)
K (Pause)
L (Play—repeat for 1.5x, 2x, 5x, 8x)
JK simultaneously (Reverse play slow motion -1/8x; repeat for
-1/4x, -1/2x)
KL simultaneously (Forward play slow motion 1/8x; repeat for
1/4x, 1/2x)
Stop Ctrl+S
Forward Frame Ctrl+F
Ctrl+Mouse Wheel, one frame per wheel click
K+L (Forward bump one frame)
K+L held down (Forward bump repeat
1/4 speed)
Left Arrow (Reverse bump one frame)
Right Arrow (Forward bump one frame)
Forward/Reverse 10 Up Arrow —Forward bump 10 frames
Frames Down Arrow—Reverse bump 10 frames
Forward/Reverse Mouse Wheel (no modifier keys)—one second per wheel click
One Second Shift + Left Arrow (Reverse bump one second)
Shift + Right Arrow (Forward bump one second)
Forward/Reverse Shift +Mouse Wheel—one minute per wheel click
One Minute
Forward/Reverse Ctrl+Shift+Mouse Wheel—one hour per wheel click
One Hour
Reverse Frame Ctrl+B
Ctrl+Mouse Wheel—one frame per wheel click
K+J—Reverse bump one frame
K+J held down—Reverse bump repeat 1/4 speed
Shortcut Keys 317
Portal Player Shortcuts
Function Controls
Mark In Ctrl+I or Ctrl+E (In points are indicated by tick marks on the
timeline.)
Mark Out Ctrl+O or Ctrl+R
Go to mark in frame Ctrl+Q
Go to mark out Ctrl+W
frame
Go to start Ctrl+Home
Go to end Ctrl+End
Audio Mute (toggle) Ctrl+M
Adjust Volume Drag volume button right or left to adjust volume.
Scroll media Drag media button right or left to scrub (scroll) media.
Duplicate selected Ctrl+T (Selects the new clip and sets its mark in to the original
clip clip’s mark out, if appropriate)
Jump to next Alt+Left | Right Arrow Jumps to the next or previous segment,
segment as noted by the white bars on the scrubber bar. Works even
when segment markers are not displayed.
Jump to next scene Shift-Alt+Left | Right Arrow Jumps to the next or previous scene
change marker change marker, as noted by the green bars on the scrubber bar.
Works even when scene change markers are not displayed.
Ctrl+: Switches to dropframe timecode.
Ctrl+; Switches to non-dropframe timecode.
Tab Moves through functions to enable mouse-free operation.
318 Shortcut Keys
Vantage Dublist Portal Shortcuts
Function Shortcut
Ctrl+A Selects all in the current list.
Ctrl+C, Ctrl+V Duplicates the selected item or text entry.
Ctrl+Q Exits the program.
Ctrl+V Pastes cut or copied text.
Ctrl+X Cuts the selected text.
F1 Opens the Vantage Domain Management Guide.
Alt-F4 Closes the Vantage Domain Management Guide.
F10 Selects the File menu for mouse-free operation. Use right and
left arrows to move to other top menus. Use up and down
arrows to navigate menu selections. Press Enter to select the
highlighted menu.
Tab Moves through functions to enable mouse-free operation.
Shortcut Keys 319
Web Apps Shortcuts
Function Controls
Play (appears in binder list)
Enabled in play mode (click Press L x 1—play 1x speed (normal).
Play button or press K key). Press L x 2—play 2x speed.
Press L x 3—play 3x speed.
Press L x 4—play 5x speed.
Press L x 5—play 8x speed.
(IE only) Tap the + (plus) key to accelerate the clip’s play
speed to the next level. Press the - (minus) key to
decelerate the clip’s play speed down the next level.
Reverse Play
Enabled in play mode (click Press J x—reverse play.
Play button or press K key). Press J x 2—reverse play 2x speed.
Press J x 3—reverse play 3x speed.
Press J x 4—reverse play 5x speed.
Press J x 5—reverse play 8x speed.
(IE only) Press the + (plus) key to accelerate the clip’s play
speed up to the next level. Press the - (minus) key to
decelerate the clip’s play speed down the next level.
Play/Pause
Press K—play forward or pause. Hold K down to step in
reverse.
Forward Frames
Press L—step forward one frame.
(IE only) Press the Right Arrow key—move forward 10
frames.
(Chrome and IE 11) Press the Right Arrow key—move
forward 1 frame. Press the Up Arrow key to move forward
10 frames.
The arrow keys on the numbers keypad function in the
same manner.
320 Shortcut Keys
Web Apps Shortcuts
Function Controls
Reverse Frames
Tap J—move reverse one frame.
(IE only) Press the Left Arrow key—move reverse 10
frames.
(Chrome and IE 11) Press the Left Arrow key—move
reverse 1 frame. Press the Down Arrow key to move
reverse 10 frames.
The arrow keys on the numbers keypad function in the
same manner.
Go to start
(IE only) Press the Home key.
Go to end
(IE only) Press the End key.
Mute audio
(IE only) Press the M key during play. Press again to
unmute.
Scroll media
Full screen mode
Press this button to expand to full screen mode.
Zoom mode (IE 11 only) Press Z to zoom in. Press Z again to zoom back
out.
Video-safe overlay
Click to display/hide the video safe overlay frame, for SD
and HD proxies.
Closed captioning
Click to display closed captions, when provided by
browser.
Audio track menu
Function Shortcut
Ctrl+A Selects all in the current list.
Ctrl+C, Ctrl+V Duplicates the selected item or text entry.
Ctrl+Q Exits the program.
Ctrl+V Pastes cut or copied text.
Ctrl+X Cuts the selected text.
F1 Opens the Vantage Domain Management Guide.
Alt-F4 Closes the Vantage Domain Management Guide.
F10 Selects the File menu for mouse-free operation. Use right and
left arrows to move to other top menus. Use up and down
arrows to navigate menu selections. Press Enter to select the
highlighted menu.
Tab Moves through functions to enable mouse-free operation.
322 Shortcut Keys
Vantage Management Console Shortcuts
323
Vantage Glossary
action
An action is the smallest unit of work that can be specified in a Vantage workflow.
Actions are connected together in a workflow to perform a useful task. Each action
must be configured to perform its task in the context of the workflow, using an
action Inspector. Action inspectors are specific to each type of action.
Actions are grouped in Workflow Designer by functional categories:
communication, transcoding, file operations, metadata processing, etc. Each action
is defined by the specific task it performs. For example, an email action, or a
metadata label/file transformation action. All actions are executed by Vantage
Windows services, which correlate to the functional categories.
Actions have limited interdependency, and so, are very flexible. You may impose
limitations on actions in a workflow. For example, you might require action B to
depend on action A in a Vantage workflow.
During execution, actions operate on files, binders, variables, and states, and they
generate an action state when they complete. Actions are executed by Vantage
services, which perform the requirements of the action. In the case of the Vantage
Transport Service and most transcoding services, the services may manage file
transfers and transcoding/rendering via an out-of-process resource.
AAF action
The AAF action uses the Vantage Avid Service to ingest incoming AAF files and
processes the MXF folder referenced in the AAF file. Avid Media Composer then
utilizes Persistent Media Record (PMR) files for information about the online status
of file Media Object information (MOB). Each PMR file provides an index in a form
that an editor can quickly load all the file MOBs and their associated media files in
the media directory in which the PMR file resides.
action state
The action state describes the condition of an action execution in process and after
completion.
During execution, an action may be Queued | Paused | In Process | Waiting. After
execution, an action's final state may be Success | Ignore | Failure. Certain actions
(Decide/Examine/Compare/Identify, for example) allow the use to specify the post-
324 Vantage Glossary
execution state, including Ignore. For all other actions, the post-execution state is
set by the service, and is either Success or Failure. These states display in the
Vantage Workflow Designer Job Status tab.
Action states are always passed to subsequent actions. The incoming state is tested
by the next actions to determine whether or not following actions should execute.
Some actions allow you to specify that an action should execute on a specific state
(right-click the action, and select Perform On > Success | Failure | Ignore | Any).
If an action fails, then the next action will inherit the Failure state and (in most
cases) will not execute. If one action fails, the entire job fails.
Similarly, if you specify an action to set the Ignore state, the next action will inherit
the Ignore state and will also likely not execute. Certain special actions, such as
Message, can be configured to perform on any state (Failure, for example)—this
allows workflows to send an email if they detect a failure.
Action states have precedence when an action receives states from multiple
incoming actions (a merge of multiple branches):
- If at least one incoming state is Failure, regardless of other incoming states, the
action will inherit the Failure state. Failure has precedence over all action states.
- If there is no Failure state, but at least one Success state, then the action will inherit
the Success state. Success has precedence over Ignore states.
- If all incoming states are Ignore, the action will inherit the Ignore state. Ignore has
lowest precedence of the three states. If an action receives an Ignore state and does
not explicitly fail, then it emits a Success state. Otherwise, it emits a Failure state
unless it is an action which can emit Ignore, and you have configured it to do so.
Alchemist File action
The Alchemist File action, which is executed by the Vantage Alchemist Service,
allows you to configure connection settings with an existing installation of Grass
Valley Alchemist File software.
Vantage Alchemist Service
The Alchemist Service allows Vantage to interact with an installation of the Grass
Valley Alchemist software via the Alchemist File action. For configuration and set
up details, see the Alchemist File app note available on the Telestream web site.
All-in-one domain
An all-in-one (or single-node or single-server) Vantage domain is one in which all
server components of Vantage—the Microsoft SQL Server database, all Vantage
services, and the optional Vantage web applications—are installed and operate on
a single computer.
See also Vantage array.
Analyze action
The Analyze action, which is executed by the Vantage Analysis Service on-premises
or the Cloud Service when in Vantage Cloud mode, enables you to perform analysis
on media using a variety of analysis tools, specifying the result of the analysis in
variables, for use in downstream actions. It is Vantage Cloud capable.
Vantage Glossary 325
metadata, an SCC caption file, or an STL or PAC subtitle file. An attachment may also
be a PDF file, Excel spreadsheet, or Word document, for example. Attachments are
identified and processed using nicknames for simplicity. Processing is optional—
attachments may be simply passed through a workflow for storage with the
processed media and registered in a Vantage catalog.
attachment nickname
An attachment nickname is an alias or alternate name that is assigned to an
attachment file during Vantage workflow execution. When an attachment file is
submitted to a workflow, the actual file name and location is stored in a Vantage
binder along with a nickname as defined in the workflow. Within the workflow, all
references to a file are by nickname. However, when Vantage needs to access a file,
Vantage uses the actual file name and location stored in the binder.
See media nickname and nickname.
AudioTools action
An AudioTools action is an optional, licensed feature in Vantage. It uses the Vantage
AudioTools Service to enable Vantage workflows to utilize and interact with various
AudioTools products from Minnetonka Audio Software. The AudioTools Custom
Workflow executes a selected, pre-defined AudioTools Server workflow. AudioTools
Loudness Control executes the typical loudness processes, including hitting
multiple target parameters using an iterative processing pass.
Vantage AudioTools Service
The AudioTools Service implements the AudioTools Connector and enables Vantage
workflows to utilize and interact with various AudioTools products from
Minnetonka Audio Software.
Aurora action
An Aurora action is an optional, licensed feature in Vantage. It uses the Vantage
Aurora Service to enable Vantage workflows to utilize and interact with various QC
tests provided by the Digimetrics Aurora software. The tests provide the ability to
determine whether a particular input media (specified by nickname) either passes
or fails a particular QC check. Each test also generates a report file that may be
utilized during later stages of the workflow.
Vantage Aurora Service
The Aurora Service implements the Digimetrics Aurora software for Vantage, and
provides two-way communication between workflows (and the Aurora action)
utilizing Aurora and the Aurora software itself.
Automate action
The Automate action, which is executed by the Vantage Communicate Service, is
similar to the Notify action. It contains system-integration extensions which are
relevant to TrafficManager workflows, enabling you to save job or other metadata
to a file and interface/integrate with external automation systems. This capability
ranges from writing XML-based material to a file system to direct integration with
specific automation systems.
Vantage Glossary 327
Change Log
The Change Log (Vantage Management Console > Support Utilities) captures
changes to the Vantage domain configuration and operation and records the
following details: date and time of change, Vantage user who made the change,
host computer where the change occurred, change summary message.
Chronicle action
The Chronicle action, along with Colocate, Compose, and Conform actions, are part
of the optional, licensed Post Producer feature in Vantage. The Chronicle action
uses the Vantage Edit Service to convert post-rendered Composition XML files into
formats for use in other systems—ad-insertion systems, for example.
Vantage Cloud mode
Vantage Cloud mode is an execution option that you can enable in Vantage Cloud-
capable actions to enable processing in the cloud (enabled by configuring your
Vantage domain with a valid Telestream Cloud account). When supported actions
execute in the Vantage Cloud mode, they are executed by the Cloud Service.
Cloud Service
The Cloud Service connects a Vantage domain with Telestream Cloud or
Encoding.com. The Cloud service acts primarily as a proxy for Telestream Cloud as
the Vantage component that is responsible for transporting files and executing
actions which interact with resources in Telestream Cloud or are related to Cloud
processing: Cloud Qualify action | Cloud Speech action | Location action. In
addition, the Qualify Action is provided, in the Cloud category. The Cloud Service is
also responsible for executing the Analyze action | Conform action | Flip64 action |
IPTV Flip action | Multiscreen Flip action | Tempo action | Timed Text Conform
action | Timed Text Flip action when these actions execute in Vantage Cloud mode.
To use the Cloud Service and its associated actions and features in your workflows,
you must have an Encoding.com account or Telestream Cloud account. For
Encoding.com accounts, contact your Telestream support team.
You can create a Telestream Cloud account on the Telestream Cloud web site:
https://cloud.telestream.net. When you create your Telestream Cloud account, you
are supplied an API key. Use this key in the Vantage Management Console >
Settings & Options > Telestream Cloud tab to allow Vantage to log into your
Telestream Cloud account automatically to perform cloud processing that you
specify in workflows.
Cloud Qualify action
The Cloud Qualify action The Cloud Qualify action is part of the Cloud group, which
is executed by the Vantage Telestream Cloud service. The Cloud Qualify action is
supported in Vantage Cloud hosted workflows. For details on using hosted
workflows, consult the Vantage Cloud User Guide.
To use the Cloud Qualify action you must have a Telestream Cloud account and it
must be registered in Vantage. In your account, you should create one or more
Quality Control projects that can be executed by Cloud Qualify workflows in
Vantage.
330 Vantage Glossary
Compose action
A Compose action, along with Chronicle, Colocate, and Conform actions, are part of
the optional, licensed Post Producer feature in Vantage. The Compose action uses
the Vantage Edit Service to convert various media descriptor file formats
(Anystream AN2, Final Cut Interchange XML, Simplified Avid AAF, QuickTime
Reference, Adobe FC7XML, and Telestream TSEDL) into a Composition XML file so
that it can be used by the Conform action to compose media) into a Composition
XML file so that it can be used by the Conform action to compose media.
Composition (CML) file
A Composition file is an XML schema that provides the vocabulary to describe
media elements and their temporal and spatial relationships on a video timeline.
Composition files (or Composition XML objects in a computer program) are
submitted to a Conform action in a workflow to render the media file from the
description.
Compute action
A Compute action, which is implemented in every Vantage service, performs various
arithmetic and string manipulation functions, permitting you to create and modify
values in variables, for use in downstream actions. This action is Open Workflow
capable.
Conform action
A Conform action, along with the other Edit actions, are part of the optional,
licensed Post Producer feature in Vantage. The Conform action, which is Vantage
Cloud capable, uses the Vantage Edit Service to assemble and optionally transcode
multiple video and still image files into a single output file, applying filters as
specified by you. The input files and related specifications for the output file are all
defined in a Composition XML file. This action is Open Workflow capable except
when executing in Vantage Cloud mode.
Construct action
A Construct action, which is implemented in every Vantage service, enables you to
construct complex strings, paths, and math expressions from literals, variables, and
tokens, for use in downstream actions. This action is Open Workflow capable.
Copy action
A Copy action is executed by the Vantage Transport Service and is used to replicate
a file from a source target (file system/device and directory) to a destination target
(file system/device and directory). It typically performs this task by copying the file
to the destination.
Copy actions can be executed on any action state. This action is Open Workflow
capable.
database
The term database is the common term used to refer to the Vantage domain
database, where all specifications for the domain are stored, along with workflows
and job history.
332 Vantage Glossary
the media to an on-air server and notifies an automation system. For more details,
see the TrafficManager User Guide.
Dublist Portal
Dublist Portal is a client Windows program provided as part of a TrafficManager
license. Dublist Portal enables customers who are performing advertisement
processing to define, manage, and process dublists as part of their automated
TrafficManager workflows.
Edit Decision List
A Vantage edit decision list (EDL) is a list of clips that will be merged together in a
target clip. The list entries specify the start and stop of the clip, and Vantage
supports list entries from multiple media files. Vantage operators use the Workflow
Portal program to create EDLs.
Vantage Edit Service
The Edit Service executes the Playlist actions: Colocate action, Conform action,
Chronicle action, and Compose action. In the case of Conform, the Edit Service may
manage the rendering via an out-of-process resource.
emotion Action
The emotion action is an optional, licensed feature in Vantage. The emotion action
enables Vantage to utilize and interact with Emotion Systems Emotion Engine
audio software.
Error Log
The Error Log utility captures Vantage errors and records the following details: date
and time of error, error source (Vantage service), host computer where the error
occurred, type of error (Info or Error), and error message.
Examine action
An Examine action uses the Vantage Analysis Service to evaluate the video and
audio of a media file to measure certain characteristics, such as audio loudness, or
to detect characteristics, such as the presence and size of curtains. You can
configure it to publish metadata or variables containing the results of analysis.
Exist action
An Exist action uses the Vantage Catalog Service, and allows you to determine if a
binder of a given name (or name fragment) is present in a specified catalog.
Extract action
The Extract action, executed by the Vantage Metadata Service, is used to extract
specific values from element attributes in XML or key-value pairs in JSON metadata.
The Extract action identifies and extracts specific values from structured metadata
and populates variables for use in downstream actions. The Extract action enables
you to browse a sample file and identify the location in the structured data where
the value is located.
The workflow can ingest an XML or JSON file during job execution or by making
web service calls. The Extract action automatically generates XPATH or JSONPath
Vantage Glossary 335
references from the structured metadata in these files to extract the data, and
populates a variable with the value. During execution, each extraction path is
evaluated against the input and the associated variables are populated for use in
downstream actions.
This action is Open Workflow capable if the Open Workflows license is installed.
Faspex Delivery action
A Faspex Delivery action, which is executed by the Vantage Aspera Service, is used
to deliver files to Aspera Faspex servers. Upon delivery, recipients are notified and
can download the package.
Faspex 5 Delivery action
A Faspex 5 Delivery action, which is executed by the Vantage Aspera Service, is used
to deliver files to Aspera Faspex 5 servers. Upon delivery, recipients are notified and
can download the package.
FileCatalyst action
The FileCatalyst action is an optional, licensed feature, which enables Vantage
workflows to access and deliver files to FileCatalyst servers via integrated
FileCatalyst client software. It is executed by the Vantage FileCatalyst Service.
Vantage FileCatalyst Service
The FileCatalyst Service implements the FileCatalyst action for Vantage.
Flip action
A Flip action is executed by the Vantage Transcode Service, and implements the
specified codec, which is used to transcode decoded digital baseband media into
another media encoding format. The Telestream Media Transcode and Analysis
Engine performs the transcode on behalf of Vantage. The Flip action has an Export
command, which allows you to save the configured Flip action as an XML file, for
use in SDK applications.
Flip64 action
The Flip64 action is a Vantage Cloud-capable, 64-bit multi-core-optimized encoder
running under the Vantage Transcode Service (except in Vantage Cloud mode,
when it is executed by the Cloud Service, operating as a proxy of Telestream Cloud).
It transcodes media from one or more input files into another format as specified by
the output configuration you specify. Available resolutions extend from SD to
UltraHD and 4K in a broad range of file formats, from QuickTime to MPEG-4 and
TIFO, and including encoding for x264, x265 (H.265 HEVC), MXF, and more. This
action is Open Workflow capable except when executing in Vantage Cloud mode.
Forward action
A Forward action, which is implemented in every Vantage service, forwards a binder
and all current variables to another workflow, starting a new job with the target
workflow. A Forward action may be added to the end of a workflow, and requires
that the target workflow have a Receive action as its first action.
Typically, workflows are created with a Receive action when they are intended for
execution by another workflow that immediately precedes this one. This ability to
336 Vantage Glossary
Transcode Service except when operating in Vantage Cloud mode, when the Cloud
Service executes it as a proxy for Telestream Cloud. IPTV Flip can optionally run on a
Lightspeed Server for GPU-enhanced x264/x265 encoding and video processing.
The IPTV Flip action and IPTV VOD Service supports the features required to handle
varying IPTV, set-top box and cable encoding requirements, and ancillary metadata
specific to cable ad splicing and cable/IPTV set-top box environments. This action is
Open Workflow capable except when executing in Vantage Cloud mode.
Vantage IPTV VOD Transcode Service
The IPTV VOD Transcode Service is the Vantage component that executes the IPTV
Flip action. This service (which can optionally run on a Lightspeed Server for H264
and HEVC encoding and video processing), supports the features required to
handle varying IPTV, set-top box and cable encoding requirements, and ancillary
metadata specific to cable ad splicing and cable/IPTV set-top box environments.
Transcoding is performed by the Telestream Media Framework on behalf of
Vantage. Rendering may be performed by an out-of-process resource managed by
the IPTV VOD Transcode Service.
job
A job is each execution of a Vantage workflow. Jobs have a state (separate from
action states), and jobs are comprised of actions that are executing. Jobs, like
actions, may be in-process or they may be complete.
As a job executes, each action may be performed by any service (on any computer)
in the Vantage domain that is capable of performing it. The capability of a service to
perform a specific job depends on its current operating state, its workload, and its
suitability, defined by a qualification rule.
Jobs for a given workflow can be viewed in the Vantage Workflow Designer by
selecting the workflow in the Workflow Designer panel and displaying the Job
Status tab. Alternatively, all in-process and failed jobs within a Vantage Domain
may be viewed in the Status details panel of the Management Console.
job routing
See qualification rule and run on rules.
job state
A job state is the current status of a job. Keyword values are In Process | Paused |
Complete | Failed | Waiting | Stopped by User | Waiting to Retry.
Job Status Views Web Application
The Vantage Job Status Views web application is installed on a Vantage web server
and enables you to view real-time information about jobs in the domain from
anywhere on your network with a web browser.
label
A label or metadata label defines a set of metadata by use of name/value pairs
associated with content. For example, a spot label may contain Agency, Author, or
Ad-ID and other metadata values; this set of metadata is collectively called a Spot
metadata label. Metadata labels can be stored in binders with the associated media
and attachment files.
338 Vantage Glossary
Vantage supplies a set of default metadata labels for use in workflows. In addition,
you can create and modify labels for your use using the Management Console
(Workflow Design Items > Metadata Labels).
license
A Vantage license is stored in the Vantage domain database and enables one or
more Vantage features within a Vantage domain. Licenses are delivered as XML files
and imported into the database and activated via the Vantage Management
Console.
Lightspeed Live Capture
Telestream’s Lightspeed Live Capture is a scalable, multi-channel on-premise capture
solution hosted on a Lightspeed Live Server for ingesting live, live linear or tape-
based media directly into production, post-production and broadcast workflows. It
is implemented in two web apps—Live Capture and Tape Capture.
Lightspeed Live Server
Telestream’s Lightspeed Live Server is a 1RU, GPU-enabled, multi-core CPU server
used to host Lightspeed Live Capture and Lightspeed Live Stream.
Lightspeed Live Stream
Telestream’s Lightspeed Live Capture is an enterprise-class, live streaming system
hosted on a Lightspeed Live Server that can ingest, encode, package and deploy
multiple sources to multiple destinations. Lightspeed Live Stream is for
broadcasters and media and entertainment companies that are producing high-
production-value live streaming video that needs to be encoded and packaged for
distribution.
Lightspeed Server
A Vantage Lightspeed Server is a 1RU, GPU-enabled, multi-core CPU server used to
host Vantage services and accelerate video processing and x264 transcoding.
Lightspeed Server accelerates compute-intensive image processing, including
scaling, de-interlacing, frame rate conversion, motion vector calculation, and other
tasks that require computation and analysis to modify or create new video frames.
Lightspeed Live Schedule
Live Schedule is a Windows service-based web application (Scheduling Live
Capture Sessions); an optional, separately licensed feature offered as part of
Lightspeed Live Capture. Live Schedule enables you to create events you want
captured for each source, and automatically starts and stops capturing video on an
event-by-event basis, with optional SDI router control.
Lightspeed Live Play
Live Play is an optional, separately licensed product offered as part of Lightspeed
Live Capture. The Live Play web app is an enterprise-class software solution that
provides flexible and scalable SDI video playback on Telestream’s Lightspeed Live
Server. Live Play enables you to perform confidence monitoring of file-based and
streaming media by playing it back on-screen and via SDI.
Vantage Glossary 339
Listen action
The Listen action uses the Vantage Monitor Service to listen to a cloud-based
message queue and generate jobs from received messages. The Listen action uses
a plugin model for various cloud endpoints such as Amazon Simple Queue Service
(SQS). The content of these messages could be very simple and contain a single
value such as a file path or some sort of identifier to be used, or they could be more
complex such as a blob of json/xml to be processed by a downstream action such
as Extract. The Listen action automatically deletes messages from the queue as it
processes them. Any messages that are present in the queue when the Listen
action starts up will be processed.
Location action
The Location action uses the Cloud Service to determine if a specified file is located
in Cloud-native storage or in local storage with an optional, 24-hour signed URL for
HTTPS access. This information is usually utilized in branching workflows which
execute a given workflow branch based on the location of the file.
Lookup action
The Lookup action is part of the Metadata group and is executed by the Metadata
Service. The Lookup action performs a search operation on a set of key-value pairs
in a master CSV file, based on values extracted from the metadata file associated
with a job submission. If the key is found, the value is returned in the output
variable, for use downstream. Lookup is typically used with a Catch action
workflow, in TrafficManager applications.
Management Console
The Management Console enables Vantage system administrators to effectively
configure Vantage domains, and scale domains across multiple servers to meet
their operating requirements and perform effectively in their environment.
MediaInfo action
The MediaInfo action, which is executed by the Vantage Analysis Service, performs
2 tasks, based on its analysis of the media file and its streams:
- Creates variables from properties, using the MediaInfo API
- Creates a report of the properties and their values.
In each category, you can produce variables of selected metrics with the results the
analysis.
Media Creation action
The Media Creation action uses the Vantage Avid Service to deliver new media to
the specified Interplay server and issue the Interplay commands necessary to check
the file into the Interplay server. This action is Open Workflow capable.
media nickname
A media nickname is an alias or alternate name that is assigned to a media file
during Vantage workflow execution. When a media file is submitted to a workflow,
the actual file name and location is stored in a Vantage binder along with a media
nickname as defined in the workflow. Within the workflow, all references to a file
340 Vantage Glossary
are by media nickname. However, when Vantage needs to access a file, Vantage
uses the actual file name and location stored in the binder.
See attachment nickname and nickname.
MediaMate action
A MediaMate action uses the Vantage MediaMate Service to enable Vantage
workflows to utilize and interact with the Subtitling capabilities of Screen
MediaMate. Each subtitling option provides different capabilities that relate to the
subtitle process.
Vantage MediaMate Service
The MediaMate Service implements the MediaMate Screen software for Vantage,
and provides two-way communication between workflows (and the MediaMate
action) utilizing the MediaMate Screen software itself.
Message action
A Message action is implemented in the Vantage Communicate Service and enables
you to generate and transmit an electronic Message—an email, for example. A
Vantage administrator must configure Vantage to use an SMTP server (Vantage
Management Console: Settings & Options > Email) before email can be utilized.
Vantage Metadata Service
The Metadata Service executes the actions the extract metadata values, and
perform conversions between attachment files, metadata labels, and variables.
Metadata Service actions include the Extract action, the Populate action, and the
Transform action.
Vantage Metric Service
The Metric Service gathers and supplies machine-level information about a specific
Vantage node. It monitors CPU, network, and RAM utilization and reports these to
Vantage. On a Lightspeed server, it also monitors the GPU activity. The bulk of the
information that the Metric Service presents is visualized in the Machine Metrics
section of the Vantage Console. By convention, a Metric Service should be installed
and running on every node in a Vantage domain. If you do not have a Metric
Service running on a specific machine, then that machine will not appear (will not
have an entry) in the Machine Metrics section of the Vantage Console.
Vantage Monitor Service
The Monitor Service is the Vantage component that executes Watch actions and
Associate actions, Camera Ingest action, Workorder action, and Listen action all
relating to the discovery of files and starting jobs.
Move action
A Move action is executed by the Vantage Transport Service, and is used to move a
file from a source target (file system/device and directory) to a destination target
(file system/device and directory). It performs this task by copying the file to the
destination, then deleting the source. The copy first, delete last process insures that
the move completes normally before deleting the source file.
Move actions can be executed on any action state.
Vantage Glossary 341
Multi-Decide action
The Multi-Decide action simplifies a Vantage workflow by allowing multiple phases
of Boolean logic called Decision Groups to be implemented within a single action.
One Multi-Decide action can evaluate many different groups of variables and set a
Result variable to represent the evaluation result for each group.
A key feature is that the Decide groups defined in the action can be chained
together, similar to Compute and Construct actions, so that the Result variable of
one group within the action can feed the input conditions of a subsequent group
within the same action. This provides powerful internal logical processing within a
single Multi-Decide action. The variable values resulting from a Multi-Decide action
can trigger any of several branches in a workflow.
As an example, a Multi-Decide action can implement internal logic to trigger
downstream workflow branches. For example, IF the video format is MXF AND the
video frame rate is 60, THEN IF the bit rate is 35 MB/sec, execute branch 1; IF the bit
rate is 50 MB/sec, execute Branch 2; otherwise, execute Branch 3. IF the video
format is not MXF or the frame rate is not 60, execute Branch 4. The Multi-Decide
greatly reduces the number of Decide actions required per workflow because many
expressions can be grouped into a single action.
Multiscreen Flip action
The Multiscreen Flip action is an optional, licensed feature. Multiscreen Flip actions
are Cloud actions; executed by the Vantage Multiscreen Service in Vantage or by
the Cloud Service operating as a proxy, when executed in Telestream Cloud. The
Multiscreen Service performs adaptive bit-rate encoding and simultaneous
packaging of decoded digital baseband media into multiple bit-rate variants of
H.264/HEVC video and containers in adaptive rate streaming formats, including
Adobe HDS, Apple HLS, Microsoft HSS, and players the support MPEG DASH. You
can configure the Multiscreen action to perform transcoding on a standard
Vantage server or on a Lightspeed Server. This action is Open Workflow capable
except when executing in Vantage Cloud mode.
Vantage Multiscreen Service
The Multiscreen Service is the Vantage component that executes the Multiscreen
Flip action and the DRM action. This service (which can optionally run on a
Lightspeed Server for H264 and HEVC encoding and video processing), supports
the features required to handle varying adaptive bit-rate encoding and packaging
requirements. Transcoding is performed by the Telestream Media Framework on
behalf of Vantage. Rendering may be performed by an out-of-process resource
managed by the Multiscreen Transcode Service.
Nexidia Action
The Nexidia action is an optional, licensed feature in Vantage. It uses the Vantage
Nexidia Service to interact with Nexidia QC servers running Nexidia QC software.
The specified input files are passed to the Nexidia QC software where they are
analyzed using the test profile selected.
342 Vantage Glossary
Populate action
A Populate action uses the Vantage Metadata Service to read and write metadata
labels. During ingest, metadata labels can be added to ingested media and
generally include trim information, audio levels, file properties, and commercial
metadata. The metadata labels can then be reviewed and modified by operators
using Workflow Portal. At any stage of a workflow, Vantage can extract information
from labels using the Populate action, allowing Vantage for example to use trim
points during a transcode, or audio level information when creating the final
broadcast asset. This action is Open Workflow capable.
Post Producer
Post Producer is a specially-licensed set of actions and functionality in Vantage that
enables iterative, template-driven assembly and encoding of assets for publication.
Post Producer workflows automate assembly and reduce production costs by
producing multi-layer video deliverables with transition and image effects, graphic
overlays, and conformed for IPTV and cable VOD production, news or weather
updates, international localization, promo assembly and insertion and
advertisement insertion.
Vantage Publish Service
The Publish service implements the Frame.io actionand Stanza action in Vantage.
Pulsar Action
The Pulsar action is an optional, licensed feature which enables broadcasters to
integrate the Pulsar suite of content verification components directly in Vantage
workflows. It is executed by the Vantage Pulsar Service.
Vantage Pulsar Service
The Pulsar service implements the Pulsar action in Vantage.
qualification rule
A qualification rule influences or controls the routing and execution of actions
among Vantage services of the same type in a distributed Vantage domain.
Qualification rules can be used to ensure that jobs are routed to services that are
best suited for the task. Vantage uses values contained in variables to determine
the suitability of a given service to execute the action.
Qualification rules are exclusively based on variables; they are not based on any
actual machine analysis. As a result, it is up to the system administrator to correctly
set up variables and qualification rules, and apply variables to the appropriate
actions to ensure that jobs are routed correctly.
Qualification rules are created and managed in the Vantage Management
Console> Services.
See also run on rules.
Qualify Action
The Qualify action allows Vantage to execute Quality Control functionality using
the Encoding.com cloud platform and content present in cloud storage. Contact
Telestream support for configuration or account details.
344 Vantage Glossary
Receive action
A Receive action is an origin action which is implemented in every Vantage service.
Receive actions are designed to receive files from other systems: workflows, SDK-
based applications, and Workflow Portal, for example. Files can also be
automatically submitted to a workflow starting with a Receive action from another
workflow using the Forward action.
See Forward action.
Register action
A Register action uses the Vantage Catalog Service to add the binder created by
each job to a Vantage catalog. Register actions can be executed on any action state.
See also Vantage catalog.
Remove action
A Remove action is executed by the Vantage Catalog Service, and is used to
permanently remove a binder from the catalog and set the associated file resources
to expired. If the action succeeds, it emits an action state of Success; otherwise,
Failure.
Report action
A Report action, which is executed by the Vantage Analysis Service, generates a list
of variables and their values and saves them in a file format specified by you.
resource cost
A resource cost is an integer value, implemented in the Vantage Management
Console on each action type to specify a relative computer resource consumption
value in relation to all other action types. This value enables Vantage to maximize
resources and optimize transactions, so that you can tune your Vantage system for
the highest possible throughput on your particular hardware.
retry rules
Retry rules are rules that you can specify on certain actions, to re-execute actions
that fail primarily due to platform access and network latency problems. The retry
rules you set on a given action override the default retry rules established in the
Management Console.
run on rules
Run on rules are rules that you specify on a given action, to qualify which services
have the characteristics that enable them to execute this action. Rules are set up by
specifying variables which have been bound to a given Vantage service and values
set. After configuration, the action can test each rule by comparing its run time
value to the value in the service’s copy and determine if there is a match before
attempting to execute it.
See also qualification rule.
Vantage Glossary 345
Utilization action
A Utilization action enables users to determine the relative load on the domain as
well as transcoding services within the domain. Other downstream actions can
then make intelligent branching decisions based on that information: Telestream
Cloud versus on-premises transcoding of media, for example.
Vantage array
A Vantage array is a Vantage domain whose software components are distributed
among multiple computers for durability and scalability, instead of installed and
operating on a single computer (often referred to as a distributed domain). A
typical array has the Vantage domain database installed on a dedicated server, and
all Vantage services installed on another computer, and additional Transcode
Services each installed on other computers for high-performance, parallel
transcoding.
Vantage catalog
Formal name for catalog. Similar in concept to the folders in a file system, a Vantage
catalog is a container that stores binders. Catalog folders are sub-containers that
organize binders. To access a binder, Workflow Portal operators search through the
visible catalogs and folders, just as they might sort through folders in a file system.
Vantage domain database
A Vantage domain database is a Microsoft SQL Server database which contains all
workflows, actions, jobs, binders, licenses, and configuration information for a
Vantage domain.
Vantage domain
A Vantage domain is a collection of computers, Vantage workflows, actions,
Vantage services, jobs, binders, and configuration settings, all known to and
interacting with each other, stored in a database. This collection constitutes a
Vantage domain. Vantage domains may exist on a single computer or they may be
distributed across many computers for durability and scalability.
The name of a Vantage domain is the same as the name of the server that hosts the
Vantage domain database.
Multiple Vantage domains may exist on a network, but they are independent
entities that do not communicate with each other. They are not bound together
and do not share resources or work. The purpose of storing an entire domain in a
database is to provide an easy way to create and manage the domain and to
provide access to all the details about each resource in the domain to any other
resource that needs it.
Vantage EDL nickname
The nickname Vantage EDL is a reserved nickname that is typically assigned to
media files that are created in catalog ingest workflows, to identify the ingest files
of an Edit Decision List in Workflow Portal, during Stitch and Trim operations. See
media nickname.
350 Vantage Glossary
Windows network folder, etc.) to discover new files. This action is Open Workflow
capable.
When a new file is discovered, the Watch action submits a job for the workflow
which it is part of, for processing the file—typically, a media file.
Web Dashboard
The Web Dashboard is an optional, licensed web app which displays important
domain information from anywhere on your network in a web browser. The Web
Dashboard is installed on the IIS server on your Vantage domain database server.
workflow
A workflow in Vantage is a set of actions designed to perform an automated
process. Vantage workflows are created using the Vantage Workflow Designer by
adding and configuring actions and connecting them together. Workflows are
stored in the Vantage domain database, and executed by Vantage services.
Workflow Designer
Vantage Workflow Designer is a client program that enables you to create and edit
workflows, activate and deactivate workflows, monitor job status, and review and
delete jobs that have completed.
Workflow Portal
Workflow Portal is a client program that features a customizable set of functionality
to support various operator-related tasks: selecting media and submitting jobs,
updating variables and metadata, forwarding jobs, creating EDL-based jobs, etc.
Customization is implemented in the Vantage Management Console, when
Vantage administrators construct the user interface and functionality they want for
a given task, then save it. When operators launch Workflow Portal, they select the
configuration appropriate to the task at hand, and Workflow Portal dynamically
display the user interface components specified in the configuration file.
Workflow Portal Web Application
The Workflow Portal web app is a limited implementation of Workflow Portal, for use
in a web browser over a network or Internet connection.
Workorder action
A Workorder action is an origin action; it uses the Vantage Monitor Service to
regularly poll a target Windows directory for new workorder files to process. The
Workorder action provides a simple and highly effective method of submitting
multiple similar jobs without using the SDK.
When a new file is discovered, the Workorder action submits one job for each row
in the file.
workorder file
A workorder file is a comma-separated value (CSV) text file containing one or more
work orders, or job descriptions. Each row in the CSV file specifies a job, and each
column specifies either an input file for the job, or value for run-time use; typically
assigned to a variable in the workflow. Workorder file configurations are specified
Vantage Glossary 353