Definition von Hierarchietypen in IBMMatch 360 as a Service

Definieren Sie Hierarchietypen, die in Ihrer Stammdateninstanz verwendet werden können, um hierarchische Beziehungen zwischen Entitäten zu verfolgen.

Mit Hierarchien können viele verschiedene Arten von Beziehungen definiert werden, z. B. rechtliche Hierarchien, Eigentümerhierarchien, Berichtskettenhierarchien, Stammbäume, Produkthierarchien und vieles mehr.

Innerhalb IBMMatch 360 von as a Service können Sie Hierarchien innerhalb eines einzelnen Entitätstyps oder über mehrere Entitätstypen hinweg modellieren. Um mit Hierarchien arbeiten zu können, muss ein Dateningenieur mindestens einen Hierarchietyp definieren.

Nachdem ein Hierarchietyp definiert wurde, können Datenverwalter Hierarchieinstanzen erstellen, Mitglieder hinzufügen oder entfernen und Hierarchiebeziehungen definieren. Weitere Informationen zur Arbeit mit Hierarchien finden Sie unter Hierarchien erforschen.

Definieren eines Hierarchietyps

Um Datenverwaltern die Arbeit mit Hierarchien zu ermöglichen, müssen Sie mindestens einen Hierarchietyp in Ihrem Datenmodell definieren.

Erforderliche Berechtigungen: Um eine Stammdateninstanz zu konfigurieren, müssen Sie Mitglied der DataEngineer Benutzergruppe für den Dienst IBMMatch 360 „as a Service“ sein.

Um einen neuen Hierarchietyp zu definieren:

Klicken Sie im Navigationsmenü Stammdaten auf Datentypen , um die Seite Datentypen zu öffnen.
Wählen Sie Hierarchietypen und klicken Sie dann auf Neuer Hierarchietyp.
Geben Sie die Details Ihres neuen Hierarchietyps an:

a) Geben Sie einen Anzeigenamen und eine Beschreibung für diesen Hierarchietyp an.

b) Wählen Sie die zulässigen Datentypen in diesem Hierarchietyp aus. Wenn es sich bei dieser Hierarchie beispielsweise um ein Unternehmensorganigramm handelt, können Sie nur Datensätze mit der Datensatzart Mitarbeiter zulassen.

c) Klicken Sie auf Erstellen.
Optional können Sie der Hierarchie Attribute und Felder hinzufügen. Weitere Informationen finden Sie siehe Hinzufügen von Attributen und Feldern zu einem Hierarchietyp.
Wenn Sie den neuen Hierarchietyp hinzugefügt haben, klicken Sie in der Aktionsleiste des Bildschirms auf Datentyp veröffentlichen.

Wichtig: Nachdem ein Hierarchietyp veröffentlicht wurde, kann er nicht mehr gelöscht werden. Sie können Hierarchietypen nur löschen, bevor sie veröffentlicht werden.

So löschen Sie einen unveröffentlichten Hierarchietyp:

a) Klicken Sie im Navigationspfad auf Datentypen, um zum Bildschirm Hierarchietypen zurückzukehren.

b) Überprüfen Sie die Liste der Hierarchietypen. Vergewissern Sie sich in der Spalte Datenmodellstatus, dass der Wert Nicht veröffentlicht lautet.

c) Klicken Sie auf das Aktionsmenü für die Hierarchie und wählen Sie Hierarchietyp löschen.

Hinzufügen von Attributen und Feldern zu einem Hierarchietyp

Nachdem Sie einen Hierarchietyp erstellt haben, können Sie Attribute und Felder hinzufügen. Sie können entweder Hierarchieattribute oder Mitgliederattribute hinzufügen.

Hierarchieattribute sind Attribute, die das Hierarchieobjekt beschreiben.
Mitgliedsattribute sind Attribute, die auf jeden Mitgliedsknoten in der Hierarchie angewendet werden.

Innerhalb der Hierarchieattribute gibt es ein voreingestelltes Attribut namens Hierarchiename. Dieser Attributwert wird in der Regel als Bezeichnung verwendet, um den Namen der Hierarchie innerhalb IBMMatch 360 von as a Service anzuzeigen.

So fügen Sie ein neues Attribut oder Feld zu einem Hierarchietyp hinzu:

