Getting Started with Orchestrator

This section contains the basics required to build and deploy a simple Dialog Application. The Dialog Application is a sequence of combined miniApps and other building blocks (optional) for running a conversation according to the logic predefined.

The progress is saved automatically at any point of the development.

To log in to Conversational Natural Language, follow the steps below:

1. Navigate to Home | Omilia Cloud Platform and click Console, which is a unified entry point for managing all OCP® services.

2. Select the regional OCP Console URL that you are using.

3. Enter your email or OCP® username and click Sign In.

4. Enter your password and click Sign In.

5. If the credentials are correct, you are forwarded to the OCP Console® landing page. Click Orchestrator on the sidebar on the left.

6. You will be forwarded to the landing page of Orchestrator where it is possible to:

• select one of the applications to work on:

  

• or start with creating a new application by clicking the +Create button:

  

7. If it is the first use of the Orchestrator, it is prompted to create a new application. Fill in the fields of the Create new application form that pops up once you log in.

• Application Name: enter a name for your new Dialog Application.

• Group: select a group from the available groups of the dropdown list to which the Dialog Application belongs. The Dialog application is accessible from other group members.

8. Click Save to be directed to the Orchestrator board.

• 

  The left sidebar contains the building blocks: miniApps, Flows, Shared Flows and Dialog Controls, which are the building blocks of the Dialog Application.

• The central part displays the canvas where you can drag and drop building blocks, connect them with arrows and create a Dialog Application.

• In the upper panel there is a tab of the current Dialog Application. The dot on the left of the current Dialog Application’s name is grey if the application is not deployed and turns green if the application is deployed.

• In the upper right, there is a dropdown menu of the available Dialog Applications that you can switch between, and the Deploy button to deploy your Dialog Application at any time for testing or production use.

• Click the Chat  icon in the lower right corner to open the Orchestrator chat and simulate a deployed Dialog Application.

• The Event Handlers drawer on the right side allows the configuration of possible conversation scenarios if an error occurs.

Create a Dialog Application

To create a simple Dialog Application, follow the steps below:

1. Navigate to the miniApps panel on the left sidebar and click the +Create button to create a miniApp of any particular type. Read on about the types of miniApps on Types of OCP miniApps®.

2. Fill in the form which allows to create a miniApp directly from Orchestrator. For more information, check out How to manage your miniApps® and click Save when finished.

3. If you want to view the list of all the available miniApps and manage them, click the Console icon.

3. Once created in the miniApps web application, it is automatically listed in the miniApps tab of the Orchestrator.

4. If you want to change some settings of the miniApp, it also possible to do it directly through Orchestrator:

• Сlick the Options menu in the right upper corner of the miniApp.

• Select the Configure option.

• Once clicked, you are redirected to the miniApp’s configuration page within Orchestrator.

4. To apply a miniApp in the Dialog Application, drag and drop it onto the canvas.

A basic Dialog Application is built. This Dialog Application that contains this particular miniApp will be played when receiving a call or talking to a chatbot.

5. Click the Deploy button to run the Dialog Application. The Dialog Application is ready to accept calls and have sessions with a chatbot.

6. A message appears if the deployment was completed successfully.

7. To test the Dialog Application, click the Chat icon in the right lower to open the Orchestrator Chat. The Orchestrator Chat simulates the conversation using the deployed Dialog Application on the canvas.

Connect building blocks

To connect building blocks, follow the steps below:

1. Navigate to the miniApps panel at the left sidebar, and click the Manage button to create a miniApp in OCP miniApps® web application. Configure this miniApp according to purpose whether it is a question trying to get an intent or information out of the caller, an announcement, or anything else. Once created, it is listed in the miniApps section.

2. Select the created miniApp and drag and drop it onto the canvas.

3. Hover the cursor over a building block on the canvas. When the dots appear, click on the building block and hold. Drag the connection line to the building block you want to connect to (a second miniApp in this case) and release the button to connect them.

Application Options Menu

If clicking the Application Options menu button, it will provide you with the following options:

• Incoming Attached Data

• Voice Biometrics

• Global Fields

• App as Flow

• Share

• Delete

Delete a Dialog Application

To permanently delete a Dialog Application, do the following:

1. Select the Dialog Application you want to delete and click the Options menu button on the Dialog Application panel.

2. Click on the Delete option to open the confirmation window.

3. In the confirmation window, type CONFIRM DELETE in the corresponding field, and click the Delete button to finish.

Once deleted, the Dialog Application can not be restored!

App as Flow

The App as Flow feature allows users to re-use Applications developed by others in their own applications similarly to Flows. It is possible for the Application to have configured Inputs and Outputs in order to receive or send values before or after shared Application could be used in a Subdialog. Note that Inputs and Outputs can be configured without having an Application shared. Read more about Configure settings of miniApps and Flows in the corresponding section. The Application becomes visible as Shared App after setting the groups in Share dialog even with no Inputs or Outputs configured.

To use the App as Flow option, follow the steps below:
1. Click the Options menu button on the Application name tab, and select App as Flow.

2. Configure the Input and Output Fields as described Configure settings of miniApps and Flows section. It is possible to assign multiple values. Also, you can switch the Report Flow toggle bar and select the reporting type for this Application/Flow. Read more about reporting type in theManage Flowssection. Click Save when finished.

3. The success message appears when completed.

Share Application

The Share option allows to share the Application with other groups so that the users who don’t belong to your group could still use it. Note that you can select multiple groups. Once shared, the Application will be available in the Shared Flows and could be used as a sub-flow.

To share the Application, proceed as follows:
1. Click the Options menu button on the Application name tab, and select Share.

2. In the opened window select the group you want to share the Application with from the dropdown list. Click Save when finished.

3. When shared, the Application will appear in the Shared Flows section.

4. Once appeared in the Shared Flows section, these Flows are available to be drag and dropped onto the canvas and can be managed as regular Flows. Read more about Flows in the Manage Flows section.

Migrate a Dialog Application

App Migration is an experimental feature that allows changing internal application data structure to improve large applications performance. When migrated, the application's miniApps store the configuration and lose the ability to use the existing miniApps interface for these miniApps. All flows and miniApps that exist in the application at this moment will be upgraded to a new version and become incompatible with previous versions.

To use the Migrate feature, proceed as follows:

1. Select the Dialog Application you want to delete and click the Options menu button on the Dialog Application panel.

2. Click the Migrate option.

3. Confirm the migration by typing CONFIRM MIGRATE in the appropriate field.

Orchestrator keyboard functions

Delete a building block (miniApp, Flow, Condition, Transfer)

1. Click on the building block you want to delete to select it.

2. Press <Fn> + <Backspace> or the <X> button on the keyboard.

Delete a connection between building blocks

1. Click on the connection line you want to delete to select it.

2. Press <Fn> + <Backspace> or <X> button on the keyboard.

Copy and paste a single building block.

1. Click on a single building block you want to copy.

2. Press <Cmd/Ctrl> + <C> to copy it.

3. Hover the cursor onto the canvas and press <Cmd/Ctrl> + <V> to paste it.

To select multiple blocks, hold Shift and then click on each one of them.

Orchestrate an advanced Dialog Application

This section describes advanced features of the Orchestrator:

• How to build a more complex Dialog Application with at least two building blocks.

• How to configure them by passing values to miniApps.

• How to create and use Conditions, Transfers, Flows and Event Handlers.