Skip to main content

Using External Systems

In Codebricks, a Command Usecase can integrate with external systems. These systems allow the usecase to interact with third-party services, external APIs, or packages, enabling more complex workflows and communication with external resources.

Adding an External System

To add an external system to a Usecase, follow these steps:

  1. Open Usecase Details Menu:

    • Select the desired Usecase on the event map to access its details.
  2. Open the Management Menu:

    • Click the Hamburger Menu icon (Hamburger icon) in the upper left corner of the Usecase Details Menu.

    This action will reveal the Usecase Management menu on the left side.

  3. Add an External System:

    • Select Add External System from the Usecase Management menu.

    Codebricks Planner with opened Usecase Details with Usecase Management menu. Add External System is highlighted.

  4. Configure the External System:

    • Provide a name for the external system.
    • Define the input parameters, which represent data sent to the external system.
    • Define the output values that the external system will return.
    info

    The input parameters for an external system can use values from the aggregate's method properties. The output from the external system can be used as a value source for events.

Removing an External System

To remove an external system from a Usecase, follow these steps:

  1. Open Usecase Details Menu:

    • Select the Usecase on the event map to access its details.
  2. Open the Management Menu:

    • Click the Hamburger Menu icon (Hamburger icon) in the upper left corner of the Usecase Details Menu to reveal the Usecase Management menu.
  3. Remove the External System:

    • Locate the external system in the list of systems and click the small x icon on its chip to remove it.

    Codebricks Planner with opened Usecase Details with Usecase Management menu. Remove External System is highlighted.