Version: 2025.1

neon

Provides methods for working within a neon environment (e.g. working with entities, webclient-access, etc.)

Methods

addRecord

addRecord(pConsumerName, pFieldnameValues): string

Adds a new record to a entity linked by a consumer

Parameters

pConsumerName

string | number | boolean

Name of the consumer, which should be used to write the record

pFieldnameValues

any

The values as a map. E.g.: {Fieldname:Value, Fieldname2:Value}

Returns

string

the UUID of the new record

Throws

May throw an exception.

closeImage

closeImage(pImageID, pForce): void

Closes a frame.

Parameters

pImageID

string | number | boolean

The ID of the frame.

pForce

boolean

'true' if you want to close the frame without prompting the user.

Returns

void

Throws

May throw an exception.

Example

var imageID = neon.openCalendar();
  neon.closeImage(imageID, true);

copyToClipboard

copyToClipboard(pDataToCopy): void

Copies the provided String to the clipboard.

Parameters

pDataToCopy

string | number | boolean

the String to copy to the clipboard.

Returns

void

Throws

May throw an exception.

deleteRecord

deleteRecord(pConsumerName, pUid): void

Removes a record from an outgoing linked Entity (an Entity that is consumed by the current Entity).

Parameters

pConsumerName

string | number | boolean

Name of the consumer in the current entity that points to the entity where record is deleted.

pUid

string | number | boolean

UID of the record to delete.

Returns

void

Throws

May throw an exception.

download

download(pBase64, pFileName): void

Returns a file to the client

Parameters

pBase64

string | number | boolean

The content of the file.

pFileName

string | number | boolean

The name of the file.

Returns

void

Throws

May throw an exception.

Example

var file = getIcon("CHATPortrait", "Admin", true);
  neon.download(file, "PictureAdmin.png")

downloadToZip

downloadToZip(pZipFileName, pFileData, pFileNames): void

Liefert einen ZIP-Datei an den Client welches die übergebenen Dateien beinhaltet

Parameters

pZipFileName

string | number | boolean

Der Name der zu erstellenden ZIP-Datei

pFileData

string[]

Dateiinhalte Base64 kodiert

pFileNames

string[]

Dateinamen

Returns

void

Throws

May throw an exception.

executeJs

executeJs(pExpression): void

Executes a JavaScript Expression in the current UI.

Parameters

pExpression

string | number | boolean

the Expression to be executed in the browser.

Returns

void

Throws

May throw an exception.

focusComponent

focusComponent(pComponentId): void

Focuses an UI component with the given ID. The ID of the component is composed of "<entityname> . <entityfieldname> " e.g. "Organisation_entity.NAME".

If multiple components with the same ID are present then the first component in the HTML DOM is focused.

</entityfieldname> </entityname>

Parameters

pComponentId

string | number | boolean

the ID of the component to be focused

Returns

void

Throws

AditoUnsupportedOperationException

getImageContent

getImageContent(pImageID): string

Retrieves the current contents of the TopComponent as defined in the Designer.

Parameters

pImageID

string | number | boolean

this parameter is currently ignored. Always the current main image is used.

Returns

string

Title and description of the image

Throws

May throw an exception.

openCalendar

openCalendar(pViewMode?, pUsers?, pDays?): string

Öffnet den Kalender

Parameters

pViewMode?

number

der gewünschte Viewmode

pUsers?

any

die User, die sofort geöffnet werden sollen

pDays?

string[]

die Tage, die selektiert werden sollen

Returns

string

die ID des Kalenders

Throws

May throw an exception.

openCalendarEntry

openCalendarEntry(pEntry, pReccurrenceID, pOperatingState, pPrompts, pCalendarOwner): string

Opens a calendar entry in a window. If it has a UID, it will be edited, otherwise, it will be opened as a newly created entry.

Parameters

pEntry

any

The entry to be opened, as a map or object[] (or the UID of the entry)

pReccurrenceID

string | number | boolean

For recurring appointments, this ID indicates the element to be edited. 'Null' for the main element (date als "long").

pOperatingState

string | number | boolean

The operatingState in which this entry should be opened.

pPrompts

any

Additional variables for the frame, as a map; 'null' for none.

pCalendarOwner

string | number | boolean

Returns

string

Throws

May throw an exception.

openCalendarEntryByUID

openCalendarEntryByUID(pType, pUser, pEntryUID, pReccurrenceID, pOperatingState, pPrompts, pCalendarOwner): string

