Environments Manager User Guide

Overview

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

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.

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.

If you have entered the correct credentials but are still unable to log in, it's possible that your account has been suspended. For further details and steps to resolve this issue, please refer to the Account suspension section.

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.

8. If you currently have no Orchestrator Applications, click the Import button. Navigate to the Import Application section to read more about it.

Manage Applications

In this section, you will find detailed instructions on how to import and export an Application or Application Tag between different groups or environments. Additionally, you will learn the steps to promote an Application effectively.

When you export an Application, it is exported along with its associated miniApps, Flows, and a Variables collection. This process ensures that all necessary components are correctly integrated and functional. However, when exporting an Application Tag, the Variables collection is not included.
For more information, refer to the Variables Collection section.

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 an Application or Application Tag.

   • To export an Application, click Application. Here you may mark the Export with NLU box to also export NLU model references in the export files.

b. To export an Application Tag, click Tag and select an Application Tag from the available ones in the dropdown menu.

3. Click Download when completed.

4. The exported application will be downloaded to the targeted folder as a ZIP file. Unpack the ZIP file to view the content. The ZIP file contains the Application with its miniApps, Flows and a Variables collection in JSON format.

Import an Application

You can import either an Application as is, or an Application Tag which is the application’s instance. You can read more about Application Tags.

When you import an Application, it is imported along with its associated miniApps, Flows, and Variables collection. When importing an Application Tag, the Variables collection is not included.
For more information, refer to the Variables Collection section.

Importing an Application

To import the application, follow the next steps:

1. Click the Import Application button.

2. In the Import Application form, click Application.

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

4. 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!

5. 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 an 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 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!

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

7. Click Import when finished.

8. A toast message will appear in the upper-right corner of the screen, indicating that the import is in progress.

9. Once the process is complete, a service notification will display the import status. To see the service notification, click the Bell icon.

Importing an Application Tag

To import an Application Tag, follow the next steps:

1. Click the Import Application button.

2. In the Import Application form, click Tag.

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

4. Select the Application from the dropdown list of the available applications.

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

6. Click Import when finished.

7. A toast message will appear in the upper-right corner of the screen, indicating that the import is in progress.

8. Once the process is complete, a service notification will display the import status. To see the service notification, click the Bell icon.

Promote Application

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

Promoting an 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 from the dropdown list of the available ones (optional). Otherwise, you can promote the application by not selecting any tag.

3. Confirm by clicking Promote.

4. A toast message will appear in the upper-right corner of the screen, indicating that promoting is in progress.

5. Once the process is complete, a service notification will display the import status. To see the service notification, click the Bell icon.

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

Application Tags

An Application Tag is an application’s instance. You can read more about Application Tags in Orchestrator User Guide. In the Environments Manager, you can find the list of all the Application Tags available for a particular Application.

List Application Tags

To find the list of Application Tags, click on a selected Application. This will open a page with SND (Sandbox) and PRD (Production) Application Tags available for the selected Application.

Delete an Application Tag

To delete an Application Tag, proceed as follows:

1. Click the Delete icon next to the selected Application Tag.

2. The following dialog box opens.

3. Type CONFIRM DELETE and confirm by clicking Delete. The Application Tag is deleted.

Variables Collection

A Variables Collection provides 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.

When you export or import an Application, it is exported and imported along with its Variables collection.

During the import process, pay attention to the following aspects:

• Non-Sensitive Variables: Keys for both non-sensitive and sensitive Variables can be imported. However, to maintain security and confidentiality, the values of sensitive Variables are not included.

• Create-Only Approach: The import mechanism follows a "create-only" approach for Variables. This means:

  • Creation of Missing Variables: If there are Variables in the imported collection that do not exist in the current environment or group, they will be created.

  • No Updates to Existing Variables: The Variables and their values that already exist in the environment or a group will not be updated. However, there is an option to overwrite the values of non-sensitive Variables during the import process. If enabled, this option allows the values of non-sensitive Variables to be updated with the values from the imported collection.

Create a Variables Collection

To manually create a Variables Collection for an application, proceed as follows:

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.

You can create only one Variable Collection per Application.

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

When an application, which already has an associated Variable Collection, is published in Orchestrator with a new Application tag, a new Variable Collection is automatically created for the newly assigned application tag.

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

   

3. Click the +Variable button.
   

   

4. In the opened dialog-box, fill in the fields as described below:

• Key name: Enter the name of the key.

• Enable Masking: If marked, the variable will be treated as sensitive even if the application is not marked as sensitive. Sensitive variables will not be updated during the application import. Masked variables cannot be logged and the Logging option will not be available to be checked.
  

  

• Description: An optional description for the created variable.

• SND Value: Enter a Sandbox (SND) value for the variable.

• Use the same for PRD value: If checked, the SND and PRD values will be identical. Otherwise, unmark the checkbox and fill in the PRD field.

• PRD Value: Enter a Production (PRD) value if different from SND.

• Skip values update on import: Specifies if the values are to be updated during the application import. If the Enable Masking checkbox is marked, this checkbox is automatically greyed-out.

  • Checked: The value will not be updated during the application import.

  • Unchecked: The value will be updated during the application import. This only refers to non-sensitive data.

• Logging: By default, the system logs variable values that are not masked. To stop this process and create a smaller and more manageable log file, deselect the respective checkbox. This can make the investigation process easier when needed.

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

   

You can add as many Variables to a collection as required.

Updating Variables

To update a Variable from the list, proceed as follows:

1. Click the kebab Menu icon on the right of each variable and select Edit Variable.

2. In the opened dialog-box, modify the necessary fields same way as in Create Variables section. All the fields are editable.

Deleting Variables

To delete a Variable from the list, proceed as follows:

1. Click the Context Menu icon on the right of each variable and select Delete Variable.

2. In the opened dialog-box, click Delete to confirm.

Rename a Variable Collection

To rename a Variable Collection:

1. Click the three dots menu on the right and select the Rename Collection.
   

   

2. Edit the name of the collection in the Variable Collection window and click the Update button.

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.myKeyValue == "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.