ProductInstance-API – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Die ProductInstance- API generiert einen Produktinstanzbezeichner (PID), ruft PID-Konfigurationsdaten ab und bestimmt, ob eine Modellkategorie eine Produktinstanz ist.

    Diese API wird im Namespace sn_cmdb ausgeführt und erfordert die Rolle „category_manager“ oder „snc_internal“. Der Zugriff wird auch Benutzern mit ACLs für die Modellkategorietabelle [cmdb_model_category] gewährt. Sie können die ACLs in der Tabelle „Tabelle“ [sys_db_object] anzeigen.

    Eine PID ist ein eindeutiger Bezeichner für eine Produktinstanz und verknüpft Asset, CI und ein Installationsbasiselement (IBI), um Aktualisierungen zwischen allgemeinen Produktdarstellungen zu synchronisieren. Eine Produktinstanz ist Assets einer bestimmten Modellkategorie zugeordnet.

    Der Zugriff auf Installationsbasiselemente erfordert das Plugin „Customer Service Install Base Management“ (com.snc.install_base).

    Siehe auch:

    ProductInstance – generatePID(String className, String modelCategorySysId, Object jsonKeyValues)

    Generiert den Hash-Wert der Produktinstanz und gibt ihn zurück.

    Diese Methode kann viele Male aufgerufen werden, ohne die Leistung der aufrufenden Anwendung zu beeinträchtigen. Diese Methode ändert keine Daten in der Datenbank und speichert die Daten, die zur Berechnung der PID erforderlich sind, im Cache.

    Ein Produktinstanzbezeichner (PID) ist ein eindeutiger Bezeichner für eine Produktinstanz und verknüpft Assets, CIs und Installationsbasiselemente (IBI).

    Eine PID wird basierend auf den folgenden Elementen generiert, die in der Tabelle „Produktinstanzbezeichner-Konfigurationen“ [product_instance_identifier_configuration] definiert sind:
    • PID-Konfigurationen (schreibgeschützt)
    • Reihenfolge, die jeder Konfiguration zugewiesen ist
    Siehe auch Product Instance feature in Hardware Asset Management.
    Tabelle : 1. Parameter
    Name Typ Beschreibung
    className Zeichenfolge Tabellenname für die zu generierende PID.
    modelCategorySysId Zeichenfolge Die sys_id der Modellkategorie in der Tabelle „Modellkategorien“ [cmdb_model_category]. Diesbezügliche Informationen finden Sie unter Model categories.
    jsonKeyValues Objekt JSON-Schlüssel-Wert-Paar von PID-Parametern, die in der Tabelle „Produktinstanzbezeichner-Konfigurationen“ [product_instance_identifier_configuration] konfiguriert sind.

    Die Schlüssel-Wert-Paare enthalten Attributnamen mit ihren entsprechenden Werten. Diese Werte variieren je nach den für die PID definierten Konfigurationseigenschaften.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Objekt Informationen, die zum Generieren der PID verwendet werden.
    Das Objekt gibt unter den folgenden Bedingungen einen leeren Eigenschaftswert product_instance_id zurück:
    • In der PID fehlen die erforderlichen PID-Konfigurationsattribute. Die PID-Konfiguration befindet sich in der Tabelle „Konfigurationen des Produktinstanzbezeichners“ [product_instance_identifier_configuration].
    • Der angegebenen Klasse ist keine Produktinstanz zugeordnet.
    {
  "model_category_sysId": "String",
  "parameters": [Array],
  "product_instance_id": "String"
}
    <Object>.model_category_sysId Die sys_id der Produktkategorie in der Tabelle „Modellkategorien“ [cmdb_model_category].

    Dieser Wert kann sich vom Eingabewert unterscheiden, wenn die Modellkategoriehierarchie zum Generieren der PID verwendet wurde.

    Datentyp: Zeichenfolge
    <Object>.Parameter Liste der Parameter, die zum Generieren der PID verwendet werden und in der Tabelle „Produktinstanzbezeichner-Konfigurationen“ [product_instance_identifier_configuration] definiert sind.

    Datentyp: Array von Zeichenfolgen
    <Object>.product_instance_id PID im Feld product_instance_id eines Assets, CI oder Installationsbasiselements.
    Der Hash-Wert der PID kann für diese Eigenschaft festgelegt werden, um allgemeine Werte in Objekten in einer der folgenden Tabellen zu synchronisieren:
    • Assets [alm_asset]
    • Configuration Items [cmdb_ci]
    • Installationsbasiselemente [sn_install_base_item]
    Installationsbasiselemente erfordern das Plugin „Customer Service Install Base Management“ (com.snc.install_base).

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine PID für ein Asset in der Tabelle „Medizinische Assets“ [sn_ent_metrical_asset] erstellt wird. Diese Tabelle ist im Plugin „Customer Service Install Base Management“ (com.snc.install_base) enthalten.

    var output = sn_cmdb.ProductInstance.generatePID('sn_ent_medical_asset', '4b8aa89a77710110dd5fca22fe5a9984', { "serial_number" : "SN1001"});