Opens a calendar entry in a window. If it has a UID, it will be edited, otherwise, it will be opened as a newly created entry.

Parameters

pType

number

The entry type (appointment or task).

pUser

string | number | boolean

The users in whose mailbox the entry exists.

pEntryUID

string | number | boolean

The UID of the entry.

pReccurrenceID

string | number | boolean

For recurring appointments, this ID indicates the element to be edited; 'null' for the main element. (date als "long")

pOperatingState

string | number | boolean

The operatingState in which this entry should be opened.

pPrompts

any

Additional variables for the frame, as a map; 'null' for none.

pCalendarOwner

string | number | boolean

Returns

string

Throws

May throw an exception.

Example

if(vars.exists("$sys.selectionRows"))
  {
  var uid = JSON.parse(vars.get("$sys.selectionRows"))[0].UID;
  uid = text.decodeMS(uid)[0];



 neon.openCalendarEntryByUID(calendars.VTODO, null, uid, "", neon.OPERATINGSTATE_VIEW, null);
  }

openCalendarICS

openCalendarICS(pICalText, pDefaultTimeZone, pOperatingState, pPrompts, pCalendarOwner): boolean

Opens an appointment in ICS format.

Parameters

pICalText

string | number | boolean

The contents of the ICS file.

pDefaultTimeZone

string | number | boolean

The default time zone to be used if none was specified.

pOperatingState

string | number | boolean

The operatingState in which this entry should be opened.

pPrompts

any

Additional variables for the frame, as a map; 'null' for none.

pCalendarOwner

string | number | boolean

Returns

boolean

'true' if the contents was opened.

Throws

May throw an exception.

openContext()

openContext(pContextName, pViewName, pIds, pInitialOperatingState, pVariables, pTabID, pOpenInNewTab?): string

Opens a designated view of a context.

Parameters

pContextName

string | number | boolean

Name of the context, e.g. "Organisation"

pViewName

string | number | boolean

Name of the view that exists in the context given in pContextName, e.g. "OrganisationFilter_view", "OrganisationSpecialisedGeodata_view"

pIds

string[]

An includelist of UIDs (=filter for record(s) with these IDs) or "null"/empty array for all

pInitialOperatingState

string | number | boolean

OperatingState that is loaded, see "neon.OPERATINGSTATE_***"; Examples: for a filter_view you probably want to set "neon.OPERATINGSTATE_SEARCH" while for an edit_view you might want to pass "OPERATINGSTATE_NEW" or "OPERATINGSTATE_EDIT"

pVariables

any

Parameter variables as "Object" (key-value-pairs); null for no parameter variables

pTabID

string | number | boolean

ID of the tab which is opened by default; "null" for non specific (=use default behaviour); this is useful for example when using the MasterDetail-layout in a view

pOpenInNewTab?

boolean

Flag that determines if the context is to be opened in a new tab. This parameter is only effective in desktop browsers. It will be ignored on tablets or mobile devices, and when targeting unsupported Views (e.g, PreviewViews or "small" EditViews).

Returns

string

ImageId of the newly opened context or null if the image could not be opened while not throwing an error

Deprecated

This API is deprecated.

Throws

May throw an exception.

Throws

AditoIllegalArgumentException

openContextWithRecipe

openContextWithRecipe(pContextName, pViewName, pEntityRecordsRecipe, pInitialOperatingState, pTabID, pOpenInNewTab, pUseInitFilterAsFallback?): string

Opens a designated view of a context with a EntityRecordsRecipe.

You can create a new EntityRecordsRecipe with a EntityRecordsRecipeBuilder (neonFilter.createEntityRecordsRecipeBuilder) or you can pass an already existing entityRecordsRecipe.

Parameters

pContextName

string | number | boolean

Name of the context, e.g. "Organisation" This param is always required and must not be empty.

pViewName

string | number | boolean

Name of the view that exists in the context given in pContextName, e.g. "OrganisationFilter_view", "OrganisationSpecialisedGeodata_view" This param is always required but may be null.

pEntityRecordsRecipe

any

