Skip to main content
Version: 2025.2

NeonNotificationType

This page provides generated reference documentation for the NeonNotificationType data model.

A custom notification for your project.

Overview​

PropertySummary
aliasThe database alias that is associated with the notifications.
archivableSet if notification can be moved to the archive to be accessable again later on.
commentProperty to store a developer comment in form of
defaultPriorityThe default priority of this notification type
deletePerLogoutIf set to yes, notifications of this type get deleted on log out.
descriptionDescription
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
iconImage.
iconProcessSpecifies the icon dynamically. If the icon has no effect, neither will the result of the process.
imageProcessProcess that reads the image data is returned by result.string('binary data').
onResultOpenAction that occurs when you double-click index search results or neon notifications.
onResultOpenIconIcon for the onResultOpen action.
titleTitle (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:

alias​

Type: String

The database alias that is associated with the notifications.

archivable​

Type: Boolean
Default: true

Set if notification can be moved to the archive to be accessable again later on.

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.

defaultPriority​

Type: ENotificationPriority

The default priority of this notification type

deletePerLogout​

Type: Boolean
Default: false

If set to yes, notifications of this type get deleted on log out.

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 they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

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.

<!--EOF-->

You can add a custom icon by placing an icon.png file in the folder of your data model.

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.

imageProcess​

Type: String

Process that reads the image data is returned by result.string('binary data').

For example, 'binary data' is the value returned by swing.doClienIntermediate(swing.CLIENTCMD_GETDATA, …).

Error messages from this process do not arrive at the client, they are only visible in the server log.

Parameters​

$local.idvalue
  The ID of the found record. If it cannot be found in the query, it must be checked with vars.exist

onResultOpen​

Type: String

Action that occurs when you double-click index search results or neon notifications.

Parameters​

$local.values
  Contents of the changed values

$local.alias
  Alias of the change

$local.type
  The type

onResultOpenIcon​

Type: String

Icon for the onResultOpen action.

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