Using the AI Design Assistant

The AI Design Assistant in Event Portal uses AI to help you quickly design and implement an event-driven architecture (EDA) with application domains, applications, and events. If you've enabled runtime configuration, the AI Design Assistant can even promote your new applications and events to an environment and send runtime configuration to an event broker service.

The AI Design Assistant is not suited for designing and deploying a production-quality EDA, but it can help you create a prototype that makes use of our Topic Architecture Best Practices to build your understanding of what you can accomplish with Solace Cloud and how to create a rich, well-defined topic architecture.

This section includes:

Before You Begin

The AI Design Assistant can help you design a prototype EDA, from creating application domains to configuring an operational event broker service. If you want to explore all of the AI Design Assistant's capabilities, you need to set up a few things before you start:

  • You must have at least the Event Portal Manager role to use the AI Design Assistant.

  • You need an environment with runtime configuration enabled. If runtime configuration is not enabled, you can still design an EDA in the AI Design Assistant but you can't deploy it to an event broker service. We recommend choosing an environment used for development or testing, or creating an environment for use with the AI Design Assistant. You must have the Administrator role to create and update environments.

  • You need an event broker service in the environment or the permissions to create one. We recommend choosing an event broker service used for development or testing, or creating an event broker service for use with the AI Design Assistant. You must have at least the Mission Control Manager role to create an event broker service.

Designing an EDA with AI

You can find the AI Design Assistant within Designer. The AI Design Assistant asks for information about your organization and the goals for your EDA, and then steps you through creating the required applications and events and deploying them to your event broker service. Application domains created by the AI Design Assistant are named with a prefix that indicates so.

To start designing an EDA with AI, perform these steps:

  1. Log in to the Solace Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the Solace Cloud Console.
  2. On the navigation bar, select Designer .
  3. In Designer, above the list of application domains, click Design with AI.
  4. If a confirmation dialog appears, click Start Designing.
  5. In the Your Company and Your Goals fields, enter information about your organization and what you want your EDA to do. The AI Design Assistant will create applications and events based on the information you provide.
  6. (Optional) Clear the Generate all objects in one application domain check box if you want the AI Design Assistant to create multiple application domains based on different functions within your EDA.
  7. Click Next: Application Domains and interact with the AI Design Assistant as it steps you through creating an application domain and then applications and events for your use case. The AI Design Assistant can help you:
    • name your application domain and add a description
    • set a topic domain, including variables
    • add more assets and edit or remove assets suggested by the AI Design Assistant
    • create applications to publish and subscribe to events
    • create events with topic addresses that start with the topic domain and relevant schema objects to define the event data attributes and their relationships
  8. When you reach the Promote to Runtime step you can choose whether to promote your assets to Runtime Event Manager or only create the assets in Designer.

    If you select Promote Applications and Events to Runtime Event Manager, you must select an environment and either create or select an event broker service. You must have the Administrator or Mission Control Manager role to create an event broker service.

    If you don't have the necessary setup to create a modeled event mesh and promote your assets, you receive an error message stating that you can only create the assets in Designer.  

    Click Create Assets to begin generating the application domains, applications, and events.

  9. If you receive an error dialog, click Close then clear the Promote Applications and Events to Runtime Event Manager checkbox and click Create Assets to create the application domains, applications, events, and schemas without promoting them. You can promote them later.