defines which records are loaded when opening the view; To create a new EntityRecordsRecipe use "neonFilter.createEntityRecordsRecipeBuilder" Can be either from type "String" (a stringified RecordsRecipe from a $sys-variable for example) or an object of "EntityRecordsRecipeBuilder". The entity-property of the EntityRecordsRecipe is ignored because the entity is already defined by the entity of the given context (pContextName). The provider-property of the EntityRecordsRecipe is ignored because the provider is defined by the used view. Note that this method will handle the includedIds of the EntityRecordsRecipe different than the neon.openContext methods: While the deprecated methods neon.openContext(...) treat a value for pIds null or empty array equally, this method follows the EntityRecordsRecipe principle where null represents no filter for includedIds and an empty array represents records with exactly these includedIds which means: no data. This param is always required but may be null. Only if this param is null an existing default filter or the defined initFilter will be used.

pInitialOperatingState

string | number | boolean

pTabID

string | number | boolean

ID of the tab which is opened by default; null for non specific (=use default behaviour); this is useful for example when using the MasterDetail-layout in a view To get the ID of a tab you can either open the tab and take a look in the URL or you can view the data-model source - for example the name(=id) of a neonViewReference. This param can be omitted.

pOpenInNewTab

boolean

Flag that determines if the context should be opened in a new tab. This param can be omitted or must be true/false (never null); default value is false

pUseInitFilterAsFallback?

boolean

When the userFilter in the recordRecipe is null and pUseInitFilterAsFallback = false then an empty fallback filter will be used. Otherwise if pUseInitFilterAsFallback = true then no filter will be set and initFilterProcess will be used.

Returns

string

ImageId of the newly opened context or null if the image could not be opened while not throwing an error

Throws

May throw an exception.

Throws

AditoUnsupportedOperationException

openFile

openFile(pBase64, pFileName, pMimeType, pNewTab): void

Try to open the file in the browser. If the browser does not support this action, the file will be downloaded.

Parameters

pBase64

string | number | boolean

The content of the file.

pFileName

string | number | boolean

The name of the file.

pMimeType

string | number | boolean

The mimeType of the file.

pNewTab

boolean

Specifies if the file should be opened in the new tab.

Returns

void

Throws

May throw an exception.

Example

var file = getIcon("CHATPortrait", "Admin", true);
  neon.openFile(file, "PictureAdmin.png", "image/png", true)

openHome

openHome(): string

Öffnet das die Home-Maske

Returns

string

die ID des Frames

Throws

May throw an exception.

openIndexSearch

openIndexSearch(pPattern, pGroups, pTagTitles?): string

Opens the index search.

Parameters

pPattern

string | number | boolean

A pattern; 'null' for none.

pGroups

string[]

The restricting groups; 'null' for all.

pTagTitles?

string[]

The titles of the tags; 'null' for none.

Returns

string

The ID of the index search.

Throws

May throw an exception.

Example

var id = neon.openIndexSearch("Meier*", ["PERS", "ORG"]);

openReport()

openReport(pName, pCondition, pPrompts, pColumnNames, pData, pVariables, pOpenInNewTab?): string

Opens a report.

Parameters

pName

string | number | boolean

The name of the report.

pCondition

any

A restricting condition.

pPrompts

any

The prompts for the report itself.

pColumnNames

string[]

The columns, if you want to pass the data directly.

pData

string[][]

The report data.

pVariables

any

The variables for the image.

pOpenInNewTab?

boolean

Returns

string

The report ID.

Deprecated

This API is deprecated.

Throws

May throw an exception.

Example

var params = new Array;
  var imgData = getMyASYS_ICONSdata();
  params["myAddr"] = imgData[0];
  params["adito.image.myLogo"] = imgData[1];
  params["CAMPAIGN"] = vars.getString("$comp.name");

 var rptfields = ["CODE", "STEP"];
  data = db.table("select "+ rptfields.join(",") + " from CAMPAIGNLOG " + " join CAMPAIGNSTEP on STEP_ID = CAMPAIGNSTEPID " + " where CAMPAIGNLOG.CAMPAIGN_ID = '" + id + "' order by CODE");

 neon.openReport("RPTJ_CAMPAIGN", null, params, rptfields, data, null);

openUrl

openUrl(pLocation, pNewTab): void

Opens a URL on the client.

Parameters

pLocation

string | number | boolean

The URL to open.

pNewTab

boolean

'true' to open the URL in a new window, 'false' in the current window.

Returns

void

Throws

May throw an exception.

Example

neon.openUrl("https://www.dict.cc/?s=halozination", false);

refresh

refresh(pFieldNames?): void

Refreshes specific fields within the current view (image) in the ADITO system. This method re-executes the processes for the specified fields, ensuring that the data is updated without resetting the field values to null or reloading them from the recordContainer.

