Tutorial: Product Search interaction model

Steps

Follow these steps in order to build the interaction model from scratch.
To start the tutorial go to the Main page (after passing the authentication).

1. 1

   Create generic types

   One the main page open the Architecture Types page. The model already contains a root component named RootType and a root layer named Default Layer (will see later) — this is the top level of the model, the shared context in which your system architecture is defined.

   Create two generic types: Simple Component and Simple Process.

   
2. 2

   Configure the component structure

   Configure the Simple Component generic type:

   • Create a layer named Main Layer inside it.
   • Place the Simple Process generic type inside Main Layer.
   • Place Simple Component inside RootType → Default Layer.

   
3. 3

   Define the data types

   Using the side menu, open the Data Types page, click the edit button, and create two data types using TypeScript syntax. Save the changes when done.

   interface SearchRequest {
       searchText: string;
   }
   
   interface SearchResponse {
       productIds: string[];
   }

   
4. 4

   Create the components

   Open the Architectures page. In Default Layer, create two components of type Simple Component: User and Online Catalog. Keep the Actor role for both.

   
5. 5

   Create the processes

   Open the User component and create a process inside its Main Layer named Main User Process, generic type Simple Process, role Process.

   Open the Online Catalog component and create a process inside its Main Layer named Main Catalog Process, generic type Simple Process, role Process.

   The resulting structure should be User → Main User Process and Online Catalog → Main Catalog Process.

   
6. 6

   Create the call specification

   Open the Online Catalog component, then open Main Catalog Process — you will be taken to the process editing page.

   Create a call named Search products with input type SearchRequest and output type SearchResponse. Save the call, then expand it to verify the structures of SearchRequest and SearchResponse are displayed.

   
7. 7

   Connect the processes and verify

   In the Connections sidebar, enable edit mode. In the Incoming section, add a connection: search for user, select Main User Process, then select the call name Search products. Click Save and disable edit mode.

   Click the button next to Main User Process in the Incoming list to confirm the connection appears in its outgoing connections list. Then return to Architectures and open the connections sidebar on both the User and Online Catalog tiles — the same connection will be visible at both component levels.