> ## Documentation Index
> Fetch the complete documentation index at: https://docs.up.telestream.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UP.Workflow Design

You can design workflows using UP.Workflow Designer.

# **Workflows**

A workflow represents a series of Actions and the sequence in which these actions are executed. Each action references a specific context in which that action is executed.

You can design a workflow to perform a controlled, automated media-processing task. While most workflows center around decoding and encoding video, you can also construct workflows that process metadata files, or perform other tasks. You can create and revise workflows, either manually or assisted by the AI UP.Workflow Designer.

# **Preparation for UP.Workflow Design**

Before constructing a workflow, clearly define its objective—what you want to accomplish with it. Determine which actions you need to achieve the objective. Consider the following:

* Where the media, metadata, and associated files originate
* What transcoding and metadata processing are required
* Where any new copies of media, metadata, and associated files should be stored or deployed
* Which external systems these jobs will interact with
* Whether you want to register and track the output files and metadata related to each job

With these details, you can construct the workflow, and configure each action to correctly perform its assigned task. If you don't have all this information at the start, you can configure the workflow later.

# **UP.Workflow Basics**

To construct and configure workflows in the *Create New Workflow* view, add various types of actions, such as Analysis, Flip, or Copy. Then connect the Actions to form a chain of sequential tasks.

Start a valid workflow with an origin action. Workflows should only have a single origin action.

Workflows are executed by jobs. Jobs are executed whenever a new file is discovered by a workflow’s origin action, or when you submit a job manually.

You don’t need to end a workflow with a terminating action. Workflows automatically terminate once the last action in the graph has executed.

Generally, construct a workflow in stages. First, conceptualize and design the workflow. Then add the actions. Connect them together to control execution. Finally, configure each action in the workflow to perform exactly the way you want. Test your workflow, and fine tune it as needed.

Once you have constructed and configured a workflow, click Activate to make it usable in UP.

To disable a workflow and prevent it from accepting new jobs, simply Deactivate it.

You can edit new drafts and versions of workflows while they are active. The version of the workflow that was activated is the one that will process incoming requests for new jobs.

# **Creating a Workflow Manually**

To create a new workflow, do the following:

1. In UP, select the Space desired.
2. Browse to *Workflow* > *Manage Workflows* .\
   Workflow displays a list of *Categories* in the *Manage Workflows* view of the Space selected.
3. Select a category from the list of *Categories*.\
   UP.Workflow displays a list of workflows in the selected Space and category.
4. Click the *Create New* button to the upper-right of the *Manage Workflows* view.\
   UP.Workflow opens the *Create New Workflow* pane.
5. Enter a *Workflow Name*.
6. In the *Category* field, do one of the following:
   * Select an existing category from the drop-down menu.
   * Create a new category by entering a category name into the *Category* field, and clicking *Add New*.
7. (Optional) Enter a description of the workflow into the *Description* field.
8. Enter an expiration time, in hours, into the *Expire Jobs After* field. This value will determine how long job history is maintained for this workflow.
9. (Optional) Enter any tags desired.\
   You can use tags to quickly find related workflows across the entire UP. (Upcoming Feature).
10. Click the *Create* button.\
    UP.Workflow opens the *UP.Workflow Designer* in your browser.\
    To the upper-left of the *UP.Workflow Designer* , the lock/unlock icon shows whether the workflow is locked or unlocked, and the status icon displays whether the workflow is in the *Active* or *Inactive* state. You can submit jobs only to *Active* workflows.
11. To open the menu of actions, click the *Actions Button*.\
    UP.Workflow opens the *Actions* pane.
12. Drag any desired actions from the *Actions* pane onto the workflow canvas.
13. To open the menu of templates, click the *Template Library Button*.
14. Drag any desired templates from the *Template Library* pane onto the Workflow Designer canvas.
15. To connect actions, drag lines from the output pins of specific actions to the input pins of other actions, as desired.\
    You can connect a single output to multiple inputs.

<Note>
  To delete a connection, hover your cursor over the connection line until a red “x” appears. Click the “x” to delete the connection.
</Note>

16. Enter descriptions into the *Description* fields of actions, as desired.
17. Select *Nicknames* or *Variables* to appear on actions, using the *Nicknames/Variables Drop-Down Menu Button*.
18. To edit the properties of any action, double-click the action.\
    UP.Workflow opens the action configuration pane.
19. (Optional) To view additional options for an action, click the three-dot button to the upper-right of the action card.

<Note>
  If there is anything badly configured for an action, a yellow caution icon appears in the lower-right corner of the action. Hover your cursor above the icon to view details about the problem.
</Note>

20. To view a list of all actions in the workflow, click the *Outline Button*.
21. To save the workflow, click *Save*.

