Channels registration template

Template for the registration of a channel in Aura

How to use the template

The main steps that OBs willing to register a channel in Aura must follow are summarized below:

Create a task for channel registration in JIRA
Copy the table below and paste it onto the JIRA task
Fill in all the fields in the table’s column “Value in channel” for the complete definition of the channel.
Do not modify the content of the remaining columns aside from “Value in channel”.

This will serve as the basis for the subsequent creation of the channel by Aura by Aura Global Team or GES.

Template

CHANNELS REGISTRATION TEMPLATE
a. Channel basic data
Property	Definition	Feasible Values	Value in channel
Channel name	Channel descriptive name Use lowercase hyphen-separated words	N/A	to be completed
Channel prefix	Minimal expression of the channel name Use lowercase hyphen-separated words	N/A	to be completed
Channel ID	UUID that identifies the channel univocally in Aura	N/A	to be completed
Channel type	Type of channel among the feasible values	*- directline* *- directline.tv* *- whatsapp* *- auraline*	to be completed
Formats	Specific formats used by the channel: language, date, currency, etc.	N/A	to be completed

b. Channel configuration
Property	Definition	Feasible Values	Value in channel
Configuration environments	Name of environment(s) where the channel is to be configured	N/A	to be completed
channelData version	Version of the channelData property that defines Aura request-response model	*- channelData v1* *- channelData v2* *- channelData v3*	to be completed
Response type	Type of response messages supported by the channel. Parameter defined in the outputMessageFormat channel model property. Recommended value in new channels: *custom*	*- custom: TV channels - enrich: Channels supporting Adaptive Cards (Novum) - simple*: Channels supporting Hero Cards (WhatsApp)	to be completed
Global suggestions	Indicate if the channel must include global suggestions	*- Yes* *- No*	to be completed
Disambiguation	*- Suggestions* *- Prompt* *- Disabled*	to be completed
Type of users	Type(s) of Aura users that can be supported by the channel	*- Anonymous users* *- Authenticated users*	to be completed
Type of anonymous users	Type of anonymous users, depending on the `userId`	*- Anonymous* *- Identifiable* *- N/A*	to be completed
Authentication type	Type of authentication supported by the channel	*- Integrated authentication* *- Non-integrated authentication* *- N/A*	to be completed
UserProfile allowed?	Indicate whether or not UserProfile Kernel API must be called when authenticating a user in the channel	*- Yes* *- No* *- N/A*	to be completed
Terms and Conditions required?	In case of integrated authentication, indicate whether or not T&C are required	*- Yes* *- No* *- N/A*	to be completed
POEditor resources	Are specific POEditor resources required for this channel? If yes, add the list of resources from other channels that should be duplicated here	*- Yes* *- No*	to be completed

c. Understanding issues
Property	Definition	Feasible Values	Value in channel
Aura NLP required?	Indicate whether or not the channel counts on any training handled by Aura NLP	*- Yes* *- No*	to be completed
*- Yes* *- No*	to be completed
Entities recognition stages	Indicate if NLP will contain entities recognition stages (therefore, dictionaries will be required)	*- Yes* *- No*	to be completed
Local grammars	Indicate if local grammars are required	*- Yes* *- No*	to be completed
NLP development	Indicate which team is in charge of NLP development	*- OB's Local Team* *- Aura Global Team*	to be completed

Last modified May 18, 2026: Remove KGB (52b04d91)