@ablegroup/propertymapping 中文文档教程

发布于 3年前 浏览 27 项目主页 更新于 3年前

ABLE PropertyMapping Modul

Dieses Modul bietet Zurgang 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

一个类别 beschreibt eine Kategorie im d.3 und wird durch die Auflistung der Kategorien unter dem Endpunkt /dms/r/{{repoID}}/source< /code> 定义。 Sie ist eine reine Datenpräsentation und bietet keine eigenen Methoden。

Variablen

VariableDatentypBeschreibung
categoryIDStringDurch die Datenbank vergebene UUID einer Kategorie
categoryKeyStringID einer Kategorie im d.3
displaynameStringAnzeigename einer Kategorie im d.3
writeAccessbooleanBerechtigung für User Werte zu ändern
childrenString[]Liste der Kindkategorien (anhand des categoryKey)
parentStringElternkategorie (anhand des categoryKey)

Property

Eine Property beschreibt eine Eigenschaft im d.3 und wird durch die Auflistung der Eigenschaften unter dem Endpunkt /dms/r/{{repoID}}/objdef 定义。 Eigenschaften werden für jede Nutzung in einer Kategorie einzeln hinterlegt。 所以 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天使线。 Sie ist eine reine Datenpräsentation und bietet keine eigenen Methoden。

Variablen

VariableDatentypBeschreibung
propertyIDStringDurch die Datenbank vergebene UUID einer Eigenschaft
displaynameStringAnzeigename einer Eigenschaft im d.3
databasePositionNumberDatenbankposition im d.3, abhängig von der Kategorie
categoryKeyStringID der übergeordneten Kategorie im d.3
mandatorybooleanPflichtfeld
modifiablebooleanBerechtigung für User Werte zu ändern
propertyKeyNumberID einer Eigenschaft im d.3, stage-abhängig

Methoden

Initialisierung der Datenbank

mapping.initDatabase(accessKeyID, secretAccessKey);

Funktionsparameter

ParameterBeschreibung
accessKeyIDID des Access Keys des zu nutzenden AWS-Accounts
secretAccessKeySecret Access Key des zu nutzenden AWS-Accounts

Laden aller Kategorien

const categories = await mapping.getAllCategories(stage);

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

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'

Rückgabewert

DatentypBeschreibung
Category[] oder
[]
Liste der Kategorien in der Datenbank

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category oder
undefined
Gefundene Kategorie entsprechend der Filterparameter oder
undefined, wenn keine Kategorie gefunden wurde

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category[] oder
[]
Gefundene Kindkategorien entsprechend der Filterparameter

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category oder
undefined
Gefundene Elternkategorie entsprechend der Filterparameter oder
undefined, wenn keine Kategorie gefunden wurde

Laden aller Eigenschaften

const properties = await mapping.getAllProperties(stage);

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

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'

Rückgabewert

DatentypBeschreibung
Property[] oder
[]
Liste der Eigenschaften in der Datenbank

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。 过滤器 databasePositioncategoryKey müssen stets zusammen angegeben werden, da die Datenbankpositionen nur je Kategorie eindeutig sind。

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
propertyIDFilterparameter, optional
ID der Eigenschaft in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
displayNameFilterparameter, optional
Anzeigename der Eigenschaft
'Personalnummer'
databasePositionFilterparameter, optional
Datenbankposition der Eigenschaft
12
categoryKeyFilterparameter, optional
ID der übergeordneten Kategorie im d.3
'XAPER'
propertyKeyFilterparameter, optional
ID der Eigenschaft im d.3, stage-spezifisch
47

Rückgabewert

DatentypBeschreibung
Property oder
undefined
Gefundene Eigenschaft entsprechend der Filterparameter oder
undefined, wenn keine Eigenschaft gefunden wurde

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) 类别。

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Property[] oder
[] oder
undefined
Gefundene Eigenschaften innerhalb der Kategorie oder
undefined, wenn keine Kategorie gefunden wurde

Exceptions

TitelBeschreibungLösung
Stage is not availableEs wurde eine nicht vorhandene Stage übergeben.Übergabe einer verfügbaren Stage (aktuell dev, qas, version, prod).
No params found, provide at least one param to search forEs wurden keine Filterparameter übergeben.Übergabe mindestens eines Filterparameters.
CategoryKey and DatabasePosition are required in order to search by themEs wurde eine Kategorie, aber kein Datenbankfeld (oder umgekehrt) übergeben.Übergabe von Kategorie-Key und Datenbankposition oder Übergabe keines dieser Parameter.
Database was not initializedDie Datenbank wurde vor der Nutzung nicht initialisiert.Aufruf von mapping.initDatabase(accessKeyID, secretAccessKey); zu Beginn

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

