JavaScript-Bibliothek common/metadata collection

Diese Bibliothek bietet Funktionen zum Abrufen von metadata collections und zum Aufbauen von Masken oder Filtern

Verwendung

---

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let metadataCollection = require('common/metadata-collection');

let definition = metadataCollection.get('mu_ohne_migration_vertrag', 'docform');

Funktionen

---

usages

Liefert alle im System verwendeten usages als Array.

Beispiel

let metadataCollection = require('common/metadata-collection');

let usages = metadataCollection.usages();

Beispiel der Rückgabe

[ 'acic', 'form', 'docform' ]

get

Liefert die Items der metadata collection zurück inklusive weiterer Angaben für den Verwendungszweck, sofern Sie einen usage angegeben haben.

Beispiel mit der Angabe des usages „docform“

let metadataCollection = require('common/metadata-collection');

// ohne definitionName (Name der Kollektion) oder usage (Verwendungszweck) erhalten Sie alle Kollektionen zurück
// Aufbau: metadataCollection.get([ definitionName ], [ usage ]);
let definition = metadataCollection.get('mu_ohne_migration_vertrag', 'docform');

definition;

Beispiel der Rückgabe

Sie erhalten die Items der metadata collection mu_ohne_migration_vertrag für den usage docform.

Die Angabe extractor (fett markiert) gilt nur für docform.

{
  "displayName" : "Vertrag",
  "usage": [ 'acic', 'docform' ],
  "items" : [ {
    "displayName" : "Anlegedatum",
    "defaultValue" : null,
    "descriptionLong" : null,
    "format" : null,
    "inheritance" : "NOT_INHERITED",
    "description" : null,
    "extractor" : "date",
    "readOnly" : false,
    "optional" : false,
    "type" : "date",
    "mappedName" : "~mu_ohne_migration_createDate:date",
    "multi" : false,
    "displayType" : "default",
    "restricted" : false,
    "name" : "mu_ohne_migration_createDate",
    "verificationRegex" : null,
    "verificationType" : "none",
    "verificationFailText" : null,
    "dataSource" : null
  }, {
    "displayName" : "Vertragsnummer",
    "defaultValue" : null,
    "descriptionLong" : null,
    "format" : null,
    "inheritance" : "NOT_INHERITED",
    "description" : null,
    "extractor" : "string",
    "readOnly" : false,
    "optional" : false,
    "type" : "string",
    "mappedName" : "~mu_ohne_migration_vertragsnummer:string",
    "multi" : false,
    "displayType" : "default",
    "restricted" : false,
    "name" : "mu_ohne_migration_vertragsnummer",
    "verificationRegex" : null,
    "verificationType" : "none",
    "verificationFailText" : null,
    "dataSource" : null
  } ]
}

Beispiel ohne usage

let metadataCollection = require('common/metadata-collection');

// ohne definitionName (Name der Kollektion) oder usage (Verwendungszweck) werden alle Kollektionen zurückgeliefert
// Aufbau: metadataCollection.get([ definitionName ], [ usage ]);
let definition = metadataCollection.get('mu_ohne_migration_vertrag', '');

definition;

Beispiel der Rückgabe

Sie erhalten die Items der metadata collection mu_ohne_migration_vertrag, im Vergleich zur Angabe des usages „docform“ dieses Mal ohne spezielle Angaben für den Verwendungszweck.

Die für docform gültige Angabe extractor fehlt jetzt:

{
  "displayName" : "Vertrag",
  "usage": [ 'acic', 'docform' ],
  "items" : [ {
    "displayName" : "Anlegedatum",
    "defaultValue" : null,
    "descriptionLong" : null,
    "format" : null,
    "inheritance" : "NOT_INHERITED",
    "description" : null,
    "readOnly" : false,
    "optional" : false,
    "type" : "date",
    "mappedName" : "~mu_ohne_migration_createDate:date",
    "multi" : false,
    "displayType" : "default",
    "restricted" : false,
    "name" : "mu_ohne_migration_createDate",
    "verificationRegex" : null,
    "verificationType" : "none",
    "verificationFailText" : null,
    "dataSource" : null
  }, {
    "displayName" : "Vertragsnummer",
    "defaultValue" : null,
    "descriptionLong" : null,
    "format" : null,
    "inheritance" : "NOT_INHERITED",
    "description" : null,
    "readOnly" : false,
    "optional" : false,
    "type" : "string",
    "mappedName" : "~mu_ohne_migration_vertragsnummer:string",
    "multi" : false,
    "displayType" : "default",
    "restricted" : false,
    "name" : "mu_ohne_migration_vertragsnummer",
    "verificationRegex" : null,
    "verificationType" : "none",
    "verificationFailText" : null,
    "dataSource" : null
  } ]
}

Beispiel ohne Angabe einer metadata collection und ohne usage

let metadataCollection = require('common/metadata-collection');

// ohne definitionName (Name der Kollektion) oder usage (Verwendungszweck) werden alle Kollektionen zurückgeliefert
// Aufbau: metadataCollection.get([ definitionName ], [ usage ]);
let definition = metadataCollection.get('', '');

definition;

Beispiel der Rückgabe

Sie erhalten alle vorhandenen metadata collections inklusive Items.

{
  "mu_ohne_migration_vertrag" : {
    "displayName" : "Vertrag",
    "usage": [ 'acic', 'docform' ],
    "items" : [ {
      "displayName" : "Anlegedatum",
      "defaultValue" : null,
      "descriptionLong" : null,
      "format" : null,
      "inheritance" : "NOT_INHERITED",
      "description" : null,
      "readOnly" : false,
      "optional" : false,
      "type" : "date",
      "mappedName" : "~mu_ohne_migration_createDate:date",
      "multi" : false,
      "displayType" : "default",
      "restricted" : false,
      "name" : "mu_ohne_migration_createDate",
      "verificationRegex" : null,
      "verificationType" : "none",
      "verificationFailText" : null,
      "dataSource" : null
    }, {
      "displayName" : "Vertragsnummer",
      "defaultValue" : null,
      "descriptionLong" : null,
      "format" : null,
      "inheritance" : "NOT_INHERITED",
      "description" : null,
      "readOnly" : false,
      "optional" : false,
      "type" : "string",
      "mappedName" : "~mu_ohne_migration_vertragsnummer:string",
      "multi" : false,
      "displayType" : "default",
      "restricted" : false,
      "name" : "mu_ohne_migration_vertragsnummer",
      "verificationRegex" : null,
      "verificationType" : "none",
      "verificationFailText" : null,
      "dataSource" : null
    } ]
  }
}