Skripteinbindungen

Skripteinbindungen werden zum Speichern von JavaScript-Code verwendet, der auf dem Server ausgeführt wird.

Erstellen Sie Skripteinbindungen zum Speichern von JavaScript-Funktionen und -Klassen zur Verwendung durch Serverskripts. Jede Skripteinbindung definiert entweder eine Objektklasse oder eine Funktion.

Erwägen Sie die Verwendung von Skripteinbindungen anstelle von globalen Business Rules, da Skripteinbindungen nur auf Anforderung geladen werden.

Weitere Informationen finden Sie unter Datenschutzeinstellungen für vom Client aufrufbare Skripteinbindungen und Discovery-Skripteinbindungen.

Skripteinbindungsformular

Skripteinbindungen haben einen Namen, eine Beschreibung und ein Skript. Sie geben außerdem an, ob sie aktiv sind oder nicht, und ob sie von einem Client-Skript aus aufgerufen werden können. Zeigen Sie vorhandene an, oder erstellen Sie eine neue Skripteinbindung mithilfe des Skripteinbindungsformulars.

Um auf Skripteinbindungen zuzugreifen, navigieren Sie zu Systemdefinitionen > Skripteinbindungen.

Tabelle : 1. Skripteinbindungsformular

Feld	Beschreibung
Name	Der Name der Skripteinbindung. Wenn Sie eine Klasse definieren, muss dieser Name mit dem Namen der Klasse, des Prototyps und des Typs übereinstimmen. Wenn Sie eine klassenlose (On-Demand-)Skripteinbindung verwenden, muss der Name mit dem Funktionsnamen übereinstimmen.
API-Name	Schreibgeschützter und automatisch ausgefüllter API-Name.
Vom Client aufrufbar	Macht die Skripteinbindung für Client-Skripts, Listen-/Berichtsfilter, Referenzqualifizierer verfügbar, oder wenn sie als Teil der URL angegeben wird. Wenn diese Option ausgewählt ist, ist der zugehörige Link Zugriffssteuerungen verfügbar. Weitere Informationen finden Sie unter Datenschutzeinstellungen für vom Client aufrufbare Skripteinbindungen.
Anwendung	Die Anwendung, in der diese Skripteinbindung enthalten ist.
Zugänglich von	Legt fest, welche Anwendungen auf diese Skripteinbindung zugreifen können: Alle Anwendungsbereiche Der Zugriff ist aus jedem Anwendungsbereich möglich. Nur dieser Anwendungsbereich Der Zugriff ist nur aus dem aktuellen Anwendungsbereich möglich.
Aktiv	Aktiviert die Skripteinbindung, wenn ausgewählt. Deaktivieren Sie das aktive Feld, um die Skripteinbindung zu deaktivieren.
Beschreibung	Enthält eine Beschreibung der Skripteinbindung.
Skript	Definiert das serverseitige Skript, das bei Aufruf durch andere Skripts ausgeführt wird. Das Skript muss eine einzelne JavaScript-Klasse oder eine globale Funktion definieren. Der Klassen- oder Funktionsname muss mit dem Wert im Feld Name übereinstimmen.
Paket	Das Paket, das diese Skripteinbindung enthält.
Erstellt von	Der Benutzer, der diese Skripteinbindung erstellt hat.
Aktualisiert von	Der Benutzer, der diese Skripteinbindung zuletzt aktualisiert hat.
Schutzrichtlinie	Legt die Schutzstufe für die Skripteinbindung fest: Keine Ermöglicht jedem das Lesen und Bearbeiten dieser heruntergeladenen oder installierten Skripteinbindung. Schreibgeschützt Erlaubt jedem, Werte aus dieser heruntergeladenen oder installierten Skripteinbindung zu lesen. Kein Benutzer kann Skriptwerte in der Instanz ändern, in der er die Skripteinbindung herunterlädt oder installiert. Geschützt Bietet Schutz für geistiges Eigentum für Anwendungsentwickler. Kunden, die die Skripteinbindung herunterladen, können den Inhalt des Skriptfelds nicht sehen. Das Skript wird im Arbeitsspeicher verschlüsselt, um zu verhindern, dass unbefugte Benutzer es im Nur-Text-Format sehen.
Zugehörige Listen in der Formularansicht:
Versionen	Zeigt alle Versionen der Skripteinbindung an. Verwenden Sie diese Liste, um Versionen zu vergleichen oder eine vorherige Version wiederherzustellen. Siehe Versionen.
Zugriffssteuerungen	Wird verfügbar, wenn die Checkbox Aufrufbares Client -Element aktiviert und in standardmäßigen Skripteinbindungen ausgeblendet wird. Verwenden Sie diese Option, um ein CCSI vor nicht autorisierter Verwendung zu schützen, wenn kein öffentlicher Zugriff gewährt wird.

