Environments Manager User Guide

This document describes the functionality and usage peculiarities of Environments Manager.

The Environments Manager is a part of OCP® and it allows to manipulate Orchestrator Applications. It provides actions which can do the following:

• Export Application

• Import Application

• Promote Application

Access Environments Manager

To enter Environments Manager, proceed as follows:

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.

6. Click Environments Manager on the left pane.
   

   

7. Once on the Environments Manager page, the list of the Orchestrator Applications is available to you.

If you currently don’t have any Orchestrator Applications, click the Import button. Navigate to the Import Application section to read more about it.

Manage Applications

Export Application

To export the application, proceed as follows:

1.Select the application, click the options menu button on the right, and click the Export button.

2. In the opened form, you can select to export the Application by choosing the Application tab. Also, you can export a particular tag of the Application if choosing Tag. Read more about Application versioning in Orchestrator User Guide.

   1. If choosing Application, you may tick the Export with NLU box to also export NLU model references in the export files. Click Download when completed.

b. If choosing Tag, select the Application tag from the available ones in the dropdown menu. Click Download when completed.

3. The ZIP file which contains the Application with its miniApps and Flows in JSON format will be downloaded to the targeted folder. Unpack ZIP to view the content.

Import Application

To import the application, follow the next steps:

1. Click the Import button.

   

2. In the Import Application form, select Application if you want to import the Application as is, or Tag if you want to import a particular Application tag:

Application:

Tag:

Promote Application

Promoting the application allows to detach application traffic from different clusters.

Originally, if you want to deploy the application, it is deployed to the DiaManT Sandbox cluster (SND) where, for example, you can use the chat simulator to check the application. Promoting the application allows to create the copy of the deployed application which will be placed to the DiaManT Production cluster (PRD) with the real traffic, so that traffic for testing the application does not affect real calls.

To promote the application:

1. Select the application, open the Options menu on the right and click the Promote button.

2. You may select an Application Tag to promote from the dropdown list of the available ones (optional). Otherwise, you can promote the application by not selecting a tag. Confirm by clicking Promote.

3. Navigate to Dashboard or miniApps in order to check the created clusters.

Variable Collections

Variable Collections provide a way to store information such as numbers, or text. By using OCP variables, you can make your job scripts more dynamic and adaptable, as they enable you to change the stored data or perform calculations based on the values stored in the variable.

Create a Variable Collection

1. Navigate to Environment Manager → Variable Collections
   

   

2. Click the +Variable Collection button

3. Select the Application from the dropdown list and provide a name for the Variables Collection you wish to create for it.

   

4. Click Create Collection button and the new collection will be added to the Variables Collection list.

Create Variables

Once you have created a Variables Collection for a specific application, you can start creating variables within that collection, that can be used in your application and the related miniApps.

1. Navigate to Environment Manager → Variable Collections

2. Click on the collection you wish to add variables.
   

   

3. Click the +Variable button
   

   

4. Add the Key name, a Sandbox (SND) value and a Production (PRD) value if different from SND.
   

   

5. Click Save to add the new Variable to your Collection list

   

Edit Variables

To edit or delete a variable from the list click the three dots menu list on the right of each variable and select the desired option.

Use of Variables

Variables are JavaScript objects and can be used anywhere in OCP miniApps and Orchestrator as per below.

miniApps

1. As a dynamic value in prompts → {{ocpvars:myKeyValue}}
   

   

2. As a JS object in functions → if (ocpvars.myKetValue == "Test") { ... }
   

   

Orchestrator

In Orchestrator variables can be used to create conditions in Condition blocks. Open the condition setting and enter the variable name in the Field as #V_{name}and the required value.