Skip to content

Create People Bot

Jump to bottom
lauren-mills edited this page May 13, 2021 · 5 revisions

Tutorial: Setup your Enterprise People Bot

Create your project in Composer

The Enterprise Calendar Bot template is included in the Bot Framework Composer by default. Follow these steps to create a project:

  1. Open Bot Framework Composer (version 2.0.0 or higher)
  2. Click Create new
  3. Select Enterprise Calendar Bot from the list
  4. Enter your desired Name, Location, and Runtime type then select Create

Provision Azure resources

The Enterprise People Bot requires Azure resources in order to run locally. Follow these steps to provisioned the required resources:

  1. Create a publishing profile and provision resources according to the steps in Publish a bot to Azure. The following resources are required for local development:

    • Microsoft Application Registration
    • Azure Hosting
    • Microsoft Bot Channels Registration
    • Microsoft Language Understanding Authoring Account

  2. Fill in the following settings in Configure > Development Resources with the resources you provisioned:

    1. Language Understanding authoring key
    2. Microsoft App Id
    3. Microsoft App Password

Configure authentication

You must configure an authentication connection on your Azure Bot in order to log in and access Microsoft Graph resources. You can configure these settings either through the Azure Portal or via the Azure CLI.

Option 1: Using the Azure Portal

  1. Open your Azure Bot resource and go to the Configuration tab

  2. Click Add OAuth Connection Settings

  3. Assign your connection setting a name (save this value for later)

  4. Select Azure Active Directory v2 from the Service Provider dropdown.

  5. Fill in the following fields and click Save:

    • Client id: your Microsoft App ID
    • Client secret: your Microsoft App Password
    • Tenant ID: your Azure Active Directory tenant ID, or "common" to support any tenant
    • Scopes: Contacts.Read Directory.Read.All People.Read People.Read.All User.ReadBasic.All User.Read.All

  6. In the Configuration tab, click Manage next to your Microsoft App ID

  7. In the API permissions tab, click Add a permission

  8. Click Microsoft Graph > Delegated Permissions and add the following scopes:

    • Contacts.Read
    • Directory.Read.All
    • People.Read
    • People.Read.All
    • User.ReadBasic.All
    • User.Read.All

  9. In the Authentication tab, click Add a platform

    1. Select Web
    2. Set the URL to https://token.botframework.com/.auth/web/redirect

  10. In Bot Framework Composer, open your Project Settings and toggle the Advanced Settings View

  11. Set the following property to the value from Step 3:

    {
  "oauthConnectionName": "Outlook",
}

Option 2: Using Azure CLI

  1. Get your Microsoft App Object ID (used in later steps):

    az ad app show --id <bot-app-id> --query objectId

  2. Set the Redirect URL on your Microsoft App:

    az rest --method patch --url https://graph.microsoft.com/v1.0/applications/<objectId> --body "{'web': {'redirectUris': ['https://token.botframework.com/.auth/web/redirect']}}"

  3. Add the required Microsoft Graph scopes to your Microsoft App:

    az rest --method patch --url https://graph.microsoft.com/v1.0/applications/<objectId> --body "{ 'requiredResourceAccess': [{'resourceAppId': '00000003-0000-0000-c000-000000000000','resourceAccess': [{ 'id': 'b89f9189-71a5-4e70-b041-9887f0bc7e4a', 'type': 'Scope' }, { 'id': 'b340eb25-3456-403f-be2f-af7a0d370277',	'type': 'Scope'	}, { 'id': 'a154be20-db9c-4678-8ab7-66f6cc099a59',	'type': 'Scope'	}, { 'id': '06da0dbc-49e2-44d2-8312-53f166ab848a', 'type': 'Scope' }, { 'id': 'ff74d97f-43af-4b68-9f2a-b77ee6968c5d', 'type': 'Scope'	}, { 'id': 'ba47897c-39ec-4d83-8086-ee8256fa737d', 'type': 'Scope' } ]}	]}"

  4. Add your OAuth setting to your Azure Bot Service. The values for bot-name, bot-rg, bot-app-id, and bot-app-secret can be found in your bot's publish profile under Publish > Publishing profile > Edit > Import existing resources > Next.

    az bot authsetting create  --name <bot-name> --resource-group <bot-rg> --client-id <bot-app-id> --client-secret <bot-app-secret>  --service "Aadv2" --setting-name "Outlook" --provider-scope-string "Contacts.Read Directory.Read.All People.Read People.Read.All User.ReadBasic.All User.Read.All" --parameters clientId="<bot-app-id>" clientSecret="<bot-app-secret>" tenantId=common

  5. Update your Bot settings with your OAuth Connection name in the Advanced Settings View:

    {
  "oauthConnectionName": "Outlook",
}

Next steps

After you have completed the preceding steps to run and test locally, you can follow these steps to publish your bot to Azure:

Publish to Azure

To publish your Enterprise People Bot, follow these steps:

  1. Create a publishing profile and provision resources according to the steps in Provision in Composer. The following resources are required for production environments:

    • Microsoft Application Registration
    • Azure Hosting
    • Microsoft Bot Channels Registration
    • Azure Cosmos DB
    • Application Insights
    • Microsoft Language Understanding Authoring Account
    • Microsoft Language Understanding Prediction Account

  2. Publish your bot via the Publish tab

Clone this wiki locally