This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Global use cases

Use global use cases

Learn how to make the most of Aura global use cases, experiences already developed by Aura Platform Team at your disposal

Introduction

Aura global use cases are experiences already designed, developed and tested by the Aura Platform Team (i.e., check my bill; list my bundle; data allowance; etc.).

Take into account that global use cases cannot be modified by OBs, they must be used as they are. You only have to perform a mandatory task over them for the edition of texts to be included in the response to your users.

Optionally, you can install the use case in local environment to become aware of how it is designed and build as an inspiration source for the development of other local use cases.

Check the global use cases currently included in Aura Platform:

  • Experiences in video services related to play TV content, channels tuning, navigation and other use cases for TV-related channels.
    Find the available experiences in Aura video use cases.

Interested in making a global use case available in your Aura system?

1 - Install global use cases

Install global use cases

Guidelines for the installation of Aura global use cases

Introduction

If you are interested in taking advantage of an Aura global use case, already developed by Aura Platform Team, follow these instructions for its installation.

Installation of global use cases

To install the global use cases, use the following command:

npm run local-dependencies:install

This command will add the dependencies of the global use case libraries in both the package.json and the plugin-config.json file and install them into the project.

In order to install the versions needed, please update the following file local-dependencies/libraries-list.json and set the corresponding versions of your libraries.

⚠️ Remember to add a new profile if checking a new version of the libraries. For instance:

To test aura-platform version killets:

[
     {
        "profile": "release/killers",
        "description": "Use cases delivered in The Killets",
        "disttags": [
            "devkillers"
        ],
        "libraries": [
            { "name": "@telefonica/aura-bot-alfred-library" },
            { "name": "@telefonica/aura-bot-bill-library" },
            { "name": "@telefonica/aura-bot-cognitive-library" },
            { "name": "@telefonica/aura-bot-common-library" },
            { "name": "@telefonica/aura-bot-disambiguation-library" },
            { "name": "@telefonica/aura-bot-generic-library" },
            { "name": "@telefonica/aura-bot-handover-library" },
            { "name": "@telefonica/aura-bot-issues-library" },
            { "name": "@telefonica/aura-bot-linking-library" },
            { "name": "@telefonica/aura-bot-miscellaneous-library" },
            { "name": "@telefonica/aura-bot-none-library" },
            { "name": "@telefonica/aura-bot-onboarding-library" },
            { "name": "@telefonica/aura-bot-recommender-library" },
            { "name": "@telefonica/aura-bot-services-library" },
            { "name": "@telefonica/aura-bot-tv-library" },
            { "name": "@telefonica/aura-bot-wakeup-library" },
            { "name": "@telefonica/aura-bot-wifi-library" }
        ]
    }
]

Uninstallation of global use cases

To uninstall the global use cases, use the following command:

npm run local-dependencies:uninstall

This command will uninstall all the dependencies of the global libraries you have previously installed, it will also clear the file package.json and plugin-config.json.

Installation of dialogs in Aura minibot

Yo can see how to install new dialogs here

2 - Manage global use cases

Use Aura global experiences

Learn how to make the most of Aura global use cases, experiences already developed by Aura Platform Team at your disposal

Introduction

In this section, two actions to be done over Aura global use cases are explained, both for the edition of texts in Aura response and for analyzing how the experience has been developed.

Build Aura response: edit POEditor texts

ℹ️ This section is intended for OBs’ content managers in charge of editing texts included in Aura response.

When a global use case is implemented, it is necessary to design Aura response for each step of the conversational flow. The different texts, in a specific language, shown to the user are designed through POEditor.

  • For global use cases, you should work over the POEditor Aura-bot project, which is managed by the Aura Platform Team.
  • Resources are already created in aura-bot, so at this stage you only have to edit the copies (texts) of each resource.

Edit texts

In the POEditor global project, edit the texts (copies) of the existing resources associated with the use case under development or translate texts to one specific language.

Follow the Guidelines for the edition of texts in POEditor but taking into account that you have to work with Aura Global project in POEditor.

Import locale files

Import the locales files from POEditor to aura-bot.

Once imported, when a new version of the library is generated, they are automatically integrated during the make-up process.

Management of locales for intents canonical phrases

The management of canonical phrases for intents has been implemented in POEditor, as intents must have a canonical phrase to be able to disambiguate with them.

To do this, follow the guidelines in Manage locales for canonical phrases of intents.

Analyze a global use case in local environment

Moreover, OB product managers can be interested in analysing the global use cases in order to know how they are designed, their structure and files, associated dialog logic, etc. This can be an inspiration for building your own local experiences.

From the point of view of aura-bot, the OB should carry out the following tasks:

Get started and configure Aura Bot

This step is required only for developers that firstly face aura-bot and need the creation and configuration of a bot service in your local environment.

If this is your case, learn how to do it the section Get started with Aura Bot.

Install global use cases dependencies in local environment

In order to install the versions needed, update the file local-dependencies/libraries-list.json and set the corresponding versions of your libraries. Remember to add a new profile if checking a new version of the libraries.

  • The installation of the libraries must be carried out through the following command: npm run local-dependencies:install This command adds the dependencies of the global use case libraries both in package.json and plugin-config.json files and installs them into the project.

  • To uninstall libraries from global use cases, developers must use the following command: npm run local-dependencies:uninstall This command uninstalls all the dependencies of the global libraries previously installed, and also clears the file package.json and plugin-config.json.

Bot running

Once the aura-bot instance is properly configured according to the guidelines established in the previous sections, the instance can be started using the following command for running the bot in local environment:
npm start

The previous command can be enriched passing environment variables following the guidelines stated by the concrete operating system where the aura-bot instance is about to be started.