Skip to main content
Skip table of contents

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:

A user must have an Applications Manager role to access the Environments Manager.

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.

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

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

  1. Enter your password and click Sign In.

  1. If the credentials are correct, you are forwarded to the OCP Console® landing page. Click Environments Manager on the left pane.

  1. 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.

  1. 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:

  1. Select the application you want to import, and place it onto the drop zone, or click the Browse button to manually select the application.

  2. Select the Group for which the application will be available from the dropdown menu. It is also possible to enter a new application name in the Rename App field if you want to change the application’s name.

Renaming is only available for application. Flows and miniApps can’t be renamed!

  1. You can optionally check the Include imported NLU model references box. It allows to reuse the NLU models within the same environment.

For example, if you export the application, and then import it to the same environment under the new name, checking the Include imported NLU model references box allows to use already existing NLU models without creating the new ones. If you import the application to the new environment, the new NLU models will be created automatically.

Note that if the box is enabled, then selecting Production/Testing NLU Deployments is not available!

  1. Select the NLU Deployment type:

    • Production (default) - this type complies with Production Grade SLAs. Use with your Production applications handling live traffic!

    • Testing - this type is cost efficient and used for Testing purposes only.

  2. Click Import when finished.

Tag:

  1. Select the Application Tag you want to import, and place it onto the drop zone, or click the Browse button to manually select the Application Tag.

  2. Select the Application tag from the dropdown list of the available tags.

  3. Choose the Deployment type:

    • Production (default) - this type complies with Production Grade SLAs. Use with your Production applications handling live traffic!

    • Testing - this type is cost efficient and used for Testing purposes only.

  4. Click Import when finished.

Promote Application

Promoting application requires a user to have deployment access to the PRD application which can be provided by the CSF team.

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.

  1. 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 ManagerVariable Collections

    2024-03-28_13-39-17.png

  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.

    2024-03-28_13-43-54.png

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

You can create only one Variable Collection per Application.

Alway redeploy the Application in Orchestrator after a Variables Collection has been added.

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 ManagerVariable Collections

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

    2024-03-29_09-25-16.png

  3. Click the +Variable button

    2024-03-29_09-27-59.png
  4. Add the Key name, a Sandbox (SND) value and a Production (PRD) value if different from SND.

    2024-03-29_09-35-26.png

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

    2024-03-29_09-36-41.png

If you check the Enable Masking option the value will be masked and treated as sensitive information throughout the application even if the miniApp or application is not marked as sensitive.

2024-03-29_09-38-15.png

After a Variable is added or edited to a collection, it can take up to 5 minutes before it is applied. To work around this, redeploy the application.

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.

2024-03-29_09-43-59.png

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.

2024-04-04_10-48-32.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.