Guides
Breadcrumbs

Working with Legacy Applications

This feature is not yet available in all environments.

This article explains how to create and deploy a Legacy Application.
A Legacy Application is a valid DiaManT® application, manually created and configured as a set of corresponding files, archived into a ZIP file according to DiaManT® naming conventions.

Create Legacy App

To create a Legacy App, follow the steps below:

  1. Go to the Orchestrator page in your OCP Console® and click +Create.

    create_new_app2.png


  2. In the Create new application form:

    • In App Type, select Legacy.

    • In Application Name, use only Latin letters, numbers, and underscores.

create_legacy_app.png
  1. Click Save.

image-20240724-163256.png

You can manage Legacy Applications from the Orchestrator landing page.
Click the three‑dots icon next to the Legacy App to access the following options:

  • Edit Description & Labels

  • App as Flow

  • Share

  • Deploy

  • Audio Manager

  • Delete

new_legacy_app.png

Legacy App in Orchestrator Board

A Legacy App can be opened on the Orchestrator board with limited functionality. It cannot be modified like a typical Orchestrator app on Canvas because it was not built with Orchestrator and contains only raw XML data.

new_legacy_app2.png

For a Legacy Application:

  • The left sidebar with miniApps, Flows, Shared Flows, and Dialog Controls is disabled.

  • The Event Handlers drawer on the right side is disabled.

This means you cannot add new blocks to Canvas or edit existing ones for a Legacy App created from raw XML data.

The Application Options Menu for a Legacy App includes:

  • App as Flow

  • Share

  • Audio Manager

  • Delete

new_legacy_app3.png


The App as Flow and Share features are not yet available to all environments.

Be careful when configuring the Input and Output Fields for App as Flow. These fields must exactly match the fields you defined manually in the XML file of the Legacy App.

You can use the Orchestrator chat feature to test your application as usual by clicking the chat icon in the lower‑right corner.

It is also possible to deploy a Legacy App directly from the Orchestrator board, as described below.

Deploy Legacy App

Deploy from Orchestrator landing page

To deploy a Legacy Application from the Orchestrator landing page:

  1. Click the three‑dots icon to the right of the Legacy App name and select Deploy.
    A pop‑up window appears, prompting you to upload a ZIP file (drag and drop or click Browse Files).

    deploy_legacy_app2.png
    deploy_legacy_app3.png
  2. Prepare the ZIP file:

    • The ZIP file must contain a folder with the same name and group as the Orchestrator application.

    • The folder must follow this format:
      {your_group}@SND_{yourAppName}
      where your_group and yourAppName are the same group and application name you used when creating the Legacy App in the Orchestrator UI.

    • Before uploading the ZIP file, make sure you have incremented the application version inside the XML file.

  3. After you add the file, click Deploy.

    • If you uploaded the wrong file, click the Trash icon above the Deploy button, or click Cancel to close the pop‑up.

  4. If the Legacy App is deployed successfully:

    • The file is sent directly to DiaManT®.

    • A green Success message appears in the upper‑right corner of the screen.

  5. If deployment fails:

    • A red Error message appears explaining why the deployment failed.
      Make the required changes to the file, upload it again, and redeploy.

No files are changed, and no validations are performed for Legacy Apps on the Orchestrator side. You are responsible for manually configuring all XML files, including updating the application version.

Deploy from Orchestrator board

You can also deploy a Legacy App directly from the Orchestrator board.
The deployment flow is the same as when deploying from the Orchestrator landing page: you upload a ZIP file with the required structure and then click Deploy.

deploy_legacy_app.png

Audio Uploads for Legacy Apps

You can add audio files to Legacy Apps using the Audio Manager.

To open the Audio Manager:

  • Open the Legacy App and click the Application Options Menu button, or

  • Find your Legacy App in the Orchestrator app list and click the action menu button on the right.

audio_manager.png
audio_manager2.png

In the Audio Manager:

legacy_audio.png
  1. In Select Locales, choose the language(s) for which you want to upload audio.
    You can select multiple locales and upload files separately for each.

  2. Prepare and upload audio files:

    • Files must be in WAV format.

    • Compress the files into a ZIP archive.

    • You can include multiple files per locale in a single ZIP archive.

    • Once uploaded, files remain available for that locale indefinitely.

  3. After upload:

    • Click Download System Audio List to download a TXT file with the list of audio files.

    • The next time you add locales, you can download the list of locales that already have uploaded audio.

  4. Click Save Changes to apply the changes and exit Audio Manager.