Skip to content

Latest commit

 

History

History
127 lines (72 loc) · 6.76 KB

advanced-bot-framework-composer-fundamentals.md

File metadata and controls

127 lines (72 loc) · 6.76 KB
title description keywords ms.date ms.topic author ms.author ms.reviewer ms.custom ms.collection
Getting started with Bot Framework Composer
Import your Power Virtual Agents bot into a Composer project to extend your bot's capabilities.
composer
11/03/2022
article
iaanw
iawilt
makolomi
cex
virtualagent

Getting started with Bot Framework Composer

[!INCLUDE Composer integrated with PVA]

To use Bot Framework Composer to extend your Power Virtual Agents bot, you'll need to first import your bot into a Composer project.

Prerequisites

Open your bot in Composer

Important

You should always open Composer from within Power Virtual Agents. This will ensure that Composer has all the necessary plug-ins needed for integration with Power Virtual Agents.

  1. Go to the Topics page for the bot you want to edit and select the down-arrow symbol next to + New topic.

  2. Select Open in Bot Framework Composer in the dropdown menu to open your bot in Composer.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/Composer_OpeninBotFrameworkComposerButton_dropdown.png" alt-text="Screenshot of the button used to open a bot in Composer.":::

  3. If you don't have Composer installed already:

    1. Select download Composer.

      :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/composer-not-present.png" alt-text="Screenshot of the download Composer link highlighted.":::

    2. In the Download Bot Framework Composer window, select Download Composer.

      :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/download-composer.png" alt-text="Screenshot of the Power Virtual Agents Composer window indicating that Composer is not installed.":::

    3. When the download completes, run it to install Composer.

    4. Once you've installed Composer, go back to Power Virtual Agents. Go to the Topics page and select the down-arrow symbol next to + New topic.

      [!NOTE] In some cases, a firewall might be blocking some features in Composer and you might need to explicitly allow access. Check with your admin for details.

  4. If Power Virtual Agents is unable to launch Composer automatically, you can launch it manually:

    1. Select Copy Link to copy the link to your clipboard.

      :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/copy-link.png" alt-text="Screenshot of copy link button.":::

    2. Open a new tab and paste the link in your web browser's address bar.

  5. The first time you open a Power Virtual Agents bot in Composer, it will be imported into a new Composer project. The name you specified in Power Virtual Agents will automatically be used as the name for the project, but you can also enter a custom name.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/ComposerUI_CreateProject.png" alt-text="Screenshot of the import screen in Composer.":::

  6. Select Create to finish importing your bot into Composer.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/ComposerUI_Open_initialView.png" alt-text="Screenshot of the import screen in Composer with the create button highlighted.":::

Test Composer content within Power Virtual Agents

You can't use the Bot Framework Emulator to test Composer content created for Power Virtual Agents bots. Instead you'll need to publish your Composer content to your Power Virtual Agents bot, then use the Test bot pane.

[!INCLUDE Publish Composer]

  1. Go to the Publish page.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/publish-tab.png" alt-text="Screenshot of the publish tab in Composer.":::

  2. Select your bot in the Bot list, then select Publish selected bots.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/publish-bot.png" alt-text="Screenshot of the bot selected for publish.":::

  3. Optionally enter a message for Comments, then select Okay.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/publish-window.png" alt-text="Screenshot of the publish window.":::

  4. Once publishing completes, go to Power Virtual Agents. You may need to refresh the page to see the new topics you've added in Composer.

  5. Open the Test bot pane and start a conversation by typing in a trigger phrase.

View the publish log

If you're having trouble publishing your Composer content to Power Virtual Agents, you can troubleshoot by reviewing the publish log. The publish log provides a detailed description of any warnings or errors encountered during validation and suggestions on how to fix them.

Note

If you're having trouble with your Power Virtual Agents bot, use the topic checker instead.

  1. In Composer, go to the Publish page.

  2. Select the right arrow (>) next to your bot. You may need to increase the size of the Composer window to make the arrow visible.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/open-publish-history.png" alt-text="Screenshot of the right arrow button.":::

  3. Under Publish history, select View log.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/view-log.png" alt-text="Screenshot of the View log button under Publish history.":::

  4. In the Publish log window, review logs for any errors or warnings.

    :::image type="content" source="media/advanced-bot-framework-composer-fundamentals/Tl_PublishError.png" alt-text="Screenshot of the public log.":::

If you encounter issues developing in Composer, you can:

Next steps

To help you get started using Composer, we've created four examples that detail different scenarios:

[!INCLUDEfooter-include]