For information about the various controls in the Manage Workflows view, see *Manage Workflow View*.

# **Revising an Existing Workflow Manually**

To revise an existing workflow, do the following:

1. In UP, select the Space desired.
2. Browse to *Workflow* > *Manage Workflows*.\
   UP.Workflow displays a list of *Categories* in the selected Space.
3. Select a category from the list of *Categories*.\
   UP.Workflow displays a list of workflows in the selected Space and category.
4. (Optional) If desired, use the tabs at the top of the Manage Workflows view to filter the workflows displayed.
5. To alter a workflow, use the buttons to the right of the workflow canvas, and the other controls for the workflow canvas.

For information about the various controls in the *Manage Workflows* view, see *Manage Workflow View*.

# **Editing the Details of an Existing Workflow**

To edit the details of an existing workflow, do the following:

1. In UP, select the Space desired.
2. Browse to *Workflow* > *Manage Workflows*. UP.Workflow displays a list of *Categories* in the selected Space.
3. Select a category from the list of *Categories*. UP.Workflow displays a list of workflows in the selected Space and category.
4. (Optional) If desired, use the tabs at the top of the Manage Workflows view to filter the workflows displayed.
5. Do one of the following:
   * Right-click the listing for the desired workflow and select *Edit Details* from the drop-down menu.
   * Select the desired workflow and click the *Edit Details* button towards the top of the listing of workflows.
   * UP.Workflow displays the *Edit Workflow* pane.
6. Edit the details in the *Edit Workflow* pane as desired.
7. Click *Save*.

# **Creating a Workflow with the AI Workflow Builder**

You can save time, and learn the basics of building workflows with the AI Workflow Builder. To create a new workflow with the AI Workflow Builder, do the following:

1. In UP user interface, browse to *Workflow* > *Manage Workflows*.
2. Select a category for the new workflow.
3. Create a new workflow and use the prompt field to describe what you want the workflow to accomplish. Be as detailed and precise as possible to insure the AI Workflow Builder has the information needed to create a proper workflow graph.
4. Click the *Generate* button. UP.Workflow creates the workflow containing the necessary actions and connections on the Workflow Designer canvas, fills in the details on each action, and commits the workflow graph to the designer ready for editing and final preparation.
5. Revise the workflow and workflow actions as needed.
6. Save and Activate your workflow when you are ready to start processing media.

# **Describing an Existing Workflow with the AI Workflow Builder**

To let the AI Workflow Builder write a description for an existing workflow, do the following:

1. Launch the *Edit Workflow* pane for the desired workflow. See *Editing the Details of an Existing Workflow*.
2. Click *Generate AI Summary* towards the bottom of the *Description* field. UP.Workflow generates a description of the workflow in the *Description* field.
3. Do one of the following:
   * To accept the description, click *Accept* towards the bottom of the *Description* field.
   * To deny the description, click *Deny* towards the bottom of the *Description* field.
4. Click *Save*.

# **Archiving a Workflow**

To archive a workflow, do the following:

1. In UP, select the Space desired.
2. Browse to *Workflow* > *Manage Workflows*. UP.Workflow displays a list of *Categories* in the selected Space.
3. Select a category from the list of *Categories*. UP.Workflow displays a list of workflows in the selected Space and category.
4. Select a workflow for archiving.
5. In the *Manage Workflow View* , do one of the following:
   * Right-click the workflow for archiving, and select *Archive.*
   * Select the workflow for archiving, click the three-dot button to the extreme-right of the workflow listing, and select *Archive.*
   * Select the workflow for archiving, click the three-dot button above the list of workflow, and select *Archive* UP.Workflow displays the *Archive Workflow* dialog.
6. Click *Archive*. UP.Workflow moves all versions of the workflow to the *Archived* view, retaining the job history for the workflow and the details of all the actions in the workflow.

# **Viewing Archived Workflows**

* To view archived workflows, click the *Archived* button. You can view all the details of a workflow and its actions in the *Archived* view. However, you can’t revise any workflow while it’s in the *Archived* view.

# **Restoring a Workflow from the Archive**

To restore a workflow from the archive, do the following:

1. On the *Manage Workflow View* , click the *Archived* button. UP.Workflow displays the archived workflows view.
2. Right-click the workflow to be restored, and select *Restore* from the drop-down menu. UP.Workflow displays the *Restore Workflow* dialog.
3. Select a category from the drop-down menu.
4. Click the *Restore* button. UP.Workflow moves the workflow from the archived workflows view to the view of all workflows.

# **Deleting a Workflow**

To delete a workflow from the archive, do the following:

