General capabilities of Solution Designer

This page is about the general functionality of Solution Designer and its user interface. Most of the capabilities are available only within low-code projects but there are also some common elements.

Search

In each page there is a Search capability that is used to search the shown components such as namespaces, entities, properties etc. by their label, prefix or identifier.

Filtering

For tables in Solution Designer there is a Filter capability. This capability is used to filter elements by one or more column values.

Table settings

For tables in Solution Designer there is a Table Settings capability. This capability is used to choose which columns should be shown in the table. By using the Reset to default capability, you are able to return to the default set of columns shown in the table.

Commenting

On every instance page, on the top right side, there is the Comment capability. By using this capability, you are able to see existing comments or to write new ones in the comment field and add this comment by using the Add comment capability. The comment field is mandatory. By using the Cancel capability, the comment will not be saved, and you will be redirected to the instance page.

Documentation

For a lot of artifacts in Solution Designer e.g.

  • Workspace description

  • Projects

    • All project types:

      • Project overview documentation

    • Low-code projects only:

      • Namespaces (API, Domain and Integration)

      • Entities (Root Entities, Entities and External Entities)

      • Services

      • Commands

      • Properties

      • Events

      • Agents

      • Errors

      • Operations

The section Documentation allows the user to easily write Markdown documentation. The text editor offers a WYSIWYG and a Markdown mode with live preview that supports both CommonMark and GFM specifications. The edit mode can be entered (only if the user has permission to edit the artefact) by clicking on the content or by using the symbol on the right top displayed while hovering over the content.

For each type of artefact a pre-defined structure is proposed and automatically displayed.

Visualization of modelled content

You can easily create plantUML diagrams by either inserting native plantUML syntax in a codeblock or auto-generate a diagram by clicking on the "Insert diagram" button or using the fsw command.

For all kinds of diagrams the placeholder ns has to be replaced with the name of the namespace that holds the object for which the diagram should be generated.

Root entities

    aggregate ns:EntityName parents children properties commands

Replace EntityName with the name of the Root Entity you want to generate a diagram for.

Options:

  • parents: Shows direct parent entities of the root entity that should be displayed

  • children: Shows all direct children of the root entity that should be displayed

  • properties: Shows all direct associated properties of each entity displayed in the diagram

  • commands: Shows all associated commands for each root entity displayed in the diagram

  • all: Shows direct parents, children, associated properties and commands

Note: By using the command without any extension the default is to show the aggregate with direct parents, without children, with properties and commands.

Services (domain services and integration services)

    services ns:ServiceName events agents errors all

Replace ServiceName with the name of the service you want to generate a diagram for.

Options:

  • events: Shows all events published by that service

  • agents: Shows agents within the same solution that are subscribed to a published event

  • errors: Shows all business errors that could be thrown by that service

  • all: Shows all events, agents and business errors associated to that service

Note: By using the command without any extension the default is to show the service with its input and output.

Operations

    operation ns:OperationId request response all

Replace OperationId with the name of the operation you want to generate a diagram for.

Options:

  • request: Shows the request (incl. parameter + request bodies)

  • response: Shows the responses

  • all: Shows request and responses

Note: By using the command without any extension the default is to show the operation with its request and responses.

Project overview

    solution api domain integration queue database all

This will generate the project overview diagram for the project you are currently working on.

Options:

  • api: Shows all api namespaces available in the current solution

  • domain: Shows all domain namespaces available in the current solution

  • integration: Shows all integration namespaces available in the current solution

  • queue: Shows all messaging topics associated to their domain namespace

  • database: Shows all database collections associated to their domain namespace

  • all: Shows all api, domain and integration namespaces with their related massaging topics and database collections of the current solution

Note: By using the command without any extension the default is to show the solution with its api, domain and integration namespaces.

Task bar

On the bottom of the page in Solution Designer, there is an expandable panel which contains additional information around project design and development.

Problems section

On the bottom of the page in Solution Designer, there is a panel which contains a **Problems section. In these sections all problems and warnings are listed, and it is possible to navigate to the affected object in order to solve the issue by using the link capability.

Solution CLI section

On the bottom of the page in Solution Designer, there is a panel which contains a **Solution CLI section. There you can find instructions on how to download, install and set up the Solution CLI which is necessary to clone the project to your local machine and test/debug it.

Header bar capabilities

The header bar offers some basic capabilities regardless of the project type.

Commit & push

In order to commit and push changes to the remote Git repository, use the Commit & Push capability located in the header bar of Solution Designer.

Settings

On the top right side of Solution Designer there is a User Profile capability.

Help

There you can find a link to the product documentation.

User profile

From there it is possible to view your name and username and sign out.

Applications

This item provides links to relevant product components such as Solution Hub.