Objektbezeichnung prüfen

Prüft ob die Objektbezeichnung eindeutig ist oder gibt deren Konfiguration aus.

Seitenverzeichnis:

1 cable.object_title_check.read
2 cable.object_title_check.validate
3 Konfiguration

cable.object_title_check.read

Beschreibung

Gibt die Konfiguration zurück.

Beispielaufruf

Lesen eines speziellen Generators:

{
	"method":"cable.object_title_check.read",
	"params":{
		"apikey":"24174j3tqj"
	},
	"version":"2.0",
    "id": 1
}

Parameter

keine

Rückgabewert

Aktuelle Einstellungen.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
enabled	boolean	Prüfung ist aktiviert oder nicht	ab Version 1.0
object_types	array	Liste der zu prüfenden Objekttyp-IDs	ab Version 1.0
properties	array	Liste der zu prüfenden Eigenschaften	ab Build 2147

cable.object_title_check.validate

Beschreibung

Prüft die Bezeichnung eines Objektes.

Beispielaufruf

{
	"method":"cable.object_title_check.validate",
	"params":{
		"apikey":"24174j3tqj",
		"obj_id": 4,
		"properties": {
			"title": "Kabel 1",
			"purpose": "ISDN",
			"category": "LAN",
			"cmdb_status": "C__CMDB_STATUS__IN_OPERATION",
			"status": 2,
			"location": 1234
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

obj_id

int

Optional: ID des zu prüfenden Objektes

Hinweis: Es muss entweder eine obj_id oder eine obj_type_id gesetzt sein.

ab Version 1.0

obj_type_id

int

Optional: ID des zu prüfenden Objekttyps

Hinweis: Es muss entweder eine obj_id oder eine obj_type_id gesetzt sein.

ab Version 1.0

properties

array

Liste aller zu prüfenden Werte:

title: Bezeichnung der Objektes
- Typ: String
- Zulässige Werte: alle
- Beispiel: "Element01"
- erforderlich: nur ohne Angabe der obj_id
purpose: Einsatzzweck
- Typ: String
- Zulässige Werte: Alle Bezeichner aus isys_purpose
- Beispiel: "CU", "LWL"
- erforderlich: nein
category: Kategorie
- Typ: String
- Zulässige Werte: Alle Bezeichner aus isys_catg_global_category
- Beispiel: "LAN", "Dosen"
- erforderlich: nein
cmdb_status: CMDB-Status
- Typ: Integer oder String
- Zulässige Werte: Alle CMDB-Status-IDs oder -Konstanten aus isys_cmdb_status
- Beispiel: 2, "C__CMDB_STATUS__IN_OPERATION"
- erforderlich: nein
status: Status des Objektes
- Typ: Integer
- Zulässige Werte: Alle IDs aus isys_obj
- Beispiel: 2
- erforderlich: nein
location: Objekt-ID des übergeordneten Standortes
- Typ: Integer
- Zulässige Werte: Alle Objekt-IDs denen ein Standort zugewiesen ist
- Beispiel: 1234
- erforderlich: nein

ab Build 2168

Rückgabewert

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
success	boolean	Geprüfter Wert ist gültig oder nicht	ab Version 1.0
message	string	Ergebnis-Meldung der Prüfung	ab Version 1.0

Konfiguration

Menüpunkt

Die Konfiguration zur Prüfung der Objektbezeichnung befindet sich unter dem Menüpunkt Extras → SM-VIEW Cable im Abschnitt "Objektbezeichnung prüfen".

Parameter

In der unten dargestellten Maske lassen sich folgende Einstellungen konfigurieren:

Wert	Beschreibung	Hinweis

Wert

Beschreibung

Hinweis

Aktiviert

Schaltet die Prüfung der Objektbezeichnung an oder ab.

Zu prüfende Objekttypen

Auswahl der Objekttypen, für welche die Objektbezeichnung geprüft werden soll.

Eigenschaften

Auswahl von Eigenschaften, für welche die Objektbezeichnung eindeutig sein muss.

Wird beispielsweise zusätzlich zur Objektbezeichnung die Eigenschaft "Einsatzzweck" ausgewählt, kann dieselbe Objektbezeichnung für verschiedene Einsatzzwecke verwendet werden.

Eine gleiche Objektbezeichnung mit gleichem Einsatzzweck ist hingegen nicht möglich.