Skripteinbindungen verwenden

Skripteinbindungen finden Sie unter „Systemdefinition“ oder „System-UI“. Sie können vorhandene Skripteinbindungen aus einem Skript aufrufen oder eine neue Skripteinbindung erstellen.

Um eine völlig neue Skripteinbindung zu erstellen, können Sie das Format einer der vorhandenen Skripteinbindungen verwenden. In diesem Beispiel lautet der Name Ihrer Skripteinbindung NewInclude, und es gibt eine einzige Funktion namens myFunction. Es ist wichtig, dass der Name der Skripteinbindung mit dem Namen der Klasse, des Prototyps und des Typs übereinstimmt. Wenn Sie eine neue Skripteinbindung erstellen und ihr einen Namen geben, stellt das System ein Code-Fragment mit der Klasse und dem Prototyp bereit, die ordnungsgemäß eingerichtet sind.

var NewInclude =Class.create();
 
NewInclude.prototype={
  initialize :function(){},
 
  myFunction :function(){<Put function code here>},
 
  type :'NewInclude'};

Sie können die myFunction -Zeile dann wie folgt verwenden:

var foo =new NewInclude();
foo.myFunction();

Hinweis:

Eine von ServiceNow bereitgestellte Skripteinbindung sollte nach Möglichkeit nicht geändert werden. Wenn Sie eine Skripteinbindung erstellen möchten, die eine ähnliche Funktion wie eine vorhandene haben soll, kopieren Sie die vorhandene Funktion, und nehmen Sie Änderungen an der Kopie vor. Alternativ können Sie das Objekt erweitern. Dies ist eine gängige Vorgehensweise bei der Verwendung von GlideAjax.

Vom Client aufrufbare Skripteinbindungen

Client Callable Script Includes (CCSI) machen die Skripteinbindung für Client-Skripts, Listen-/Berichtsfilter, Referenzqualifizierer oder als Teil der URL verfügbar.

Vorbereitungen

Erforderliche Rolle: admin

Prozedur

1. Navigieren zu Systemdefinition > Skripteinbindungen.
2. Wählen Sie Neu, oder wählen Sie eine vorhandene Skripteinbindung aus, um sie anzuzeigen oder zu bearbeiten.
   Weitere Informationen zum Schreiben von Skripteinbindungen finden Sie unter Skripteinbindungen verwenden.
3. Füllen Sie das Formular aus, und aktivieren Sie das Kontrollkästchen Client Callable (Aufrufbarer Client).
   Eine Rollenauswahl wird angezeigt, um eine Benutzerrolle auszuwählen und automatisch einen Zugriffssteuerungseintrag zu erstellen. Wählen Sie eine Benutzerrolle aus, und klicken Sie auf OK.

   Hinweis:

   Um das Rollenauswahlfenster zu deaktivieren, legen Sie glide.script.ccsi.enable_acl_create_ux auf falsefest.

   Ein neuer CCSI-Datensatz mit einer rollenbasierten Zugriffssteuerung wird erstellt. Der zugehörige Link Zugriffssteuerung wird verfügbar, wenn das Kontrollkästchen Client calIable aktiviert wird.

   

Datenschutzeinstellungen für vom Client aufrufbare Skripteinbindungen

Datenschutzeinstellungen für vom Client aufrufbare Skripteinbindungen (CCSI) bestimmen, wer auf eine vom Client aufrufbare Skripteinbindung zugreifen kann.

Private Datenschutzeinstellung

Die private Datenschutzeinstellung bedeutet, dass Gäste, die auf öffentliche Seiten zugreifen, nicht auf die vom Client aufrufbare Skripteinbindung zugreifen können. Ein privates Skript kann nur von einem angemeldeten Benutzer ausgeführt werden.

Öffentliche Datenschutzeinstellung

Eine öffentliche Datenschutzeinstellung bedeutet, dass das Client-Skript von nicht angemeldeten Benutzern ausgeführt werden kann, die eine entsprechende HTTP-Anforderung erstellen. Dies kann zu einem Sicherheitsproblem führen, wenn das Client-Skript vertrauliche Informationen bereitstellt.

Die folgenden Skripteinbindungen bleiben standardmäßig öffentlich, da UI-Seiten öffentlich oder privat machen auf sie zugreifen muss:

• GlideSystemAjax
• SysMessageAjax
• KnowledgeMessagingAjax
• KnowledgeAjax
• PasswordResetAjax

Legen Sie den Datenschutz für alle vom Client aufrufbaren Skripteinbindungen fest

Ändern Sie die Datenschutzeinstellungen für alle vom Client aufrufbaren Skripteinbindungen.

