Automation Hub is the spot where you manage your automation opportunities pipeline. There might be cases when you have other 3rd party tools where you collect or perform reporting around your Automation Program.
The Open API layer provides the necessary integration layer to:
- Submit ideas from external sources (like chatbots)
- Integrate with Slack / Teams for bring the key information to the target audience
- Send data from Automation Hub to BI tools and build custom reports
Target audience: CoE leads, Heads of Delivery, IT admins, RPA Developers
Speaker:
👨‍🏫 Sorin Visan, Principal Product Manager - Automation Hub
Take control of your SAP testing with UiPath Test Suite
Â
Automation Hub Best practices - Integrating with 3rd Party Applications.pdf
1. Automation Hub Best Practices
Session 5: Integrating with 3rd
Party Applications
Sorin Visan
Product Manager
Automation Hub
2. This presentation may include forward-looking statements. Forward looking statements include all statements that are not historical facts, and in some cases, can be identified by terms
such as “anticipate,” “believe,” “estimate,” “expect,” “intend,” “may,” “might,” “plan,” “project,” “will,” “would,” “should,” “could,” “can,” “predict,” “potential,” “continue,” or the negative
of these terms, and similar expressions that concern our expectations, strategy, plans or intentions. By their nature, these statements are subject to numerous risks and uncertainties,
including factors beyond our control, that could cause actual results, performance or achievement to differ materially and adversely from those anticipated or implied in the statements.
Although our management believes that the expectations reflected in our statements are reasonable, we cannot guarantee that the future results, levels of activity, performance or
events and circumstances described in the forward-looking statements will be achieved or occur. Recipients are cautioned not to place undue reliance on these forward-looking
statements, which speak only as of the date such statements are made and should not be construed as statements of fact.
This meeting is strictly confidential. By participating in this meeting, you agree to keep any information we provide confidential and not to disclose any of the information to any other
parties without our prior express written permission. Neither the information contained in this presentation, nor any further information made available by us or any of our affiliates or
employees, directors, representatives, officers, agents or advisers in connection with this presentation will form the basis of or be construed as a contract or any other legal obligation.
Safe Harbor
3. Integration
use cases
How to use the
API
Best Practices
Documentation
Special Query
Parameters
In this session…
5. 5
2.
1.
3.
4.
ACCESS
Automation Hub data programmatically
AUTHENTICATE
Using a generated access token
AUTHORIZE
Our permission system will make sure
you have access to the right data
USE THE DATA
To build your reports or integrate with 3rd
party applications
What is the Automation Hub Open API?
6. 6
How to Authenticate?
Setup an app key
To differentiate between different
tokens generated for each integration
you setup
Start generating the
token
from the Automation Hub interface
Set the expiration date
So you can control with precision the
token validity
Select the type of token
User token
User-less token
7. 7
Token Type
A. User token – grants access to
all the endpoints, applying the
permissions the user has in
Automation Hub
B. Userless token – is limited to
a certain number of endpoints
(defined in the documentation)
and it is recommended for
generic/tenant level usage.
Automation Hub
permissions
Are applied only when a user
token is used. Based on the roles
of the user associated with the
token, we will give access exactly
to the data you have permissions
to view.
How do the permissions work with the API?
8. 8
Where can I find the documentation?
Swagger
Main documentation where you will find the latest updates around the API
and have a simple interface to try it out.
UiPath Docs
Provides general information around the API, as well as videos, demos
and best practices.
Postman
Use the Postman Collection to get access to various use cases/examples
on how to use the API.
10. 10
Excel/PowerBI integration
Manipulate data with ease with this fast integration between Excel and the
Automation Hub API
Extract Collaborators for each idea and split columns by using the role they
are assigned to on idea level.
Short Description
Use Case
12. 12
Teams integration
Send Automation Hub data to Teams and keep your users engaged with the
latest automation insights and ideas
Notify idea approvers about the ideas they need to review/action upon.
Short Description
Use Case
14. 14
Slack integration
Send Automation Hub data to Slack and keep your users engaged with the
latest automation insights and ideas
Notify idea approvers about the ideas they need to review/action upon.
Short Description
Use Case
16. 16
Best Practices when using the Open API
Use the new Submit Idea
Endpoints
These endpoints allow you to submit automation idea
via 3rd party applications, regardless if you have
performed customizations to your assessments
Use Pagination
Pagination improves the performance,
while allowing you to dynamically get
all the data you are looking for
Use the Postman Collection
This collection is a great way to get you
started on your journey with the API, as it
provides practical examples on how to use it.
Check for updates
Check the Automation Hub Release
Notes as well as the Swagger
documentation for any updates around
the API.
Merge data
Use the idea/automation ID and merge
queries to get even more data to your
report
Filter your data
Use the various filters and parameters
to get only the right data you need
18. 19
Question Answer
Is there any plugin/connector
available to connect Automation
Hub with PowerBI/Excel?
No, there isn't a plugin/connector for Power BI/Excel but here is a demo on
how to integrate with Power Bi. https://docs.uipath.com/automation-
hub/reference#power-bi-integration-video-tutorial
Our employees use Service Now
so we want to use that for
automation idea submission and
then automatically update auto
hub.
Here is a demo on how to achieve that. https://docs.uipath.com/automation-
hub/reference#service-now-outbound-integration-video-tutorial
Would be great to be able to
follow feature development from
Azure DevOps in sync with
Automation Hub
An Azure DevOps integration sits on the 2023 roadmap. We have launched
the Jira Cloud one in July 2022, and we plan to continue with the Azure
DevOps one. Could you please summarize 2-3 use cases you would like to
cover with the ADO integration, please?
Q&A (1)
19. 20
Question Answer
Unfortunately, I missed the use
case with PowerBI before. So, is
this integration possible without
any "scripting"/tool in between
AH and PowerBI?
Yes, it is possible without any scripting. Have a look at the demo video here
to see a step-by-step tutorial on how to configure and use the integration
with Power BI/Excel - https://docs.uipath.com/automation-
hub/reference#power-bi-integration-video-tutorial
Will there be a later discussion
around how to utilise the APIs
using the Orchestrator/on-
premise orchestrator?
In this webinar series, we only focus on the Automation Hub scope and
APIs, not the Orchestrator ones. I recommend reaching out to the user
documentation and Forum for deep diving on the Orchestrator APIs.
Is there any plan of expansion
on the list of requests available
in this AH Open API? e.g.
DELETE/automations/{automati
onId} to delete an automation
pipeline Currently we wish to
delete duplicate entries thru this
API from our list.
There is also the possibility of mass deleting ideas directly from the UI.
Have you tried this capability? Check the docs available here:
https://docs.uipath.com/automation-hub/docs/automation-pipeline
Q&A (1)
20. 21
Question Answer
Would be helpful to know if there
are any available options to
integrate automation hub with
jira on-prem
Currently, we have an integration with Jira Cloud:
https://docs.uipath.com/automation-hub/docs/jira-integration
For Jira on-premises, you can leverage the same Open API layer, but it
requires extra work on your side to achieve the business scenarios you
want to cover.
what's the business value? why
is it important that I integrate
these tools with my collection of
automation ideas?
Business value that might determine one to consider integrating 3rd party
applications with Automation Hub:
- easier change management, in order to not significantly disrupt the way
you collect ideas from your business users (for scenarios like SNOW
integrations)
- avoid redundant work for keeping tools in sync - AH for discovery and
opportunity backlog management and SDLC tools like Jira / ADO, which
one would use for granular task management
Q&A (1)
21. 22
Question Answer
Is it in the pipeline to POST
components? We'd specifically
like to link to source control
items rather than files, so it
should be possible, right?
We do have a POST Components endpoint in the pipeline for 2023, but the
use case you are describing links more to another feature from our backlog:
Feeds for Reusable Components. In this feature, we’re looking to change
the consumption mechanism for components from direct download to using
feeds (in the first phase we’re looking at using the Orchestrator Feeds).
Looks like your use case extends even further than that as you are looking
to link the components to source control. We don’t have any plans for that
yet, but we’d be happy do discuss more on the topic.
Will the Automation Hub API
collections be uploaded to the
UiPath Postman public
workspace?
We have not done that yet, but it’s definitely something we are considering.
Would be useful to have change
control API endpoint so we can
integrate to ServiceNow
requests into AH
Your use case can be solved by webhooks – which is a feature that we are
targeting for 2023. Using it, you would be able to fetch data from
Automation Hub based on certain events that occur in the platform.
Q&A (1)