Klicken Sie im Navigationsmenü Stammdaten auf Datentypen , um die Seite Datentypen zu öffnen.
Klicken Sie auf Hierarchietypen und wählen Sie den Hierarchietyp aus, den Sie aktualisieren möchten.
Klicken Sie auf die Registerkarte Attribute und Felder. Auf dieser Seite gibt es zwei Abschnitte: Hierarchieattribute und Mitgliederattribute.
Klicken Sie auf Neues Attribut, um Hierarchie- oder und Mitgliedsattribute hinzuzufügen. Geben Sie die Details des Attributs an:

a) Wählen Sie den Typ des Basisattributs aus. Diese Optionen basieren auf anderen Attributen, die in Ihrem Datenmodell definiert sind.

b) Definieren Sie die Kardinalität dieses Attributs. Wählen Sie Einzel, wenn Sie nicht mehrere Werte für dieses Attribut angeben müssen.

d) Geben Sie den Anzeigenamen und, falls gewünscht, eine Beschreibung des Attributs ein.

e) Klicken Sie auf Erstellen.

Wiederholen Sie diesen Vorgang, um so viele Attribute hinzuzufügen, wie Sie benötigen.
Definieren Sie den Anzeigenamen für Hierarchien dieses Typs:

a) Wählen Sie ein Attribut aus.

b) Ziehen Sie oder klicken Sie auf +, um ein Feld hinzuzufügen.
Wenn Sie den neuen Hierarchietyp hinzugefügt haben, klicken Sie in der Aktionsleiste des Bildschirms auf Datentyp veröffentlichen.

Wichtig: Nachdem ein Hierarchietyp veröffentlicht wurde, kann er nicht mehr gelöscht werden. Sie können Hierarchietypen nur löschen, bevor sie veröffentlicht werden.

So löschen Sie einen unveröffentlichten Hierarchietyp: a) Klicken Sie im Navigationspfad auf Datentypen, um zum Bildschirm Hierarchietypen zurückzukehren.

b) Überprüfen Sie die Liste der Hierarchietypen. Vergewissern Sie sich in der Spalte Datenmodellstatus, dass der Wert Nicht veröffentlicht lautet.

c) Klicken Sie auf das Aktionsmenü für die Hierarchie und wählen Sie Hierarchietyp löschen.

Informationen zum Erstellen und Verwalten von Hierarchieinstanzen finden Sie unter Erkunden und Arbeiten mit Hierarchien.

Arbeiten mit Hierarchien unter Verwendung der API

Da viele Hierarchieaktionen als Technologievorschau bereitgestellt werden, können Sie auch mit Hierarchien arbeiten, indem Sie die API verwenden.

Definieren eines Hierarchietyps mit Hilfe der API

So erstellen Sie einen neuen Hierarchietyp namens DnB Hierarchy mit Hilfe der API:

Holen Sie sich das vorhandene Datenmodell.
```
GET /v1/config_data_model  
```
Ändern Sie das Datenmodell, um den neuen Hierarchietyp hinzuzufügen. Die Beispiele in dieser Prozedur erstellen einen neuen Hierarchietyp namens DnB Hierarchy.

Definieren Sie die neuen Hierarchiebeziehungstypen für diesen Hierarchietyp. Fügen Sie die JSON-Objekte dnb_hierarchy_node_association_relationship und dnb_hierarchy_node_relationship in den Abschnitt relationship_types ein.

"relationship_types": {
	"dnb_hierarchy_node_association_relationship": {
		"internal": true,
		"label_from_source": "dnb_hierarchy_source_HYui4x",
		"label_from_target": "dnb_hierarchy_target_EKhbfJ",
		"directional": true,
		"description": "Link a hierarchy node with a record or an entity or other data types",
		"rules": [
			{
				"source": {
					"node_types": [
						"dnb_hierarchy_node"
					]
				},
				"target": {
					"hierarchy_types": [],
					"entity_types": [
						"person_entity",
						"organization_entity"
					],
					"record_types": [
						"person",
						"organization"
					]
				}
			}
		],
		"label": "DnB Hierarchy node association relationship",
		"classification": "hierarchy_node_association_relationship",
		"cardinality": "ONE2ONE"
	},
	"dnb_hierarchy_node_relationship": {
		"internal": true,
		"label_from_source": "dnb_hierarchy_source_0QbKqr",
		"label_from_target": "dnb_hierarchy_target_LCwveN",
		"directional": true,
		"description": "DnB Hierarchy node to node relationship",
		"rules": [
			{
				"source": {
					"hierarchy_types": [
						"dnb_hierarchy"
					],
					"node_types": [
						"dnb_hierarchy_node"
					]
				},
				"target": {
					"node_types": [
						"dnb_hierarchy_node"
					]
				}
			}
		],
		"label": "DnB Hierarchy node relationship",
		"classification": "hierarchy_node_relationship"
	}
}

