About This Document
The Dashboard System Description is for developers and administrators who are creating, configuring and managing apps with voice assistants. The Documentation is divided into chapters according to the Dashboard main menu, it describes the purpose and, where relevant, valid inputs for fields on Dashboard pages and subpages.
You can access the Dashboard through a web browser by clicking here
The following login screen appears:
Enter your Dashboard username and password or use your Google account to Log in
Forgot your password? To request a new password, click on the Forgot your Password, enter your e-mail address, and click E-mail new password. You will receive a link that provides you with a one-time login to the Dashboard, where you can change your password.
Click on the Create account link if you don’t have an account. Enter your first and last name, and an e-mail address, then click Create new account. You will get a link. Use it to log in to the dashboard and set your password.
Creating a New App
Select New App in the Dashboard main menu to access the wizard where the administrator or developer defines a new app:
Select Custom industry from the drop-down menu and enter your company name. When done, click next. On the second screen, you can decide which devices and services you’d like to support.
- Click on one of the icons to select it.
- Then click Next to proceed to the third screen. Select Customize to edit your new app.
- If your Industry is Banking, you will be able to choose the name of the bank from our list.
- Once done, select “Publish” to add your new Alexa Skill to Amazon.
Editor Top Menu
Select Editor in the Dashboard main menu to access the Dashboard page where the developer views and edits the adaptation rules for a selected app. Select the app to be edited from the list of staging sites (by default).
Use the buttons starting from left to right to carry out the following actions in the upper menu of the Editor:
- Save: Saves all changes made to the adaptation rules.
- Refresh: Clear recent un-saved changes
- Beautify: Beautify source code format
- Export Rules: Export the rules to zip file
- Export Media: Export the media to zip file
- Import Rules: Import rules (zip file)
- Clear Cache: Clears the cache for that app.
- Revisions: Select the revision version (by its timestamp) to view the adaptation rules. To revert back to the desired rules revision, click on the Revert revision button.
The deleted set can be restored by first selecting it from the sets drop-down menu and then reverting one of the revisions.
- Publish: Copies the rules to the production site, clears the production site cache, and copies various configurations to the production site.
- Publish Alexa Skill: Opens a step-by-step wizard to help you set up your Alexa skill.
- Sets: Show / Hide rules sets selection
- Add Rules Set: Add new rules set
- Show Simulator: Show / Hide simulator view
The scripts for the selected domain are managed in the Editor tabs on the left.
Interaction (Graphic Editor)
The Graphic Editor is used to create new intents, add sample phrases to invoke these intents, edit assistant’s response and re-prompt messages.
You can also add custom entities for users to provide their input on it.
- What is an intent?
An intent represents an action that fulfills a user’s spoken request.
The list of intents depends on the industry selected for the skill: e.g. banking will have such intents as balance, transactions, transfers, etc.
- Creating an intent
First, type the name and then click on the Add button. The intent will be added to the list.
- Editing an intent
The name of the intent can later be edited by clicking on the Edit sign.
- Reordering intents
Click on the sign and then drag and drop the intent you want to move to change its order.
- Intent creation and editing
Open the Intent to be able to add sample sentences, entities, and responses or edit the existing ones.
- Disabling and deleting intents
Each intent can be disabled or deleted. A disabled intent will still be present in the editor list, but it will not appear in the Interaction model while publishing the flow.
- Sample Sentences
A sample sentence is a phrase said by the user to invoke an intent. Click on the Add button to create new sample sentences.
The sentences created before can be edited or deleted.
Note that an utterance can contain only Unicode characters, spaces, and valid punctuation.
Valid punctuation marks are periods for abbreviations, underscores, apostrophes, and hyphens.
- Discovery Suggestions
Discovery suggestion is an optional feature that allows adding a “hint” phrase in case the user does not know what to ask. It is usually a sample sentence from one of the existing intents.
‘Discovery suggestion’ can be used when there is no reprompt message.
An example of an entity is a ‘date’ or ‘type’ in a skill called My Bank.
A user can say: What were the transactions on the first of May (date) on my savings (type) account?
Entities are divided to custom and predefined.
- Custom entities – a representative list of possible values for an entity. Custom entities are used for lists of items that are not pre-integrated.
- Predefined entities are those already integrated into conversation.one.
You can always create a new entity and delete an existing one.
A response is a text spoken back to a user as an answer to their request. It can also include a card to be displayed in Alexa app ( a card usually contains text and optionally an image).
The text can be static or dynamically defined by a function.
The state of the End Session checkbox indicates whether a session should close after the assistant’s response or remain open.
Reprompt text such as “is there anything else I can do for you?” is needed when a session continues, but the user doesn’t say anything.
- Manage Entities
The Manage entities section contains entity types that define how the data in the entity is organized and handled, list of entity values and list of intents that use the given entity type.
You need to click on the Entity type field to open the lists of values and intents. It is also possible to add and delete entity types and values.
This tab contains additional code that can be used as an intent response.
The tab allows generating APIs from existing web applications.
The tab allows designing a login page for account linking.
The tab allows uploading different file types that can later be used on the Authorization tab.
- In the editor tab, click the find button to search for text in your app and write the text to be searched.
- Choose search in current set or all sets (examples below).
- In the find/replace box click the replace tab to replace text in your app.
- Write the text to be replaced in the “Text” field.
- Write the replacement text in the “Replace with” field.
- Mark the specific result you want to replace and click Replace or press Replace all to replace all results.
My Apps Home Page
Select My Apps in the Dashboard main menu to access the My Apps homepage:
My Apps tab provides access to the following app parameters:
- General: App parameters that are common to both the Staging app and the Production app.
- Production: app parameters that are unique to the Production app, i.e., the app that is published and accessible to end-users.
- Staging: app parameters that are unique to the Staging app, i.e., an internal app that is under development and available only to developers.
Other actions you can perform in the current tab:
- Save: You must click this button in order to save changes made in the App Manager.
- Clear Cache: We recommend clearing an app’s cache after editing apps parameters (as explained below), after changing the Dashboard version, or upon any kind of malfunction in the app..
- Edit: Go to the Edit app page.
- Delete: Permanently delete the app.
- Export: Export scripts and sets to a file.
- Import: Import previously exported scripts and sets.
The following app parameters appear in the Features section of the General parameters tab:
Use as master: If checked, the rules can be inherited to other Apps.
Use as public master: If checked, the corresponding app will appear in the master list when creating a new app, the rules of the “public master” app can be inherited to other Apps.
The Analytics section contains the following info:
Analytics ID: site id is taken from the Piwik analytics server. Click Remove to delete the id and then the Add button to automatically generate a new domain in the Piwik analytics system.
If you already know your site id you can edit it manually.
Add default tracking code: If checked, automatically adds a tracking code to each page of a site.
Both features (Analytics ID and Add default tracking code) are available only for admin users.
The following app parameters appear in the Information section of the General parameters tab:
App ID: Automatically generated when the app was created
Last update: Automatically generated when the app was last updated
Click the Single New Permission or the Group New Permission button to add a User/Group drop-down.
Select from the drop-down list the relevant user or group.
Click the Save button to save changes.
When you select the Production tab in the App Manager, the following page appears:
The following Production App parameters are controlled in the Settings section:
Name: By default, this will be the App name specified when the app was created.
Master: Select from the drop-down list all of the apps whose customization rules have been made available for inheritance.
The following Production App parameters are defined in the Alexa section:
Alexa suppport: enables Alexa skill.
Account linking: allows integrating your Alexa skills with a third-party application.
Redirect URLs: The list of HTTPS redirection endpoints that could be requested during authorization to redirect the user back to after the authorization process.
Client Id: Unique public string used to identify the client requesting for authentication.
Client secret: Unique private string used to identify the client requesting for authentication.
Client Id and Client secret are generated automatically.
A server for your app can be selected in the network tab.
The fields in the Staging tab are the same as in the Production tab, except that they apply to the staging sub-domain, i.e., a sub-domain that is used for development.
Select Analytics in the Dashboard main menu to access the Dashboard page that presents a detailed analysis of your data.
Once an app has been selected, analytics information will be shown.
Choose an app from the list to view the report. Mind that only published apps will have analytics data. The report contains Intents over time graph and two pie charts.
Mouse over the graph to see the exact number of users and intents.
You can change the time range presented in the report by selecting one of the options from the drop-down menu on top.
Click Custom range to set your own dates.
Mouse over the pie charts to see the exact data in percentage.
Figure: Pie charts info
Select Servers in the Dashboard main menu to change the name or hostname for an existing server, or to provide the same parameters for a new server.
Select Audit Logs in the Dashboard main menu to access a table of all system actions carried out on the Dashboard.