Übersicht über eindeutige Kennungen
Verwendung eindeutiger Kennungen
Was sind eindeutige Kennungen?
Eindeutige Kennungen werden in der Learning Suite verwendet, um Nutzern und allen Objekten eindeutige Werte zuzuweisen. Es gibt eindeutige Kennungen, die immer von der Learning Suite generiert werden, und optionale Felder, die aus externen Quellsystemen migriert werden können. Die Kennungen sind wichtig, da sie in verschiedenen Schnittstellen verwendet werden können, z. B. für die Bereitstellung von Nutzern, die Authentifizierung, den Import von Organisationsstrukturen und viele APIs.
Nutzerbezogene eindeutige Kennungen
Nutzerattribute werden verwendet, um nutzerbezogene eindeutige Kennungen zu speichern. Es gibt eine Kombination aus von der Learning Suite generierten und extern bereitgestellten Kennungen, die für verschiedene Zwecke verwendet werden. Jede wird im Folgenden beschrieben:
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Personen-ID | PERSON_ID | Eindeutige Kennung für einen Nutzer, die von der Learning Suite generiert wird. Diese Nummer wird von vielen REST-API-Aufrufen (GET, PUT, POST) verwendet, um Nutzer zu identifizieren. Die meisten Nutzerlisten, Berichtsauszüge und Protokolldateien in der Learning Suite zeigen diesen Kennung an. |
Nummer | USER_ID | Dieses Nutzerattribut muss mit einem eindeutigen Wert für alle Nutzer gefüllt werden, und die Registrierungsregeln verweisen normalerweise auf den Wert PERSON_ID, wenn USER_ID leer ist. Häufig wird dieser Anzeigename des Nutzerattributs aktualisiert, wenn er von einem externen Quellsystem eingegeben und in einer Authentifizierungsschnittstelle verwendet wird. |
CSV-ID | EXT_ID_CSV | Dieses Nutzerattribut wird für den Import von CSV-Dateien verwendet. Das Attribut ID enthält die eindeutige Kennung für die Nutzer im Quellsystem. Bei einem Import wird ein neuer Nutzer in der Learning Suite angelegt, wenn kein Nutzer mit der Kennung gefunden wird, und wenn ein Nutzer mit der passenden Kennung gefunden wird, wird der Datensatz aktualisiert. |
LDAP-ID | EXT_ID_LDAP | Dieses Nutzerattribut wird für LDAP-Importe verwendet. Das Attribut ID enthält die eindeutige Kennung für die Nutzer im Quellsystem. Bei einem Import wird ein neuer Nutzer in der Learning Suite angelegt, wenn kein Nutzer mit der Kennung gefunden wird, und wenn ein Nutzer mit der passenden Kennung gefunden wird, wird der Datensatz aktualisiert. |
Externe SCIM ID | EXT_ID_SCIM | Dieses Nutzerattribut wird für die Erstellung von SCIM-API-Konten (POST) verwendet. Das Attribut ID enthält die eindeutige Kennung für die Nutzer im Quellsystem. Bei einem Import wird ein neuer Nutzer in der Learning Suite angelegt, wenn kein Nutzer mit der passenden Kennung gefunden wird. Wird ein Nutzer mit der passenden Kennung gefunden, wird der Datensatz aktualisiert. Die SCIM-API würde dies normalerweise mit dem Zuordnungswert „id“ ausfüllen. Bei der Erstellung gibt die Learning Suite eine PERSON_ID zurück, die dann für spätere Aktualisierungen (PUT) benötigt wird. |
ERP-ID | EXTERNAL_ID | Diese Kennung wurde ursprünglich für eine inzwischen veraltete Universal-API-Bereitstellungsmethode erstellt. Dieses Nutzerattribut kann verwendet werden, um eindeutige Nutzer-IDs von externen Systemen zu erfassen und als Kennung in Schnittstellen zu verwenden. |
Versicherungsvermittler-ID | IDD_AGENT_ID | Diese Kennung bezieht sich auf die Versicherungsbranche und ermöglicht es einem Nutzer, seine IDD-Punkte von einem Arbeitgeber zum nächsten mitzunehmen. |
Anmeldename | LOGIN | Diese Kennung wird für den Zugriff auf die Learning Suite mit lokaler Authentifizierung (Benutzername / Passwort) verwendet. Dieser Wert kann in Nutzerdatenschnittstellen abgebildet oder von der Learning Suite generiert werden. LOGIN kann bei vielen Batch-Importen als Kennung und bei Nutzerdatenschnittstellen wie SAML und OIDC verwendet werden. |
E-Mail ist nicht unbedingt eine eindeutige Kennung, da mehrere Nutzer technisch gesehen die gleiche E-Mail-Adresse haben können. Dieses Nutzerattribut wird jedoch häufig als Kennung in OIDC- und SAML-Schnittstellen verwendet. |
Auswahlliste Nutzerattribute
Nutzerattribute für Auswahllisten enthalten Auswahllistentabellen, die eine von der Learning Suite generierte ID und einen Schlüssel für jeden Wert enthalten. Letzterer kann je nach Bedarf durch manuelle Eingabe oder csv-Import von Auswahllistentabellenwerten gefüllt werden. Beide werden im Folgenden beschrieben:
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Objekt-ID | ID | Vom LMS generierte eindeutige ID für einen Auswahllistenwert. Die ID wird mithilfe eines Zählers auf Grundlage der Reihenfolge der Erstellung generiert. Diese ID wird in Standardregistrierungsregeln für setCommand-Regeln verwendet. |
Schlüssel | external_id | Es kann ein alphanumerischer Wert eingegeben werden, der kein Komma (,) enthält, das als Dateitrennzeichen dient. Dort, wo der Schlüssel ein Komma enthält, ist für das Hochladen eine durch Tabulatoren abgegrenzte txt-Datei erforderlich. Der Schlüssel kann mit Registrierungsregeln verknüpft werden, um Werte auszuwählen, die den Quellsystemen beim Importieren von Nutzern bekannt sind. |
Kostenstellen
Kostenstellen sind ziemlich einzigartig, da die Funktion sowohl ein Nutzerattribut als auch ein Metatag hat. Die Werte werden in einer zentralen Funktion der Kostenstellen erstellt, die automatisch die Werte der Auswahllisten für Nutzerattribute und Metatags auffüllt. Beide werden im Folgenden beschrieben:
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Objekt-ID | object_id | Vom LMS generierte eindeutige ID für einen Auswahllistenwert |
Schlüssel* | external_id | Es kann ein alphanumerischer Schlüssel eingegeben werden, der wahrscheinlich mit einer eindeutigen Kennung in einem externen System übereinstimmen würde. |
Objektbezogene eindeutige Kennungen
Alle nicht-nutzerbezogenen Objekte in der Learning Suite haben ebenfalls eindeutige Kennungen; zu diesen Objekten gehören zum Beispiel Kurse, Lernpfade, Medien, Kataloge, Gruppen, Standorte, Jobprofile, Skills, Zertifizierungen, Abzeichen, Erfahrungspfade, Kostenstellen und Ressourcen.
Kurse und Kursvorlagen
Die nachfolgend aufgeführten Kennungen haben viele Verwendungszwecke, wie z. B. die Erstellung von Berichten oder die Durchführung von Buchungen über API, die Bereitstellung von direkten Links zu Kursen und die Durchführung von Migrationen von vergangenen Kursen über CSV.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Objekt-ID | object_id | Die Objekt-ID ist eine von der Learning Suite generierte feste ID für ein Objekt, die bei der Versionierung unverändert bleibt. Diese eindeutige ID wird von vielen objektbezogenen REST-APIs verwendet. |
Kurs-ID / Komponenten-ID | component_id | Die Komponenten-ID ist eine von der Learning Suite generierte, versionsspezifische Objektkennung. Diese ID wird üblicherweise von REST-APIs verwendet, um Aktionen wie Buchungen oder direkte Verknüpfungen mit Kursen durchzuführen. ID der beschriebenen Lernkomponenten (= Version eines Lerninhalts / Objekts) |
Kursvorlage | template_id | Dies ist die Komponenten-ID der Kursvorlage, von der ein Lernobjekt abgeleitet wurde. Sie bezieht sich auf die Spalte component_id in dieser Tabelle. Sie kann in REST-API-Ergebnissen zurückgegeben oder in POST verwendet werden. |
Identifikationscode | identification_code | Von der Learning Suite generierte ID, unter der das Muster konfiguriert werden kann. Das Muster kann im Menü Identifikationscode der Konfiguration-Funktion definiert und im Tab Prozesskomplexität der Funktion Kurstypen aktiviert werden. Dieser Identifikationscode ist in erster Linie für Lernende gedacht und nicht für Schnittstellen. |
Kurstyp ID | course_type_id | Objekt-ID des Kurstyps (zu sehen in der Spalte Objekt-ID oder im Tab Beschreibung, wenn das Objekt bearbeitet wird). |
External Template ID | external_migration_id | Wird für den Import von Kursvorlagen über csv verwendet. Der Kursimport verwendet dann diese Kennung, um die Kursvorlage zu bestimmen, von der ein importierter Kurs abgeleitet wird. Diese wird in der Datenbanktabelle e_componenttype in der Spalte external_migration_id gespeichert. |
Externe Kurse ID | external_migration_id | Diese Kennung wird für den Import von Kursen über csv verwendet. Dieselbe Kennung wird auch in den Zuweisungen für den Schulungsverlauf verwendet, bei denen die Einschreibungen und Abschlüsse von Nutzern für importierte Kurse aufgezeichnet werden. Sie wird auch in der Spalte external_migration_id der e_component-Datenbanktabelle gespeichert. |
Externe Objekt-ID | external_object_id | Eine eindeutige ID, die für Kursmigrationen konfiguriert werden kann. Diese Kennung wird bei Migrationen des Trainingsverlaufs verwendet, um die Abschlüsse der Lernenden zuzuordnen. |
Externe System-Id | external_system_id | Kennung des externen Systems, aus dem der Kurs migriert wurde |
Status | status | Status-ID des Teilnehmers in Bezug auf die Buchung der Komponente: |
Lernpfade
Die nachfolgend aufgeführten Kennungen können in vielerlei Hinsicht verwendet werden, z. B. für die Erstellung von Berichten oder die Durchführung von Buchungen über die API und die Bereitstellung von direkten Links zu Lernpfaden.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Objekt-ID | object_id | Die Objekt-ID ist eine von Learning Suite generierte feste ID für ein Objekt, die bei der Versionierung unverändert bleibt. Diese ID wird von vielen objektbezogenen REST-APIs verwendet. |
Komponenten-ID | component_id | Die Komponenten-ID ist eine von der Learning Suite generierte versionsspezifische Objektkennung. Diese ID wird üblicherweise von REST-APIs verwendet, um Aktionen wie Buchungen oder direkte Verknüpfungen mit Kursen durchzuführen. ID der beschriebenen Lernkomponenten (= Version eines Lerninhalts / Objekts) |
Externe ID | external_object_id | Kennung der Gruppe in einer externen Datenquelle, die mit OE-Gruppenimporten aufgefüllt wird. Registrierungsregeln führen häufig Gruppenzuordnungen mit HashIdent-Zuordnung auf der Grundlage dieses Wertes durch. |
Identifikationscode | identification_code | Von der Learning Suite generierte ID, unter der das Muster konfiguriert werden kann. Das Muster kann im Menü Identifikationscode der Konfiguration-Funktion definiert und im Tab Prozesskomplexität der Funktion Kurstypen aktiviert werden. Dieser Identifikationscode ist in erster Linie für Lernende gedacht und nicht für Schnittstellen. |
Status | status | Status-ID des Teilnehmers in Bezug auf die Buchung der Komponente: |
Lerninhalte
Die nachfolgend aufgeführten Kennungen können in vielerlei Hinsicht verwendet werden, z. B. für die Erstellung von Berichten oder die Durchführung von Buchungen über die API und die Bereitstellung von direkten Links zu Lerninhalten.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
Objekt-ID | object_id | Die Objekt-ID ist eine von Learning Suite generierte feste ID für ein Objekt, die bei der Versionierung unverändert bleibt. Diese ID wird von vielen objektbezogenen REST-APIs verwendet. |
Komponenten-ID | component_id | Die Komponenten-ID ist eine von der Learning Suite generierte versionsspezifische Objektkennung. Diese ID wird üblicherweise von REST-APIs verwendet, um Aktionen wie Buchungen oder direkte Verlinkungen zu Lerinhalten durchzuführen. ID der beschriebenen Lernkomponenten (= Version eines Lerninhalts / Objekts) |
Kataloge
Diese Kennungen sind vor allem für Headless-LMS-Szenarien nützlich, in denen die REST-API verwendet wird, um die Katalogstruktur zwischen Systemen zu replizieren.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | category_id | ID des Katalogordners |
Externe ID | external_object_id | Kennung der Gruppe in einer externen Datenquelle, die mit OE-Gruppenimporten aufgefüllt wird. Registrierungsregeln führen häufig Gruppenzuordnungen mit HashIdent-Zuordnung auf der Grundlage dieses Wertes durch. |
Externe System-ID | external_system_id | Kennung des externen Systems, aus dem auch der Katalog stammt |
N/A | parent_id | Übergeordneter Katalog; verweist auf die category_id in dieser Tabelle; für Hauptkataloge wird hier 0 eingetragen. |
N/A | parent_ids | Strukturcode mit Ordner-IDs, der den Pfad zum Hauptkatalog enthält (übergeordnete ID:...übergeordnete ID:Ordner-ID). |
N/A | root_id | Zugeordneter Hauptkatalog; verweist auf die category_id in dieser Tabelle; für Hauptkataloge wird hier der gleiche Wert wie in category_id eingetragen. |
N/A | composing_type | Beschreibt, welche Art von Inhalt einem Katalog zugeordnet werden kann (1 = Studiengänge, 2 = Kursvorlagen, 3 = Kurse, 4 = Lerninhalte, 5 = Tests, 6 = Feedbackbögen). |
Gruppen
Alle Gruppen erhalten eine von der Learning Suite generierte eindeutige ID. System- und Organisationseinheits (OE)-Gruppen können zusätzlich eine externe ID erhalten, wenn sie über eine Schnittstelle oder einen Import erstellt werden.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | group_id | Eindeutige ID für eine Gruppe, die von der Learning Suite generiert wird. Diese ID wird in den Registrierungsregeln verwendet, um Nutzer zu Gruppen zuzuordnen und die Freigabe von Nutzern für Gruppen zu erteilen. Die ID wird auch für verschiedene REST-API-Aufrufe einschließlich Filterung verwendet. |
Externe ID | external_object_id | Kennung der Gruppe in einer externen Datenquelle, die mit OE-Gruppenimporten aufgefüllt. Registrierungsregeln führen häufig Gruppenzuweisungen mit HashIdent-Zuordnung auf der Grundlage dieses Wertes durch. |
Externe System-Id | external_system_id | Kennung des externen Systems, aus dem die Gruppe migriert wurde |
Standorte
Standorte sind Objekte, die Kursen, Lernpfaden, Veranstaltungen und Ressourcen zugewiesen werden können. Die ID wird von der REST-API bei der Erstellung von Objekten verwendet, denen ein Standort hinzugefügt werden muss.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | location_id | Die von der Learning Suite generierte ID des Standorts |
Externe ID | external_object_id | Kennung des Standorts in einem externen System; wird ausschließlich für benutzerdefinierte Migrationen verwendet |
Externe System-Id | external_system_id | Kennung des externen Systems, aus dem auch der Standort stammt; wird ausschließlich für benutzerdefinierte Migrationen verwendet |
Skills (Kompetenzen)
Alle Skills erhalten eine von der Learning Suite generierte eindeutige ID. Bei der Erstellung eines Skills ist es auch möglich, eine externe ID anzugeben, die anderen Systemen bekannt ist. Die Skill-ID ist wichtig für Importe und API-Anfragen oder Aktualisierungen.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | skill_id | Die ID wird von der Learning Suite generiert. Für jeden Skill gibt es eine feste, unveränderliche ID. Diese ID kann von REST-API-Aufrufen verwendet werden, um Daten anzufordern oder Aktualisierungen durchzuführen. |
Externe ID | external_object_id | Die externe ID kann bei der Erstellung von Skills in der grafischen Benutzeroberfläche oder während der Erstellung über die REST-API eingegeben werden. Sie kann bei der Zuweisung von Skills über CSV und in REST-API-GET-Aufrufen verwendet werden; letzteres ist nützlich, um externe Systeme mit Skillsdaten zu aktualisieren. |
Externe System-ID | external_system_id | Kennung des externen Systems, aus dem auch der Skill stammt |
Skillstruktur | comp_structure_id | ID der Skillskala. Verweist auf die Spalte der Tabelle T_COMPETENCY-STRUCTURE mit demselben Namen. |
Jobprofile (Rollen)
Alle Jobprofile erhalten eine von der Learning Suite generierte eindeutige ID. Bei der Erstellung eines Jobprofils ist es auch möglich, eine externe ID anzugeben, die anderen Systemen bekannt ist. Die Jobprofil-ID ist wichtig für Zuordnungen und API-Anfragen oder Aktualisierungen. Bei der Erstellung von Jobprofilen über API ist die Vorlagen-ID erforderlich.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | role_id | Alle Job-Profile erhalten eine von der Learning Suite generierte eindeutige ID. Bei der Erstellung eines Stellenprofils können Sie auch eine externe ID angeben, die anderen Systemen bekannt ist. Die Jobprofil-ID ist wichtig für Zuweisungen und API-Anfragen oder Aktualisierungen. Bei der Erstellung von Jobprofilen über API ist die Vorlagen-ID erforderlich. |
Vorlage-ID | template_id | Die Vorlagen-ID ist die ID der Jobprofilvorlage, aus der das Jobprofil erstellt wurde. Dies ist erforderlich, wenn ein Jobprofil über die REST-API erstellt wird. |
Externe ID | external_object_id | Die externe ID kann bei der Erstellung von Jobprofilen in der grafischen Benutzeroberfläche oder während der Erstellung über REST API eingegeben werden. Der Wert wird auch in GET-Aufrufe der REST-API aufgenommen, was für die Aktualisierung externer Systeme mit Jobprofildaten nützlich ist. |
Externe System-Id | external_system_id | Kennung des externen Systems, in dem die Fertigkeit auch gespeichert ist. |
Skill | skill_id | Die Skill-ID ist Teil der Jobprofiltabelle, da Skills Jobprofilen zugewiesen werden können. Dies ist in der Regel erforderlich, wenn Jobprofile über die REST-API erstellt oder aktualisiert werden. |
Zertifizierungen
Zertifizierungen werden verwendet, um den Fortschritt beim Erreichen der erforderlichen Ausbildungspunkte oder -stunden innerhalb eines bestimmten Zeitrahmens zu verfolgen. Diese ID kann mit der REST-API verwendet werden, um vorhandene Zertifizierungsdaten abzurufen.
Anzeigename | Datenbankname | Beschreibung |
|---|---|---|
ID | certification_id | Eindeutige ID der Zertifizierung, wie sie von der Learning Suite generiert wird |
Das Feld Objekt-ID oder ID steht allen Objekten in der Learning Suite zur Verfügung, einschließlich Mandanten, Berichten, On-the-job-Aufgaben, Ressourcen, Zertifikaten, Dashboards, Panels und Navigationspunkten; eine Ausnahme bilden Systemtexte, die eindeutige Bündelnamen haben.