Definieren Sie die neuen Hierarchieknotentypen (Membertypen) für diesen Hierarchietyp. Fügen Sie das JSON-Objekt node-types in das Datenmodell auf derselben Ebene wie record_types ein.

"node_types": {
	"dnb_hierarchy_node": {
		"attributes": {
			"role": {
				"indexed": true,
				"description": "",
				"attribute_type": "string",
				"label": "role",
				"cardinality": "LIST"
			},
			"level": {
				"indexed": false,
				"description": "",
				"attribute_type": "string",
				"label": "level",
				"cardinality": "SINGLE"
			},
			"description": {
				"indexed": false,
				"description": "",
				"attribute_type": "string",
				"label": "description",
				"cardinality": "SINGLE"
			},
			"designation": {
				"indexed": true,
				"description": "",
				"attribute_type": "string",
				"label": "designation",
				"cardinality": "LIST"
			}
		},
		"label": "DnB Hierarchy",
		"classification": "hierarchy_node"
	}
}

Definieren Sie die Details des neuen Hierarchietyps. Fügen Sie das JSON-Objekt hierarchy_types in das Datenmodell auf derselben Ebene wie record_types ein.

"hierarchy_types": {
	"dnb_hierarchy": {
		"node_type": "dnb_hierarchy_node",
		"node_relationship_type": "dnb_hierarchy_node_relationship",
		"attributes": {
			"hierarchy_name": {
				"indexed": true,
				"description": "",
				"attribute_type": "string",
				"label": "Hierarchy name",
				"cardinality": "SINGLE"
			},
			"hierarchy_value": {
				"indexed": false,
				"description": "",
				"attribute_type": "string",
				"label": "hierarchy value",
				"cardinality": "SINGLE"
			},
			"description": {
				"indexed": false,
				"description": "",
				"attribute_type": "string",
				"label": "Description",
				"cardinality": "SINGLE"
			}
		},
		"label": "DnB Hierarchy",
		"node_associations": {
			"dnb_hierarchy_node_association_relationship": []
		}
	}
}

Löschen Sie den Wert des Parameters is_model_published . Wenn das Feld im Modell nicht vorhanden ist, fügen Sie es wie folgt hinzu:
```
"is_model_published": "",
```
Tipp: Überprüfen Sie Ihr JSON, um sicherzustellen, dass es richtig formatiert ist. Vergewissern Sie sich beispielsweise, dass keine Kommas zwischen den Objekten fehlen, wenn Sie die neuen Hierarchieobjekte hinzugefügt haben.
Laden Sie das aktualisierte Datenmodell hoch, indem Sie die vollständige, geänderte Datenmodellkonfiguration JSON als Nutzlast des Befehls API PUT /v1/config_data_model übermitteln.
```
PUT /v1/config_data_model
```

Veröffentlichen Sie das Datenmodell.

POST /v1/configuration_metadata/processes

   {
     "process_name": "publish_model",
     "initiator": "admin"
    }

Warten Sie auf die Veröffentlichung des Datenmodells.

Bestätigen Sie, dass das Datenmodell erfolgreich aktualisiert wurde, indem Sie die neueste Version abrufen.
```
API GET /v1/config_data_model
```
Überprüfen Sie die Nutzdaten der Antwort, um sicherzustellen, dass Ihre Hierarchieänderungen vorhanden sind.

Erstellen einer Hierarchieinstanz mit Hilfe der API

Nachdem Sie einen oder mehrere Hierarchietypen definiert haben, können Sie API-Befehle ausführen, um eine Hierarchieinstanz zu erstellen.

Um eine neue Hierarchieinstanz mit dem Namen ABC DnB Hierarchie mithilfe der API zu erstellen, führen Sie den API-Befehl POST /v1/hierarchies mit einer Nutzlast aus, die die neuen Hierarchieattribute definiert, einschließlich des Hierarchietyps, auf dem sie basiert, und Details wie die Hierarchiequelle, den Namen und die Beschreibung.

POST /v1/hierarchies

{
  "type": "hierarchy",
  "type_name": "dnb_hierarchy",
  "attributes": {
  	"hierarchy_source": "MDM",
	"hierarchy_name": {"value": "ABC DnB hierarchy"},
	"description": {"value": "ABC DnB hierarchy description"}
  }
}

