Overview of Detail Modules
Level: Catalog
Keywords: entity information detail, properties, attributes, related entities, attachments, comments, notes,
The result: help you to decide, which detail module to choose
This chapter lists all web modules that can be included in the entity Information detail. We distinguish several types of these modules based on their function. There is always a configuration example below the chosen illustration of detail module. After clicking on the module's title a new tab will open with a link to the Dynamic-App Module Catalog, where you can find all configuration possibilities.
Entity information
This section describes modules used to display entity properties (feature attributes).
Samo-entity-properties-detail
This is the most basic module usable in Information details. In its default configuration it loads the default Lids form of entity from the LIDS model.xml. You can specify a different Lids form to be loaded by using propertyGroupId parameter. There are also other available configuration options, which enable you to redefine (overrideProperties), hide (hideProperties), or sort (sortProperties) the default Lids form items.
Key-value-detail
Also basic module which does not load any metadata and all displayed properties must be configured including its type, label and value from data context. This module is internally used also in samo-entity-properties-detail.
Samo-entity-card-detail-module
Related entity information
Related-entity-list
Assigned-entity-list
Samo-entity-feature-ref-properties-detail
Simple-path-entity-list
Simple-path-entity-list-no-search
Property-entity-list
Entity business
Samo-entity-history
Using this web module only makes sense for versioned entities (versioned=true tag in definition of their container in LIDS model.xml). It is possible to use this module as a separate section in Information Detail, or as a part of Samo-entity-workflow module (shown by default, configurable by "withoutHistory": true).
By default Samo-entity-history module shows entity events related to creation or update of entity (entityCreated, entityUpdated), attribute update (entityAttributeUpdated) or action trigger (entityActionTriggered). These default settings can be overriden and custom entitiy event can be defined.
Fig. 1: Samo-entity-history in separate section
Fig. 2: Samo-entity-history as a part of a samo-entity-workflow module
Fig. 3: Samo-entity-history dialog
{
"detail" : {
"default" : {
"sections" : [
{
"type": "component:entity-modules/components/samo-entity-history"
}
]
}
}
}
Samo-entity-timeline - EXPERIMENTAL
This web module extends the Samo-entity-history module and shows the overview of performed entity events in time on graph. By default it shows entity events related to creation or update of entity (entityCreated, entityUpdate), attribute update (entityAttributeUpdated) or action trigger (entityActionTriggered). These default settings can be overriden and custom entity event can be defined.
In following example Samo-entity-timeline module is used to show the overview of created Work orders and Calculation versions related to selected Project, and also changes in Project state.
{
"detail" : {
"default" : {
"sections" : [
{
"module" : {
"type": "component:entity-modules/components/samo-entity-timeline",
"eventTypes": {
"exclude": [
"entityCreated.*",
"entityAttributeUpdated.*",
"entityActionTriggered.*"
],
"selected": [
".*Attach.*",
"workOrderCreated.*",
"entityStateUpdated.*",
"versionValidatedEvent.*"
]
}
}
}
]
}
}
}
Samo-entity-workflow
This web module enables user to run predefined business actions by simple click. The configuration of client metadata is very simple, however it is linked to more complicated configuration of business metadata, see page Workflow.
{
"detail" : {
"default" : {
"sections" : [
{
"module" : {
"type": "component:entity-modules/workflow/samo-entity-workflow"
}
}
]
}
}
}
Others
Entity-attachments
This web module enables uploading different types of attachments to your entity Information detail. When uploaded, user can open detail with information of chosen attachment and download it. A specific part of data model for storing these attachments needs to be preconfigured in LIDS metadata, see Entity Attachments.
Samo-comments
This is a web module, which enables integration of LIDS Collaboration platform extension. It provides the possibility to add comments and conversation threads to your entity Information detail.
{
"detail" : {
"default" : {
"sections" : [
{
"icon": "cbu-icons:comments"
"module": {
"title": "Comments",
"type": "component:entity-modules/collaboration/comments/samo-comments"
}
}
]
}
}
}
Samo-subscriptions
Samo-notes
This web module, enables adding notes to your entity Information Detail. For storing these notes, you need to define corresponing part of data model, see Samo-notes page.
{
"detail" : {
"default" : {
"sections" : [
{
"icon": "cbu-icons:report-notes"
"module": {
"type": "component:entity-modules/notes/samo-notes",
"titleProperty": "at_exampleNote__title",
"contentProperty": "at_exampleNote__note",
"entity": "ft_exampleNote",
"relation": "as_example_exampleNote",
"role": "rt_exampleNote"
}
}
]
}
}
}
Samo-entity-documents
This web module provides a section with browse of all entity-related documents. It is a part of Document Management System.