gs.info(JSON.stringify(output,null,'\t'));

    Ausgabe:

    {
  "model_category_sysId": "4b8aa89a77710110dd5fca22fe5a9984",
  "product_instance_id": "tw8QgznsS4cP3b4U0+rSbnbIWxirYpeVSquk3g81K/8=",
  "parameters": [
    "serial_number"
  ]
}

    ProductInstance – getPIDConfig(String className, String modelCategorySysId)

    Ruft die der Modellkategorie zugeordnete PID-Konfiguration basierend auf der Hierarchie und dem Klassennamen ab.

    Diese Methode durchsucht alle Hierarchien nach der Modellkategorie und gibt die PID-Konfiguration(en) für die erste gefundene Modellkategorie zurück.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    className Zeichenfolge Tabellenname für die zu generierende PID.
    modelCategorySysId Zeichenfolge Die sys_id der Modellkategorie in der Tabelle „Modellkategorien“ [cmdb_model_category]. Diesbezügliche Informationen finden Sie unter Model categories.
    Tabelle : 4. Ausgabe
    Typ Beschreibung
    Objekt JSON-Objekt, das die PID-Konfigurationen enthält, die dem angegebenen Klassennamen und der Modellkategorie zugeordnet sind.
    {
  "model_category_sysId": "String",
  "configs": [Array]
}
    <Object>.model_category_sysId Die sys_id der Produktkategorie in der Tabelle „Modellkategorien“ [cmdb_model_category].

    Dieser Wert kann sich vom Eingabewert unterscheiden, wenn die Modellkategoriehierarchie zum Generieren der PID verwendet wurde.

    Datentyp: Zeichenfolge
    <Object>.configs Liste jeder Konfiguration, die der angegebenen Modellkategorie zugeordnet ist.
    
"configs": [
 {
  "configuration_order": Number,
  "parameters": [Array]
 }
]

    Datentyp: Array
    <Object>.configs.configuration_order Gibt die Reihenfolge der Konfiguration zurück, die in der Tabelle „Parameter für Produktinstanzbezeichner“ [product_instance_identifier_parameters] definiert ist.

    Datentyp: Zahl
    <Object>.configs.parameter Liste aller Parameter, die der Konfiguration zugeordnet sind, und deren Reihenfolge.
    "parameters": [
  {
   "parameter_class_attribute_name": "String",
   "parameter_class_name": "String",
   "parameter_name": "String",
   "parameter_order": Number
  }
]

    Datentyp: Array von Objekten
    <Object>.configs.parameters.parameter_class_attribute_name Parametername, der der Eigenschaft „parameter_class_name“ zugeordnet ist. Diese Zeichenfolge stellt den Namen der Spalte dar, die dieser Klasse entspricht.

    Datentyp: Zeichenfolge
    <Object>.configs.parameters.parameter_class_name Klassenname, der dem Parameter zugeordnet ist, der in der Tabelle „Produktinstanz-Bezeichnerparameter“ [product_instance_identifier_parameters] definiert ist.

    Datentyp: Zeichenfolge
    <Object>.configs.parameters.parametername Parametername, der in der Tabelle „Parameter für Produktinstanzbezeichner“ [product_instance_identifier_parameters] definiert ist.

    Datentyp: Zeichenfolge
    <Object>.configs.parameters.parameter_order Reihenfolge des Parameters, der in der Tabelle „Produktinstanz-Bezeichnerparameter“ [product_instance_identifier_parameters] definiert ist.

    Datentyp: Zahl

    Das folgende Beispiel zeigt, wie Konfigurationsdetails für eine Modellkategorie mit dem Namen in der Tabelle „Medizinische Assets“ [sn_ent_Medical_asset] abgerufen werden. Diese Tabelle ist im Plugin „Customer Service Install Base Management“ (com.snc.install_base) enthalten.

    var config = sn_cmdb.ProductInstance.getPIDConfig('sn_ent_medical_asset', '4b8aa89a77710110dd5fca22fe5a9984');
gs.info(JSON.stringify(config,null,'\t'));

    Ausgabe:

    {
  "model_category_sysId": "4b8aa89a77710110dd5fca22fe5a9984",
  "configs": [
    {
      "parameters": [
        {
          "parameter_class_attribute_name": "serial_number",
          "parameter_class_name": "sn_ent_medical_asset",
          "parameter_name": "serial_number",
          "parameter_order": 1
        }
      ],
      "configuration_order": 100
    },
    {
      "parameters": [
        {
          "parameter_class_attribute_name": "parent",
          "parameter_class_name": "sn_ent_medical_asset",
          "parameter_name": "parent_asset",
          "parameter_order": 1
        },
        {
          "parameter_class_attribute_name": "model_component_id",
          "parameter_class_name": "sn_ent_medical_asset",
          "parameter_name": "model_component_id",
          "parameter_order": 2
        }
      ],
      "configuration_order": 200
    }
  ]
}

    ProductInstance – isProductInstance(String modelCategorySysId)

    Überprüft, ob eine bestimmte Modellkategorie eine Produktinstanz ist.

    Wenn beide der folgenden Bedingungen erfüllt sind, wird die Modellkategorie als Produktinstanz qualifiziert:
    • Der Wert der Kennzeichnung is_model_category der Modellkategorie ist „true“.
    • Für die Modellkategorie ist in der Tabelle „Produktinstanzbezeichner-Konfigurationen“ [product_instance_identifier_configuration] eine gültige Konfiguration definiert.

    Diese Methode kann in Business Rules verwendet werden, bevor die generatePID()- Methode aufgerufen wird.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    modelCategorySysId Zeichenfolge Die sys_id der Modellkategorie in der Tabelle „Modellkategorien“ [cmdb_model_category]. Diesbezügliche Informationen finden Sie unter Model categories.
    Tabelle : 6. Ausgabe
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob die angegebene Modellkategorie eine Produktinstanz ist.
    Gültige Werte:
    • true: Die angegebene Modellkategorie ist eine Produktinstanz.
    • false: Die angegebene Modellkategorie ist keine Produktinstanz.

    Das folgende Beispiel zeigt, wie Sie feststellen können, ob die angegebene Modellkategorie eine Produktinstanz ist.

    var isProductInstance =  sn_cmdb.ProductInstance.isProductInstance('4b8aa89a77710110dd5fca22fe5a9984');
gs.info(isProductInstance);

    Ausgabe:

    true