Um eine weitere Kontrolle über alle vom Client aufrufbaren Skripteinbindungen zu ermöglichen, können Administratoren die Eigenschaft glide.script.ccsi.ispublic hinzufügen. Diese Eigenschaft ändert die Sichtbarkeit der vom Client aufrufbaren Skripteinbindungen, indem sie alle als öffentlich oder privat definiert. Konfigurieren Sie die Eigenschaft wie folgt:

Tabelle : 2. Eigenschaft konfigurieren

Titel	Eigenschaft
Name	glide.script.ccsi.ispublic
Typ	Wahr|Falsch
Wert	false

Hinweis:

Weitere Informationen zu dieser Eigenschaft finden Sie unter Datenschutz für vom Client aufrufbare Skripteinbindungen in Härtungseinstellungen für Instanzsicherheit.

Datenschutz für eine einzelne vom Client aufrufbare Skripteinbindung ändern

Ändern Sie die Datenschutzeinstellung für eine einzelne vom Client aufrufbare Skripteinbindung, indem Sie die Funktion isPublic() hinzufügen.

Die Einstellung isPublic() hat Vorrang vor der Eigenschaft glide.script.ccsi.ispublic. Beispiel: Wenn die Eigenschaft auf falsefestgelegt ist, wodurch alle vom Client aufrufbaren Skripteinbindungen privat sind, und ein Skript isPublic() auf truesetzt, ist das Skript öffentlich.

Um die Datenschutzeinstellung für eine einzelne vom Client aufrufbare Skripteinbindung zu ändern, fügen Sie der Skripteinbindung die folgende Methode hinzu:

  isPublic:function(){return[true/false];},

Legen Sie das NewInclude-Client-Skript als privat fest.

var NewInclude =Class.create();
 
NewInclude.prototype={
   initialize:function(){},
 
   myFunction:function(){//Put function code here},
   isPublic:function(){return false;},
 
   type:'NewInclude'};

Sicherheit für vom Client aufrufbare Skripteinbindungen

Pschützen Sie Ihre vom Client aufrufbare Skripteinbindung (CCSI) vor nicht autorisierter Verwendung. Für alle CCSI-Datensätze, die in einer Kundenanwendung erstellt werden, werden Empfehlungen angezeigt, die das Sicherheitsrisikoreduzieren können.

Beim Erstellen einer CCSI zeigt das System die folgenden Sicherheitsempfehlungen an, sofern sie noch nicht konfiguriert wurden:

• Fügen Sie eine Zugriffssteuerung hinzu, oder definieren Sie sie, es sei denn, die CCSI hat öffentlichen Zugriff.
• Verwenden Sie GlideRecordSecure anstelle der GlideRecord- API, um die Sicherheit zu verbessern, wenn das Skript die Datenbank abfragt.

  

  Hinweis:

  Um die Sicherheitsempfehlungsmeldungen zu deaktivieren, legen Sie die Eigenschaft glide.script.ccsi.customer_scoped.security_msgs_enabled in der Tabelle „sys_properties“ auf „ false “ fest. Der Standardwert ist auf truefestgelegt.

Weitere Informationen zur Sicherheits-Compliance finden Sie unter Härtungseinstellungen für Instanzsicherheit.

Discovery-Skripteinbindungen

DiscoverySkripteinbindungen enthalten definierte JavaScript-Klassen, die für Discovery-Aufgaben verwendet werden können.

Hinweis:

Benutzer mit der Rolle discovery_admin können Skripteinbindungen schreiben. Befolgen Sie die Best Practices für serverseitiges und clientseitiges Skripting, um Sicherheitsprobleme zu vermeiden. Weitere Informationen finden Sie im Wissensartikel KB0550828.

GlideRecordUtil für die Arbeit mit GlideRecords verwenden

GlideRecordUtil ist eine Dienstprogrammklasse, die nützliche Methoden für die Arbeit mit GlideRecords während Discovery bietet. Beschreibungen der verfügbaren Methoden finden Sie unter GlideRecordUtil.

Eine GlideRecord-Instanz erhalten

Um eine GlideRecord-Instanz für ein bestimmtes Configuration Item und für die richtige Klasse und Tabelle zu erhalten, verwenden Sie die Methode getCIGR(sys_id). Mit dem folgenden Code wird beispielsweise der GlideRecord eines CI mit der sys_id „2dfd7c8437201000deeabfc8bcbe5d56“ abgerufen:

var now_GR = new GlideRecordUtil().getCIGR("2dfd7c8437201000deeabfc8bcbe5d56");

Um eine hierarchische Tabelle abzurufen, ohne den Klassentyp zu kennen, verwenden Sie die Methode getGR(base_table, sys_id). Um beispielsweise einen GlideRecord für ein Computerklassen-CI zu erhalten, müssen Sie möglicherweise unterscheiden, ob es sich um eine Computerklasse, Windows Server oder Linux Serverklasse handelt. Die Verwendung dieser Methode garantiert einen GlideRecord mit der richtigen Klasse. Verschiedene Klassen haben unterschiedliche Attribute. In diesem Anwendungsfall weist ein Windows -Server andere Attribute auf als ein Linux -Server. Das folgende Beispiel zeigt, wie ein GlideRecord in der richtigen Klasse mit seinen Attributen abgerufen wird.

var now_GR = new GlideRecordUtil().getGR( "cmdb_ci_computer", "2dfd7c8437201000deeabfc8bcbe5d56");

Alle Felder in einem GlideRecord abrufen

Die Methode getFields(now_GR) gibt ein JavaScript-Objekt zurück, z. B. eine Hashmap, aller Felder oder Attribute, die in einem bestimmten GlideRecord vorhanden sind.

var now_GR = new GlideRecordUtil().getGR("cmdb_ci_computer", "2dfd7c8437201000deeabfc8bcbe5d56");
var fields = new GlideRecordUtil().getFields(now_GR);
gs.log(fields.join(" ")); // List all the fields that are in a computer CI

GlideRecord-Objektfelder ausfüllen

Mit der Methode populateFromGR(hashmap, gr, ignore) können Sie ein GlideRecord-Objekt verwenden und dessen Felder und Werte in ein JavaScript-Objekt füllen. Das dritte Argument (ignore) ist ein optionales JavaScript-Objekt, mit dem Sie bestimmte Felder ausschließen können. Beispielsweise sind Ihnen die Felder sys_created_by oder sys_updated_by in einem GlideRecord möglicherweise egal.

var objectToPopulate = { }; 
var now_GR = new GlideRecordUtil().getGR("cmdb_ci_computer", "2dfd7c8437201000deeabfc8bcbe5d56"); 
var ignore = {"sys_created_on": true, "sys_updated_by": true}; 
new GlideRecordUtil.03().populateFromGR(objectToPopulate, gr, ignore); 
// Now the objectToPopulate contains field/value pairs from the computer GlideRecord

Mit der Methode mergeToGR(hashmap, gr, ignore) können Sie einen GlideRecord mit einem Feld-/Wert-gepaarten Objekt ausfüllen. Das Argument „ignore“ stoppt die Aktualisierung der angegebenen Felder. Im folgenden Codebeispiel werden die Felder name und os eines Computerdatensatzes aktualisiert, das Feld sys_created_by ] jedoch nicht:

var now_GR = new GlideRecordUtil().getGR("cmdb_ci_computer", "2dfd7c8437201000deeabfc8bcbe5d56"); 
var obj = {"name": "xyz", "os": "windows 2000", "sys_created_by", "aleck.lin"};
var ignore = {"sys_created_by": true}; 
new GlideRecordUtil().mergeToGR(obj, gr, ignore);
gr.update();

Tabellenhierarchien abrufen

Die Methode getTables(table) gibt eine Liste von Tabellenhierarchien aus, wie im folgenden Beispiel gezeigt:

var tables = new GlideRecordUtil().getTables("cmdb_ci_linux_server");
gs.log(tables.join(",")); 
// The result would be "cmdb_ci, cmdb_ci_computer, cmdb_ci_server, cmdb_ci_linux_server".

DiscoveryException und AutomationException verwenden

Beim Schreiben von Discovery-Sensoren und sensorbezogenen Skripts möchten Sie möglicherweise DiscoveryException oder AutomationException verwenden, um anzuzeigen, dass eine Ausnahme von Discovery aufgetreten ist.

Die Skripteinbindung DiscoveryException erweitert AutomationException, die wiederum die Klasse GenericException erweitert. Das folgende Beispiel verwendet DiscoveryException, um eine Ausnahme auszulösen:

function foo() { 
  if(//condition matches) throw new DiscoveryException("The message", "The cause"); }

Das erste Argument nimmt die Nachricht der Ausnahme und das zweite Argumente (optional) die Ursache der Ausnahme. Die Ausnahme kann gegebenenfalls abgefangen und wie im folgenden Beispiel protokolliert werden:

try {
  foo(); 
} 
catch(e) { 
   if(e instanceof DiscoveryException)
     gs.log("A DiscoveryException occurred. It is " + e. getMessage() + " caused by " + e.getCause()); }

Das obige Beispiel gilt auch für AutomationException. DiscoveryException wird normalerweise verwendet, um die Ausnahmebehandlung speziell für Discovery bereitzustellen, während AutomationException für die Ausnahmebearbeitung, die sowohl für Orchestration als auch für Discovery gilt, verwendet wird.