Conversational Object property

Official Content
This documentation is valid for:
GeneXus object that will resolve the flow’s action. In the case of web objects, it has to be a Web Component. It's called automatically after the User inputs are entered. If the Message of the Flow has a Component view Style, and the SD Component or Web Component property is set, you have to call the conversational object from the Start Event of the corresponding component.

Description

It is a property of the Flow of a Conversational instance.

The value of this property should be a GeneXus object (Business Components, Data Providers, Procedures, Web components and SD Panels), which will end up resolving the intent associated with the Flow. 

At the end of the flow necessary to fulfill the intent, all data will be passed on to this object, which may return a response.

When is the Conversational Object triggered?

The conversational object can be triggered automatically. It happens when all of  these are fullfilled:

  1. The intent is recognized
  2. All the Chatbot User Inputs are entered

There are two different situations in which the conversational object is automatically triggered, which are the following:

1. If there is a Chatbot Response with a Message whose Style = "Component view", and the Component is auto-generated (Web Component property or SD Component property is empty), the conversational object is called from the auto-generated Component (Generated SD Component property and Generated Web Component property).

On the contrary, if the Style = "Component view" but you use a custom component (SD Component property or Web Component property is set to a component of your own), you have to call the Conversational object in the ClientStart (Start) event of your component.

2. If there is no Chatbot Response, or the Chatbot Response is a Message whose Style = "Text" or "Redirect To", the conversational object is called immediately after the User inputs are entered.

Notes:

  • You can check the generated object called <ConversationalObject>Bot, where the call to the Component, or the call to conversational object is made.
  • The value of the Conversational object can be left empty, which means that the Flow doesn't trigger the execution of any GeneXus object.

Samples

Consider the following example, where the conversational object associated with the Flow is the "GreenPlaces" procedure:

image_201842591521_1_png

The procedure has the following parm rule:

parm(in:&UserIdentification, in:&ComplaintDescription, in:&ComplaintAddress,out:&response);

Note the User inputs declared in the flow which are mapped to each of the parameters received by the "GreenPlaces" procedure.

image_201842692228_1_png

The same happens to the &response parameter, which is assigned when the "GreenPlaces" procedure finishes its execution.

Availability

This property is available since GeneXus 15 upgrade 12.

Scope

Objects: Conversational Flows

See Also

Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.