1. In the *Manage Workflow View* , click the *All* button. UP.Workflow displays all available workflows.
2. Do one of the following:
   * Select the workflow to delete, and click the *Delete* button above the list of workflows.
   * Right-click the workflow for deleting, and select *Delete.*
   * Select the workflow for deleting, click the three-dot button to the extreme-right of the workflow listing, and select *Delete.*
3. In *Delete Workflow* dialog, click the *Delete* button. UP.Workflow moves the workflow from the view of all workflows to the *Deleted* view.

<Note>
  30 days after moving a workflow to the *Deleted* view, UP.Workflow automatically deletes the workflow permanently. The PERMANENT DELETE column displays the time remaining before UP.Workflow permanently deletes a workflow.
</Note>

# **Viewing Deleted Workflows**

* To view deleted workflows, click the *Deleted* button. You can view all the details of a workflow and its actions in the *Deleted* view. However, you can’t revise any workflow while it’s in the *Deleted* view.

# **Restoring a Workflow from the Deleted View**

You can restore a workflow from the *Deleted* view for 30 days after it was deleted. To restore a workflow from the deleted view, do the following:

1. On the *Manage Workflow View* , click the *Deleted* button. UP.Workflow displays the *Deleted* view.
2. Right-click the workflow to be restored, and select *Restore* from the drop-down menu. UP.Workflow displays the *Restore Workflow* dialog.
3. Select a destination category from the drop-down menu.
4. Click the *Restore* button. UP.Workflow moves the workflow from the archived workflows view to the view of all workflows.

# **Describing an Action with the AI Workflow Builder**

Actions are the workhorses of UP.Workflow, providing numerous tools and settings for media management. To let the AI Workflow Builder write a description for an action, do the following:

1. Create a new workflow, or open an existing workflow.\
   See *Creating a Workflow Manually* and *Revising an Existing Workflow Manually*.
2. To open the menu of actions, click the *Actions Button*.
3. Drag any desired action from the *Actions* pane onto the workflow canvas.
4. Click the description field for the action.
5. Click Generate AI Summary towards the bottom of the action description field.\
   UP.Workflow enters a summary of the action into the action description field.
6. Do one of the following:
   * To accept the description, click *Accept* towards the bottom of the *Description* field.
   * To deny the description, click *Deny* towards the bottom of the *Description* field.

# **Creating a Template on the Workflow Designer**

You can save workflows containing any number of actions as templates you can re-use on any of your media assets.

To create a workflow template from an existing workflow, do the following:

1. Open or create a workflow.
2. Click-hold and drag a lasso around the actions you want to save as a template. UP.Workflow creates a bounding box around the selected actions, and displays two buttons, *Save Template* and *Group Actions* below the selection.
3. Click *Save Template*. UP.Workflow opens the *Create New Template* pane.
4. In the *Create New Template* pane, select one of the following options, as desired:
   * Create new template
   * Overwrite existing template
5. Enter a name for the new template into the *Template Name* field, or select the name of an existing template to overwrite from the *Template* drop-down menu.
6. Select a template category from the *Category* drop-down menu.
7. Add information to the *Description* and *Tags* fields as desired.
8. Click *Create* or *Overwrite*. UP.Workflow adds, or overwrites, a tab for the template in the *Template Library* , in the chosen category.

# **Using Templates in the Workflow Designer**

To use a template in a new workflow, start the new workflow and drag the template onto the Workflow Designer canvas.

<Note>
  UP.Workflow does not propagate changes made to a template into workflows already containing that template.
</Note>

# **Creating Templates from Settings**

To create a workflow template via UP.Workflow *Settings* , do the following:

1. In UP, browse to *Workflow* > *Settings* > *Templates*.\
   UP.Workflow opens the Template Designer.
2. (Optional) To add a category of templates, do the following:
   * Click the “+” button toward the top of the Categories pane.\
     UP.Workflow opens the *Create New Category* dialog.
   * Enter a name into the *Category Name* field, and click *Create*.\
     UP.Workflow adds the name of the new category to the Categories pane.
3. Click the *Create New* button to the upper-right of the Template Designer.\
   UP.Workflow opens the *Create New Template* pane.
4. Enter a name into the Template Name field.
5. Select a category from the Category drop-down menu.
6. Add a description and tags as desired.
7. Click *Create*.\
   UP.Workflow opens the Template Designer canvas.
8. Create a template the way you’d create a workflow on Workflow Designer.\
   UP.Workflow saves the new template to the *Template Library* automatically.

# **Editing Templates from Settings**

To edit a workflow template via UP.Workflow *Settings* , do the following:

1. In UP, browse to *UP.Workflow* > *Settings* > *Templates*.\
   UP.Workflow opens the Template Designer.
