agorum core JavaScript-API

Diese Dokumentation bietet eine Übersicht zu den JavaScript-Bibliotheken in agorum core. Die Bibliotheken sind in verschiedene Kategorien unterteilt.

Voraussetzungen

• JavaScript-Kenntnisse
• Verständnis für die verschiedenen Bibliotheken von agorum core

Einstieg

Thema	Beschreibung	Link
Erste Zeile	Beschreibung der ersten Zeile eines JavaScripts	Erste Zeile eines JavaScripts
Monaco-Editor und JSDoc	Hintergrundinformationen zum integrierten Editor und zur Verwendung von JSDoc	Monaco-Editor und JSDoc

DataHandler

DataHandler	Beschreibung	Link
metadata-collection	Funktionsweise des DataHandlers metadata-collection	DataHandler metadata-collection
user-group	Funktionsweise des DataHandlers user-group	DataHandler user-group

SessionController

Java-Klasse	Beschreibung	Link
SessionController	Funktionen des SessionControllers (sc/sca)	SessionController (sc)

require('...')

JavaScript-Bibliothek	Beschreibung	Link
ac	Generelle Hilfs-Funktionen	JavaScript-Bibliothek ac

require('3rdparty/...')

JavaScript-Bibliothek	Beschreibung	Link
3rdparty/lodash	Verwenden der Funktionen der externen Hilfsbibliothek lodash in agorum core	JavaScript-Bibliothek 3rdparty/lodash

require('acaudit/...')

JavaScript-Bibliothek	Beschreibung	Link
acaudit/js/lib/audit	Gezieltes Abfragen von Einträgen aus der Audittabelle	JavaScript-Bibliothek acaudit

require('adapter/...')

JavaScript-Bibliothek	Beschreibung	Link
E-Mail-Adapter	Funktionen zum Erstellen, Updaten, Synchronisieren und Testen eines E-Mail-Adapters	JavaScript-Bibliothek adapter/objects

require('address/...')

JavaScript-Bibliothek	Beschreibung	Link
address	Enthält einen Überblick über das Erstellen von Adressobjekten über eine JavaScript-API.	JavaScript Address API JavaScript Address API - create JavaScript Address API - update JavaScript Address API - query JavaScript Adress API - get Beispielskript zur JavaScript Address API

