README.md

Microsoft Graph Search API Sample for Excel (Node.js)

Table of contents

• Introduction
• Prerequisites
• Getting started with the sample
• Build and run the sample
• Code of note
• Questions and comments
• Contributing
• Additional resources

Introduction

This sample includes a NodeJS/Express application that demonstrates how to add an AddIn to Outlook and trade and IdentityAPI token for a Graph token to make a call to Microsoft Graph Search API endpoint.

Prerequisites

This sample requires the following:

• Visual Studio Code
• Outlook 2016 or higher
• Microsoft work or school account

Getting started with sample

1. Download or clone this repo.

Create an Azure AD Application

Follow the steps in Configuring Azure.

Configure the project

1. Open Visual Studio code to the ./Sample2.2a/SearchBetaApi folder
2. Open the server.ts file
3. Replace the values for the following:

• {client TenantID} - your Azure AD Tenant ID
• {client GUID}- the client id from the Configuring Azure steps
• {client secret} - the client secret from the Configuring Azure steps

NOTE: If you did the Visual Studio sample in Sample 2.0, you can skip to Test the AddIn as all the settings are the same.

Update the AddIn manifest xml

1. Open the GraphSearchApiOutlook.xml file
2. Scroll to the bottom of the file, in the WebApplicationInfo section, ensure that the clientid matches the client id from the Configuring Azure steps
3. Save the file

Test the AddIn

1. Switch back to Visual Studio Code
2. Click the debug tab, then select Launch Program configuration
3. Switch back to Excel, click Retry to refresh the application task pane.
4. Run a search, review the results that are exported to the workbook sheet as a filterable and searchable table

Code of note

• Remember if you make changes, you must run npm run-script build to rebuild the TypeScript files into their corresponding javascript.
• The server.ts file contains the endpoint that will trade the identity token for the graph token.

Questions and comments

We'd love to get your feedback about this sample! Please send us your questions and suggestions in the Issues section of this repository.

Your feedback is important to us. Connect with us on Stack Overflow. Tag your questions with [MicrosoftGraph].

Contributing

If you'd like to contribute to this sample, see CONTRIBUTING.md.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Additional resources

• Microsoft Graph Security API Documentaion
• Other Microsoft Graph Connect samples
• Microsoft Graph overview
• Sideload Outlook add-ins for testing
• Tutorial: Build a message compose Outlook add-in
• Deploy and publish your Office Add-in
• Use the Outlook REST APIs from an Outlook add-in
• Identity API requirement sets
• Enable single sign-on for Office Add-ins
• Authorize to Microsoft Graph in your Office Add-in
• Register SSO AddIn in AAD v2
• How to switch from Semi-Annual Channel to Monthly Channel for the Office 365 suite
• Troubleshoot error messages for single sign-on (SSO)
• Enable your tenant for Modern Autentication
• Microsoft Graph with Node/Express App

Copyright

Copyright (c) 2019 Microsoft. All rights reserved.