@ablegroup/propertymapping v1.0.8

ABLE PropertyMapping Modul

Dieses Modul bietet Zugang zur Datenbank des Property Mappings, welches stage-übergreifende Kategorien und Eigenschaften bereitstellt. Zur Nutzung muss das Modul über require eingebunden werden. Außerdem muss die Datenbank mit initDatabase() initialisiert werden, wobei sowohl die AWS Access Key ID als auch der AWS Secret Key übergeben werden müssen. Der Key muss berechtigt sein DynamoDBs zu lesen.

Beispielverwendung

const mapping = require('@ablegroup/propertymapping');
mapping.initDatabase(accessKeyID, secretAccessKey);
const categories = await mapping.getAllCategories(stage);

Klassen

Category

Eine Category beschreibt eine Kategorie im d.3 und wird durch die Auflistung der Kategorien unter dem Endpunkt /dms/r/{{repoID}}/source definiert. Sie ist eine reine Datenpräsentation und bietet keine eigenen Methoden.

Variablen

Property

Eine Property beschreibt eine Eigenschaft im d.3 und wird durch die Auflistung der Eigenschaften unter dem Endpunkt /dms/r/{{repoID}}/objdef definiert. Eigenschaften werden für jede Nutzung in einer Kategorie einzeln hinterlegt. So kann es sein, dass das Feld "E-Mail" im d.3 unter /dms/r/{{repoID}}/source nur einmal auftaucht, aber durch die Nutzung in mehreren Kategorien auch mehrfach angelegt wird. Sie ist eine reine Datenpräsentation und bietet keine eigenen Methoden.

Variablen

Methoden

Initialisierung der Datenbank

mapping.initDatabase(accessKeyID, secretAccessKey);

Funktionsparameter

Laden aller Kategorien

const categories = await mapping.getAllCategories(stage);

Lädt alle in der Datenbank verfügbaren Kategorien zu einer Stage.

Funktionsparameter

Rückgabewert

Suche nach bestimmter Kategorie

const category = await mapping.getCategory(stage, categoryID, categoryKey, displayName);

Lädt eine Kategorie anhand eines eindeutigen Filerparameters. Zur Suche nach einer Kategorie muss mindestens ein Filterparameter gesetzt sein.

Funktionsparameter

Rückgabewert

Suche nach Kind-Kategorie

const categories = await mapping.getCategoryByParent(stage, categoryID, categoryKey, displayName);

Lädt die Kindkategorien einer Kategorie anhand eines eindeutigen Filerparameters. Zur Suche nach einer Kategorie muss mindestens ein Filterparameter gesetzt sein.

Funktionsparameter

Rückgabewert

Suche nach Eltern-Kategorie

const category = await mapping.getCategoryByChildren(stage, categoryID, categoryKey, displayName);

Lädt die Elternkategorie einer Kategorie anhand eines eindeutigen Filerparameters. Zur Suche nach einer Kategorie muss mindestens ein Filterparameter gesetzt sein.

Funktionsparameter

Rückgabewert

Laden aller Eigenschaften

const properties = await mapping.getAllProperties(stage);

Lädt alle in der Datenbank verfügbaren Eigenschaften zu einer Stage.

Funktionsparameter

Rückgabewert

Suche nach bestimmter Eigenschaft

const property = await mapping.getProperty(stage, propertyID, displayName, databasePosition, categoryKey, propertyKey);

Lädt eine Eigenschaft anhand eines eindeutigen Filerparameters. Zur Suche nach einer Eigenschaft muss mindestens ein Filterparameter gesetzt sein. Die Filter databasePosition und categoryKey müssen stets zusammen angegeben werden, da die Datenbankpositionen nur je Kategorie eindeutig sind.

Funktionsparameter

Rückgabewert

Laden aller Eigenschaften zu einer Kategorie

const properties = await mapping.getPropertiesByCategory(stage, categoryID, categoryKey, displayName);

Lädt alle Eigenschaften, die zu einer (anhand der Filterparameter definierten) Kategorie gehören.

Funktionsparameter

Rückgabewert

Exceptions