General Capabilities of Solution Designer
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 the 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 the 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 columns that are 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
- Solution
- 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 section provides a view mode and an edit mode. The edit mode can be entered only if the user has privilege 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 Modeled Content
Within the edit mode of the Markdown editor or via a dialog you can auto-generate UML diagrams.
For all kinds of diagrams the placeholdernshas to be replaced with the name of the namespace that holds the object for which the diagram should be generated.
``` fsw
aggregate ns:EntityName parents children properties commands
``` Replace EntityName with the name of the Root Entity you want to generate a diagram for.
| Extension | |
|---|---|
| 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 |
``` fsw
services ns:ServiceName events agents errors all
``` | Extension | |
|---|---|
| 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 |
``` fsw
operation ns:OperationId request response all
``` | Extension | |
|---|---|
| request | Shows the request (incl. parameter + request bodies) |
| response | Shows the responses |
| all | Shows request and responses |
``` fsw
solution api domain integration queue database all
``` | Extension | |
|---|---|
| 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 |
Commit & Push
In order to commit and push changes to the remote repository of the Git provider, use the Commit and Push capability located on the top right of the Solution Designer.
Problems Section
On the bottom of the page in the Solution Designer, there is a panel which contains a Problems section. In this 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.
User Profile
On the top right side of the Solution Designer page there is a User Profile capability. From there it is possible to view your name and user name, acess the User Settings page and sign out.