onUpdate (Dashlet)

Property:

Beschreibung:
Informationen zum Dashlet.

objectTypes

string | string[]

Nein

Falls das Dashlet für alle Objekttypen angezeigt wird, so enthält diese Property die Zeichenkette *. Ansonsten enthält sie ein Array mit den internen Namen der Objekttypen, für die das Dashlet sichtbar ist.

platforms

string[]

Nein

Ein Array mit String-Konstanten, auf welchen Plattformen das Dashlet angezeigt wird:

• web - enaio® webclient im Browser

• desktop_app - enaio® webclient als Desktop-Anwendung

• mobile - enaio® webclient im Browser auf iOS oder Android (aktuell noch nicht unterstützt)

• mobile_app - enaio® mobile app für iOS und Android (aktuell noch nicht unterstützt)

uri

string

Ja

Die URL, unter welcher das Dashlet gehostet ist.

title_DE

string

Ja, Einsprachig

Der Titel des Dashlets, wenn enaio® webclient auf Deutsch eingestellt ist.

title_EN

string

Ja, Einsprachig

Der Titel des Dashlets, wenn enaio® webclient auf Englisch eingestellt ist.

title_FR

string

Ja, Einsprachig

Der Titel des Dashlets, wenn enaio® webclient auf Französisch eingestellt ist.

iconId?

string

Nein

Eine Icon-ID aus enaio® editor für ein Icon, das neben dem Titel des Dashlets im Menü dargestellt wird.
>> enaio® editor, "Icons"

users?

string[]

Nein

Ein Array mit enaio®-Benutzernamen, die das Dashlet sehen dürfen.
Ist diese Property nicht vorhanden, so ist das Dashlet für alle Benutzer sichtbar.

groups?

string[]

Nein

Ein Array mit enaio®-Gruppennamen. Die Benutzer in den Gruppen dürfen das Dashlet sehen.
Ist diese Property nicht vorhanden, so ist das Dashlet für alle Gruppen und deren Benutzer sichtbar.

Property:

Beschreibung:
Das aktiv ausgewählte Objekt in einer Trefferliste oder welches z. B. auf einer Indexdatenmaske angezeigt wird. Sind in einer Trefferliste mehrere Objekte ausgewählt, so enthält dieses Property das zuletzt ausgewählte davon.

hasVariants

boolean

Nein

Hat das Objekt Varianten?

mainType

string

Nein

Der Main Type des Objekts.

objectTypeId

string

Ja

Die Objekttyp-ID des Objekts.

Aus Konsistenzgründen wird durch die Kommunikationsbibliothek für typenlose Dokumentobjekt immer die objectTypeId “-1” zurückgegeben, wenngleich im enaio® client selbst die numerischen Werte bei den Eigenschaften angezeigt werden (“13107200” Ablage des Benutzers oder “19660800” in der Workflow-Akte).

osid

string

Ja

Die ID des Objekts.

objectType

string

Nein

Eine der folgenden Konstanten:

• DOCUMENT - Es handelt sich um ein Dokument-Objekt.

• REGISTER - Es handelt sich um ein Register-Objekt.

• FOLDER - Es handelt sich um ein Ordner-Objekt.

Property:

Beschreibung:
Objekt identisch zu enaio® client (Rich Client) Aufruf zur Initialisierung.

objectident

string

Ja

Die Objekttyp-ID des Objekts.

objecttype

string

Ja

Die Objekttyp-ID des Objekts.

Aus Konsistenzgründen wird durch die Kommunikationsbibliothek für typenlose Dokumentobjekt immer objecttype “-1” zurückgegeben, wenngleich im enaio® client selbst die numerischen Werte bei den Eigenschaften angezeigt werden (“13107200” Ablage des Benutzers oder “19660800” in der Workflow-Akte).

userid

string

Ja

Die Benutzer-ID des angemeldeten Benutzers.

userguid

string

Ja

Die Benutzer-GUID des angemeldeten Benutzers.

sessionguid

string

Ja

Die Session-ID zu enaio Server.

regenerate

string

Ja

Aktuell von enaio® webclient nicht unterstützt. Der Wert ist immer "0".

pagecount

number

Ja

Die Anzahl der Content-Seiten, die dem Objekt angehängt sind.

searchterm

string

Ja

Im Zuge einer Volltextsuche wird hier die Volltext-Suchzeichenkette übergeben.

Property:

Beschreibung:
Eine Array der aktuell ausgewählten Objekte in einer Trefferliste. Ist eine Indexdatenmaske sichtbar, dann hat das Array nur ein Element, nämlich das gerade aktive Objekt.

Array of objects

Ja

