JavaScript-Bibliothek agorum.dev/js/lib/finder

Mithilfe dieser JavaScript-Bibliothek finden Sie Objekte, etwa Workflows, basierend auf diversen Kriterien.

Verwendung

Diese Bibliothek binden Sie stets am Anfang eines Skripts ein:

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

Instanziierung

Sie müssen finder() grundsätzlich instanziieren:

finder()

Funktionen

build

Bildet eine Funktion zur Durchführung der definierten Suche.

Das System baut generell diverse Suchkriterien durch einen verketteten Aufruf von Funktionen zu einer internen Gesamtsuche zusammen und stellt sie mit build() als Funktion zur Verfügung.

Syntax

finder()....build()

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

// Folgender Aufruf baut eine Suche durch Angabe der diversen Kriterien auf und bildet diese mit "build" als Funktion ab.
// Hier wird etwa ein Workflow gesucht, der im UI "createTasks" steht und als Anhang den übergebenen Anhang besitzt.
let searchFunction = finder().workflowUi('createTasks').workflowAttachment(attachment).build();

// Durch den Aufruf der Funktion "searchFunction" erhalten Sie das Ergebnis.
let token = searchFunction();

// Die Suchfunktion liefert den ersten gefundenen Treffer zurück.

Rückgabewerte

Sie erhalten den ersten Treffer als agorum core-Objekt zurück, sofern das System etwas findet.

Verwendung

Diese Funktion verwenden Sie, um eine Funktion zur Suche zu erzeugen.

Sie verwenden diese Funktion in der Regel in Kombination mit der Funktion cx.wait für automatisierte Tests:

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

it('Test', cx => {
  // Sucht maximal 2 Minuten nach dem Token "createTasks" des Workflows mit dem angegebenen Anhang.
  let token = cx
    .wait('token in step createTasks')
    .minutes(2)
    .for(finder().workflowUi('createTasks').workflowAttachment(attachment).build());
});

Exceptions

Zu dieser Funktion existieren keine Exceptions.

find

Führt die gebildete Suche direkt durch, ohne eine Funktion zurückzuliefern.

Syntax

finder()....find()

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

// Folgender Aufruf baut eine Suche durch Angabe der diversen Kriterien auf und bildet diese mit "build" als Funktion ab.
// Hier wird etwa ein Workflow gesucht, der im UI "createTasks" steht und als Anhang den übergebenen Anhang besitzt.
let token = finder().workflowUi('createTasks').workflowAttachment(attachment).find();

// Die Suchfunktion liefert den ersten gefundenen Treffer zurück.

Rückgabewerte

Sie erhalten den ersten Treffer als agorum core-Objekt zurück, sofern das System etwas findet.

Verwendung

Diese Funktion verwenden Sie, um die gebildete Suche direkt auszuführen und das Objekt zurückzuerhalten.

Exceptions

Zu dieser Funktion existieren keine Exceptions.

workflowUi

Findet eine Workflow-UI mit dem gegebenen Namen.

Zum Verständnis der Funktionsweise siehe Funktion build.

Syntax

finder().workflowUi(name)

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
name	Definiert den Namen der gesuchten Workflow-UIs.	ja	–

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

finder().workflowUi('createTasks');

Rückgabewerte

Sie erhalten die finder-Instanz zurück, um weitere Suchanfragen verketten zu können.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Token finden möchten, das sich in einem bestimmten Workflow-UI befindet.

Exceptions

Zu dieser Funktion existieren keine Exceptions.

workflowToken

Findet ein Workflow-Token mit dem gegebenen Namen.

Zum Verständnis der Funktionsweise siehe Funktion build.

Syntax

finder().workflowToken(name)

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
name	Definiert den Namen des gesuchten Workflow-Tokens.	ja	–

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

finder().workflowToken('name-of-token');

Rückgabewerte

Sie erhalten die finder-Instanz zurück, um weitere Suchanfragen verketten zu können.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Token mit einem bestimmten Namen suchen.

workflowProcess

Findet einen Workflow-Prozess mit dem gegebenen Namen.

Zum Verständnis der Funktionsweise siehe Funktion build.

Syntax

finder().workflowProcess(name)

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
name	Definiert den Namen des gesuchten Workflow-Prozesses.	ja	–

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

finder().workflowProcess('name-of-process');

Rückgabewerte

Sie erhalten die finder-Instanz zurück, um weitere Suchanfragen verketten zu können.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Prozess-Objekt mit einem bestimmten Namen suchen.

Exceptions

Zu dieser Funktion existieren keine Exceptions.

workflowAttachment

Findet ein Workflow-Token mit einem bestimmten angehängten Anhang.

Zum Verständnis der Funktionsweise siehe Funktion build.

Syntax

finder().workflowAttachment(objekt)

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
objekt	Definiert ein Objekt (Anhang) in agorum core.	ja	–

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

finder().workflowAttachment(attachment);

Rückgabewerte

Sie erhalten die finder-Instanz zurück, um weitere Suchanfragen verketten zu können.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Token finden möchten, an dem ein bestimmter Anhang hängt.

Exceptions

Zu dieser Funktion existieren keine Exceptions.

add

Fügt zur Suche ein weiteres Kriterium hinzu.

Zum Verständnis der Funktionsweise siehe Funktion build.

Syntax

finder()....add(query)...

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
query	Definiert eine beliebige Solr-Query, um die Suche zu verfeinern.	ja	–

Beispiel

let finder = require('/agorum/roi/customers/agorum.dev/js/lib/finder');

finder().add('classname:folderobject');

Rückgabewerte

Sie erhalten die finder-Instanz zurück, um weitere Suchanfragen verketten zu können.

Verwendung

Diese Funktion verwenden Sie, wenn Sie die Suche weiter einschränken möchten.

Exceptions

Zu dieser Funktion existieren keine Exceptions.