MOTOROLA SOLUTIONS MN007834A01 Ecosystem With Orchestrate User Guide
- June 1, 2024
- Motorola Solutions
Table of Contents
MN007834A01 Ecosystem With Orchestrate
“`html
Product Information
Specifications:
- Product Name: Orchestrate User Guide
- Version: JANUARY 2024
- Model Number: MN007834A01-AB
Product Usage Instructions
1. Getting Started
Before using the Orchestrate User Guide, ensure you have read
the entire manual for a comprehensive understanding of the product
features and functionalities.
2. Accessing the Orchestrate Dashboard
To access the Orchestrate Dashboard, follow these steps:
- Open the Orchestrate application on your device.
- Click on the Dashboard tab to view the main interface.
3. Managing Workflows
To manage workflows within the Orchestrate User Guide:
-
Use the options provided in the Workflows section to create,
delete, or join workflows. -
Refer to specific subsections for detailed instructions on
different workflow operations.
4. Troubleshooting and FAQ
If you encounter any issues while using the product, refer to
the Troubleshooting/FAQ section in the manual for solutions to
common problems.
Frequently Asked Questions (FAQ)
Q: How can I export data from the Orchestrate User Guide?
A: To export data, go to the Runtime Data Table section and
follow the instructions provided to export data to a CSV file.
Q: How do I change settings in the Orchestrate
application?
A: Navigate to the Settings menu within the application to
modify various configurations based on your preferences.
“`
Orchestrate User Guide
JANUARY 2024
© 2024 Motorola Solutions, Inc. All Rights Reserved.
MN007834A01
MN007834A01-AB
MN007834A01-AB Intellectual Property and Regulatory Notices
Intellectual Property and Regulatory Notices
Copyrights
The Motorola Solutions products described in this document may include
copyrighted Motorola Solutions computer programs. Laws in the United States
and other countries preserve for Motorola Solutions certain exclusive rights
for copyrighted computer programs. Accordingly, any copyrighted Motorola
Solutions computer programs contained in the Motorola Solutions products
described in this document may not be copied or reproduced in any manner
without the express written permission of Motorola Solutions. No part of this
document may be reproduced, transmitted, stored in a retrieval system, or
translated into any language or computer language, in any form or by any
means, without the prior written permission of Motorola Solutions, Inc.
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.
Open Source Content
This product may contain Open Source software used under license. Refer to the
product installation media for full Open Source Legal Notices and Attribution
content.
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-AB 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
[email protected]. 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-AB Document History
Document History
Version MN007834A01-A MN007834A01-B
MN007834A01-C MN007834A01-D MN007834A01-E MN007834A01-F
MN007834A01-G MN007834A01-H MN007834A01-J
Description Initial version of the Orchestrate User Guide. Minor UI updates.
The following sections were updated: Moving Workflows Deleting Workflows on
page 24 Joining Workflows
The following sections were updated: Orchestrate Dashboard on page 13
Workflows on page 18 and its subsections Orchestrate Troubleshooting/FAQ on
page 41
The following sections were updated: Orchestrate Dashboard on page 13
Replacing Dead Nodes on page 25
The following sections were updated: Orchestrate Dashboard on page 13 Runtime
Data Table on page 34 Orchestrate Troubleshooting/FAQ on page 41
The following sections were updated: Orchestrate Permissions and Access
Control Lists
on page 47 Enabling/Disabling Workflows Globally on page 26 Orchestrate
Troubleshooting/FAQ on page 41
The following sections were updated: Orchestrate Dashboard on page 13
Enabling/Disabling Workflows Globally on page 26 Orchestrate
Troubleshooting/FAQ on page 41
The following sections were updated: Orchestrate Dashboard on page 13 Multi-
select Operations Runtime Data Table on page 34
The following sections were updated: Selecting Orchestrate Theme on page 18
Exporting Runtime Data Table to CSV File
Date February 2021 March 2021
April 2021 May 2021 June 2021 July 2021
July 2021 August 2021 September 2021
4
MN007834A01-AB Document History
Version MN007834A01-K MN007834A01-L MN007834A01-M
MN007834A01-N
MN007834A01-P MN007834A01-R
MN007834A01-S MN007834A01-T MN007834A01-U
Description
Runtime Data CSV Export Fields
The following sections were updated: Orchestrate Dashboard on page 13
Product Thresholds on page 38 chapter was added. Runtime Data Table on page 34
chapter was updated.
The following sections were updated: Orchestrate Dashboard on page 13
Replacing Dead Nodes on page 25 Orchestrate Troubleshooting/FAQ on page 41
The following sections were updated: Moving Workflows Runtime Data Table on
page 34 Exporting Runtime Data Table to CSV File Runtime Data CSV Export
Fields
The User Guide is redesigned to reflect the new workspace UI.
Moving Workflows to Different Workspaces on page 30 was added. The following
sections were updated: Orchestrate Permissions and Access Control Lists
on page 47 Orchestrate Dashboard on page 13
The following sections were updated: Orchestrate Dashboard on page 13 Creating
Workflows on page 19
System Health Dashboard on page 32 was added. The following sections were
added: Sharing Workspaces on page 29 Orchestrate Permission List on page 47
Default Orchestrate Roles on page 49 Managing Orchestrate Permissions in Admin
on
page 51 The following sections were updated: Orchestrate Dashboard on page 13
Creating Workflows on page 19 Managing Workspaces on page 28
Date October 2021 January 2022 February 2022
May 2022
August 2022 August 2022
October 2022 November 2022 December 2022
5
MN007834A01-AB Document History
Version MN007834A01-V MN007834A01-W
MN007834A01-Y
MN007834A01-AA MN007834A01-AB
Description
Moving Workflows to Different Workspaces on page 30
Orchestrate Permissions and Access Control Lists on page 47
The following sections were added: Search Field on page 16 Audit
Considerations for Orchestrate on page 40 The following sections were updated:
Orchestrate Dashboard on page 13 Creating Workflows on page 19
The following sections were added: Enabling Workflow Suppression on page 31
Connection Center on page 36 The following sections were updated: Orchestrate
Dashboard on page 13 Creating On-Failure Workflows on page 23 Orchestrate
Troubleshooting/FAQ on page 41
The following sections were added: Touch Support on page 22 Smaller Displays
Support on page 23 The following sections were updated: Configuring Ally on
page 31 Connection Center on page 36 Configuring Product Thresholds on page 38
Orchestrate Troubleshooting/FAQ on page 41
Connection Center on page 36 was updated. The following sections were updated:
Orchestrate Dashboard on page 13 Connection Center on page 36
Date April 2023 June 2023
August 2023
October 2023 January 2024
6
MN007834A01-AB Contents
Contents
Intellectual Property and Regulatory Notices…………………………………………………………. 2 Contact
Us…………………………………………………………………………………………………………….3 Document
History………………………………………………………………………………………………….4 List of
Figures………………………………………………………………………………………………………. 9 List of
Procedures………………………………………………………………………………………………. 11 About This
Manual……………………………………………………………………………………………….12
Related Information………………………………………………………………………………………………………………..12
Chapter1:Orchestrate Overview…………………………………………………………………………. 13
1.1 Safety Reimagined……………………………………………………………………………………………………………13 1.2
Orchestrate Dashboard……………………………………………………………………………………………………..13
1.2.1 Search Field……………………………………………………………………………………………………….. 16 1.2.2 Selecting
Orchestrate Theme……………………………………………………………………………….. 18 1.3
Workflows………………………………………………………………………………………………………………………..18 1.3.1 Creating
Workflows……………………………………………………………………………………………… 19
1.3.1.1 Touch Support………………………………………………………………………………………… 22 1.3.1.2 Smaller
Displays Support…………………………………………………………………………. 23 1.3.2 Creating On-Failure
Workflows……………………………………………………………………………… 23 1.3.3 Deleting Actions and
Triggers……………………………………………………………………………….. 24 1.3.4 Deleting
Workflows……………………………………………………………………………………………….24 1.3.5 Duplicating
Workflows…………………………………………………………………………………………..25 1.3.6 Renaming
Workflows…………………………………………………………………………………………… 25 1.3.7 Replacing Dead
Nodes………………………………………………………………………………………… 25 1.3.8 Enabling/Disabling
Workflows………………………………………………………………………………..26 1.4 Enabling/Disabling Workflows
Globally………………………………………………………………………………..26 1.5 Managing
Workspaces………………………………………………………………………………………………………28 1.6 Sharing
Workspaces…………………………………………………………………………………………………………29 1.7 Moving Workflows to
Different Workspaces………………………………………………………………………….30 1.8 Configuring
Ally………………………………………………………………………………………………………………..31 1.9 Enabling Workflow
Suppression………………………………………………………………………………………… 31
Chapter2:System Health Dashboard…………………………………………………………………… 32
2.1 Disabled Incident Notifications……………………………………………………………………………………………33
Chapter3:Runtime Data Table…………………………………………………………………………….. 34
Chapter4:Connection Center……………………………………………………………………………… 36 Chapter5:Product
Thresholds……………………………………………………………………………..38
7
MN007834A01-AB Contents
5.1 Configuring Product Thresholds………………………………………………………………………………………… 38
Chapter6:Audit Considerations for Orchestrate………………………………………………….. 40
Chapter7:Orchestrate Troubleshooting/FAQ………………………………………………………..41 AppendixA:
Orchestrate Permissions and Access Control Lists…………………………. 47
A.1 Orchestrate Permission List……………………………………………………………………………………………… 47 A.2
Default Orchestrate Roles………………………………………………………………………………………………… 49 A.3 Managing
Orchestrate Permissions in Admin……………………………………………………………………… 51
8
MN007834A01-AB List of Figures
List of Figures
Figure 1: Orchestrate Terms and Conditions……………………………………………………………………………………….
14 Figure 2: Orchestrate Dashboard……………………………………………………………………………………………………… 14
Figure 3: Workspace Selected…………………………………………………………………………………………………………..15
Figure 4: Empty Workspace………………………………………………………………………………………………………………15 Figure
5: Title Bar Icons……………………………………………………………………………………………………………………15 Figure 6:
What’s New Section……………………………………………………………………………………………………………16 Figure 7:
Workflow Found…………………………………………………………………………………………………………………16 Figure 8: Workflow
Not Found………………………………………………………………………………………………………….. 17 Figure 9: Searching for
Text String in Nodes………………………………………………………………………………………. 17 Figure 10: Quotation
Marks in Search……………………………………………………………………………………………….. 18 Figure 11: Workflow
Card………………………………………………………………………………………………………………… 19 Figure 12: Workflow Details
Example…………………………………………………………………………………………………19 Figure 13: Last Recorded
Trigger Time……………………………………………………………………………………………… 20 Figure 14: Workflow
Operations……………………………………………………………………………………………………….. 20 Figure 15: Segment Name
on Node Card………………………………………………………………………………………….. 21 Figure 16: Renaming Group
Node……………………………………………………………………………………………………..21 Figure 17: Connecting Triggers
and Actions………………………………………………………………………………………..21 Figure 18: Maximum Chain
Depth Information……………………………………………………………………………………. 22 Figure 19: Starting
Workflows……………………………………………………………………………………………………………22 Figure 20: On-Failure
Connection Creation…………………………………………………………………………………………23 Figure 21: Workflow
Connection Options…………………………………………………………………………………………… 24 Figure 22: On-Failure
Connection for Groups…………………………………………………………………………………….. 24 Figure 23: Deleted
Node…………………………………………………………………………………………………………………..25 Figure 24: Dead Node in a
Workflow………………………………………………………………………………………………….26 Figure 25: Workflow after
Dead Node Deletion…………………………………………………………………………………… 26 Figure 26: Pausing
Workflows Warning………………………………………………………………………………………………27 Figure 27: Workflows
Disabled…………………………………………………………………………………………………………. 27 Figure 28: Resuming
Workflows………………………………………………………………………………………………………..27 Figure 29: Creating a
Workspace……………………………………………………………………………………………………… 28 Figure 30: Workspace
Access Control Window……………………………………………………………………………………29 Figure 31: Workflow
Suppression………………………………………………………………………………………………………31 Figure 32: System Health
Dashboard Icons Based on Incident Severity………………………………………………… 32 Figure 33:
System Health Dashboard…………………………………………………………………………………………………32 Figure 34:
Incident Details……………………………………………………………………………………………………………….. 33 Figure 35:
Runtime Data Table Example……………………………………………………………………………………………. 35 Figure 36:
Connection Center Icon…………………………………………………………………………………………………….36
9
MN007834A01-AB List of Figures Figure 37: Connection
Center……………………………………………………………………………………………………………36 Figure 38: Avigilon Product
Details Page…………………………………………………………………………………………… 37 Figure 39: Login
Screen………………………………………………………………………………………………………………….. 41 Figure 40: Login and
Password………………………………………………………………………………………………………… 42 Figure 41: Search
View…………………………………………………………………………………………………………………….43 Figure 42: Card Full
Name………………………………………………………………………………………………………………. 43 Figure 43: Integration
Settings…………………………………………………………………………………………………………..44 Figure 44: Turning All
Workflows On Toggle………………………………………………………………………………………..45 Figure 45: Starting
Workflows……………………………………………………………………………………………………………45
10
MN007834A01-AB List of Procedures
List of Procedures
Selecting Orchestrate Theme ………………………………………………………………………………………………………….. 18
Creating Workflows …………………………………………………………………………………………………………………………19 Creating
On-Failure Workflows …………………………………………………………………………………………………………23 Deleting
Actions and Triggers …………………………………………………………………………………………………………..24 Deleting
Workflows ………………………………………………………………………………………………………………………… 24 Duplicating
Workflows ……………………………………………………………………………………………………………………..25 Renaming Workflows
………………………………………………………………………………………………………………………25 Replacing Dead Nodes
……………………………………………………………………………………………………………………25 Enabling/Disabling Workflows
…………………………………………………………………………………………………………..26 Enabling/Disabling Workflows
Globally ………………………………………………………………………………………………26 Managing Workspaces
…………………………………………………………………………………………………………………… 28 Sharing Workspaces
……………………………………………………………………………………………………………………….29 Moving Workflows to Different
Workspaces ………………………………………………………………………………………. 30 Configuring Ally
………………………………………………………………………………………………………………………………31 Enabling Workflow
Suppression ………………………………………………………………………………………………………. 31 Configuring Product
Thresholds ………………………………………………………………………………………………………. 38 Managing Orchestrate
Permissions in Admin ……………………………………………………………………………………..51
11
MN007834A01-AB About This Manual
About This Manual
This manual describes the use of Orchestrate solution a cloud-based workflow
management tool. In Orchestrate you can create custom workflows between
Avigilon Alarms and MOTOTRBO radios or Ally and manage your workspace.
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:
Related Information Orchestrate Deployment Guide
Orchestrate System Planner CommandCentral Admin 2.0 Online Help
Purpose
This manual is developed as a support tool for Motorola Solutions employees
and channel partners. The chapters within this manual present information on
deploying the solution and onboarding radios and talkgroup.
Provides information concerning the impact of the solution on pre-sales system
planning considerations.
Provides instructions on how to use CommandCentral Admin 2.0.
12
MN007834A01-AB 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 Reimagined
technology 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 Reimagined
Safety Reimagined 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 MSI 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
Orchestrate Dashboard
Orchestrate can be accessed through the CommandCentral Admin portal or
directly under the following URL addresses:
For US customers: orchestrate.commandcentral.com For Canada customers:
orchestrate.commandcentral.ca Before you access Orchestrate, you must accept
the CommandCentral Terms and Conditions on behalf of your agency.
13
MN007834A01-AB Chapter 1: Orchestrate Overview Figure 1: Orchestrate Terms and
Conditions
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. After you log on to Orchestrate, your Orchestrate dashboard
appears. Figure 2: Orchestrate Dashboard
In your dashboard, all workflows defined for your agency 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 19. 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 agency, 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 16. The dashboard can be divided into
separate workspaces, according to your agency 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.
14
Figure 3: Workspace Selected
MN007834A01-AB Chapter 1: Orchestrate Overview
In empty workspaces the instructions for creating new workflows display. Figure 4: Empty Workspace
To return to the overview of all the workflows in your agency, at the top of
the dashboard, from the My workspaces drop-down list select Show all.
At the top of the screen on the title bar, you can access the Application
Switcher that allows you to switch to other applications from the
CommandCentral suite, or access a user help.
Figure 5: Title Bar Icons
When you click
, the Information pane displays.
In the My Agency Info section you can find your Agency Name and Agency ID, which you can copy or reference for additional support.
In the Help section, the contact information and a link to the MSI Learning Experience Portal display. You can also launch an inbuilt guide by clicking In-app User Guide.
In the What’s New section, you can access the release notes and read about all the new features and bug fixes introduced in each Orchestrate release.
15
MN007834A01-AB Chapter 1: Orchestrate Overview In the Contact Us section, you
can submit questions, feedback, feature requests, and bug reports. When
you fill out this form, a support case is created for further investigation if
needed. In the Agreements section you can find the agreements that you have
previously accepted. Figure 6: What’s New Section
1.2.1
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 agency display. Figure 7:
Workflow Found
If you select a specific workspace from My workspaces list, the possible
relevant results from other workspaces do not display.
16
Figure 8: Workflow Not Found
MN007834A01-AB Chapter 1: Orchestrate Overview
The search results also include the workflow cards which triggers or actions contain the searched text string. Figure 9: 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:
17
MN007834A01-AB Chapter 1: Orchestrate Overview
Figure 10: Quotation Marks in Search
1.2.2
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:
1. From the navigation on the left, select
Settings.
2. Select Orchestrate.
3. Under Theme, select the option according to your preferences.
Any theme change is automatically applied.
1.3
Workflows
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 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.
18
Figure 11: Workflow Card
MN007834A01-AB Chapter 1: Orchestrate Overview
When you double-click a workflow card or select Figure 12: Workflow Details Example
Open, the workflow creation screen opens.
1.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. 2. Perform one of the following actions:
If… If you want to create a new workflow,
If you want to edit an existing workflow,
Then…
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.
perform one of the following actions:
in that workflow card, select
Open,
double-click that workflow card.
Workflow creation screen appears.
The selection pane on the left-hand side contains the available triggers and
actions that can be explored and searched through by using the All Triggers
and All Actions tabs, as well as the Grouped by Application tab which filters
triggers and actions based on which application they are associated with. The
application filters that are available to you depend on your custom
configuration.
19
MN007834A01-AB Chapter 1: Orchestrate Overview
Orchestrate records the last time that a product with triggers fired a trigger
event. An icon displays next to the name of the products with triggers when
you hover over that icon, a tooltip displays. The tooltip states the time of
the last trigger event (Last triggered X seconds/minutes/hours/
days/weeks/months/years ago). The time value is accurate when you load the
Orchestrate page. Then, the pane refreshes automatically every five minutes,
and the tooltip information is updated accordingly. Figure 13: Last Recorded
Trigger Time
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 14: 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 To fully zoom out,
press ctrl + 0
NOTE: It is not possible for two or more users to edit the same workflow
simultaneously. When two users save changes to the same workflow, the second
user to save that workflow receives a notification asking them to refresh the
page to see the most recent state of the workflow. 3. From the pane on your
left-hand side, select the All Triggers tab. 4. Select a desired trigger, and
drag and drop it onto the workflow configuration area. 5. From the pane on
your left-hand side, select the All Actions tab. 6. 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.
20
Figure 15: Segment Name on Node Card
MN007834A01-AB Chapter 1: Orchestrate Overview
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 16: 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. 7. 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. Figure 17: Connecting Triggers and Actions
8. At the top of the screen, in the Enter workflow name field, enter a unique
workflow name 9. 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. 10. 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.
21
MN007834A01-AB Chapter 1: Orchestrate Overview
A new workflow is created. The workflow is paused on creation by default.
NOTE: You can create a four-nodes long workflow at maximum, that is a workflow
which consists of a trigger node, and three consecutive connected action
nodes. Workflows that consist of more than four consecutive nodes cannot be
saved. If you try to create such a workflow and save your workspace, the
following pop-up displays:
Figure 18: Maximum Chain Depth Information
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 19: Starting Workflows
1.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, Drag nodes to move them, Long-press nodes to multi-
select, Drag workflow canvas to pan, Pinch workflow canvas to zoom in/out Drag
from one node port to another to create a band, Tap band center point, then
select the desired option to change the connection type, Tap band center
point, then tap Delete connection to delete a band, Tap band, then drag the
white dots near its ends to move the existing band, Scroll lists of nodes by
dragging up/down on the gray region to the left of the list
22
MN007834A01-AB Chapter 1: Orchestrate Overview
1.3.1.2
Smaller Displays Support
Orchestrate display scales approprately 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
collapsed, the Expand button becomes available. On mobile devices, a button is
available within the workflow canvas when tapped, it launches a
full-screen view. 1.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 19.
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
20: On-Failure Connection Creation
4. Click the circle in the middle of the connection bar, and from the
Connection type list, select unsuccessful.
23
MN007834A01-AB Chapter 1: Orchestrate Overview
Figure 21: 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 22: On-Failure
Connection for Groups
5. To save and deploy your configuration, in the top-right corner of the
dashboard, click Save workflows. 1.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.
1.3.4
Deleting Workflows
Procedure: 1. Log on to Orchestrate by using your CommandCentral Admin
credentials.
24
MN007834A01-AB Chapter 1: Orchestrate Overview
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.
1.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:
1.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.
1.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 23: Deleted Node
25
MN007834A01-AB Chapter 1: Orchestrate Overview
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 24: Dead Node in a Workflow
Figure 25: Workflow after Dead Node Deletion
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.
1.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.
1.4
Enabling/Disabling Workflows Globally
With appropriate user permissions, 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. For more information on permissions, see
Orchestrate Permissions and Access Control Lists on page 47.
26
MN007834A01-AB Chapter 1: Orchestrate Overview
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:
1. From the navigation on the left, select
Settings.
2. Select Orchestrate.
3. To globally disable your workflows, under Workflow States turn off the Toggle workflows on/off setting and confirm when prompted.
Figure 26: Pausing Workflows Warning
All your workflows are immediately disabled. The following notification
displays at the top of your dashboard: Figure 27: Workflows Disabled
4. To re-enable your workflows globally according to their displayed states,
under Workflow States turn on the Toggle workflows on/off setting and confirm
when prompted. Figure 28: Resuming Workflows
All your workflows are immediately resumed.
27
MN007834A01-AB Chapter 1: Orchestrate Overview
1.5
Managing Workspaces
With appropriate user permissions, you can create new workspaces to logically
divide the workflows operating within your agency. For each workspace that you
create you can select a specific set of available triggers and actions from
your agency ecosystem. For more information on permissions, see Orchestrate
Permissions and Access Control Lists on page 47.
Procedure: 1. Log on to Orchestrate by using your CommandCentral Admin
credentials. 2. To create a new workspace, perform the following actions: a.
At the top of the dashboard, click New workspace. Create a new workspace
screen opens.
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.
The selected Triggers and Actions display in the Preview section. Figure 29:
Creating a Workspace
d. When ready, click Save.
3. To change the available Triggers and Actions within a workspace, perform
the following actions:
a. At the top of the dashboard, from the My workspaces drop-down list, select
the workspace for which you want to change the available Triggers and Actions.
b. Next to the workspace name, select
Edit.
Edit
28
MN007834A01-AB Chapter 1: Orchestrate Overview
4. To delete a workspace, perform the following actions:
a. At the top of the dashboard, from the My workspaces drop-down list, select
the workspace that you want to delete.
b. Next to the workspace name, select
Delete.
c. When prompted, enter the workspace full name and click Delete.
IMPORTANT: You cannot revert this operation all workflows associated with the workspace will be deleted.
1.6
Sharing Workspaces
With appropriate user permissions, you can provision the workspaces in your
agency to be either public or private.
Public workspaces are available for all users in your agency. 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 47.
Private workspaces are available only for a specifically defined Access
Control List of your agency 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 agency:
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.
The workspace Access Control window appears. Figure 30: Workspace Access Control Window
29
MN007834A01-AB Chapter 1: Orchestrate Overview
All users tab includes the list of all your agency 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 agency. When a workspace is private, you
can configure the user access in All users and Added users tabs.
2. In the Privacy tab, click Make workspace private. 3. To share a private
workspace with the desired users, perform the following actions:
a. Select All users tab.
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 agency, in the
Privacy tab, click Make workspace
public. Your workspace is now public and available for all the users in your
agency.
1.7
Moving Workflows to Different Workspaces
You can move workflows from one workspace to another according to your
agency’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 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
its workflow card select
Move
The workflow is immediately moved to the selected workspace.
30
MN007834A01-AB Chapter 1: Orchestrate Overview
1.8
Configuring Ally
The Ally integration to Orchestrate is performed within the Ally web
application. After succesful configuration, the Ally action become available
for use in Orchestrate.
1.9
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:
1. From the navigation on the left, select
Settings.
2. Select Orchestrate.
3. Turn on or turn off the Workflow suppression toggle according to your agency needs.
Figure 31: Workflow Suppression
31
MN007834A01-AB Chapter 2: System Health Dashboard
Chapter 2
System Health Dashboard
From the left-hand menu, you can access the System Health Dashboard, which
shows all known product service disruption incidents for your agency.
NOTE: The System Health Dashboard icon may differ depending on the highest
severity of active incidents in your system, ranging from regular black to
red. Figure 32: System Health Dashboard Icons Based on Incident Severity
Figure 33: System Health Dashboard
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 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.
Selecting the link might require authentication to that product.
32
Figure 34: Incident Details
MN007834A01-AB Chapter 2: System Health Dashboard
In the top-left corner of the page, you can switch between viewing current and
past incidents by selecting Current or Past. Past 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).
Users with Recipient of urgent notifications permission receive emails for all
incident creations, updates, and resolutions.
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.
33
MN007834A01-AB Chapter 3: Runtime Data Table
Chapter 3
Runtime Data Table
From the left-hand menu, 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 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. Complete 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.
In progress the action is scheduled to run, but was not executed yet, or it
was sent to the connector and is awaiting a response.
Failed the action was attempted to be fired, but there was a failure
response, or there was no response and a timeout.
34
Figure 35: Runtime Data Table Example
MN007834A01-AB Chapter 3: Runtime Data Table
The table does not update in real time. You can manually refresh it by
clicking Refresh in the top-right corner of the screen.
The table does not load all the content at once to load more content, you
need to scroll down.
35
MN007834A01-AB Chapter 4: Connection Center
Chapter 4
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 36: 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 37: Connection Center
Select Open for the desired product to be navigated to that product details
page.
36
Figure 38: Avigilon Product Details Page
MN007834A01-AB Chapter 4: 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.
You can print the checklist by selecting . Under Capabilities you can see the
examples of Triggers or Actions that can be used in your workflows.
NOTE: Connection Center requires appropriate system permissions in
CommandCentral Admin 2.0. For Admin 2.0 application assignment, Configure
connections (integrations) permission must be provisioned. For more
information, refer to CommandCentral Admin 2.0 Online Help. For more
information on products that integrate with Orchestrate, see Orchestrate
Deployment Guide.
37
MN007834A01-AB Chapter 5: Product Thresholds
Chapter 5
Product Thresholds
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. 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
agency 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 agency 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 Product Thresholds
When you enable product thresholds, your agency is alerted when Orchestrate
has not received any trigger events from this product within a designated time
interval. Alerts are sent to your agency administrators when the threshold is
exceeded, and again when service is restored.
Procedure:
1. From the navigation on the left, select
Settings.
2. Select Orchestrate.
3. Under Enable Threshold, next to the desired product, click Edit.
4. Enter the desired threshold value, and from the dropdown select the desired time unit.
5. Optional: If you want to enable email alerts for the agency administrators, select the Notify check box.
6. Click Save.
7. Turn on the Status toggle for the configured product threshold.
The threshold is enabled for the selected product. If the configured threshold is exceeded, a toast notification displays, and the threshold status is Exceeded! in the settings.
If the threshold is not exceeded, the threshold status is Normal in the settings.
8. To edit an existing product threshold, perform the following actions:
a. From the navigation on the left, select
Settings Orchestrate.
Under Product thresholds, the icon is green when the threshold is not exceeded, and it is yellow when the threshold is exceeded.
b. Next to the product which threshold you want to edit click Edit.
c. Enter the new threshold value, and from the dropdown select the desired time unit.
38
MN007834A01-AB Chapter 5: Product Thresholds
d. Optional: If you want to enable email alerts for the agency administrators,
select the Notify check box.
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.
9. To disable an existing product threshold, perform the following actions:
a. From the navigation on the left, select
Settings Orchestrate.
b. Under Product thresholds, next to the product which threshold you want to disable, turn off the Status toggle.
39
MN007834A01-AB Chapter 6: Audit Considerations for Orchestrate
Chapter 6
Audit Considerations for Orchestrate
All user actions in Orchestrate that modify data in any way are audited and
viewable in CommandCentral Audit. You can access the Audit application by
using the application switcher in the top-right of the page. The following is
the list of audited events (also referred to as Actions):
Create workflow Edit workflow Enable workflow Disable workflow Delete workflow
Create workspace Edit workspace Delete workspace Add user to workspace ACL
Remove user from workspace ACL Make workspace public Make workspace private
Change trigger friendly name Change action friendly name Change product
threshold config Globally re-enable all workflows Globally disable all
workflows Accept terms & conditions For each event, the following fields are
recorded (if applicable): Timestamp Action (a value from the previous list)
Details (a new state, or what changed if applicable) User ID Object
Id/Name/Url Events related to workflows, workspaces, and settings include
URLs. If a specific object was not deleted in Orchestrate, users can click the
URL in Audit to navigate to that object in Orchestrate.
NOTE: Renaming triggers and actions and accepting Terms and Conditions do not
include URLs.
40
MN007834A01-AB 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 into
Orchestrate on page 41 2. I logged in, but my cards/nodes are not appearing on
page 42 3. I cannot find the card I am looking for on page 42 4. A card name
was changed, and I need to see its original name on page 44 5. Some of the
trigger/action cards I expect to see are not showing on page 44 6. I need to
add a new trigger or action on page 44 7. The workflow is not functioning on
page 44 8. Talkgroup Action does not run on page 45 9. My saving attempt
failed on page 46 10. I just logged in, and the workflows looks different on
page 46 11. Warnings about conflicting workflow saves on page 46
I cannot log into Orchestrate
1. Ensure that you are using the correct URL: For US customers:
orchestrate.commandcentral.com For Canada customers:
orchestrate.commandcentral.ca
2. Ensure that you are using your correct user name/email. Figure 39: Login
Screen
If not, contact Support Services. 3. Ensure that you have correct password.
41
MN007834A01-AB Chapter 7: Orchestrate Troubleshooting/FAQ
Figure 40: Login and Password
If not, follow the links from the sign on page.
I logged in, but my cards/nodes are not appearing
In the case of your Workspace loading failure, you are redirected to one of
the error pages describing the issue. 1. Confirm that each system (MOTOTRBO or
Avigilon Unity Video Cloud Connection) is functioning. 2. Confirm that your
user identity is associated with the same Agency as your MOTOTRBO or Avigilon
Unity
Video Cloud Connection. 3. Contact Support.
I cannot find the card I am looking for
1. Use one of the grouping choices to limit the number of cards/nodes you are
sorting through. 2. Use Search.
42
Figure 41: Search View
MN007834A01-AB 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 42:
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.
43
MN007834A01-AB Chapter 7: Orchestrate Troubleshooting/FAQ
Figure 43: Integration Settings
A card name was changed, and I need to see its original name
Hover over the title to see the original name.
Some of the trigger/action cards I expect to see are not showing
See the “Troubleshooting” section in the Orchestrate Deployment Guide.
I need to add a new trigger or action
See the “Troubleshooting” section in the Orchestrate Deployment Guide.
The workflow is not functioning
1. If All workflows are currently disabled… is shown at the top of your
workspace, deploy the workflows by going to Settings Orchestrate and turning
on the Toggle workflows on/off.
44
Figure 44: Turning All Workflows On Toggle
MN007834A01-AB Chapter 7: Orchestrate Troubleshooting/FAQ
2. If a single workflow is not functioning, start it by clicking the toggle
switch icon in the top-right corner. Figure 45: Starting Workflows
3. Ensure that the following Edge systems are running: a. Cloud Connector and
Avigilon Unity Video b. MOTOTRBO Edge Node c. Ally
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.
Talkgroup Action does not run
A talkgroup action may fail to run for up to one minute after its alias is
updated in CommandCentral Admin.
45
MN007834A01-AB Chapter 7: Orchestrate Troubleshooting/FAQ
My saving attempt failed
Orchestrate deploys everything that is saved. If you have something in your
workflow that cannot be deployed, the system prevents you from saving.
Tooltips near the save button indicate if there are any problems on the
workspace that are preventing the save from being processed. Unsavable cards
are shaded.
I just logged in, and the workflows looks different
The reason for a different workflows look is that another user may have made
changes that have overwritten or changed the workflows.
Warnings about conflicting workflow saves
The Orchestrate workspace is a shared entity for all the users of an agency.
When two users save changes to the same workflow, the second user to save that
workflow receives a notification asking them to refresh the page to see the
most recent state of the workflow.
46
MN007834A01-AB Appendix A: Orchestrate Permissions and Access Control Lists
Appendix A
Orchestrate Permissions and Access Control Lists
Orchestrate users can have different permissions within the solution.
Permissions depend on the user’s role within their agency. For example, users
in your agency may have either the Admin or the Reader role established in the
system, with the Admins performing all operations available in Orchestrate,
and the Readers only viewing the content in Orchestrate, without edit
permissions (renaming workflows, pausing and playing, editing and creating
workspaces, etc.)
For a list of default roles, see Default Orchestrate Roles on page 49.
To access the Orchestrate UI and view the content, users must have the
Orchestrate service enabled and the view permision granted in CommandCentral
Admin 2.0 application. All additional permissions, depending on your agency
needs, can be independently assigned to specific users, in the per-role
Application permissions module.
For more information on user groups, roles, and permisions, see “Groups
Management” and “Role Management” in the CommandCentral Admin 2.0 Online Help.
Workspaces in Orchestrate also track a list of users which have been assigned
to them by using Access Control Lists (ACLs). For assigned users, any action
which they have permissions to perform can be performed within the context of
that workspace. Some permissions supersede ACLs, but having one of these
permissions is not the same as being added to all ACLs. For example, the View
all workspaces and Edit workflows in assigned workspaces permissions do not
grant a user the capability to edit all workflows in all workspaces. The users
with those permissions are able to view all workspaces, but they can only edit
those in which they are a part of the ACL.
Workspaces are currently the only entity handled by ACLs. When users are
removed from your agency in CommandCentral Admin, they remain on the ACL until
explicitly removed by an authorized user.
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. Permissions control which actions a user can perform,
and 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. A 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.
Table 1: Orchestrate Permissions Permission Name Edit all workflows
Capabilities
Enables the user to perform the following workflow edit actions:
Creating workflows in any workspace,
47
MN007834A01-AB Appendix A: Orchestrate Permissions and Access Control Lists
Permission Name
Turn on/off all workflows
Manage access for all workspaces Delete all workspaces Edit all workspaces
View all workspaces Rename triggers and actions Recipient of urgent
notifications Edit product thresholds
Capabilities
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 workspaces
Includes all capabilities of Turn on/off all workflows
Enables the user to perform the following actions: Toggling on/off the state
of workflows in any
workspace, Turning on/off all workflows globally in the Set-
tings section. Includes all capabilities of View 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 workspaces
Enables the user to delete any workspace. Includes all capabilities of View
all workspaces
Enables the user to perform the following actions: Editing workspaces,
Creating new workspaces. Includes all capabilities of View all workspaces
Enables the user to view all workspaces (including all associated workflows
and runtime data). Enables the user to rename triggers and actions (renames
globally).
Enables the user to perform the following actions: Receiving email
notifications for incident crea-
tion/update/deletions, Receiving email notifications for exceeded/re-
stored thresholds.
Enables the user to edit product threshold configurations.
48
MN007834A01-AB Appendix A: Orchestrate Permissions and Access Control Lists
Permission Name View (Access Orchestrate UI)
Edit workflows in assigned workspaces
Turn on/off workflows in assigned workspaces Manage access for assigned
workspaces Edit assigned workspaces
Capabilities
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.
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 workflows in assigned workspaces
Enables the user to turn on/off workflows in assigned workspaces.
Enables the user to manage the user access for assigned workspaces.
Enables the user to edit the assigned workspaces.
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
agency, and they are not maintained long-term by Orchestrate. You can use the
default Roles, modify them to more precisely meet your agency’s needs, or
ignore them and create new Roles with unique permission combination.
Refer to the following table for a list of permissions associated with the
default Roles established in Orchestrate.
Table 2: Default Orchestrate Roles
Role name Orchestrate Admin
Role description
Orchestrate Admins have Super Admin Permissions, and they can perform every
action available in the Orchestrate UI.
Associated Permissions
View (Access Orchestrate UI) Manage access for all workspaces Edit all
workspaces Delete all workspaces View all workspaces Manage access for
assigned workspaces
49
MN007834A01-AB Appendix A: Orchestrate Permissions and Access Control Lists
Role name
Orchestrate Agency Workspace Owner
Orchestrate Workspace Manager
Orchestrate Workflow Editor
Orchestrate Reader Orchestrate Issue Stakeholder
Role description
Agency Workspace Owners are responsible for managing workspaces. They can
perform all workspace management actions in all workspaces (assigning,
editing, deleting, viewing), and they can also create new workspaces. They
cannot edit workflows.
Workspace Managers are responsible for managing access in the workspaces they
have access to. They also have all the capabilities of Orchestrate Workflow
Editor.
Workflow Editors are responsible for configuring and editing workflows within
a workspace that they are assigned to. They also maintain the ability to
rename capabilities Agency-Wide.
Readers can view all resources with the exception of Workspaces that they are
not assigned to through the resources ACL. Responders do not have access to
the Orchestrate UI at all, but they are alerted of incident, health, and
threshold changes (and other future urgent notifications). This allows for
controlling notifica-
Associated Permissions
Edit assigned workspaces Edit all workflows Turn on/off workflows in assigned
workspaces Edit workflows in assigned workspaces Rename triggers and actions
Edit product thresholds Turn on/off all workflows
View (Access Orchestrate UI) Manage access for all workspaces Edit all
workspaces Delete all workspaces View all workspaces Manage access for
assigned workspaces Edit assigned workspaces
View (Access Orchestrate UI) Manage access for assigned workspaces Turn on/off
workflows in assigned workspaces Edit workflows in assigned workspaces Rename
triggers and actions
View (Access Orchestrate UI) Turn on/off workflows in assigned workspaces Edit
workflows in assigned workspaces Rename triggers and actions
View (Access Orchestrate UI)
Recipient of urgent notifications
50
MN007834A01-AB Appendix A: Orchestrate Permissions and Access Control Lists
Role name
Role description
tions on a user-by-user basis.
Associated Permissions
A.3
Managing Orchestrate Permissions in Admin
All permissions, depending on your agency needs, can be independently assigned
in CommandCentral Admin 2.0 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 agency, according to your needs.
Procedure:
1. Log on to Orchestrate by using your CommandCentral Admin credentials.
2. At the top of the screen, select
Admin 2.0
CommandCentral Admin 2.0 opens in a new tab.
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 agency.
7. When ready, in the top-right corner of the screen click Save.
51