Custom App Series - Step 3 - Publishing to a Channel

Objective

This document will demonstrate how to publish a custom app to Lex from the ixHello platform.

Introduction to API

After an app is configured in the ixHello platform the app can be published directly to the AWS Developer Console without having to write code or configure anything in Lex.

Goal

Our goal will be to show how to publish a custom app from the ixHello platform to AWS Developer Console.

Steps

The following shows the general steps/activities that will be carried out in setting up this integration. Note: It is advisable to use same E-Mail for signup across the 3 channels below. Step 1 -3 below are compulsory.

1. Sign up for AWS account (Part of pre-requisites)

2. Sign up for ixHello platform (Part of pre-requisites)

3. Setup connection to Amazon Lex

4. Setup connection to the external web API

5. Create a custom app in ixHello.

6. Publish the app

7. Test the Amazon Lex app.

Publish to Lex

1. To publish to Lex, use top menu tabs, select “Publish” then click “Add App Publishing”.

1. Then input or select the following:

External Skill Name: ContactFinder. (This will be the name of the skill in Lex. Therefore, make it unique and different from the names of your other app in Lex.)

App Type: Search

Channel: Amazon Lex

Optional: Replace all placeholder values in all “Messages”. Uncheck all the settings shown in the second image below.

Input	Explanation
External App Name	This is the name of the app. You can give name of your choice.
App Type	It should be “Search”
Channel	Must be “Amazon Lex”
Channel Sub Type	Lex V2
Auto Publish	Keep it selected
Welcome Message	Should be auto populated.
Re-Prompt Message	Should be auto populated.
Help Message	Should be auto populated.
Goodbye Message	Should be auto populated.
Fall Back Message	Should be auto populated.

1. Publish to Lex” and this will initiate the publish process. The following results screen will appear as shown below.

2. The results screen has an option to go to the “Go To LexV2 aPP” or “Go Back to App Publishing”.

Selected App: ContactFinder (Name of the App to be published in Lex)

1. Select Amazon Lex Account, If not present then click "Add New Lex Account".

2. Afer selecting Lex Account, Click “Publish to Lex V2” and this will initiate the publish process. The following results screen will appear as shown below.

3. The results screen has an option to go to the "Test Lex Bot" or "Go to LexV2 Console" or "Go Back to App Publishing".

For each intent defined in your app, the success screen will show two rows as seen in the above screenshot.

Test the app on Amazon Lex

1. On the app publishing results page, a Go To LexV2 Console, will appear as shown.

1. Click on it, you will be redirected to the newly created Lex bot on the AWS console.

2. On the Amazon Lex bot page, ensure “Build Completed”. If not completed then the bot will be unable to test. Once in Lex, you should land on this screen.

1. Make sure it’s displaying the correct app name at the top left and then click “Test Chatbot” option at the right side. Click “Text Chatbot” then the test bot screen will appear as shown below.

1. Start testing by writing utterance in the chat area and lex will connect to the app configured in the ixHello platform. At this time a relevant response will be received.

Congratulations!

You have successfully completed an app Custom Skills Series - Step 3 publishing to the AWS-Lex console.