In the below example, I'm going to show how to do a document search on documents stored in a specific SharePoint site, from a Power Virtual Agents chatbot, using Power Automate and the Microsoft Graph API.
Here's the end result (using the new native chatbot component in Power Apps ✨😞
Accepted Solutions
Before starting, I suggest you start playing with the Microsoft Graph Explorer, especially with the "search driveitems" query:
You also might need an Azure Active Directory admin to create an application with the appropriate Graph API permissions. If not, in Power Automate, try the "HTTP with Azure AD" connector and the "Invoke an HTTP request" action (with "https://graph.microsoft.com" for both fields, the base resource URL and the resource URI).
OK, to get my bot to search documents for me, I start on the Power Virtual Agents side:
- I create a new topic, called "Document Search", and I define trigger phrases for it.
- I then ask the question "I understand you're looking for documents. Please provide me with a few keywords to help with the search."
- I capture the "User's entire response" as a "Keywords" variable.
- Then I add a new node and select "Call an action" and choose "Create a flow".
In Power Automate:
- I add as a text input "Keywords"
- I initiatize a string variable, called "ResultSet"
- I initialize a string variable called "SiteId", and give it the value of my SharePoint siteId (you can get the right siteId from the Microsoft Graph Explorer, using the "search driveitems" query).
- I initialize an integer variable, called "NumberOfResults"
I give my cloud flow a name, and I save.
In this example, I'll run the queries against the Graph API with an application (if you don't/can't have one, try the HTTP with Azure AD instead of HTTP pproach in Power Automate, as recommended in the introduction
In Azure Active Directory:
- Go to "App registrations"
- Click on "New registration"
- Give it a name and click on "Register"
- Copy the "Application (client) ID" and the "Directory (tenant) ID" somewhere for later.
- Go to "Certificates and secrets"
- Create a "New client secret"
- Copy the secret value (not the Secret ID!) somewhere, for later
- In "API Permissions", select "Add a Permission"
- Choose "Microsoft Graph", then "Application permissions", and select "Files.Read.All", and "Sites.Read.All".
- You can then "Grant admin consent" (this requires admin permissions)
Back in Power Automate:
- Add an "HTTP" action from the "HTTP" connector"
- Method: "POST"
- URI: "https://graph.microsoft.com/v1.0/search/query"
- Hearders, "Content-Type" "application/json"
- In Body:
{
"requests": [
{
"entityTypes": [
"driveItem"
],
"query": {
"queryString": "@{triggerBody()['text']}"
},
"region": "US"
}
]
}EDIT: in a below comment I also show how to filter by file type or SharePoint path to limit results.
Don't forget to add and adjust the region, as you will get this error otherwise, when trying to call the Graph API from an application:
SearchRequest Invalid (Region is required when request with application permission.)
Region is required when request with application permission.
You need to show the advanced option to then set authentication:
- Authentication: "Azure Directory OAuth".
- Tenant: the "Directory (tenant) ID" you copied from the application.
- Audience: "https://graph.microsoft.com".
- Client ID: the "Application (client) ID" you copied from the application.
- Credential Type: "Secret".
- Secret: the secret value (not the Secret ID!) you copied from the application.
Again, if you want to use your user account, you can use a similar query done with the "HTTP with Azure AD" connector and the "Invoke an HTTP request" action.
The next step is to parse the JSON answer.
You can generate the Schema from a sample, or paste the below:
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"searchTerms": {
"type": "array",
"items": {
"type": "string"
}
},
"hitsContainers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hitId": {
"type": "string"
},
"rank": {
"type": "integer"
},
"summary": {
"type": "string"
},
"resource": {
"type": "object",
"properties": {
"@@odata.type": {
"type": "string"
},
"size": {
"type": "integer"
},
"fileSystemInfo": {
"type": "object",
"properties": {
"createdDateTime": {
"type": "string"
},
"lastModifiedDateTime": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"createdBy": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
},
"createdDateTime": {
"type": "string"
},
"lastModifiedBy": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
},
"lastModifiedDateTime": {
"type": "string"
},
"name": {
"type": "string"
},
"parentReference": {
"type": "object",
"properties": {
"driveId": {
"type": "string"
},
"id": {
"type": "string"
},
"sharepointIds": {
"type": "object",
"properties": {
"listId": {
"type": "string"
},
"listItemId": {
"type": "string"
},
"listItemUniqueId": {
"type": "string"
}
}
},
"siteId": {
"type": "string"
}
}
},
"webUrl": {
"type": "string"
}
}
}
}
}
},
"total": {
"type": "integer"
},
"moreResultsAvailable": {
"type": "boolean"
}
}
}
}
}
}
},
"@@odata.context": {
"type": "string"
}
}
}
Next, we add an "Apply to each" action, so that we can append our "ResultSet" variable with each matching document. We have to go a few levels done here.
We also use an "Increment variable" action, to count the number of results we'll send back to PVA.
We also add a "Condition" node, because we want to only return results to the user for a specific SharePoint site.
EDIT: in a below comment I also show how to filter by file type or SharePoint path to limit results at the Graph API query level. A much more elegant solution than the condition in Power Automate.
On the "Append to string variable" action, you can see I use an expression.
This is to make sure the URL doesn't get messed up as spaces and such are not encoded from the Graph API results.
replace(items('Apply_to_each:_hitContainer')?['resource']?['webUrl'], ' ', '%20')
The last step is to return values to Power Virtual Agents.
Here I send back 2 variables:
- SearchResults: with the "ResultSet" variable
- NumberOfResults, with the "NumberOfResults" variable
I save the Power Automate cloud flow.
Back in PVA:
- I add the "Call an action" node and select my new flow.
- I map the appropriate variables to pass the keywords.
- After the flow, I add a "Send a message" node
- I use the cloud flow outputs to send the results to the user.
Voilà
Before starting, I suggest you start playing with the Microsoft Graph Explorer, especially with the "search driveitems" query:
You also might need an Azure Active Directory admin to create an application with the appropriate Graph API permissions. If not, in Power Automate, try the "HTTP with Azure AD" connector and the "Invoke an HTTP request" action (with "https://graph.microsoft.com" for both fields, the base resource URL and the resource URI).
OK, to get my bot to search documents for me, I start on the Power Virtual Agents side:
- I create a new topic, called "Document Search", and I define trigger phrases for it.
- I then ask the question "I understand you're looking for documents. Please provide me with a few keywords to help with the search."
- I capture the "User's entire response" as a "Keywords" variable.
- Then I add a new node and select "Call an action" and choose "Create a flow".
In Power Automate:
- I add as a text input "Keywords"
- I initiatize a string variable, called "ResultSet"
- I initialize a string variable called "SiteId", and give it the value of my SharePoint siteId (you can get the right siteId from the Microsoft Graph Explorer, using the "search driveitems" query).
- I initialize an integer variable, called "NumberOfResults"
I give my cloud flow a name, and I save.
In this example, I'll run the queries against the Graph API with an application (if you don't/can't have one, try the HTTP with Azure AD instead of HTTP pproach in Power Automate, as recommended in the introduction
In Azure Active Directory:
- Go to "App registrations"
- Click on "New registration"
- Give it a name and click on "Register"
- Copy the "Application (client) ID" and the "Directory (tenant) ID" somewhere for later.
- Go to "Certificates and secrets"
- Create a "New client secret"
- Copy the secret value (not the Secret ID!) somewhere, for later
- In "API Permissions", select "Add a Permission"
- Choose "Microsoft Graph", then "Application permissions", and select "Files.Read.All", and "Sites.Read.All".
- You can then "Grant admin consent" (this requires admin permissions)
Back in Power Automate:
- Add an "HTTP" action from the "HTTP" connector"
- Method: "POST"
- URI: "https://graph.microsoft.com/v1.0/search/query"
- Hearders, "Content-Type" "application/json"
- In Body:
{
"requests": [
{
"entityTypes": [
"driveItem"
],
"query": {
"queryString": "@{triggerBody()['text']}"
},
"region": "US"
}
]
}EDIT: in a below comment I also show how to filter by file type or SharePoint path to limit results.
Don't forget to add and adjust the region, as you will get this error otherwise, when trying to call the Graph API from an application:
SearchRequest Invalid (Region is required when request with application permission.)
Region is required when request with application permission.
You need to show the advanced option to then set authentication:
- Authentication: "Azure Directory OAuth".
- Tenant: the "Directory (tenant) ID" you copied from the application.
- Audience: "https://graph.microsoft.com".
- Client ID: the "Application (client) ID" you copied from the application.
- Credential Type: "Secret".
- Secret: the secret value (not the Secret ID!) you copied from the application.
Again, if you want to use your user account, you can use a similar query done with the "HTTP with Azure AD" connector and the "Invoke an HTTP request" action.
The next step is to parse the JSON answer.
You can generate the Schema from a sample, or paste the below:
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"searchTerms": {
"type": "array",
"items": {
"type": "string"
}
},
"hitsContainers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hitId": {
"type": "string"
},
"rank": {
"type": "integer"
},
"summary": {
"type": "string"
},
"resource": {
"type": "object",
"properties": {
"@@odata.type": {
"type": "string"
},
"size": {
"type": "integer"
},
"fileSystemInfo": {
"type": "object",
"properties": {
"createdDateTime": {
"type": "string"
},
"lastModifiedDateTime": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"createdBy": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
},
"createdDateTime": {
"type": "string"
},
"lastModifiedBy": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
},
"lastModifiedDateTime": {
"type": "string"
},
"name": {
"type": "string"
},
"parentReference": {
"type": "object",
"properties": {
"driveId": {
"type": "string"
},
"id": {
"type": "string"
},
"sharepointIds": {
"type": "object",
"properties": {
"listId": {
"type": "string"
},
"listItemId": {
"type": "string"
},
"listItemUniqueId": {
"type": "string"
}
}
},
"siteId": {
"type": "string"
}
}
},
"webUrl": {
"type": "string"
}
}
}
}
}
},
"total": {
"type": "integer"
},
"moreResultsAvailable": {
"type": "boolean"
}
}
}
}
}
}
},
"@@odata.context": {
"type": "string"
}
}
}
Next, we add an "Apply to each" action, so that we can append our "ResultSet" variable with each matching document. We have to go a few levels done here.
We also use an "Increment variable" action, to count the number of results we'll send back to PVA.
We also add a "Condition" node, because we want to only return results to the user for a specific SharePoint site.
EDIT: in a below comment I also show how to filter by file type or SharePoint path to limit results at the Graph API query level. A much more elegant solution than the condition in Power Automate.
On the "Append to string variable" action, you can see I use an expression.
This is to make sure the URL doesn't get messed up as spaces and such are not encoded from the Graph API results.
replace(items('Apply_to_each:_hitContainer')?['resource']?['webUrl'], ' ', '%20')
The last step is to return values to Power Virtual Agents.
Here I send back 2 variables:
- SearchResults: with the "ResultSet" variable
- NumberOfResults, with the "NumberOfResults" variable
I save the Power Automate cloud flow.
Back in PVA:
- I add the "Call an action" node and select my new flow.
- I map the appropriate variables to pass the keywords.
- After the flow, I add a "Send a message" node
- I use the cloud flow outputs to send the results to the user.
Voilà
Helpful resources
This month's Community Ambassador call is on May 9th at 9a & 3p PDT. Please keep an eye out in your private messages and Teams channels for your invitation. There are lots of exciting updates coming to the Community, and we have some exclusive opportunities to share with you! As always, we'll also review regular updates for User Groups, Super Users, and share general information about what's going on in the Community. Be sure to register & we hope to see all of you there!
We're pleased to share the April Community Newsletter, where we highlight the latest news, product releases, upcoming events, and the amazing work of our outstanding Community members. If you're new to the Community, please make sure to follow the latest News & Announcements and check out the Community on LinkedIn as well! It's the best way to stay up-to-date with all the news from across Microsoft Power Platform and beyond. COMMUNITY HIGHLIGHTS Check out the most active community members of the last month! These hardworking members are posting regularly, answering questions, kudos, and providing top solutions in their communities. We are so thankful for each of you--keep up the great work! If you hope to see your name here next month, follow these awesome community members to see what they do! Power AppsPower AutomateCopilot StudioPower PagesWarrenBelzDeenujialexander2523ragavanrajanLaurensMManishSolankiMattJimisonLucas001AmikcapuanodanilostephenrobertOliverRodriguestimlAndrewJManikandanSFubarmmbr1606VishnuReddy1997theMacResolutionsVishalJhaveriVictorIvanidzejsrandhawahagrua33ikExpiscornovusFGuerrero1PowerAddictgulshankhuranaANBExpiscornovusprathyooSpongYeNived_Nambiardeeksha15795apangelesGochixgrantjenkinsvasu24Mfon LATEST NEWS Business Applications Launch Event - On Demand In case you missed the Business Applications Launch Event, you can now catch up on all the announcements and watch the entire event on-demand inside Charles Lamanna's latest cloud blog. This is your one stop shop for all the latest Copilot features across Power Platform and #Dynamics365, including first-hand looks at how companies such as Lenovo, Sonepar, Ford Motor Company, Omnicom and more are using these new capabilities in transformative ways. Click the image below to watch today! Power Platform Community Conference 2024 is here! It's time to look forward to the next installment of the Power Platform Community Conference, which takes place this year on 18-20th September 2024 at the MGM Grand in Las Vegas! Come and be inspired by Microsoft senior thought leaders and the engineers behind the #PowerPlatform, with Charles Lamanna, Sangya Singh, Ryan Cunningham, Kim Manis, Nirav Shah, Omar Aftab and Leon Welicki already confirmed to speak. You'll also be able to learn from industry experts and Microsoft MVPs who are dedicated to bridging the gap between humanity and technology. These include the likes of Lisa Crosbie, Victor Dantas, Kristine Kolodziejski, David Yack, Daniel Christian, Miguel Félix, and Mats Necker, with many more to be announced over the coming weeks. Click here to watch our brand-new sizzle reel for #PPCC24 or click the image below to find out more about registration. See you in Vegas! Power Up Program Announces New Video-Based Learning Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram. These include a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the image below to find out more! UPCOMING EVENTS Microsoft Build - Seattle and Online - 21-23rd May 2024 Taking place on 21-23rd May 2024 both online and in Seattle, this is the perfect event to learn more about low code development, creating copilots, cloud platforms, and so much more to help you unleash the power of AI. There's a serious wealth of talent speaking across the three days, including the likes of Satya Nadella, Amanda K. Silver, Scott Guthrie, Sarah Bird, Charles Lamanna, Miti J., Kevin Scott, Asha Sharma, Rajesh Jha, Arun Ulag, Clay Wesener, and many more. And don't worry if you can't make it to Seattle, the event will be online and totally free to join. Click the image below to register for #MSBuild today! European Collab Summit - Germany - 14-16th May 2024 The clock is counting down to the amazing European Collaboration Summit, which takes place in Germany May 14-16, 2024. #CollabSummit2024 is designed to provide cutting-edge insights and best practices into Power Platform, Microsoft 365, Teams, Viva, and so much more. There's a whole host of experts speakers across the three-day event, including the likes of Vesa Juvonen, Laurie Pottmeyer, Dan Holme, Mark Kashman, Dona Sarkar, Gavin Barron, Emily Mancini, Martina Grom, Ahmad Najjar, Liz Sundet, Nikki Chapple, Sara Fennah, Seb Matthews, Tobias Martin, Zoe Wilson, Fabian Williams, and many more. Click the image below to find out more about #ECS2024 and register today! Microsoft 365 & Power Platform Conference - Seattle - 3-7th June If you're looking to turbo boost your Power Platform skills this year, why not take a look at everything TechCon365 has to offer at the Seattle Convention Center on June 3-7, 2024. This amazing 3-day conference (with 2 optional days of workshops) offers over 130 sessions across multiple tracks, alongside 25 workshops presented by Power Platform, Microsoft 365, Microsoft Teams, Viva, Azure, Copilot and AI experts. There's a great array of speakers, including the likes of Nirav Shah, Naomi Moneypenny, Jason Himmelstein, Heather Cook, Karuana Gatimu, Mark Kashman, Michelle Gilbert, Taiki Y., Kristi K., Nate Chamberlain, Julie Koesmarno, Daniel Glenn, Sarah Haase, Marc Windle, Amit Vasu, Joanne C Klein, Agnes Molnar, and many more. Click the image below for more #Techcon365 intel and register today! For more events, click the image below to visit the Microsoft Community Days website.
It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community. We're excited to announce that updating your community profile has never been easier! Keeping your profile up to date is essential for staying connected and engaged with the community. Check out the following Support Articles with these topics: Accessing Your Community ProfileRetrieving Your Profile URLUpdating Your Community Profile Time ZoneChanging Your Community Profile Picture (Avatar)Setting Your Date Display Preferences Click on your community link for more information: Power Apps, Power Automate, Power Pages, Copilot Studio Thank you for being an active part of our community. Your contributions make a difference! Best Regards, The Community Management Team
Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram, including a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the link below to sign up today! https://aka.ms/PowerUp
We're thrilled to announce that Ahmed Salih is our Super User of the Month for April 2024. Ahmed has been one of our most active Super Users this year--in fact, he kicked off the year in our Community with this great video reminder of why being a Super User has been so important to him! Ahmed is the Senior Power Platform Architect at Saint Jude's Children's Research Hospital in Memphis. He's been a Super User for two seasons and is also a Microsoft MVP! He's celebrating his 3rd year being active in the Community--and he's received more than 500 kudos while authoring nearly 300 solutions. Ahmed's contributions to the Super User in Training program has been invaluable, with his most recent session with SUIT highlighting an incredible amount of best practices and tips that have helped him achieve his success. Ahmed's infectious enthusiasm and boundless energy are a key reason why so many Community members appreciate how he brings his personality--and expertise--to every interaction. With all the solutions he provides, his willingness to help the Community learn more about Power Platform, and his sheer joy in life, we are pleased to celebrate Ahmed and all his contributions! You can find him in the Community and on LinkedIn. Congratulations, Ahmed--thank you for being a SUPER user!
Welcome to TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community. As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn! This Week's Tip: Private Messaging & Macros in Power Apps Community Do you want to enhance your communication in the Community and streamline your interactions? One of the best ways to do this is to ensure you are using Private Messaging--and the ever-handy macros that are available to you as a Community member! Our Knowledge Base article about private messaging and macros is the best place to find out more. Check it out today and discover some key tips and tricks when it comes to messages and macros: Private Messaging: Learn how to enable private messages in your community profile and ensure you’re connected with other community membersMacros Explained: Discover the convenience of macros—prewritten text snippets that save time when posting in forums or sending private messagesCreating Macros: Follow simple steps to create your own macros for efficient communication within the Power Apps CommunityUsage Guide: Understand how to apply macros in posts and private messages, enhancing your interaction with the Community For detailed instructions and more information, visit the full page in your community today:Power Apps: Enabling Private Messaging & How to Use Macros (Power Apps)Power Automate: Enabling Private Messaging & How to Use Macros (Power Automate) Copilot Studio: Enabling Private Messaging &How to Use Macros (Copilot Studio) Power Pages: Enabling Private Messaging & How to Use Macros (Power Pages)
