Creating a Custom User Interface - Creating a Custom User Interface - Create a Custom User Interface when you need an interface that is developed outside of Studio Modeler and packaged for use within a project. - Content Innovation Cloud - Hyland Automate Modeler - Current/Hyland-Automate-Modeler/wdh1694518105794 - Current - Current

Hyland Automate Modeler

Platform
Content Innovation Cloud
Product
Hyland Automate Modeler
Release
Current
License
ft:lastPublication
2026-11-02T23:02:36.222215
ft:locale
en-US

Create a Custom User Interface when you need an interface that is developed outside of Studio Modeler and packaged for use within a project.

A Custom UI can be:

  • An Application Development Framework (ADF) application.
  • A React application.
  • A single-page application built with HTML, CSS, and JavaScript.
  • Any application that conforms to the supported UI schema.
Note: Custom UIs cannot make direct API calls. When integration with external services is required, use the REST Connector.

To create a custom UI:

  1. Open a project.
  2. Select how to create the interface:
    • Click Create > Custom UI.
    • Click the vertical ellipsis () button next to the UI drop-down menu in the left-hand pane, then select Create Custom UI.
    Note:

    You can also upload a default UI as a JSON file. For more information, see Importing Project Assets.

    The Create Custom UI window is displayed.

  3. Enter a name in the Custom UI name field.
  4. Optional: Enter a description in the Custom UI description field.
  5. Click Create Custom UI.

    The created custom UI is opened as a new tab and added to the right pane under the UI section.

  6. Click Generate From Template to generate a .zip file with the current template.
    The custom UI file is added to the window.
  7. Click the Download source code button to download the contents of the custom UI for further development.

    The recommended approach is to use Nx generators when working with the downloaded custom UI template package. The generated template package contains resources and instructions to help you customize the application. To view the development guidance, open the following file included in the downloaded archive:

    plugins-generators.md

    This file contains instructions for customizing and extending the generated UI template.

  8. When developing, verify that the UI package meets the following requirements:
    • The application contains a valid entry point in either index.html or index.htm.
    • The entry point file is located at the root of the .zip archive.

    • The archive size does not exceed 50 MB.
  9. Once the custom UI is done, click the Upload button and select the .zip file that contains your Custom UI.
  10. Confirm that you want to replace the generated UI when prompted.
  11. Optional: Switch the Primary toggle. When enabled, this UI becomes the default interface presented to users when the application is opened.

The custom UI is uploaded. It can be used in Workspace after the project is deployed.

Note: When deploying a project with custom UI, make sure that the Enable local development option is enabled.