2. From the Categories pane, select a template to edit.
3. Edit template as you would edit a workflow on Workflow Designer.\
   See *Revising an Existing Workflow Manually*.\
   UP.Workflow saves the changes to the template automatically.

# **Renaming a Template from Settings**

To rename a category via UP.Workflow *Settings* , do the following:

1. Click the three-dot button to the right of the category name in the Categories pane.\
   UP.Workflow expands a drop-down menu.
2. Select *Rename Category*.\
   UP.Workflow opens the *Rename Category* dialog.
3. Enter a new name for the category in the *Category Name* field.
4. Click *Rename*.

# **Deleting a Template from Settings**

To rename a category via UP.Workflow *Settings* , do the following:

1. Click the three-dot button to the right of the category name in the Categories pane.\
   UP.Workflow expands a drop-down menu.
2. Select *Delete Category*.\
   UP.Workflow opens the *Delete Category* dialog.
3. Click *Delete Category*.

# **Viewing a Workflow Version History**

* To view the version history of the workflow, click the *Version History Button*.\
  UP.Workflow opens the *Version History* pane, which displays a list of version tabs for the workflow.

# **Comparing Two Workflow Versions**

To compare two workflow versions in the Workflow Designer, do the following:

1. To view the version history of the workflow, click the *Version History Button*.\
   UP.Workflow opens the *Version History* pane, which displays a list of version tabs for the workflow.
2. Select the tab for the desired earlier version in the *Version History* pane.\
   UP.Workflow displays the earlier version in the Workflow Designer, opens a button bar above the Workflow Designer, and displays a button for the earlier version in the button bar, next to the button for the current version.
3. To toggle between versions displayed in the Workflow Designer, click the button in the button bar for the desired version.

# **Comparing Multiple Workflow Versions**

To compare multiple workflow versions in the Workflow Designer, do the following:

1. To view the version history of the workflow, click the *Version History Button*.\
   UP.Workflow opens the *Version History* pane, which displays a list of version tabs for the workflow.
2. Select a tab for the first desired earlier version in the Version History pane.\
   UP.Workflow displays the earlier version in the Workflow Designer, opens a button bar above the Workflow Designer, and displays a button for the earlier version in the button bar, next to the button for the current version.
3. To keep the earlier version button in place in the button bar, click the pin in the button for the earlier version.\
   UP.Workflow pins the button in place in the button bar.
4. Select a tab for another desired earlier version in the Version History pane.\
   UP.Workflow displays the earlier version on the Workflow Designer canvas, and displays a button for the earlier version in the button bar, next to the first two version buttons.
5. To toggle between versions displayed on the Workflow Designer canvas, click the button in the button bar for the desired version.

# **Creating a New Workflow Version**

Once UP.Workflow has saved a version, you can’t edit that version. However, you can create a new version based on the saved version, and save the new version. To create a new version of a workflow, do the following:

1. Select the desired workflow.\
   UP.Workflow opens the latest version of the selected workflow, even if the latest version is in draft mode.
2. Click the *Version History Button*.\
   UP.Workflow opens the *Version History* pane, which displays a list of version tabs for the workflow.
3. In the *Version History* pane, select the workflow version you want to edit.\
   UP.Workflow displays the workflow on the *Workflow Designer View*.
4. Add, delete, or change any action on the Workflow Designer canvas.\
   UP.Workflow automatically creates a draft version of the revised workflow, adds a version tab to the *Version History* pane, and displays the message, *Unsaved Changes* to the top-right of the Workflow Designer.

<Note>
  The *Manage Workflows* view displays a pencil icon next to the name of any workflow in draft status. When you hover your cursor over the pencil icon, UP.Workflow displays a message stating who is editing the draft.
</Note>

5. Do one of the following:
   * To overwrite the last-saved version of the workflow with the current draft, click *Save*.
   * Click the downward-pointing arrow next to the *Save* button. Select *Save As New Version*, or *Discard Changes*, as desired.

When UP.Workflow opens the Save As New Version dialog, enter data into the *Version Name* and *Add Notes* fields as desired, and click *Save*.

# **Restoring a Previous Version**

You can restore a previous version of a workflow to make it again the current version. To restore a previous version of a selected workflow, do the following:

1. On the version tab for the desired previous version, click the three-dot button to the upper-right of the version tab.\
   UP.Workflow expands a drop-down menu.
2. Select *Restore*.\
   UP.Workflow displays the *Restore Version* dialog.
3. Click Restore.

# **Deleting a Previous Version**

To delete a previous version of a selected workflow, do the following:

1. On the version tab for the desired previous version, click the three-dot button to the upper-right of the version tab.\
   UP.Workflow expands a drop-down menu.
2. Select *Delete*.\
   UP.Workflow displays the *Delete Current Version* dialog.
3. Click *Delete*.