Beispiel 1: Abrufen aller Incident-Datensätze aus einer externen Quelle
Dies sind Beispiele für Skriptdefinitionen, die Sie für das Abrufen und Zwischenspeichern von Daten aus Quellen außerhalb Ihrer aktuellen Instanz erstellen können. In diesem ersten Beispiel erstellen wir ein Skript, um alle Incident-Datensätze aus einer externen Quelle zu laden.
Weitere Informationen zur Remote Table-API finden Sie unter:
/**
* Using `v_query`, add the rows to `v_table`
*/
(function executeQuery(v_table, v_query) {
fetchAllIncidents(v_table, v_query);
/**
* fetch all incidents records from the remote instance
*/
function fetchAllIncidents(v_table, v_query) {
// Uses RestMessage with name 'Remote Instance Incidents' and function 'All Incidents'
// Create a RestMessage first which calls an external REST service
try {
var restMessage = new sn_ws.RESTMessageV2('Remote Instance Incidents', 'All Incidents');
var response = restMessage.execute();
var responseBody = response.getBody();
// if REST call ends up in an error, set the last error message which shows up
// at the bottom of the list view
if (response.haveError()) {
v_query.setLastErrorMessage(response.getErrorMessage());
// can use gs.error() or gs.addErrorMessage() while debugging
// gs.debug() messages visible in session debugger
// gs.debug(response.getErrorMessage());
return;
}
} catch (ex) {
v_query.setLastErrorMessage(ex.message);
// gs.debug(ex.message);
return;
}
var transformerDefinition = getTransformerDefinition();
var transformer = new sn_tfrm.Transformer(transformerDefinition, responseBody);
// transformer parses the responseBody and extracts rows
while (transformer.transform()) {
// row is field-value map e.g. { active:"true", number: "INC0000001"}
var row = transformer.getRow();
// you may do any additional transformations to the row like GlideDuration, GlideDataTime etc. For example,
// row.duration = new GlideDuration(row.duration);
// finally add the row to the remote table
v_table.addRow(row);
}
}
/**
* returns a sn_tfrm.TransformerDefinition, which defines the mapping of the table fields and elements in the response body
*/
function getTransformerDefinition() {
// create a rule list to map a field to its element path
var ruleList = new sn_tfrm.TransformerRuleList()
.fromJSON() // the response body is a JSON
// 'active' field maps to path '$.active'
.addRule("active", "$.active")
.addRule("caller_id", "$.caller_id.value")
.addRule("number", "$.number")
.addRule("short_description", "$.short_description")
.addRule("sys_id", "$.sys_id")
.addRule("updates", "$.sys_mod_count");
var recordPath = "$.result";
return new sn_tfrm.TransformerDefinition(ruleList, recordPath);
}
})(v_table, v_query);In diesem Skript sind die folgenden Codefragmente zu beachten:
function fetchAllIncidents(v_table, v_query) {
// Uses RestMessage with name 'Remote Instance Incidents' and function 'All Incidents'
// Create a RestMessage first which calls an external REST service
try {
var restMessage = new sn_ws.RESTMessageV2('Remote Instance Incidents', 'All Incidents');
var response = restMessage.execute();
var responseBody = response.getBody();
// if REST call ends up in an error, set the last error message which shows up
// at the bottom of the list view
if (response.haveError()) {
v_query.setLastErrorMessage(response.getErrorMessage());
// can use gs.error() or gs.addErrorMessage() while debugging
// gs.debug() messages visible in session debugger
// gs.debug(response.getErrorMessage());
return;
}
} catch (ex) {
v_query.setLastErrorMessage(ex.message);
// gs.debug(ex.message);
return;
}Sie können eine RestMessage erstellen und direkt im Skript verwenden. In diesem Beispiel wird eine RESTMessageV2-API mit dem Namen Remote Instance Incidentsund der Funktion All Incidentsverwendet, die alle Incident-Daten abruft. Sobald eine Antwort vom Server zurückgegeben wurde, wird eine Fehlermeldung angezeigt, wenn beim Datenabruf Probleme auftreten.
Hinweis:
Weitere Informationen zur Verwendung von RESTMessageV2 und zum Definieren einer direkten Nachricht finden Sie unter RESTMessageV2 – Scoped, Global and Direct RESTMessageV2 Beispiel.
Wenn beim Datenabruf keine Probleme auftreten, wird der Datentext für die Datensätze abgerufen.
var transformerDefinition = getTransformerDefinition();
var transformer = new sn_tfrm.Transformer(transformerDefinition, responseBody);
// transformer parses the responseBody and extracts rows
while (transformer.transform()) {
// row is field-value map e.g. { active:"true", number: "INC0000001"}
var row = transformer.getRow();
// you may do any additional transformations to the row like GlideDuration, GlideDataTime etc. For example,
// row.duration = new GlideDuration(row.duration);
// finally add the row to the remote table
v_table.addRow(row);
Anschließend wird die Transformer-API verwendet, um erforderliche Datentransformationen durchzuführen, Zeilen zu extrahieren und der Remotetabelle eine Zeile für jeden Datensatz hinzuzufügen.
/**
* returns a sn_tfrm.TransformerDefinition, which defines the mapping of the table fields and elements in the response body
*/
function getTransformerDefinition() {
// create a rule list to map a field to its element path
var ruleList = new sn_tfrm.TransformerRuleList()
.fromJSON() // the response body is a JSON
// 'active' field maps to path '$.active'
.addRule("active", "$.active")
.addRule("caller_id", "$.caller_id.value")
.addRule("number", "$.number")
.addRule("short_description", "$.short_description")
.addRule("sys_id", "$.sys_id")
.addRule("updates", "$.sys_mod_count");
var recordPath = "$.result";
return new sn_tfrm.TransformerDefinition(ruleList, recordPath);
}
})(v_table, v_query);
getTransformerDefinition definiert das Schema des Datensatzes im externen API-Antworttext. Sie ordnet jedes der Felder im Tabellenskript einem Element im externen Datensatz zu. Externe Datenelemente außerhalb dieser Zuordnung werden nicht unterstützt oder abgerufen. Hinweis:
Sie müssen eine sys_id in der Transformatordefinition einem Element in den externen Daten zuordnen. In diesem Fall wird die sys_id der sys_id des externen Incident zugeordnet. Die maximale Länge der sys_id beträgt 32 Zeichen. Sie führen diese sys_id-Zuordnung durch, damit Formulare, die die externen Daten verwenden, ordnungsgemäß funktionieren.