Die Antwort auf diese API-Anfrage sollte ähnlich wie im folgenden Beispiel aussehen:

{
	"hierarchy": {
		"attributes": {
			"description": {
				"value": "ABC DnB hierarchy description"
			},
			"hierarchy_name": {
				"value": "ABC DnB hierarchy"
			}
		},
		"id": "181655782266320896",
		"system_attributes": {
			"created_date": 1744394453974,
			"created_user": "cpadmin",
			"hierarchy_number": 181655782266320900,
			"hierarchy_source": "MDM",
			"last_updated_date": 1744394453974,
			"last_updated_user": "cpadmin"
		},
		"type": "hierarchy",
		"type_name": "dnb_hierarchy"
	},
	"metadata": {
		"href": "https://cpd-cpd-instance.apps.test.cp.fyre.ibm.com/1744083874892597/mdm/v1/hierarchies?crn=1",
		"id": "181655782266320896",
		"updated_at": "2025-04-11T18:00:53.974Z"
	}
}

Pflege von Hierarchien mit Hilfe der API

Sie können die Mitgliedschaft und die Beziehungen innerhalb jeder Hierarchie mit dem API-Befehl PATCH /v1/hierarchies/{id} pflegen. Mit diesem Befehl können Sie:

Attribute der Hierarchieinstanz aktualisieren
Neue Hierarchiemitglieder hinzufügen
Hierarchiemitglieder aktualisieren
Beziehungen zwischen Hierarchiemitgliedern hinzufügen
Hinzufügen von Assoziationsbeziehungen zwischen Hierarchiemitgliedern
Mitglieder aus der Hierarchie löschen
Beziehungen zwischen Hierarchiemitgliedern löschen
Zuordnungsbeziehungen zwischen Hierarchiemitgliedern löschen

Zur Aktualisierung von Hierarchien über die API müssen Sie die folgenden Angaben in der API-Nutzlast machen:

Datensatznummern der Hierarchiemitglieder, mit denen Sie arbeiten möchten
Details zur Hierarchie:
- Name des Hierarchietyps
- Hierarchie-ID
- Namen der Hierarchieknotenarten
- Namen von Hierarchie-Beziehungsarten

Pflege von Hierarchien Beispiel 1: Hinzufügen von Mitgliedern und Beziehungen

Der folgende Beispiel-API-Befehl und Payload nimmt die folgenden Änderungen an einer vorhandenen Hierarchie vor:

Aktualisiert den Hierarchienamen
Fügt drei neue Mitglieder der Hierarchie hinzu
Fügt drei Hierarchieknotenbeziehungen hinzu
Fügt drei Hierarchieknoten-Assoziationsbeziehungen hinzu

API PATCH /v1/hierarchies/{id}

{
	"upserts": {
		"type": "hierarchy",
		"type_name": "dnb_hierarchy",
		"id": "181655782266320896",
		"attributes": {
			"hierarchy_name": {"value": "ABC legal entity hierarchy"}
		},
		"nodes":[
			{
				"type": "node",
				"type_name": "dnb_hierarchy_node",
				"reference_id": "11",
				"attributes": {
					"designation": {"value": "GLOBLE PARENT"}
				}
			},
			{
				"type": "node",
				"type_name": "dnb_hierarchy_node",
				"reference_id": "12",
				"attributes": {
					"designation": {"value": "LOCAL PARENT"}
				}
			},
			{
				"type": "node",
				"type_name": "dnb_hierarchy_node",
				"reference_id": "13",
				"attributes": {
					"designation": {"value": "LOCAL PARENT"}
				}
			}		
		],
		"relationships": [
			{
				"type": "relationship",
				"type_name": "dnb_hierarchy_node_relationship",
				"source": {
					"id": "181655782266320896",
					"type": "hierarchy",
					"type_name": "dnb_hierarchy"
				},
				"target": {
					"id": "11",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				}
			},
			{
				"type": "relationship",
				"type_name": "dnb_hierarchy_node_relationship",
				"source": {
					"id": "11",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				},
				"target": {
					"id": "12",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				}
			},
			{
				"type": "relationship",
				"type_name": "dnb_hierarchy_node_relationship",
				"source": {
					"id": "11",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				},
				"target": {
					"id": "13",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				}
			},
		{
			"type": "relationship",
			"type_name": "dnb_hierarchy_node_association_relationship",
			"source": {
				"id": "11",
				"type": "node",
				"type_name": "dnb_hierarchy_node"
			},
			"target": {
				"id": "2430371744395911724",
				"type": "record",
				"type_name": "organization"
			}
		},
		{
			"type": "relationship",
			"type_name": "dnb_hierarchy_node_association_relationship",
			"source": {
				"id": "12",
				"type": "node",
				"type_name": "dnb_hierarchy_node"
			},
			"target": {
				"id": "1575571744395917308",
				"type": "record",
				"type_name": "organization"
			}
		},
		{
			"type": "relationship",
			"type_name": "dnb_hierarchy_node_association_relationship",
			"source": {
				"id": "13",
				"type": "node",
				"type_name": "dnb_hierarchy_node"
			},
			"target": {
				"id": "4602671744395921139",
				"type": "record",
				"type_name": "organization"
			}
		}
   ]
	}
}

