Exchange
The Exchange page is used to find, view, install, and uninstall pre-written workflows that have been released or approved by Cisco engineers and content providers.
On the Explore tab, you can locate useful workflows, learn more about them, and streamline the workflow installation process using the built-in wizard.
-
Featured - Includes newly published workflows or workflow packages that address notable user issues that you may want to investigate.
-
Popular - Includes the most popular installed workflows across all Automation user tenants.
-
All Workflows - Includes all the workflows that are currently available from Exchange.
On the Installed tab, the table lists just the workflows in your tenant that you've installed from Exchange, if any. The searchable and sortable table shows you the author, install date, and state of the workflow (Installed, Install Failed, Update Available, Update Failed). The Actions include view details of this workflow, view this workflow on the Workflows page, and Uninstall this workflow.
On the Submissions tab, the table lists all the workflows in your tenant that have been submitted for publishing to Exchange, if any. The table, both searchable and sortable, shows the workflow category, author, authorship type, when it was submitted, and current status.
For information on how to submit and manage requests to publish a validated workflow to Exchange, see the Publish to Exchange Help topic.
Next to the name of the workflow is a badge identifying who created the workflow.
-
Cisco Managed - Authored by Cisco and supported by Cisco TAC
-
Cisco Verified - Authored by a Cisco Security Technology Partner and supported by that partner
-
Community - Authored by the community, passed a basic quality check, and supported by the Cisco DevNet Community on a best-effort basis
When you use content that was not authored by your organization, review the details in the Licensing Help topic.
When searching for a workflow, you can filter what workflows are displayed in the table by:
-
Entering text or keywords in the Search field to find workflows by their name.
-
Selecting one or more product integrations from the Integration drop-down list.
-
Selecting one or more types in the Authorship Type drop-down list: Cisco Managed, Cisco Verified, Community.
-
Selecting one or more intended uses of the workflow from the Intent drop-down list: Incident Response, Pivot Menu.
On the Explore tab, you can also sort the workflows shown by the order of their average rating, either from high to low or from low to high.
On the Submissions tab, you can also filter the table by status of the request, such as Saved, Submitted, Published, Unpublished, or Rejected.
You must be signed in to Automation as an administrator to install workflows from Exchange.
-
On the Exchange page, click the Explore tab.
-
Find the workflow you want to install, and click Learn More.
-
Review the workflow information page:
-
Read the Description and make a note of any additional requirements to install the workflow. If necessary, configure those items before you install the workflow.
-
To view licensing information for the workflow, click the Content Licensing link.
-
To view notes tracking the change and update history of the workflow, click the Release Notes link.
-
-
Check the check boxes beside the object types you want to configure or update during the installation and click Install.
-
If an integration is missing and its targets required by the workflow are not available, a link is provided in the description to go enable the integration. After you successfully configure the integration, go back to restart the install of the workflow and now you'll be able to choose the available target.
-
If a workflow uses multiple objects of any type and you uncheck the box for one object, all objects of that type will also be unchecked.
-
If you're installing a workflow where some or all of the objects already exist on the tenant, the information for those items will be populated in the wizard.
-
If a workflow is configured to use a target group, the wizard will display the target types, conditions, and matched targets. The individual targets in the target group must be configured before you install the new workflow; the target types and conditions for the target group cannot be modified in the wizard. After the install completes, you can view or modify the target group details in the workflow properties. For more information on configuring target groups, see the Target Groups Help topic.
-
-
To bypass configuring all of the workflow objects, click Skip All. You can also click Skip on the individual items that you do not want to configure. You can configure the workflow objects later from the Workflow Editor.
-
Enter the values for the Account Keys, if any, and click Next.
-
Enter the values for the Targets, if any, and click Next.
-
Enter the values for the Variables, if any, and click Next.
-
Installation successful! This workflow may come with an automation rule already configured, or you may want to add an automation rule to it now. Refer to the Automate a Workflow section below.
In some cases, the workflow was installed, but was not successfully validated. The validation warnings must be addressed before the workflow can be executed.
-
Click View in Workflows to go to the All Workflows tab.
-
Open the workflow in the Workflow Editor, and complete any remaining workflow or activity properties that are required.
-
Click Validate to ensure that the workflow has the required data to run successfully. For more information, see the Workflow Editor Help topic.
If the install fails or you want to install a clean version of the workflow:
-
Delete the existing version of the workflow, any sub-workflows, and runs on the Workflows page.
-
Reinstall the workflow.
-
If the workflow exists on your tenant in a valid state, or if any associated sub-workflows or runs still exist, you'll receive an error when you click Install.
If the workflow was published to Exchange with an automation rule configured:
-
After the workflow installation is successful (step 10 above), click Automate it. The workflow is then validated and locked.
-
The install workflow panel shows the rule associated with this workflow, along with any targets and account keys being used with this workflow.
-
You can click View in Workflows to go to the All Workflows tab, where the status of the workflow will be either Import in Progress or Import Completed.
-
In the workflow properties, the rule type and name appear in the Automation Rules section.
If you want to automate the execution of this workflow by adding an automation rule to it now:
-
After the workflow installation is successful (step 10 above), click Automate it. The workflow is then validated and unlocked.
-
Select the type of automation rule from Automation Rule Type.
-
Choose an automation rule from Automation Rule Name, or click Add New to create a new rule. See Automation Rules for more information.
-
Click Submit. The workflow is then validated and locked.
-
The install workflow panel shows the rule associated with this workflow, along with any targets and account keys being used with this workflow.
-
You can click View in Workflows to go to the All Workflows tab, where the status of the workflow will be either Import in Progress or Import Completed.
-
In the workflow properties, the rule type and name appear in the Automation Rules section.
When viewing workflows on the Explore tab, you can see the average rating of each workflow on its card and the number of ratings given.
Use the Sort by Rating drop-down to arrange the workflows on the page from high to low or from low to high.
Give a workflow that you’ve installed from Exchange a rating (or adjust it) by clicking Learn More on its card. Under the name of the workflow, click a rating from 1 to 5 stars, with 5 being totally awesome!
When a workflow configuration or object gets updated in Exchange, you can replace the workflow installed in your tenant with its newer version.
On the Exchange page, next to the Installed tab, a message shows how many of your installed workflows have an updated version available in Exchange.
Any modifications you may have done to the installed workflow, such as adding targets, variables, or actions, will be lost when the installed workflow is overwritten with the newer version. If you want to retain your modifications, duplicate the workflow (and any sub-workflows) first, so while the original gets overwritten, the copy remains intact.
-
On the Exchange page, click the Installed tab.
-
Find a workflow with an Update Available, and click Update.
-
Alternatively, click the Explore tab, and click Update on the workflow card.
-
Click Overwrite installed version to proceed with updating the selected objects. Along with the new changes, your existing configuration (target, account key, and variable values) is retained and carried over into the wizard, where you can make additional modifications to objects as needed before completing the installation of the updated workflow.
You must be signed in to Automation as an administrator to uninstall a workflow that you've previously installed from Exchange, which will remove it from your tenant.
-
On the Exchange page, click the Explore or Installed tab.
-
Find the workflow you want to remove, and click Uninstall under Actions.
-
Cancel or confirm the removal of the installed workflow. Any sub-workflows would also be removed, unless they're being used by other workflows.