Userhelp
This page provides generated reference documentation for the Userhelp data model.
Stellt eine Referenz auf ein asciiDoc File der BenutzerDoku dar
Overview
| Property | Summary |
|---|---|
| title | Title (speaking name. may contain spaces and special characters.) |
| description | Description |
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| comment | Property to store a developer comment in form of |
| icon | Image. |
| iconProcess | Specifies the icon dynamically. If the icon has no effect, neither will the result of the process. |
| reference | — |
| path | — |
| locale | — |
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title (speaking name. may contain spaces and special characters.)
This has different effects depending on the entity:
System, Application, Template, Language and Alias: no effect
Frame, NeonFrame: Caption of the frame in the client
Process: Name of the process in system administration
Report: Labeling of the report in the client
Role: Name of the role as it appears in the client
description
Type: String
Description
documentation
Type: String
Contains the documentation of the data model in the popular AsciiDoc format (.adoc).
The documentation should be set by the developer to explain different aspects
(like purpose, concept, etc.) of the data model that he designed.
You may want to add the plugin "AsciidoctorJ" to your ADITO Designer in order
to modify AsciiDoc files.
comment
Type: String
Property to store a developer comment in form of
/**
*
*/
In the past this was used in customizing for frame controls additional settings, such as the activation of rights, histories, or attributes.
This should not be done anymore in the comment-property, because therefor a metadata-property exists.
icon
Type: String
Image.
Depending on the datamodel, this has different effects:\
- Entity: used as symbol in the designer. Do not confuse this property with the iconId property\
- Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used\
- System, Language, Role, Application: icon that appears only in the designer.\
- Template: Same effect as on the respective component\
- Alias, User: no effect\
- Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.
iconProcess
Type: String
Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.
Depending on the datamodel, the result of the process has to be different:
When you can specify an icon-avatar-text (e.g. "VAADIN:USERS):
You've to return the icon-avatar.text with result.string(...)
When you can specify an image in the icon:
This is returned as a string with the ID of the image in the ASYS_BINARIES via result.string().
Error messages from this process do not arrive at the client, they are only visible in the server log.
reference
Type: String
path
Type: String
locale
Type: String