If no fields are specified, all fields within the current view will be refreshed. This makes it an efficient choice for refreshing only necessary fields after data changes.

Important Note: When using neon.refresh(), only the processes associated with the fields are re-executed. The fields themselves are not reset to null.

Parameters

pFieldNames?

string[]

an array of field names (as Strings) to refresh. - If null is passed, all fields in the current view (image) will be refreshed by invoking neon.refreshAll(). - If an empty array is passed, no action will be taken, and no fields will be refreshed. - If [null] is passed, all fields will be recalculated without reloading the data from the RecordContainer. - Fields should be referenced by their identifier, such as $field.STATUS. - To refresh multiple fields, pass them as an array of field identifiers.

Returns

void

Throws

May throw an exception.

Example

// Example 1: Refreshing all fields in the current view:
  neon.refresh(); // Will refresh all fields of the current image (MainView)

  // In this example, all fields in the current view (e.g., MainView) will be refreshed, ensuring any updates are reflected.

  // Example 2: Refreshing specific fields in the current view:

  neon.refresh(["$field.STATUS", "$field.DATE_EDIT"]); // Refreshes the STATUS and DATE_EDIT fields

  // This will only refresh the specified fields (STATUS and DATE_EDIT) in the current view.

  // Example 3: Ineffective refresh when checking for null in a process:

  // Field.valueProzess
  if (vars.get("$this.value") == null) {
  result.string("defaultValue");
  }

  neon.refresh(); // The field value will not be reset to null, so the process won't reassign "Default Value"

  // This shows that the refresh only re-executes the process. It does not reset the field value to null, so if the field was already set, the process won’t overwrite it.

Best Practices:

Use neon.refresh() when you need to refresh specific fields and re-execute their processes, without resetting field values.
If you need to reset the value of a field to null before recalculating, you must handle this manually in your process logic.

refreshAll

refreshAll(): void

Refreshes all fields in all views (images) within the ADITO system. This method re-executes all processes for all fields, actions and consumer across the entire application, ensuring that data and UI are fully updated in every view.

Unlike neon.refresh(), which only refreshes fields in the current view, neon.refreshAll() triggers a refresh for fields in every view, including the MainView, PreviewView, and any other open contexts. This makes it more comprehensive, but it can have a higher performance impact.

Important Note: Similar to neon.refresh(), this method only recalculates processes but does not reset field values to null. If a process checks whether a field's value is null (e.g., vars.get("$this.value") == null) and assigns a new value if the field is empty, the refresh will be ineffective in resetting the value. The processes will re-execute, but the fields will retain their existing values unless explicitly modified.

Best Practices:

Use neon.refreshAll() only when you need to refresh fields across the entire application, as it may impact performance.
If you only need to refresh fields in the current view, consider using neon.refresh() for better performance.

Returns

void

Throws

May throw an exception.

Example

neon.refreshAll(); // Refreshes all fields in all images (MainView, PreviewView, etc.)

// In this example, all fields in all views will be refreshed, ensuring that any updates // in the application are reflected everywhere.

// Example 2: Ineffective refresh when checking for null in a process:

// Field.valueProzess if (vars.get("$this.value") == null) { result.string("DefaultValue") }

neon.refreshAll(); // The field value will not be reset to null, so the process won't reassign "Default Value" // This shows that even though neon.refreshAll() re-executes processes for all fields, it does not reset their values to null. If a field already has a value, the process won’t overwrite it.

refreshAllNeonBadges

refreshAllNeonBadges(): void

Löst die Aktualisierung aller Badges aus

Returns

void

Throws

May throw an exception.

refreshBadge

refreshBadge(pType): void

Löst die Aktualisierung eines Badges eines bestimmten Badge-Typs aus. Meist für die Aktualiserung in afterDelete benötigt.

Parameters

pType

BadgeType

Returns

void

Throws

May throw an exception.

setFieldValue

setFieldValue(pFieldName, pValue): void

Sets the value of a field.

Parameters

pFieldName

string | number | boolean

The name of the field.

pValue

string | number | boolean

The value to be set.

Returns

void

Throws

May throw an exception.

Example

neon.setFieldValue("$field.ORGNAME", "CCK Limited");

setFieldValues

setFieldValues(pFieldValueMap): void

Sets the value of multiple fields.

Parameters

pFieldValueMap

any

Map with the names and values of the fields

Returns

void

Throws

May throw an exception.

