MN007834A01-AD Enus Orchestrate User Guide
MN007834A01-AD Enus Orchestrate User Guide
Trademarks
MOTOROLA, MOTO, MOTOROLA SOLUTIONS, and the Stylized M Logo are trademarks or registered
trademarks of Motorola Trademark Holdings, LLC and are used under license. All other trademarks are the
property of their respective owners.
License Rights
The purchase of Motorola Solutions products shall not be deemed to grant either directly or by implication,
estoppel or otherwise, any license under the copyrights, patents or patent applications of Motorola Solutions,
except for the normal nonexclusive, royalty-free license to use that arises by operation of law in the sale of a
product.
European Union (EU) and United Kingdom (UK) Waste of Electrical and Electronic
Equipment (WEEE) Directive
The European Union's WEEE directive and the UK's WEEE regulation require that products sold into
EU countries and the UK must have the crossed-out wheelie bin label on the product (or the package in some
cases). As defined by the WEEE directive, this crossed-out wheelie bin label means that customers and end
users in EU and UK countries should not dispose of electronic and electrical equipment or accessories in
household waste.
Customers or end users in EU and UK countries should contact their local equipment supplier representative
or service center for information about the waste collection system in their country.
Disclaimer
Please note that certain features, facilities, and capabilities described in this document may not be applicable
to or licensed for use on a specific system, or may be dependent upon the characteristics of a specific mobile
subscriber unit or configuration of certain parameters. Please refer to your Motorola Solutions contact for
further information.
© 2024 Motorola Solutions, Inc. All Rights Reserved
2
MN007834A01-AD
Contact Us
Contact Us
The Centralized Managed Support Operations (CMSO) is the primary contact for technical support included
in your organization's service agreement with Motorola Solutions. To enable faster response time to customer
issues, Motorola Solutions provides support from multiple countries around the world.
Service agreement customers should be sure to call the CMSO in all situations listed under Customer
Responsibilities in their agreement, such as:
● To confirm troubleshooting results and analysis before taking action
Your organization received support phone numbers and other contact information appropriate for your
geographic region and service agreement. Use that contact information for the most efficient response.
However, if needed, you can also find general support contact information on the Motorola Solutions website,
by following these steps:
1. Enter motorolasolutions.com in your browser.
2. Ensure that your organization's country or region is displayed on the page. Clicking or tapping the name
of the region provides a way to change it.
3. Select "Support" on the motorolasolutions.com page.
Comments
Send questions and comments regarding user documentation to documentation@motorolasolutions.com.
Provide the following information when reporting a documentation error:
● The document title and part number
● The page number or title of the section with the error
● A description of the error
Motorola Solutions offers various courses designed to assist in learning about the system. For information, go
to https://learning.motorolasolutions.com to view the current course offerings and technology paths.
3
MN007834A01-AD
Document History
Document History
Version Description Date
MN007834A01-AA Connection Center on page 16 was updated. October 2023
MN007834A01-AB The following sections were updated: January 2024
● Orchestrate Dashboard with Existing Configuration
on page 12
● Connection Center on page 16
MN007834A01-AC The manual was redesigned to describe the default May 2024
user workflow within Orchestrate.
MN007834A01-AD Monitor Center on page 32 was added. October 2024
The following sections were updated:
● Enabling/Disabling Workflows Globally on page 28
● System Health Dashboard on page 35
● Orchestrate Permission List on page 44
4
MN007834A01-AD
Contents
Contents
Intellectual Property and Regulatory Notices................................................................... 2
Contact Us............................................................................................................................3
Document History................................................................................................................4
About This Manual...............................................................................................................7
Related Information..................................................................................................................................7
Chapter 1: Orchestrate Overview....................................................................................... 8
1.1 Safety and Security Ecosystem......................................................................................................... 8
1.2 Logging On to Orchestrate.................................................................................................................8
1.3 Orchestrate Dashboard Overview....................................................................................................10
1.3.1 Orchestrate Dashboard with Existing Configuration.......................................................... 12
1.3.2 Workspaces........................................................................................................................12
1.3.3 Search Field....................................................................................................................... 13
1.4 Selecting Orchestrate Theme.......................................................................................................... 15
Chapter 2: Connection Center.......................................................................................... 16
Chapter 3: Orchestrate Dashboard Management............................................................18
3.1 Managing Workspaces.....................................................................................................................18
3.2 Sharing Workspaces........................................................................................................................19
3.3 Workflows Management...................................................................................................................20
3.3.1 Creating Workflows............................................................................................................ 21
3.3.1.1 Touch Support...................................................................................................... 24
3.3.1.2 Smaller Displays Support..................................................................................... 25
3.3.2 Creating On-Failure Workflows.......................................................................................... 25
3.3.3 Deleting Actions and Triggers............................................................................................ 26
3.3.4 Deleting Workflows.............................................................................................................26
3.3.5 Duplicating Workflows........................................................................................................27
3.3.6 Renaming Workflows......................................................................................................... 27
3.3.7 Replacing Dead Nodes...................................................................................................... 27
3.3.8 Enabling/Disabling Workflows............................................................................................28
3.4 Enabling/Disabling Workflows Globally............................................................................................28
3.5 Moving Workflows to Different Workspaces.....................................................................................29
3.6 Enabling Workflow Suppression...................................................................................................... 30
3.7 Simulating Workflows.......................................................................................................................30
Chapter 4: Monitor Center................................................................................................. 32
4.1 Runtime Data Table......................................................................................................................... 32
4.1.1 Filtering Runtime Data Table..............................................................................................33
5
MN007834A01-AD
Contents
6
MN007834A01-AD
About This Manual
Related Information
Go to https://learning.motorolasolutions.com/ to view the current course offerings and technology paths.
For associated information, refer to the following documents:
7
MN007834A01-AD
Chapter 1: Orchestrate Overview
Chapter 1
Orchestrate Overview
Orchestrate is a cloud-based interface tool designed to allow customers to define connections between their
products. It is part of the Safety and Security Ecosystem.
In Orchestrate, administrators can create rule-based, automated workflows between technologies to enhance
efficiency, and improve response times, effectiveness, and overall safety.
Orchestrate equips network operations teams with the capability to detect triggers across a number of
installed devices and, consequently, to quickly take actions to reduce risk of breaches and downtime by
automatically executing the proper procedure. Orchestrate helps accelerate reliable network configuration
changes, so that teams can increase agility, reduce costs and strengthen security.
1.1
Safety and Security Ecosystem
Safety and Security Ecosystem is an integrated technology ecosystem that unifies voice, data, video, and
analytics to connect and empower the individuals who keep our communities safe.
The common platform that these Motorola Solutions technologies are built upon allows for the aggregation of
all data generated throughout an enterprise to create powerful workflows and collaborations:
● Unified communications to enable team collaboration with voice and multimedia
● Centralizing all data to drive deeper analytics, and to ensure that data can be shared and accessed by all
appropriate teams
● Allowing the users to connect across an entire event lifecycle, to better detect, analyze, communicate,
and respond when incidents arise.
Eventually, the Enterprise Platform will encompass an entire portfolio of solutions. As the API becomes
standardized, new Motorola Solutions products or third-party solutions can be easily integrated into the
platform and workflows.
When all of the components of the technology ecosystem are built on one common platform, it allows for
a seamless sharing of data across applications, devices, and teams, and it also enables the creation of
customized and automated technology workflows.
1.2
Logging On to Orchestrate
Prerequisites: Obtain your username or email address, and your password. For details, contact Motorola
Solutions.
Procedure:
1. In your Chrome browser, enter the Orchestrate URL:
For US customers: orchestrate.commandcentral.com
For Canada customers: orchestrate.commandcentral.ca
The CommandCentral Sign On Window appears.
8
MN007834A01-AD
Chapter 1: Orchestrate Overview
If a new feature or a UI change has been introduced since your last logon, a pop-up box with the newest
release notes displays, where you can see the full list of new features. When you close that view, it will not
appear again on your next logon.
9
MN007834A01-AD
Chapter 1: Orchestrate Overview
1.3
Orchestrate Dashboard Overview
When you log on to an Orchestrate account, your Orchestrate dashboard appears. For new accounts, the
dashboard is initially empty.
At the top of the screen, the Common Header is located. In the Common Header you can access the
Application Switcher that allows you to switch to other applications from the CommandCentral suite, or
access a user help.
Figure 3: Common Header Icons
Below the Common Header is the Orchestrate dashboard. It consists of workspaces – within each
workspace, users can create workflows that consist of triggers and actions.
A workflow defines integrations across multiple products. Triggers represent the events originating from
various sensors, software, and devices supported by our technology ecosystem. Actions represent the
possible responses to these triggers.
After a workflow is deployed, its actions activate when the triggers occur.
To start working with workspaces and workflows, you must first configure the products that work with
Orchestrate. When a product is properly configured, its available list of triggers and actions becomes
10
MN007834A01-AD
Chapter 1: Orchestrate Overview
available for you in the workflow creation screen. Product configuration takes place in the Connection Center.
When you do not have any products configured in Orchestrate, a Connection Center Call to Action displays in
the center of the dashboard.
Figure 5: Connection Center Call to Action
For more information on configuring products, see Connection Center on page 16.
When you have products configured in Orchestrate, you can now start managing your dashboard by creating
workspaces and workflows. For more information, see Workspaces on page 12 and Orchestrate Dashboard
Management on page 18.
11
MN007834A01-AD
Chapter 1: Orchestrate Overview
1.3.1
Orchestrate Dashboard with Existing Configuration
When you have products configured in the Connection Center, all workflows specified in your organization
display in the dashboard on succesful signon.
Figure 6: Orchestrate Dashboard with Workflows
1.3.2
Workspaces
In your dashboard, all workflows defined for your organization are organized within workspaces. Each
workflow defines the connection and interactions between your products.
By double-clicking a workflow card you can access the workflow creation screen – for more information, see
Creating Workflows on page 21.
The workspaces in your dashboard and the workflows within each workspace are displayed in alphabetical
order.
At the top of the dashboard, the following items display:
● My workspaces drop-down list that includes all the workspaces defined in your organization,
● New workspace button used to create new workspaces,
● the number of created workflows (separate counters for the workflows with issues, the enabled workflows,
and the disabled workflows are available).
● Enter search terms... field, where you can search for specific workflows or nodes. For more
information, see Search Field on page 13.
The dashboard can be divided into separate workspaces, according to your organization's needs (in the
example, these are Elementary school, High school, and Middle school). In a workspace you can create
new workflows and manage the existing ones. Each workspace may contain a different set of workflows, and
you can select a specific workspace to view only the workflows created in that specific workspace.
12
MN007834A01-AD
Chapter 1: Orchestrate Overview
To return to the overview of all the workflows in your organization, at the top of the dashboard, from the My
workspaces drop-down list select Show all.
1.3.3
Search Field
By using the search field, you can filter your active workspace to display only the workflows that include a
searched text string in their titles, or the workflows that include triggers or actions containing the entered text
string.
After you enter a text string in the search field, your active workspace is filtered to display only the relevant
results.
NOTE: Punctuation marks are not searchable.
When Show all is selected under My workspaces, the results from all workspaces in your organization
display.
13
MN007834A01-AD
Chapter 1: Orchestrate Overview
If you select a specific workspace from My workspaces list, the possible relevant results from other
workspaces do not display.
Figure 10: Workflow Not Found
The search results also include the workflow cards which triggers or actions contain the searched text string.
Figure 11: Searching for Text String in Nodes
You can use quotation marks (“ “) to narrow down your search only to results that contain the specific text
string independently. See the following figure for the comparison of search results with and without quotation
marks:
14
MN007834A01-AD
Chapter 1: Orchestrate Overview
1.4
Selecting Orchestrate Theme
In the Orchestrate Settings you can select the theme of your interface by choosing between the Light Mode
and the Dark Mode.
Procedure:
15
MN007834A01-AD
Chapter 2: Connection Center
Chapter 2
Connection Center
Authorized users have access to the Connection Center configuration section, where they can view and
configure their products that integrate with Orchestrate.
Figure 13: Connection Center Icon
For each product supported by Orchestrate, a product tile displays. Each tile contains a logo and a brief
description of the product. The tile also contains a button to configure the product.
Figure 14: Connection Center
Select Open for the desired product to be navigated to that product details page.
16
MN007834A01-AD
Chapter 2: Connection Center
In the details page you can access a link to learn more product information.
The Get Started Checklist provides a step-by-step guide for connecting the product to Orchestrate. It also
provides any prerequisite configurations required of the product, and the links for more information.
17
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
Chapter 3
3.1
Managing Workspaces
With appropriate user permissions, you can create new workspaces to logically divide the workflows
operating within your organization. For each workspace that you create you can select a specific set of
available triggers and actions from your organization ecosystem. The selected items will be available for
workflow creation within the given workspace.
For more information on permissions, see Orchestrate Permissions and Access Control Lists on page 44.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
b. At the top of the screen, enter a name for the new workspace.
c. From each of the application groups, select the items that you want to enable for workflow creation
within the new workspace.
18
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
Edit <Workspace name> workspace screen opens. Select the items that you want to enable for
workflow creation within the workspace, and click Save when ready.
3.2
Sharing Workspaces
With appropriate user permissions, you can provision the workspaces in your organization to be either public
or private.
Public workspaces are available for all users in your organization. Your system permissions determine
which actions you can perform in them (viewing, editing, deleting). For more information, see Orchestrate
Permissions and Access Control Lists on page 44.
Private workspaces are available only for a specifically defined Access Control List of your organization
users. Their system permissions determine which actions they can perform in private workspaces (viewing,
editing, deleting). Unauthorized users do not see private workspaces that were not shared with them.
Workspaces are private by default on creation.
Perform the following steps to configure user access to a specific workspace in your organization:
Procedure:
1. At the top of the dashboard, from the My workspaces drop-down list, select the workspace which
Access Control settings you want to work with.
19
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
All users tab includes the list of all your organization members. In this tab you can share the
workspace with new users by adding them to the list of added users. You can also remove the users
from the list to revoke the access to a particular workspace.
Added users tab includes the list of all the users with which the workspace is shared. In this tab you
can remove the users from the list to revoke the access to a particular workspace.
In the Privacy tab you can make a particular workspace public or private. When a workspace is
public, it is available for all users in your organization. When a workspace is private, you can configure
the user access in All users and Added users tabs.
b. Next to the user that you want to share the workspace with, click .
4. To revoke the access to a workspace for particular users, perform one of the following actions:
● In All users tab, next to the user that you want to revoke the access for, click
● In Added users tab, next to the user that you want to revoke the access for, click
5. To share a private workspace with all users in your organization, in the Privacy tab, click Make
workspace public.
Your workspace is now public and available for all the users in your organization.
3.3
Workflows Management
In Orchestrate, a workflow defines integrations across multiple products, and it consists of triggers and
actions. Triggers represent the events originating from various sensors, software, and devices supported by
20
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
our technology ecosystem. Actions represent the possible responses to these triggers. After a workflow is
deployed, its actions activate when the triggers occur.
Within your instance of Orchestrate, all components of your technology ecosystem are populated and
accessible to be incorporated into workflows. This includes software, sensors, devices, and analytics.
As you add additional technology pieces to your ecosystem, those pieces are automatically added to the
Orchestrate portal and are made available for your workflows. You have full control and autonomy of the
workflows within your enterprise – you can view, edit, and add workflows according to the needs and
capabilities of your business or technology.
Figure 18: Workflow Card
When you double-click a workflow card or select → Open, the workflow creation screen opens.
Figure 19: Workflow Details Example
3.3.1
Creating Workflows
Perform the following steps to create a new workflow within one of your existing workspaces or edit an
existing workflow.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
If… Then…
If you want to create a new workflow, perform the following actions:
a. At the top of the dashboard, from the
My workspaces drop-down list, select the
workspace in which you want to create a
new workflow.
b. In the top-right corner of the screen, select
New workflow.
21
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
If… Then…
If you want to edit an existing workflow, perform one of the following actions:
In the top-right corner of the screen you can perform the following actions with your workflow:
● undo and redo your changes to the workflow (the limit for undo operations is 100)
● delete your workflow
● enable/disable your workflow
● discard all changes to the workflow
● save your workflow
Figure 21: Workflow Operations
In the bottom-right corner of the screen, there are zoom and pan controls, which can be used to
navigate across the workflow configuration area. Their location is fixed. All buttons on either tool can
be long-pressed to perform their action repeatedly.
● To fully zoom in, press ctrl + 1
22
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
4. From the pane on your left-hand side, select the All Triggers tab.
5. Select a desired trigger, and drag and drop it onto the workflow configuration area.
6. From the pane on your left-hand side, select the All Actions tab.
7. Select a desired capability, then drag and drop it onto the workflow configuration area.
Capability cards have Segment Names listed on them. If multiple segments use the same capability
name, you can differentiate between them by checking their Segment Names.
Figure 22: Segment Name on Node Card
NOTE:
You can create a group of multiple triggers or actions by dragging and dropping them onto one
another. You can then name your group accordingly by selecting Rename from the node menu.
Figure 23: Renaming Group Node
If any of the triggers within a trigger group occurs, the workflow is initiated. When it happens, all
actions in the action group for this workflow are performed.
You can also remove a trigger or an action from an existing triggers/actions group by dragging
and dropping it outside of the group node. When you remove the last but one item from a group,
the remaining item is no longer treated as a group, but as a single workflow node.
8. To connect the trigger and action nodes, click the circle at the end of one of the nodes, and drag a line
to the other node.
23
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
9. At the top of the screen, in the Enter workflow name field, enter a unique workflow name
10. To undo/redo your changes to the workflow, in the top-right corner of screen click the appropriate
buttons. To discard all edits to the workflow, select Discard.
11. To save and deploy your changes, in the top-right corner of the screen, select Save workflow.
If you did not set a name for your workflow, you are prompted to enter the workflow name at this point.
If there are invalid configurations within your workspace, saving is not allowed. Hovering over Save
Workflows displays the information about the issue, and the invalid nodes are highlighted.
Postrequisites:
After you save your workflow, enable it by clicking the toggle switch icon in the top-right corner of the screen.
You can also enable the workflow by returning to the dashboard and clicking the toggle switch icon in the
workflow card.
Figure 26: Starting Workflows
3.3.1.1
Touch Support
Orchestrate has full touch support. For most interfaces, tapping is equivalent to left-clicking.
The following are the touch controls for editing workflows:
● Tap nodes to select them,
24
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
3.3.1.2
Smaller Displays Support
Orchestrate display scales appropriately for tablets and similarly-sized computer windows.
NOTE: Smartphone displays are not yet supported.
For smaller displays, the workflow edit page includes the following enhancements:
● The side tray and the side navigation are stacked on top of one another (rather than displaying side-by-
side).
● The side navigation can be collapsed by clicking at the bottom of the screen. With the sections
3.3.2
Creating On-Failure Workflows
In the event of failure to send an alert to the destination of your first choice, you can set up a backup
on-failure workflow. The On-Failure connection is established between two action nodes.
Procedure:
1. Open an existing workflow or create a new one.
See Creating Workflows on page 21.
2. Select an action node from the panel on the left-hand side, and drag and drop it on the workflow
configuration area.
3. Connect the new action node to the existing one.
A new connection is created with a clickable circle in the middle of the connection bar.
Figure 27: On-Failure Connection Creation
25
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
4. Click the circle in the middle of the connection bar, and from the Connection type list, select
unsuccessful.
Figure 28: Workflow Connection Options
The connection bar color turns from blue to red. The selected destination acts now as a backup. It is
alerted when the first trigger-action connection fails.
NOTE:
Similarly to the successful connections between group nodes, if any of the actions in the first
node fails, the unsuccessful branch is triggered, and all actions defined for the connection are
performed.
Figure 29: On-Failure Connection for Groups
5. To save and deploy your configuration, in the top-right corner of the dashboard, click Save workflows.
3.3.3
Deleting Actions and Triggers
Procedure:
1. During workflow creation choose the action or trigger that you want to delete, and select its menu
icon.
A list of options appears.
2. From the list, select Delete, and confirm the deletion when prompted.
3.3.4
Deleting Workflows
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
26
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
2. In your workflow dashboard, choose a workflow that you want to delete, and in its workflow card select
→ Delete.
3. When prompted, confirm your operation by clicking Delete.
IMPORTANT: You cannot revert this operation.
3.3.5
Duplicating Workflows
You can create duplicates of your existing workflows.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
2. In your workflow dashboard, choose a workflow that you want to duplicate, and in its workflow card
select → Duplicate.
The duplicate of your workflow is created according to the following naming scheme: <workflow-
name> - copy (<X>).
3.3.6
Renaming Workflows
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
2. In your workflow dashboard, choose a workflow that you want to rename, and in its workflow card
select → Rename.
3. In the workflow name field, enter the new name and click anywhere on the screen or press Enter to
save your input.
NOTE: You can also rename workflows in the workflow creation screen.
3.3.7
Replacing Dead Nodes
If a trigger or action is removed from the product's end, it is no longer visible in the All Triggers or All
Actions tabs. If any of the deleted nodes was a part of one of your workflows, this node is marked in red as
deleted. In your dashboard, a workflow with unavailable nodes is labeled in red with Issues, and is taken into
account in the Workflow issues counter at the top of the dashboard.
Figure 30: Deleted Node
27
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
Also, if any of those cards was a part of a workflow, that workflow is disrupted and should be fixed to include
only the valid nodes. You should delete a dead node from your workspace and then replace it with a new
node.
NOTE: Non text-capable units are also not visible within the selection pane. Orchestrate workflows do
not currently communicate with them.
Procedure:
1. Locate a workflow with an issue, and in that workflow card select → Open.
2. Click the red warning icon on the dead node, and from the list select Delete.
If the deleted node had any connected nodes, on deletion you are still able to see the other connected
nodes.
Figure 31: Dead Node in a Workflow
You can then add a new node from the side tray to complete the disrupted workflow.
Postrequisites: In the top-right corner of the screen, save and deploy your changes by clicking Save
workflow.
3.3.8
Enabling/Disabling Workflows
Your workflows are Inactive on creation. You must manually enable them after saving. You can also manually
disable a workflow when you temporarily do not want it to be operable.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
2. In your workspace, choose a workflow that you want to enable or disable, and in the top-right corner of
its workflow card turn the toggle on/off.
The workflow automatically changes status to Active or Inactive, according to your selection.
3.4
Enabling/Disabling Workflows Globally
You can globally enable or disable all your workflows, for example when you want to ensure that all your
workflows are actionable at the same time.
NOTE:
To be able to globally enable/disable all workflows or workflows in your assigned workspaces, you must
be assigned appropriate permissions – refer to Orchestrate Permission List on page 44.
For more information on assigning permissions, see Orchestrate Permissions and Access Control Lists
on page 44.
28
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
When you globally re-enable your workflows, only the workflows that were set as Active will turn on – the
workflows that were Inactive will remain turned off until you enable them manually.
Procedure:
All your workflows are immediately disabled. The following notification displays at the top of your
dashboard:
Figure 34: Workflows Disabled
4. To re-enable your workflows globally according to their displayed states, under Global workflow
enable/disable turn on the Toggle Workflows On/Off setting and confirm when prompted.
Figure 35: Resuming Workflows
3.5
Moving Workflows to Different Workspaces
You can move workflows from one workspace to another according to your organization's needs. A workflow
can be moved to any workspace, even if it contains capabilities that are not enabled for that workspace.
While editing a workflow, only the capabilities enabled for the current workspace are available in the sidetray.
This means that when a capability that is not enabled for the workspace is removed from a workflow, it cannot
29
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
be added back (unless the workflow is first moved back into a workspace with that capability enabled, or that
capability is enabled for the workspace).
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
2. In your workflow dashboard, choose a workflow that you want to move to another workspace, and in
3.6
Enabling Workflow Suppression
You can globally turn on or turn off the workflow suppression for all your products. When the workflow
suppression is enabled, any time a workflow is executed, it is prevented from running again for 10 minutes.
Procedure:
3.7
Simulating Workflows
You can test, troubleshoot, and trial-run your workflows by manually simulating them, without sending a
trigger event from the source system.
Starting a simulated workflow triggers the workflow as if a trigger event was received from the source system.
Other workflows with the same trigger will not run. The simulated workflow executes all appropriate actions
that follow. For example, in Figure 37: Simulating Workflows on page 31, the simulated workflow sends a
real message to the connected radios. If Orchestrate has received an event from the selected trigger before,
the most recent event is replayed. This enables executed actions to behave the same way they would if the
workflow were initiated by a real event. Otherwise, a default event is used.
In either case, the trigger name is preceded with [Simulated], so that the event can be easily identified as
a simulation.
When a simulated workflow begins, a pop-up opens to show the progress of the workflow. This pop-up shows
the results of all actions as soon as the workflow completes. Historic simulated workflows can also be viewed
in the Runtime Data Table – for more information, see Runtime Data Table on page 32.
30
MN007834A01-AD
Chapter 3: Orchestrate Dashboard Management
Procedure:
1. Find a saved workflow that you want to simulate.
2. Open the workflow in workflow editor.
3. On the trigger card click Simulate workflow.
Figure 37: Simulating Workflows
31
MN007834A01-AD
Chapter 4: Monitor Center
Chapter 4
Monitor Center
The Monitor center is a single location where you can view both the Runtime Data Table and the System
Health Dashboard.
In the Runtime Data Table, you can monitor your workflow execution history, and observe which actions were
performed when a specific trigger was activated.
System Health Dashboard shows all known product service disruption incidents for your agency.
NOTE:
The Monitor icon may differ depending on the highest severity of active incidents in your system,
ranging from regular black to red.
Figure 38: System Health Dashboard Icons Based on Incident Severity
4.1
Runtime Data Table
Within the Monitor center, you can access the Runtime Data Table, where you can monitor your workflow
execution history, and observe which actions were performed when a specific trigger was activated.
In the Runtime Data Table, one entry per each firing of the workflow trigger displays. In each row, the
following items display:
● the date and time of the trigger firing (in local time – your timezone displays in the top-right corner of the
window, next to the Last synced timestamp
● the overall status of the workflow
● the name of the workflow that fired, with a direct link to the specific workflow
NOTE:
The workflow name stored in the table is the name from the time of the workflow execution. If the
workflow is renamed later, this does not change the value stored in the Runtime Data Table. If the
linked workflow has been deleted, a warning displays.
● the name of the specific trigger within that workflow that fired
● the states of the actions that follow the trigger
NOTE: Actions which were not initiated as a result of a workflow execution are not displayed in the
Runtime Data Table.
The table does not load all the content at once – to load more content, you need to scroll down.
The workflow can have one of the following statuses:
In progress
The workflow has started, but it has not yet finished reaching the end of all its possible actions.
32
MN007834A01-AD
Chapter 4: Monitor Center
Completed
The workflow execution has completed. It is possible that some of the actions ended in failures.
Suppressed
The workflow cannot run because it has already run within the last 10 minutes and it was not
acknowledged.
When you hover over the icons in the Actions column, you can see the action name, the date and time of the
latest update for that action, and its state. The following Action state icons can display for an entry:
Succeeded – the action was fired and a success response was received.
Failed – the action was attempted to be fired, but there was a failure response, or there was no
response and a timeout.
Figure 39: Runtime Data Table Example
The Runtime Data Table updates in real-time. Newly started or completed workflows automatically appear at
the top of the table. The new rows are bolded for 10 seconds for increased visibility. If you are scrolled down
when new rows are added, a pop-up notifies you of the new data with a button you can click to scroll to the
top of the table.
The runtime data row updates twice. The first update occurs when the workflow starts (no actions display).
The second update occurs when the workflow completes (all the actions display as either Succeeded or
Failed).
4.1.1
Filtering Runtime Data Table
The Runtime Data Table can be filtered to only show the desired information.
The following are available filtering criteria:
● Workspace
● Workflow
● Triggers
33
MN007834A01-AD
Chapter 4: Monitor Center
● Actions
● Workflow status
● Action status
● Date
● Time
NOTE: In each dropdown you can select multiple values to refine your search results. To remove a
selected filter option, click X on its tag.
Procedure:
34
MN007834A01-AD
Chapter 4: Monitor Center
Postrequisites: To see all Runtime Data Table entries again, in the Runtime Data Table filter pane click
Clear.
4.2
System Health Dashboard
Within the Monitor center, you can access the System Health Dashboard, which shows all known product
service disruption incidents for your organization.
When one of your components from a specific product family registers operational problems, an incident is
raised. The incident is assigned its unique Incident ID, and its creation date and time displays in the Opened
column. The Severity of the incident is configured per product.
When you click a specific incident, the incident details section expands. It includes the path of the incident, its
summary, a timeline of updates, and incident resolution details for resolved or expired incidents.
NOTE: The path of the incident contains a link to the source product. When you select the link, you may
be asked to authenticate to that product.
In the top-left corner of the page, you can switch between viewing current and closed incidents by selecting
Current or Closed. Closed incidents are marked as RESOLVED (for example when the service was restored),
or EXPIRED (the incident was resolved because no automatic update was received and the incident is more
than seven days old).
IMPORTANT:
To receive emails for all incident creations, updates, and resolutions, users require the Recipient of
urgent notifications application permission. To have this permission, users must be assigned a
specific role in CommandCentral Admin that includes this permission, or they must be assigned the
default Orchestrate Issue Stakeholder system role. Role assignment in CommandCentral Admin is
handled by organization admins.
For more information, see Default Orchestrate Roles on page 46 and Managing Orchestrate
Permissions in Admin on page 48.
4.2.1
Disabled Incident Notifications
Some incidents can be muted based on your product configuration. When an incident is muted, you do not
receive notifications from Orchestrate about the incident updates. The updates are still visible in the System
Health Dashboard interface.
The incidents with disabled notifications are marked in the System Health Dashboard with the following icon –
.
IMPORTANT:
Using notifications for all incident changes is strongly recommended, unless one of the following criteria
is met:
● A customer has chosen to explicitly disable notifications in a product or connector configuration
interface.
● The product has an alternate means of notifying the users about incidents.
35
MN007834A01-AD
Chapter 5: Inactivity Monitor
Chapter 5
Inactivity Monitor
Besides monitoring the last time a trigger occurred in a product in the Runtime Data Table, you can set
thresholds on a per-product basis for any product with triggers – this can be done in the Inactivity Monitor in
the Settings page.
When a threshold is set and enabled, the information whether the threshold is exceeded or not displays. If the
time since the last trigger occurred is greater than the established threshold, the threshold is considered to
be exceeded. You can also enable email alerts to inform your organization administrators when the threshold
changes status from exceeded to not exceeded, and vice versa.
If a threshold is exceeded, it does not necessarily imply a system issue – the threshold may be set too low, or
your organization activity for a particular day is exceptionally low.
Setting the threshold time too low may result in more frequent false-positive emails, and setting the threshold
time too high may result in delayed alerts if a system is down. A workflow administrator should choose a
threshold based on the expected activity from the source system. Activity is based on the triggers sent to
Orchestrate from the respective product, whether or not they are mapped to workflows. If the source product
has the ability to send a trigger at a regular interval, this period can be used as the threshold time.
5.1
Configuring Inactivity Monitor
When you enable product thresholds in your Inactivity Monitor, your organization is alerted when Orchestrate
has not received any trigger events from this product within a designated time interval. Alerts are sent to your
organization administrators when the threshold is exceeded, and again when service is restored.
Procedure:
36
MN007834A01-AD
Chapter 5: Inactivity Monitor
e. Click Save.
The threshold value is updated, and a toast notification displays at the top of the screen. If the
threshold changes status from exceeded to not exceeded or vice versa, another toast notification
displays.
37
MN007834A01-AD
Chapter 6: Audit Considerations for Orchestrate
Chapter 6
38
MN007834A01-AD
Chapter 7: Orchestrate Troubleshooting/FAQ
Chapter 7
Orchestrate Troubleshooting/FAQ
If you run into errors in Orchestrate, you can search the list of potential issues for possible causes, tips and
solutions.
1. I cannot log on to Orchestrate on page 39
2. I logged in, but my cards/nodes are not appearing on page 40
3. I cannot find the card I am looking for on page 40
4. A card name was changed, and I need to see its original name on page 42
5. Some of the trigger/action cards I expect to see are not showing on page 42
6. I need to add a new trigger or action on page 42
7. The workflow is not functioning on page 42
8. Talkgroup Action does not run on page 43
9. My saving attempt failed on page 43
10. I just logged in, and the workflows looks different on page 43
11. Warnings about conflicting workflow saves on page 43
39
MN007834A01-AD
Chapter 7: Orchestrate Troubleshooting/FAQ
40
MN007834A01-AD
Chapter 7: Orchestrate Troubleshooting/FAQ
3. If you cannot see the whole name of a card, hover over the name of the card – the original card name
and the current full name display.
Figure 44: Card Full Name
4. Switch to Show all workspace – a node may be not visible because it is not a part of the active
workspace.
5. If you are not seeing your Ally CAD system cards, confirm that your Ally Tenant ID is loaded (this is a part
of the original setup/onboarding).
If you do not know your Ally Tenant ID, contact your Ally sales/support representative.
41
MN007834A01-AD
Chapter 7: Orchestrate Troubleshooting/FAQ
A card name was changed, and I need to see its original name
Hover over the title to see the original name.
42
MN007834A01-AD
Chapter 7: Orchestrate Troubleshooting/FAQ
4. If a specific radio is a part of the workflow in question, ensure that the radio is turned on and that it is
registered to the system.
5. Repeat Triggers – Orchestrate intentionally squelches duplicate triggers if they are close together and if
they did not receive an acknowledgement. This is done to avoid annoyance alarms.
a. Wait until the timeout before re-attempting the trigger (the default is 10 minutes).
b. Use a different trigger. If you are using a key sequence to drive testing, set up multiple test triggers.
43
MN007834A01-AD
Appendix A: Orchestrate Permissions and Access Control Lists
Appendix A
A.1
Orchestrate Permission List
Orchestrate access control is managed through a combination of permissions managed in CommandCentral
Admin and Workspace Access Control Lists (ACLs) managed in Orchestrate. The permissions control which
actions a user can perform, and the ACLs control where a user can perform those actions.
IMPORTANT: Permissions that apply to “all workflows” or “all workspaces” are elevated permissions,
which supersede ACLs.
Currently, user permissions are not managed on a per-workspace basis. A user either is, or is not, a part of
the workspace's ACL. User's global permissions are applied to all workspaces which they have been added
to. Workspaces are currently the only entities which have their own ACLs.
44
MN007834A01-AD
Appendix A: Orchestrate Permissions and Access Control Lists
Edit all workflows Enables the user to perform the following workflow
edit actions:
● Creating workflows in any workspace,
● Editing workflows in any workspace,
● Deleting workflows in any workspace,
● Duplicating workflows in any workspace,
● Moving workflows between any workspaces.
Includes all capabilities of View all workspa-
ces
Includes all capabilities of Turn on/off all
workflows
Edit all workspaces Enables the user to perform the following actions:
● Editing workspaces,
● Creating new workspaces.
Includes all capabilities of View all workspa-
ces
Edit assigned workspaces Enables the user to edit the assigned workspaces.
Edit product thresholds Enables the user to edit product threshold configu-
rations.
Edit workflows in assigned workspaces Enables the user to perform the following actions:
● Editing workflows in assigned workspaces,
● Creating workflows in assigned workspaces,
● Deleting workflows in assigned workspaces,
● Duplicating workflows in assigned workspaces,
● Moving workflows between assigned workspa-
ces.
Includes all capabilities of Turn on/off work-
flows in assigned workspaces
Manage access for all workspaces Enables the user to perform the following actions:
● Managing user access for all workspaces,
● Making all workspaces public/private.
Includes all capabilities of View all workspa-
ces
45
MN007834A01-AD
Appendix A: Orchestrate Permissions and Access Control Lists
Turn on/off workflows in assigned Enables the user to turn on/off workflows in as-
workspaces signed workspaces.
View (Access Orchestrate UI) Enables the user to perform the following actions:
● Accessing and viewing most of the Orchestrate
UI,
● Viewing workflows in assigned workspaces,
● Viewing associated runtime data in assigned
workspaces.
View all workspaces Enables the user to view all workspaces (including
all associated workflows and runtime data).
A.2
Default Orchestrate Roles
When the Orchestrate service is enabled, several default Roles are provisioned in CommandCentral Admin.
The default Roles are only created one time per organization, and they are not maintained long-term by
Orchestrate. You can use the default Roles, modify them to more precisely meet your organization's needs,
or ignore the default Roles and instead create new Roles with unique permission combinations.
Refer to the following table for a list of permissions associated with the default Roles established in
Orchestrate.
46
MN007834A01-AD
Appendix A: Orchestrate Permissions and Access Control Lists
Orchestrate Workflow Edi- Workflow Editors are respon- View (Access Orchestrate
tor sible for configuring and edit- UI)
ing workflows within a work- Turn on/off workflows in
space that they are assigned assigned workspaces
to. They also maintain the Edit workflows in assigned
ability to rename capabilities workspaces
organization-wide. Rename triggers and actions
Orchestrate Reader Readers can view all resour- View (Access Orchestrate
ces with the exception of UI)
Workspaces that they are not
assigned to through the re-
sources ACL.
47
MN007834A01-AD
Appendix A: Orchestrate Permissions and Access Control Lists
A.3
Managing Orchestrate Permissions in Admin
All permissions, depending on your organization needs, can be independently assigned in CommandCentral
Admin application in the Application permissions module. The permissions are managed per role, so that
you can assign specific application permissions to each role in your organization, according to your needs.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
3. Select Roles.
4. Select a role for which you want to manage the Orchestrate permissions.
5. From the left-hand side navigation list, under Application permissions, select Orchestrate.
If Orchestrate is not available, you must assign the Orchestrate application to the role. Select Role
details, and from the Application assignments select Orchestrate.
6. Under Orchestrate permissions, select all the permissions that you want to assign to the particular
role in your organization.
7. When ready, in the top-right corner of the screen click Save.
48