Welcome Future Automator!
- Automate Studio Overview
- Creating an Automate Studio Account
- Prerequisites for Using Automate Studio
- Using Automate Studio
- Importing and Exporting Flows and Nodes from Communities
- Create Your First Flow
- Additional Tutorials and Resources
Automate Studio Overview
Veritone Automate Studio puts the power of AI in your hands to simply automate business processes, so you can get to solving faster.
With the drag-and-drop UI, map out your unique combination of data inputs, AI-powered business logic, and desired output, then deploy in one-click to deliver insights in the application of your choice in hours, not months.
To learn more visit veritone.com/automate.
Creating an Automate Studio Account
Is your organization new to Automate Studio?
Get started for free with the Community Plan. This plan enables 1 user to test out the app for commercial use and receives free lifetime credits to run up to 100 flows and cognitively process $300 worth of media.
Sign up here to create an account and gain immediate access to the application.
Need more credits or users?
Contact us about a solution tailored to your team's specific needs. During public beta, Business user licenses are free.
Already an Automate Studio customer?
Prerequisites for Using Automate Studio
- An active Automate Studio account - see the Creating an Automate Studio Account section above for more information.
- Access to the internet - Automate Studio is a Software-as-a-Service (SaaS) application that runs in Veritone’s AWS Commercial or GovCloud environments.
- Unstructured Data Sets - Automate Studio runs on top of the Veritone aiWARE platform which supports unstructured data such as audio, video, images, text, and more for cognitive processing. Structured data can be correlated with cognitively processed unstructured data for greater insight.
Using Automate Studio
The workspace is your canvas to design and optionally run flows within Automate Studio. It is organized by tabs located at the top, delineating and named for each individual flow.
Your building blocks
Nodes input data, execute logic, and output data within a flow. They each encapsulate business logic code or an API query to execute a specific function – inputs, outputs, event, function, storage, and more. They trigger either by receiving a message from a previous node or an external event.
Nodes can be added to the workspace in three ways:
- Node Palette - In the node palette on the left hand side of the Studio, simply click the desired menu arrow to open it and drag and drop a node into the workspace.
2. Quick-Add Dialogue Box - For a quick way to add nodes without the act of dragging and dropping, hold down the Command or CTRL key then click anywhere in the workspace. Search for or scroll and select a node to add it to the workspace. The node list appears with the five core nodes first, recently added second, and all nodes available in the palette in alphabetical order last.
3. Custom Nodes from a Community - Custom nodes not available as a default in the palette can be added imported from the open-source Node-RED community or Veritone's use case library. More information in a later section.
Simply select the node desired and press the delete key.
Editing Node Properties
Once a node has been added, it must be configured to execute your desired function. To edit a nodes configuration, open the Node Configuration sidebar menu by double-clicking the desired node or selecting the node and pressing the Enter key.
The Node Configuration menu has two sections: Node Properties and Node Settings.
Node Properties contains the input form specific to the type of node you are using. Select from the available drop down menus and enter text in input fields, then click the red Done button to save your changes. More on node types in the Palette section.
Node Settings is common to all nodes and allows you to edit the node Inputs and Outputs port labels as well as the icon that displays for the node. Input nodes only have an output port, therefore don't allow you to edit the input port and vice versa for Output nodes. Function nodes allow you to customize both Input and Output ports - simply type in the label desired and click the red Done button to save your changes. To remove the port label, click the X symbol to the right of the field.
To view the edited node port label, hover over the node's port.
To edit the nodes icon, click the icon graphic to the left of the Icon field and search for or scroll to select the icon desired. Revert back to the default node icon by selecting the use default button in the bottom right hand corner of the icon pop up menu.
At this point, your work is not saved and the edited nodes only exist in the Studio. To save your work and deploy the nodes tot he server, click the arrow on the blue Deploy button and Modified Nodes in the dropdown menu. Make sure you deploy prior to leaving your computer idle or logging out of Automate Studio in order to save your work.
Nodes must be wired together to run as a flow. Wires connect from output port to input port and nodes can have at most one input and many outputs.
To wire two nodes together, click the port and hold while dragging the wire to the destination port.
A shortcut is also available to quickly wire nodes together. Hold the CTRL and Command keys while clicking on the initiation port, then release the left mouse button and click the destination port. A wire will automatically form. If CTRL and Command continue to be held and the destination node also has an output port, a wire will begin at the output for the action to be repeated.
To easily insert a node into a flow, drag the node to insert over the wire between two nodes at the location you desire to insert it. The wire will become a dashed line. Then release the mouse, and it will automatically be inserted as well as wired into the flow at that location.
To move a wire that is already placed, press and hold the Shift key then click on the port you would like to remove it from. Hold the Shift key and drag the wire to the new port.
Simply select a wire and press the delete key. If a node is deleted, the wires connected to it will automatically be deleted as well.
Flows represent a process for automation and range from simple to highly complex. They are designed with a repeatable process in mind containing input, function, and output. Flows can be a single set of nodes wired together or contain multiple sets of connected nodes to automate a process.
To add a new flow tab, simply click on the + sign in the top right hand corner of the workspace.
Editing Flow Properties
Double click on the flow's tab to open the Edit flow window.
This window allows you to change the flow's name, enable/ disable it from running, delete it, and write a description for it that will be viewable in the Information panel for other users. Note that the Description editor utilizes Markdown, a lightweight markup language for plain text editing and format. To learn more about Markdown, check out this getting started guide.
Once you have setup your flow's properties, add custom combinations of nodes in your workspace to design intelligent process automations.
Flows can be run in the Studio workspace or as an automation engine within the Veritone aiWARE platform. Choosing a runtime depends on the latency or lack there of and scalability you require.
- Workspace Runtime - minimal latency but not highly scalable as it runs within the confines of Studio's workspace.
- Automation Engine Runtime - latency to initiate the engine with more scalability due to the fact it employs the full aiWARE architecture.
To deploy a flow to the server using the workspace runtime, click the blue Deploy button arrow and Full to deploy all flow changes within the workspace or Modified Flows to only deploy flows that contain changed nodes since your last deployment.
To deploy a flow as an automation engine, these engines are managed in the Veritone Developer application that can be found in the App Switcher in the top right hand corner of the Studio.
Once you navigate to the Developer application, click the blue NEW button in the top left hand side of the header bar and select Engine.
The New Engine wizard will automatically open in the first step, Functionality. Under the Engine Class section, click on the Data cognitive class tile and choose the Automation capability.
Once you've selected the class and capability(s), under the Engine Mode section select the Segment mode.
Next under the Supported Input Types menu, click the input field and select the first choice in the menu application/json. Once selected, click outside of the menu window and click the blue NEXT button in the bottom right hand corner of the screen.
In the second step of the wizard, Deployment Model, select the External Processing deployment model tile. Then, click the blue NEXT button in the bottom right hand corner of the screen.
In the final wizard step, Customize, fill in the engine's name (make sure you will remember it for use within the Studio), description, and optionally an icon as well as the applicable industry.
Next, choose whether your flow requires a machine learning library for training or as a reference. For example, a library of faces and their identities for a face recognition cognitive engine. Read more about library-enabled engines in our docs.
Next, fill in the specific use cases your flow will address. Under the Use Cases section, type in the use case description then click the blue + symbol to the right of the field. Optionally add multiple use cases for your flow. When you are finished, click the blue REVIEW button in the bottom right hand corner of the screen.
Finally, review your automation engine's Engine Summary and select Back to correct errors within the wizard or click CREATE ENGINE PROFILE to finish.
Once you have created your flow's engine profile in the Developer application, select the App Switcher icon and choose Automate Studio to return to the workspace.
To deploy your new automation engine build, click the blue Deploy button arrow and Deploy as Engine. A window will appear in the center of the workspace, search for or scroll and select the name of the engine build you created in the Developer application. Then select the Engine Mode to run, Batch or Chunk. Engine mode in short refers to whether the engine will process data in real-time or not as well as its payload.
- Chunk - use if your flow requires real-time processing of your data set/stream and/or your payload contains a temporal data object (TDO).
- Batch - use if you will be processing data retroactively in batches and your payload consists of executable code.
For flows deployed as automation engines, these engines are managed in the Veritone Developer application that can be found in the App Switcher in the top right hand corner of the Studio.
There are three ways to run flows: manually trigger, schedule, or trigger them with a prescribed event.
To manually trigger or schedule a flow to run, start your flow with an Inject node. By clicking the node's button when deployed within a flow in the workspace, it will manually inject the payload to run your flow.
To schedule the flow to run, double click the Inject node to open the edit it in the Node Configuration in the sidebar menu. Then, in the Repeat dropdown menu, select interval, interval between times, or at a specific time. Click the blue Done button to close the menu.
- Interval - set a time interval that will start from now
- Interval between times - set a time interval that runs in the standard cron system that will begin on the hour
- At a specific time - set a specific time per day for the flow to run in the standard cron system
To trigger a node with a prescribed event, utilize the function trigger or aiWARE event nodes at the beginning of your flow.
- aiWARE event node - receives event messages sent by webhook from the
aiWAREeventing system and reads in the events as
payloadinto the flow.
- Function trigger node - when triggered, can send a message, and then optionally a second message, unless extended or reset.
Simply click the location in the map view you would like to navigate to within the workspace. Deselect the map icon to close the viewer.
Nodes and wires are selected when they are clicked on, but there are many shortcuts that allow you to select multiple items in the workspace quickly:
- Ctrl + Command keys: holding these keys while clicking a node will allow you to add or remove to your current selection
- Shift key: if held while clicking on a node, that node and all other nodes connected to it will be selected.
- Lasso Tool: clicking and dragging your cursor in the workspace enables the lasso tool and selects all nodes within the lasso region.
Unlike nodes, a wire can only be selected when clicked on individually.
To locate a node quickly, search by a node's ID, type, and name or scroll and select a node to add it to the workspace. Simply hold down the Command or CTRL key then click anywhere in the workspace. The node list appears with the five core nodes first, recently added second, and all nodes available in the palette in alphabetical order last.
Alternatively, you can also filter nodes within the Node Palette by entering a node's ID, type, or name in the search bar located at the top of the Node Palette.
Customize your workspace view by selecting the menu icon in the top right hand corner of the Studio > Settings > View. In this menu, select whether you would like a grid or plain white background in the workspace.
You can also choose whether to see node statuses in the workspace and user tips in the bottom right hand corner of the Studio.
Discover and customize keyboard shortcuts by selecting the menu icon in the top right hand corner of the Studio > Settings > Keyboard. In this menu, look up existing keyboard shortcuts, customize existing shortcuts, and assign shortcuts to unassigned actions.
Click the shortcut column next to the desired action to edit or assign a shortcut.
The Node Palette is located on the lefthand side of the Studio and serves as your menu for nodes to add to flows within the workspace.
The Palette is separated into separate drop down menus by node type. Within each menu, hover your cursor over a node in the node palette to learn what it does.
If you there is a node you would like to add, check out the Palette Manager. Click the three line menu in the top righthand corner of the Studio and select Manage Palette in the dropdown menu.
The Palette Manager has two sections: Nodes that displays a list of node modules that are already installed in the Automate Studio runtime and Install that displays a list of available nodes that can be installed from the greater Node-RED community.
Under the Nodes tab, you can view the currently installed node modules including their version and a list of the nodes installed as a part of that module.
Optionally, update, remove, or disable all the nodes within each module by selecting the corresponding button next to the module in the list. Note that if a module displays a grayed out in use button, that this module can not be removed or disabled until the associated nodes are no longer in use within the workspace.
You may also filter the list by searching for a specific module within the search bar at the top of the list.
Under the Install tab, search within the greater Node-RED community for available node modules to install within your Palette.
Simply search by keyword or module name within the search bar at the top of the list. Results show available node modules with details, last update, and link to their documentation. Click the install button next to the desired node module to add it to your Palette.
On the right side of the Studio, is located the Sidebar which contains four different tools including the Information, Debug, Configuration Nodes, and Context Data sidebar panels.
To open a particular panel, click the corresponding icon or drop down menu arrow at the top righthand side of the Sidebar.
The sidebar can be resized by dragging the edge nearest the workspace to make it wider, more narrow, or hide it by dragging the edge all the way to the outer edge of the Studio. Once hidden, display the Sidebar again by selecting the stacked menu icon > View > Show Sidebar.
This sidebar show information about the current node including properties and help text. If you haven't selected anything, it will show the information about the current open flow which can be edited within the Flow Properties edit dialog box.
This sidebar displays the messages Debug nodes receive within a flow in addition to logs from the runtime.
Messages in the sidebar can be filtered by all nodes within the workspace, selected nodes from a dropdown list of all available nodes, and current flow which displays messages from nodes in the flow tab currently open within the workspace. In the Debug panel, click the filter icon set on all nodes as default then select the button desired to filter debug messages.
The Config panel shows a list of config nodes used On all flows and within each flow tab currently within the workspace. Select each dropdown menu to see which config nodes are being used. Within the On all flows menu, those that are not in use will be outlined with a gray dotted line. Double click on a used config node to open its edit dialog.
Filter your view by to show all or unused config nodes by selecting the filter buttons in the header of the sidebar.
Context refers to a way to store information shared between nodes without using the messages passed within a flow. There are three context levels: node, flow, and global:
- Node - only visible to the node that set the value
- Flow - visible to all nodes in the same flow or tab in the workspace
- Global - visible to all nodes
The three sections in the sidebar correspond to the different context levels. Node shows context for the currently selected node, Flow for the current flow tab open, and Global for all nodes deployed in the workspace. To display the contents of the context data store, click the refresh icon in that section or hover your mouse over a context property name and select the refresh icon that appears to refresh just that value.
Importing and Exporting Flows and Nodes from Communities
Get started with Veritone and Node-RED Community pre-built flows and nodes.
Click the menu icon and select Import to add existing flows or Manage Palette to add nodes into the Automate Studio palette.
Once you find the flow or node you want, in Automate Studio click the menu and select import, export, or manage palette to leverage Veritone and Node-RED community nodes and flows in Automate Studio as well as the Node-RED Editor.
Create Your First Flow
That's all folks! Now that you know Automate Studio from A - Z, try your hand at building your first flow with the Create Your First Flow guide.
More Tutorials and Resources
Need help or have a question? Check out more Veritone Automate Studio resources: