Skip to main content

Schema

Defining data schemas for your Usecases is essential for ensuring that data is structured and managed consistently across your application. In this section, we’ll cover how to define and add properties to your Usecase schemas.

Adding Properties to Schemas

To define the data schema for a Usecase:

  1. Open Usecase Details Menu:

    • Click on the Usecase on the map to open its details.
  2. Add a New Property:

    • Click the + icon in the bottom right corner of the Usecase Details menu.

    AddSchema

  3. Configure Property:

    • This action opens the Add Property dialog:

    AddSchemaPropertyDialog

    • In this dialog, choose from the following data types for your property:

      • string
      • int
      • decimal
      • bool
      • datetime
      • uuid
      • enum
      • object
    • Define whether the property is an array or an optional value.

  4. Specify Enums and Objects:

    • For enum and object types, specify which existing enum or object you want to use, or create a new one if needed. (Refer to Objects or Enums for more details.)

    • When working with domain Usecase details, you will also need to set a Value Object. (See Value Object for more information.)

    AddCommandSchemaProperty

tip

You can streamline your schema creation process by using the copy to button. This feature allows you to duplicate properties from one schema to another, saving time and ensuring consistency.

CopyButton