require('agorum.cards/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.cards/js/decorators	Dient zum Unterstützen der Entwicklung von decorators und enthält Funktionen, mit denen Sie Elemente in einem gegebenen cardlet finden und ändern können.	JavaScript-Bibliothek agorum.cards/js/decorators
agorum.cards/js/cards	Dient zum Unterstützen der Entwicklung von cardlets und decorators.	JavaScript-Bibliothek agorum.cards/js/cards

require('agorum.composite/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.composite/js/common	Generische Hilfsfunktionen	JavaScript-Bibliothek agorum.composite/js/common
agorum.composite/js/lib/background	Überwachung von Hintergrundaktivitäten	JavaScript-Bibliothek agorum.composite/js/lib/background
agorum.composite/js/lib/buttons	Erstellung einer Buttonleiste, Verwendung von Standardbuttons	JavaScript-Bibliothek agorum.composite/js/lib/buttons
agorum.composite/js/lib/change-listener	Vereinfachter Zugriff auf Funktionen, um über Änderungen von Attributen eines Objekts in Kenntnis gesetzt zu werden.	JavaScript-Bibliothek agorum.composite/js/lib/change-listener
agorum.composite/js/lib/message	Verschiedene Arten von Message-Boxen	JavaScript-Bibliothek agorum.composite/js/lib/message
agorum.composite/js/lib/user-settings	Persistente Benutzereinstellungen für Widgets	JavaScript-Bibliothek agorum.composite.user-settings

require('agorum.dev/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.dev/js/lib/assert	Überprüft erwartete Ergebnisse.	JavaScript-Bibliothek agorum.dev/js/lib/assert
agorum.dev/js/lib/cleaner	Sammelt und räumt Objekte auf, die das System anschließend löscht.	JavaScript-Bibliothek agorum.dev/js/lib/cleaner
agorum.dev/js/lib/delta	Fügt die Werte der Funktion patch und dort aus dem Parameter delta mit den Werten aus dem Parameter source zusammen, um ein neues JavaScript-Objekt zu erhalten.	JavaScript-Bibliothek agorum.dev/js/lib/delta
agorum.dev/js/lib/finder	Findet Objekte, etwa Workflows, basierend auf diversen Kriterien.	JavaScript-Bibliothek agorum.dev/js/lib/finder
agorum.dev/js/lib/logger	Ermöglicht es, die eingebaute Logging-Funktionalität von agorum core in Skripten zu verwenden.	JavaScript-Bibliothek agorum.dev/js/lib/logger
agorum.dev/js/lib/runner	Ermöglicht das Ausführen von Tests über Tasks oder Cronjobs	JavaScript-Bibliothek agorum.dev/js/lib/runner
agorum.dev/js/lib/workflow	Vereinfacht diverse Zugriffe zur programmatischen Steuerung von Workflows.	JavaScript-Bibliothek agorum.dev/js/lib/workflow

require('agorum.docform/...')

Diese Bibliothek gehört zum lizenzpflichtigen Modul agorum core docform.

JavaScript-Bibliothek	Beschreibung	Link
agorum.docform/js/docform	Synchrone oder asynchrone Erkennung von Metadaten	JavaScript-Bibliothek agorum.docform/js/docform

require('agorum.electronic.invoicing/...')

Diese Bibliothek steht nur zur Verfügung, wenn Sie das Plugin agorum core electronic invoicing installiert und lizenziert haben.

JavaScript-Bibliothek	Beschreibung	Link
agorum.electronic.invoicing/js/lib/e-invoice	Verarbeitung und Erstellung von E-Rechnungen (ZUGFeRD, XRechnung)	JavaScript-Bibliothek agorum.electronic.invoicing/js/lib/e-invoice

require('agorum.home/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.home/hs/home	Funktionen zum Zugreifen auf agorum.home	JavaScript-Bibliothek agorum.home/js/home

require('agorum.icons/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.icons/hs/icons	Funktionen zum Verwenden von Icons in agorum core	JavaScript-Bibliothek agorum.icons/js/icons

require('agorum.insign/...')

Diese Bibliothek steht nur zur Verfügung, wenn Sie das Plugin agorum core insign installiert und lizenziert haben.

JavaScript-Bibliothek	Beschreibung	Link
agorum.insign/js/lib/insign	Funktionen zum Übergeben eines Dokuments an den Signaturanbieter inSign zum elektronischen Signieren	agorum core insign JavaScript-Bibliotheken
agorum.insign/js/lib/settings	Verwaltung und Konfiguration von Client-Einstellungen.

require('agorum.mail.filter/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.mail.filter/js/lib/mail-filter	Automatisiertes Ausführen verschiedener Aktionen auf eingehenden und ausgehenden E-Mails	JavaScript-Bibliothek agorum.mail.filter/js/lib/mail-filter

require('agorum.notes/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.notes/js/notes	Funktionen zum Steuern der Bedienoberfläche von Notizen in agorum core	JavaScript-Bibliothek agorum.notes/js/notes

require('agorum.task/...')

JavaScript-Bibliothek	Beschreibung	Link
agorum.task/js/task	Erzeugt automatisiert ausgeführte JavaScript-Tasks.	JavaScript-Bibliothek agorum.task/js/task

require('client/...')

JavaScript-Bibliothek	Beschreibung	Link
json	Funktionen zum Lesen von JSON-Daten von einem WebStream und Wandeln von JSON-Daten in JavaScript-Objekte.	JavaScript-Bibliothek client/json

require('common/...')

JavaScript-Bibliothek	Beschreibung	Link
aguila	aguila ist das in agorum core integrierte UI-Framework.	agorum core aguila
beans	Funktionen, mit denen Sie auf die API-Propertys von Objekten lesend und schreibend zugreifen können.	JavaScript-Bibliothek common/beans
cache	Funktionen zum Bearbeiten von Werten im Cache	JavaScript-Bibliothek common/cache
CMIS	Funktionen zum Zugreifen auf ein CMIS-Repository aus agorum core heraus	JavaScript-Bibliothek common/cmis
csv	Funktionen zum Parsen von CSV-Dateien	JavaScript-Bibliothek common/csv
data	Funktionen zum Lesen, Erstellen, Aktualisieren, Holen oder Löschen von Datenquellen-Einträgen	JavaScript-Bibliothek common/data Beispiel-Datenquellen für DataHandler
history	Funktion zum Wiederherstellen einer Historie	JavaScript-Bibliothek common/history
html	Funktionen zum Parsen und Konvertieren von HTML-Dateien	JavaScript-Bibliothek common/html
i18n	Funktionen zum Übersetzen von Texten	JavaScript-Bibliothek common/i18n
index	Funktionen zum Aktualisieren des Index	JavaScript-Bibliothek common/index
jwt	Funktionen für die Erstellung und Dekodierung von JWT (JSON Web Tokens)	JavaScript-Bibliothek common/jwt
mail	Funktionen zum Erstellen und Versenden von E-Mails	JavaScript-Bibliothek common/mail
metadata	Funktionen zum Laden oder Speichern von Objekt-Metadaten	JavaScript-Bibliothek common/metadata
metadata collection	Funktionen zum Abrufen von metadata collections und zum Aufbauen von Masken oder Filtern	JavaScript-Bibliothek common/metadata collection
metadb	Funktionen zum Schreiben / Lesen von Werten aus / in die MetaDB	JavaScript-Bibliothek common/metadb
objects	Funktionen zum Erzeugen, Finden, Analysieren oder Ändern von Objekten	JavaScript-Bibliothek common/objects
pdf	Funktionen zum Bearbeiten von PDF-Dokumenten	JavaScript-Bibliothek common/pdf
property	Funktionen zum Wandeln von Strings in JavaScript-Strukturen und umgekehrt	JavaScript-Bibliothek common/property
svg	Funktionen zum Wandeln von SVG-Dateien in JPG und PNG	JavaScript-Bibliothek common/svg
templates	Funktionen zum Befüllen von Platzhalter in einem String mit Objekt-Metadaten oder Variablen	JavaScript-Bibliothek common/templates
text	Funktionen zum Erzeugen von Text aus Dokumenten, etwa die Extraktion durch OCR	JavaScript-Bibliothek common/text
time	Funktionen zum Ändern von Datumsobjekten	JavaScript-Bibliothek common/time
transaction	Funktionen zum Ablaufen von Modifikationen in Transaktionen	JavaScript-Bibliothek common/transaction
uuid	Erzeugung von UUIDs (Universally Unique Identifiers)	JavaScript-Bibliothek common/uuid
workers	Funktionen zum Steuern von Workern	JavaScript-Bibliothek common/workers
workflow	Funktionen zum Starten oder Beenden von Workflows (agorum core workflow 3.0)	JavaScript-Bibliothek common/workflow
workflows	Funktionen zum Starten und Beenden von Workflows (agorum core workflow 2.0 und agorum core fileworkflow)	JavaScript-Bibliothek common/workflows
xml	Funktionen zum Parsen einer XML-Datei	JavaScript-Bibliothek common/xml

require('docform/...')

JavaScript-Bibliothek	Beschreibung	Link
transform	Funktionen für das Transformieren eines Strings in eine JavaScript-Variable	JavaScript-Bibliothek docform/transform

require('filingassistant/...')

JavaScript-Bibliothek	Beschreibung	Link
service	Funktionen zum Verwenden von anderen Funktionen im agorum core explorer	JavaScript-Bibliothek filingassistant/service

require('mailfilter/...')

JavaScript-Bibliothek	Beschreibung	Link
mailfilter	Funktionen zum Erstellen, Ändern, Prüfen und Laden eines Mailfilters	JavaScript-Bibliothek mailfilter/objects

require('office/...')

JavaScript-Bibliothek	Beschreibung	Link
fill-template	Funktionen zum Befüllen von Platzhaltern in Office-Dokumenten	JavaScript-Bibliothek office/fill-template

require('preview/...')

JavaScript-Bibliothek	Beschreibung	Link
objects	Funktionen für das Handeln von preview-Objekten	JavaScript-Bibliothek preview/objects

Object Beschreibung

Java-Klasse	Beschreibung	Link
GlobalObject	Funktionen des Objekttyps GlobalObject	GlobalObject

Weitere Informationen zur API

Thema	Beschreibung	Link
ContentTask	Start eines Prozesses bei Änderung des Contents eines Objekts	ContentTask
Objektnamen	Objektnamen überschreiben	Objektnamen per Skript überschreiben
Selektor	Ein Selektor (Selector) stellt eine Bedingung dar, die ein Objekt entweder erfüllt (wahr) oder nicht erfüllt (nicht wahr).	Selektor
Solr	Erläuterung der Suchsyntax und Fokus auf die Arbeit mit Datum	agorum core smart search
Worker	Skripte erstellen, die regelmäßig aufgerufen werden.	Worker im agorum core support tool benutzen
yml	Aufbau der Dateien export.yml und metadata.yml	export.yml metadata.yml

Sammlung von JavaScript-Beispielen

Thema	Beschreibung	Link
Skripte für Suchmaschine	Sammlung von JavaScript-Beispielen zum Thema Suchmaschinen	DocumentTextObjects löschen und neu indizieren (Skript)
JavaScript per CronJob ausführen	Mithilfe eines CronJobs ein JavaScript in definierten Abständen ausführen.	JavaScript per CronJob ausführen