Skip to main content

NeonContext

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

A model, which can be referenced in the editor of the Global Menu

Overview​

PropertySummary
titleTitle (speaking name. may contain spaces and special characters.)
devicesDetermines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices…
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…
commentProperty to store a developer comment in form of
iconImage.
iconProcessSpecifies the icon dynamically. If the icon has no effect, neither will the result of the process.
referencesThe views and webservices in this context
entitySpecifies the entity to which the context is linked.
viewmodeProviderDefine a specific provider for the different viewmodes that should be used for loading data
mainViewThe MainView is a detailed view of one specific record (one organisation, one person, etc.) It's used for example if you "open" a record in the client.
filterViewThe filterView is used for displaying several records (for example in a table-template) that might be filtered. Often the user has the possibility to set…
editViewThe editView is a view for modifying one entire specific record (one organisation, one person, etc.) It's used for example, when you want to create a new…
previewViewThe PreviewView is a view of one specific record (one organisation, one person, etc.). It's used for example to have a quick overview of a record and should…
previewMultipleViewThe PreviewMultipleView is a summary view of several records of the same type (two selected offers). It's used for example to have a quick summary of several…
lookupViewThe lookupView is used whenever the user opens a lookup-component in the client. A lookup-component is loaded for example when you have a recordField within an…

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

devices​

Type: EDeviceType[]

Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.

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.

references​

Type: References

The views and webservices in this context

entity​

Type: String

Specifies the entity to which the context is linked.
From the specified entity, the context contains its data and functions.

viewmodeProvider​

Type: ViewmodeProviders

Define a specific provider for the different viewmodes that should be used for loading data

mainView​

Type: String

The MainView is a detailed view of one specific record (one organisation, one person, etc.) It's used for example if you "open" a record in the client.
In most cases, it should contain the most important data while also providing the possibility to see detail information of that record. Often, the mainView has a lot of viewReferences to already existing views.

filterView​

Type: String

The filterView is used for displaying several records (for example in a table-template) that might be filtered. Often the user has the possibility to set filters via the UI. Normally the filterView is the point where you start as user in the client when you open a context.

editView​

Type: String

The editView is a view for modifying one entire specific record (one organisation, one person, etc.) It's used for example, when you want to create a new record or edit an existing record. It's not used when you edit only a small part of a record.

previewView​

Type: String

The PreviewView is a view of one specific record (one organisation, one person, etc.). It's used for example to have a quick overview of a record and should include the most important data. Sometimes, if there is so less information that it wouldn't make no sense to have a main view, only a preview is used for viewing a record.

previewMultipleView​

Type: String

The PreviewMultipleView is a summary view of several records of the same type (two selected offers). It's used for example to have a quick summary of several selected records and should include the most important data aggregated.

lookupView​

Type: String

The lookupView is used whenever the user opens a lookup-component in the client. A lookup-component is loaded for example when you have a recordField within an entity that refers to another entity (via a consumer). The providing entity needs an associated context where the lookupView is loaded when you want to select a record in you consumingEntity. (e.g. select an organisation when creating a contact person). Saying that, the lookupView is used for displaying several records.
Note that the specified view should've set the "noneLayout".
If you do not specify a custom lookupView, a default view is used that contains the entities contentTitle. This does only work if you've got a Default_context that has got a DefaultLookup_view which is used in that case.