Pflege von Hierarchien Beispiel 2: Löschen von Hierarchiemitgliedern

Der folgende Beispiel-API-Befehl mit Payload löscht ein Mitglied mit der ID 181658077838260226 aus der Hierarchie.

API PATCH /v1/hierarchies/{id}

{
	"deletions": {
		"nodes": [
      {
			  "type": "node",
			  "type_name": "dnb_hierarchy_node",
			  "id": "181658077838260226"
		  }
		]
  }
}

Abrufen von Hierarchiedetails mit Hilfe der API

Sie können Einzelheiten zu den Mitgliedern und Beziehungen einer Hierarchie abrufen, indem Sie den API-Befehl GET /v1/hierarchies/{id} verwenden und die Hierarchie-ID angeben.

Hier ist eine Beispielantwort des Befehls GET hierarchies, der Hierarchieattribute und Beziehungen (Quelle-Ziel-Paare) liefert.

{
	"hierarchy": {
		"attributes": {
			"description": {
				"value": "ABC DnB hierarchy description"
			},
			"hierarchy_name": {
				"value": "ABC legal entity hierarchy"
			},
			"hierarchy_type": "dnb_hierarchy"
		},
		"id": "181655782266320896",
		"system_attributes": {
			"created_date": 1744394453974,
			"created_user": "cpadmin",
			"hierarchy_number": 181655782266320900,
			"hierarchy_source": "MDM",
			"last_updated_date": 1744396643229,
			"last_updated_user": "cpadmin"
		},
		"nodes": [
			{
				"attributes": {
					"designation": {
						"value": "GLOBLE PARENT"
					}
				},
				"id": "181658077838260224",
				"system_attributes": {
					"context_id": 181655782266320900,
					"created_date": 1744396643202,
					"created_user": "cpadmin",
					"last_updated_date": 1744396643231,
					"last_updated_user": "cpadmin",
					"node_number": 181658077838260220
				},
				"type": "node",
				"type_name": "dnb_hierarchy_node"
			},
			{
				"attributes": {
					"designation": {
						"value": "LOCAL PARENT"
					}
				},
				"id": "181658077838260225",
				"system_attributes": {
					"context_id": 181655782266320900,
					"created_date": 1744396643202,
					"created_user": "cpadmin",
					"last_updated_date": 1744396643232,
					"last_updated_user": "cpadmin",
					"node_number": 181658077838260220
				},
				"type": "node",
				"type_name": "dnb_hierarchy_node"
			}
		],
		"relationships": [
			{
				"id": "181658077839308800",
				"source": {
					"id": "181655782266320896",
					"type": "hierarchy",
					"type_name": "dnb_hierarchy"
				},
				"target": {
					"id": "181658077838260224",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				},
				"type": "relationship",
				"type_name": "dnb_hierarchy_node_relationship"
			},
			{
				"id": "181658077839308801",
				"source": {
					"id": "181658077838260224",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				},
				"target": {
					"id": "181658077838260225",
					"type": "node",
					"type_name": "dnb_hierarchy_node"
				},
				"type": "relationship",
				"type_name": "dnb_hierarchy_node_relationship"
			}
		],
		"type": "hierarchy",
		"type_name": "dnb_hierarchy"
	},
	"metadata": {
		"href": "https://cpd-cpd-instance.apps.test.cp.fyre.ibm.com/1744083874892597/mdm/v1/hierarchies/181655782266320896?crn=1&from_level=0&to_level=10&hierarchy_type=dnb_hierarchy",
		"id": "181655782266320896",
		"updated_at": "2025-04-11T18:37:23.229Z"
	}
}