Creating Dialogue Flow

Here we will use the customer.ozr which we created in the OZ e-Form Developer class.

Setting FormID

The Dialog Flow UI identifies input fields by their FormID. So you have to give a FormID for every input component to be used in the Dialogue Flow.

Set the FormID the same as the Name of the component.

If the FormID is different from the Name, scripts related to the Name may not work.

Enabling Dialogue Flow

Dialogue Flow options

Put the viewer parameters to set up the Dialog Flow environments into the OnStartUp event of the ReportTemplate.

This.SetReportOption("eform.usedialogueflow", "true"); // enable Dialogue Flow
This.SetReportOption("dialogueflow.display_area", "center");
This.SetReportOption("dialogueflow.display_at_startup", "true");
This.SetReportOption("dialogueflow.auto_next", "true");
This.SetReportOption("dialogueflow.speaker", "on");
This.SetReportOption("dialogueflow.microphone", "on");

Viewer parameters for Dialogue Flow

Parameter	Value	Description
eform.usedialogueflow	"true" / "false"	Enable Dialogue Flow
dialogueflow.display_area	"center" / "full screen"	Dialogue position on the screen
dialogueflow.display_at_startup	"true" / "false"	Dialogue Flow starts automatically when the OZR opens
dialogueflow.auto_next	"true" / "false"	Auto tab to the next input field
dialogueflow.speaker	"on" / "off"	Tern on Text To Speech for questions
dialogueflow.microphone	"on" / "off"	Tern on Speech To Text for answers

When the eform.usedialogueflow option is set in your OZR, it always starts with Dialogue Flow.

If you want to enable Dialogue Flow from HTML, remove the eform.usedialogueflow option from OZR and set it in your application as below.

oz.sendToActionScript("eform.usedialogueflow", "true");

Creating Dialogue Flow

Dialogue Flow Wizard

Select the DialogueFlow Wizard from the vertical menu. If once you have added FormIDs for input components you want, the wizard will open with a list of FormIDs.

Remove unwanted components

If you have any components that you don't want to include in the Dialogue Flow list:

• Drag & drop the component to move from the Dialogue Flow list to the Do not ask questions list on the bottom left or,

• Select Do not ask questions from the right-click popup on the component to remove.

In this example, we will move email, country, and full_name to the Do not ask questions list.

Component Properties

Welcome statement

You can put an introduction message at the beginning of the Dialogue Flow.

• Title: "Starting customer registration"

• Help message: "Thank you for joining us. Please follow the instructions accordingly."

• Description: The description text will be shown just below the help message.

• Enable: Uncheck if you want to skip the Welcome statement.

Thank you statement

You can put an ending message at the end of the Dialogue Flow.

• Title: "Customer registration completed"

• Help message: "Registration completed successfully. Thank you so much."

name

• Title: "Name"

• Question: "What is your name?" (Tooltip text by default)

gender

• Title: "Gender"

• Question: "What is your gender?"

• Synonym: The user can say "man" instead of "male". Multiple synonyms are allowed.

phone

• Title: "Phone Number"

• Question: "What is your phone number?"

plan

• Title: "Plan"

• Question: Please choose your plan.

plan_from

• Title: "From Date"

• Question: Please select the starting date.

plan_to

• Title: "To Date"

• Question: Please select the ending date.

agree_all

• Title: "Agreement"

• Question: "Do you agree to the terms of service?"

signature

• Title: "Signature"

• Question: " Please sign here."

Save the Dialogue Flow and form

• Click the Save button on the bottom-right of the Dialogue Flow Editor.

• Save the form as dialogueflow.ozr.

Testing Dialogue Flow

Preview the form and expand the width of the window to see a Combobox for the Dialogue Flow.

Choose Yes from the Combobox. And then you will see the Dialogue popup window as below.

You can go forward through the Dialogue Flow.