setFilter

setFilter(pConsumerName, pFilter): void

Sets a filter to an entity

Parameters

pConsumerName

string | number | boolean

name of the consumer field within the current entity where the filter should be set

pFilter

any

the filter, JSON - format as defined for entity-filters or a filter builder as created for example by neonFilter.createFilterCondition or neonFilter.createFilterGroup

Returns

void

Throws

May throw an exception.

updateRecord

updateRecord(pConsumerName, pUid, pFieldnameValues): void

Updates a record linked by a consumer

Parameters

pConsumerName

string | number | boolean

Name of the consumer, which should be used to write the record

pUid

string | number | boolean

The uid of the record

pFieldnameValues

any

The values as a map. E.g.: {Fieldname:Value, Fieldname2:Value}

Returns

void

Throws

May throw an exception.

Properties

BRAND_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the brandColor e.g Button Color

COMPONENTSTATE_AUTO

string

ComponentState: Automatic, depending on Framemode

COMPONENTSTATE_DISABLED

string

ComponentState: inaktiv

COMPONENTSTATE_EDITABLE

string

ComponentState: editable

COMPONENTSTATE_INVISIBLE

string

ComponentState: invisible

COMPONENTSTATE_READONLY

string

ComponentState: read only

CONTEXT_PRESENTATIONMODE_DASHBOARD

string

Context Presentationmode: DASHBOARD

CONTEXT_PRESENTATIONMODE_EDIT

string

Context Presentationmode: EDIT

CONTEXT_PRESENTATIONMODE_EDIT_SMALL

string

Context Presentationmode: EDIT_SMALL

CONTEXT_PRESENTATIONMODE_FILTER

string

Context Presentationmode: FILTER

CONTEXT_PRESENTATIONMODE_FULL

string

Context Presentationmode: FULL

CONTEXT_PRESENTATIONMODE_LOOKUP

string

Context Presentationmode: LOOKUP

CONTEXT_PRESENTATIONMODE_PREVIEW

string

Context Presentationmode: PREVIEW

DEVICE_DESKTOP

string

Type of device, used by "$sys.device": Desktop

DEVICE_HEADLESS

string

Type of device, used by "$sys.device": Headless, e.g. used by webservices

DEVICE_MOBILE

string

Type of device, used by "$sys.device": Mobile

DEVICE_TABLET

string

Type of device, used by "$sys.device": Tablet

FRAME_VIEWMODE_DATASET

string

Frame Viewmode: DATASET

FRAME_VIEWMODE_TABLE

string

Frame Viewmode: TABLE

MODIFIER_TYPE_MASK

string

Source of a value change: mask

MODIFIER_TYPE_PROCESS

string

Source of a value change: process

MODIFIER_TYPE_PROCESS_SETVALUE

string

Source of a value change: process

MODIFIER_TYPE_RECORD

string

Source of a value change: data source

NOTIFICATION_BADGE

BadgeType

Notification never appeard on users screen.

OPERATINGSTATE_EDIT

string

OperatingState: EDIT

OPERATINGSTATE_NEW

string

OperatingState: NEW

OPERATINGSTATE_SEARCH

string

OperatingState: SEARCH

OPERATINGSTATE_VIEW

string

OperatingState: VIEW

PRIMARY_ACCENT_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the primaryAccentColor e.g Selection Color

PRIORITY_HIGH_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the priorityHighColor

PRIORITY_LOW_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the priorityLowColor

PRIORITY_MEDIUM_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the priorityMediumColor

PRIORITY_NONE_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the priorityNoneColor

PRIORITY_NORMAL_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the priorityNormalColor

READONLY_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the readonly color

RESOURCETIMELINE_ACTIVE_COLOR_1

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_10

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_11

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_2

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_3

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_4

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_5

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_6

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_7

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_8

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_ACTIVE_COLOR_9

string

Color Constant that holds the name of a CSS Selector which is used for an active resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_1

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_10

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_11

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_2

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_3

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_4

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_5

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_6

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_7

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_8

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

RESOURCETIMELINE_PASSIVE_COLOR_9

string

Color Constant that holds the name of a CSS Selector which is used for a passive resource within a resource timeline.

SECONDARY_ACCENT_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the secondaryAccentColor e.g Alternating Talbe Rows Color

SECONDARY_LIGHT_COLOR

string

Color Constant that holds the name of a CSS Selector which is used for the secondaryLightColor e.g default BadgeRenderer-Background