VariableDatentypBeschreibung
categoryIDStringDurch die Datenbank vergebene UUID einer Kategorie
categoryKeyStringID einer Kategorie im d.3
displaynameStringAnzeigename einer Kategorie im d.3
writeAccessbooleanBerechtigung für User Werte zu ändern
childrenString[]Liste der Kindkategorien (anhand des categoryKey)
parentStringElternkategorie (anhand des categoryKey)

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

VariableDatentypBeschreibung
propertyIDStringDurch die Datenbank vergebene UUID einer Eigenschaft
displaynameStringAnzeigename einer Eigenschaft im d.3
databasePositionNumberDatenbankposition im d.3, abhängig von der Kategorie
categoryKeyStringID der übergeordneten Kategorie im d.3
mandatorybooleanPflichtfeld
modifiablebooleanBerechtigung für User Werte zu ändern
propertyKeyNumberID einer Eigenschaft im d.3, stage-abhängig

Methoden

Initialisierung der Datenbank

mapping.initDatabase(accessKeyID, secretAccessKey);

Funktionsparameter

ParameterBeschreibung
accessKeyIDID des Access Keys des zu nutzenden AWS-Accounts
secretAccessKeySecret Access Key des zu nutzenden AWS-Accounts

Laden aller Kategorien

const categories = await mapping.getAllCategories(stage);

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

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'

Rückgabewert

DatentypBeschreibung
Category[] oder
[]
Liste der Kategorien in der Datenbank

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category oder
undefined
Gefundene Kategorie entsprechend der Filterparameter oder
undefined, wenn keine Kategorie gefunden wurde

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category[] oder
[]
Gefundene Kindkategorien entsprechend der Filterparameter

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Category oder
undefined
Gefundene Elternkategorie entsprechend der Filterparameter oder
undefined, wenn keine Kategorie gefunden wurde

Laden aller Eigenschaften

const properties = await mapping.getAllProperties(stage);

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

Funktionsparameter

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'

Rückgabewert

DatentypBeschreibung
Property[] oder
[]
Liste der Eigenschaften in der Datenbank

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
propertyIDFilterparameter, optional
ID der Eigenschaft in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
displayNameFilterparameter, optional
Anzeigename der Eigenschaft
'Personalnummer'
databasePositionFilterparameter, optional
Datenbankposition der Eigenschaft
12
categoryKeyFilterparameter, optional
ID der übergeordneten Kategorie im d.3
'XAPER'
propertyKeyFilterparameter, optional
ID der Eigenschaft im d.3, stage-spezifisch
47

Rückgabewert

DatentypBeschreibung
Property oder
undefined
Gefundene Eigenschaft entsprechend der Filterparameter oder
undefined, wenn keine Eigenschaft gefunden wurde

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

ParameterBeschreibungBeispiel
stageZu durchsuchende d.3-Stage'dev'
categoryIDFilterparameter, optional
ID der Kategorie in der Datenbank
'c84c89c6-a5ac-4e77-a719-6cad29b74906'
categoryKeyFilterparameter, optional
ID der Kategorie im d.3
'XAPER'
displayNameFilterparameter, optional
Anzeigename der Kategorie
'Personalakte'

Rückgabewert

DatentypBeschreibung
Property[] oder
[] oder
undefined
Gefundene Eigenschaften innerhalb der Kategorie oder
undefined, wenn keine Kategorie gefunden wurde

Exceptions

TitelBeschreibungLösung
Stage is not availableEs wurde eine nicht vorhandene Stage übergeben.Übergabe einer verfügbaren Stage (aktuell dev, qas, version, prod).
No params found, provide at least one param to search forEs wurden keine Filterparameter übergeben.Übergabe mindestens eines Filterparameters.
CategoryKey and DatabasePosition are required in order to search by themEs wurde eine Kategorie, aber kein Datenbankfeld (oder umgekehrt) übergeben.Übergabe von Kategorie-Key und Datenbankposition oder Übergabe keines dieser Parameter.
Database was not initializedDie Datenbank wurde vor der Nutzung nicht initialisiert.Aufruf von mapping.initDatabase(accessKeyID, secretAccessKey); zu Beginn
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文