Für die einzelnen Objekte in dem Array siehe lastSelectedEntry.

Property:

Beschreibung:
Informationen zur aktuellen Sitzung.

language

string

Ja

Die aktuelle Sprache in enaio® webclient.

languageObjectDefinition

string

Ja

Die aktuelle Sprache der Objektdefinition in enaio® webclient.

sessionGuid

string

Ja

Die Session-GUID zu enaio® gateway. Sie kann z. B. für REST-Anfragen genutzt werden, um sich an enaio® gateway zu authentifizieren.

sessionTimeout

number

Nein

Das aktuell gesetzte Session-Timeout in enaio® webclient (ab Version 11.10.16)

clientType

string

Ja

Auf welcher Plattform wird das Dashlet gerade ausgeführt. Mögliche Konstanten sind:

• web - enaio® webclient im Browser

• desktop_app - enaio® webclient als Desktop-Anwendung

• mobile - enaio® webclient im Browser auf iOS oder Android (aktuell noch nicht unterstützt)

• mobile_app - enaio® mobile app für iOS und Android (aktuell noch nicht unterstützt)

baseUrl

string

Ja

Die Basis-URL zu enaio® gateway. Sie kann z. B. für REST-Anfragen genutzt werden.

clientVersion

string

Ja

Versionsnummer der Client-Anwendung, einschließlich Build-Zeitstempel und Commit-Hash (ab Version 11.10.41 und 12.0.12).

Format: "Hauptversion.Nebenversion.Patch (Build Zeitstempel, Commit-Hash)"

Beispiel:

• web → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss+0000)"

• desktop_app → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss.SSSZ, Commit-Hash)"

• mobile → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss+0000)"

• mobile_app → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss.SSSZ, Commit-Hash)"

• rich_client → "Hauptversion.Nebenversion.Patch"

Property:

Beschreibung:
Informationen über den aktuell angemeldeten enaio®-Benutzer.

email

string

Ja

Die E-Mail-Adresse des aktuellen Benutzers, sofern vorhanden.

fullname

string

Nein

Der volle Name des Benutzers, sofern vorhanden.

groups

string[]

Ja

Ein Array mit den enaio®-Gruppen, in denen der aktuelle Benutzer Mitglied ist.

name

string

Ja

Der Name des aktuellen Benutzers.

osGuid

string

Ja

Die GUID des aktuellen Benutzers.

userId

number

Ja

Die ID des aktuellen Benutzers.

wfGuid

string

Nein

Die Workflow-GUID des aktuellen Benutzers, sofern vorhanden.

wfOrgId

string

Ja

Die Workflow-Organisation, welcher der aktuelle Benutzer angehört.

colorScheme

string

Ja

Das aktuelle Farbschema des Clients (ab Version 11.10.41 und 12.0.12).

accentColor

string

Ja

Die aktuell verwendete Akzentfarbe des enaio® webclients (ab Version 11.10.41 und 12.0.12).

Property:

Beschreibung:
Der Kontext, in welchem sich enaio® webclient gerade befindet. Dies kann eine normale Trefferliste, eine Indexdatenmaske, eine Volltext-Trefferliste und so weiter sein.

string

Nein

Folgende Konstanten sind möglich:

• hitlist.result - Normale Trefferliste

• hitlist.fulltextResult - Volltext-Trefferliste

• hitlist.favorites - Favoriten-Trefferliste

• hitlist.history - Verlauf-Trefferliste

• hitlist.internalTray - (Interne) Ablage des Benutzers
  
  

• hitlist.inbox.revisit - Wiedervorlagen-Trefferliste

• hitlist.inbox.abo - Abo-Trefferliste

• hitlist.inbox.subscriptionObjects - Abonnierte-Objekte-Trefferliste

• hitlist.inbox.workflow - Workflow-Eingangskorb-Trefferliste

• workflow - Workflow-Detailansicht

• indexdata - Indexdatenmaske (schreibgeschützt / Bearbeitungsmodus wird nicht unterschieden)

• folder - Standort-Trefferliste

Property:
locationInfo (ab enaio® weblient 11.10.20/10.10.226/11.0.511)

Beschreibung:

Informationen zum aktuellen Standort und damit zum übergeordneten Objekt. Wird im Kontext einer Standort-Trefferliste mit Werten gefüllt.

In leeren Standorten werden die Infos aus der Navigation (dem Registerbaum) ermittelt.

objectId

string

Nein

objectId des aktuell geöffneten Standortes (FOLDER oder REGISTER)

objectTypeId

string

Nein

objectTypeId des aktuell geöffneten Standortes (FOLDER oder REGISTER)