ResponseTemplate: Bereichsbezogen, Global
Die ResponseTemplate Die Skripteinbindung bietet Methoden zum Verwalten von Antwortvorlagen.
Antwortvorlagen sind wiederverwendbare Nachrichten, die Service Desk-Mitarbeiter in Fall- oder Aufgabenformulare kopieren können. Sie stellen Anwendern schnelle und konsistente Nachrichten zur Verfügung und zeigen anfordernde Personen in standardmäßige Chatantwortnachrichten an Mitarbeiterchat. Diese Skripteinbindung erfordert das Plugin „Antworten mit Vorlagen“ (com.sn_templates_snip), das standardmäßig aktiviert ist und innerhalb von ausgeführt wird sn_templates_snip Namespace.
Weitere Informationen zu Antwortvorlagen finden Sie unter Antwortvorlagen .
ResponseTemplate – ResponseTemplate()
Instanziiert ein neues ResponseTemplate-Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
new sn_templated_snip.ResponseTemplate().query("incident","ef4225a40a0a0b5700d0b8a790747812", "", 0, 0, true, ""); ResponseTemplate – Abfrage(Zeichenfolge tableName, Zeichenfolge-Datensatz-ID, Zeichenfolge searchTerm, Zahlenlimit, Zahlenoffset, boolescher Wert inklusive EvaluatedBody, ZeichenfolgenerrorFormat, Objekt-Optionen)
Gibt alle Antwortvorlagen aus einer angegebenen Tabelle zurück, die den übergebenen Abfragekriterien entsprechen.
| Name | Typ | Beschreibung |
|---|---|---|
| tableName | Zeichenfolge | Name der Tabelle, die zum Durchsuchen der Tabelle „sn_templates_snip_note_template“ verwendet werden soll, um die entsprechenden Antwortvorlagen zu finden. Beispiel: Incident oder sn_HR_Core_Case. |
| recordId | Zeichenfolge | SYS-ID des Datensatzes, der zum Rendern der Variablen in der Antwortvorlage verwendet werden soll. |
| searchTerm | Zeichenfolge | Optional. Text, der zum Filtern der Liste der übereinstimmenden Antwortvorlagen verwendet werden soll. Die Methode führt eine ENTHÄLT-Suche nach diesem Text in den Feldern Name und Textkörper durch und BEGINNT MIT der Suche im Feld Kurzname. Wenn der Suchbegriff beispielsweise „Absturz“ lautet, gibt die Methode eine Antwortvorlage zurück, die den Abfragekriterien entspricht und im Namen oder Textkörper einen Absturz aufweist, oder der Kurzname beginnt mit „Absturz“. Antwortvorlagen mit genauen Übereinstimmungen beim Kurznamen werden zuerst in den Rückgabeergebnissen angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Namen sortiert. Standard: Alle übereinstimmenden Antwortvorlagen zurückgeben. |
| limit | Anzahl | Optional. Maximale Anzahl zurückzugebender Antwortvorlagen. Standard: 50 |
| Offset | Anzahl | Optional. Bei Paginierung der Index, bei dem die Suche gestartet werden soll. Standard: 0 |
| EingeschlosseneEvaluatedBody | Boolean | Optional. Kennzeichnung, die angibt, ob die Vorlagenvariablen gerendert werden sollen. Gültige Werte:
Standardwert: false |
| Fehlerformat | Zeichenfolge | Optional. HTML-Formatierung, die für Fehler verwendet werden soll. Zum Beispiel:
Standard: |
| Optionen | Objekt | Optional. Parameter, die an den Erweiterungspunkt sn_templates_snip.response_template übergeben werden sollen. Format und Inhalt dieser Parameter hängen von der Implementierung des Erweiterungspunkts ab. Weitere Informationen zu Erweiterungspunkten finden Sie unter Erweiterungspunkte verwenden, um die Anwendungsfunktionalität zu erweitern . |
| Typ | Beschreibung |
|---|---|
| Objekt | Array aller Vorlagen, die den angegebenen Suchkriterien entsprechen. Antwortvorlagen mit genauen Übereinstimmungen beim Kurznamen werden zuerst in den Rückgabeergebnissen angezeigt. Alle anderen zurückgegebenen Antwortvorlagen werden nach Namen sortiert. Jeder Knoten im Array kann die folgenden Parameter enthalten:
|
Dieses Beispiel zeigt, wie Antwortvorlagen abgefragt werden, die der Incident-Tabelle zugeordnet sind.
query("incident","ef4225a40a0a0b5700d0b8a790747812", "", 0, 0, false, "");Erfolgreiche Antwort:
[
{
"sys_id": "5fc1d65993003300a9bc1d1e867ffb9c",
"name": "Incident escalation",
"short_name": "escalation",
"template_body": "<p>Dear ${caller_id.first_name},</p>\r\n<p>Please note that your incident ${number} has been escalated to ${assignment_group}. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.</p>\r\n<p>Regards,</p>\r\n<p>${sys_updated_by}</p>"
}
]
Gleiche Abfrage mit einer Fehlerantwort.
query("incident","fe4225a40a0a0b5700d0b8a790747812", "", 0, 0, false, "");Fehlerantwort:
[
{
"sys_id": "5fc1d65993003300a9bc1d1e867ffb9c",
"name": "Incident escalation",
"short_name": "escalation",
"template_body": "<p>Dear ${caller.first_name},</p>\r\n<p>Please note that your incident ${number} has been escalated to ${assignment_group}. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.</p>\r\n<p>Regards,</p>\r\n<p>${sys_updated_by}</p>",
"evaluated_response": {
"success": false,
"error": {
"unEvaluatedVariables": "caller.first_name",
"message": "Cannot evaluate following variables: caller.first_name"
},
"evaluated_body": "<p>Dear <span style='color:#ff0000'>${caller.first_name}</span>,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.</p>\r\n<p>Regards,</p>\r\n<p>admin</p>"
}
}
]
ResponseTemplate – Rendern (Zeichenfolge templateId, Zeichenfolge tableName, Zeichenfolgen-Datensatz-ID, Zeichenfolgen-Fehlerformat, Objekt-Optionen)
Rendert den HTML-Text einer angegebenen Antwortvorlage.
Während des Renderings werden alle Variablen mithilfe der Informationen aus der angegebenen Tabelle und dem angegebenen Datensatz aufgelöst. Wenn Variablen nicht gelöst werden können oder während des Renderings ein anderes Problem auftritt, gibt die Methode eine Fehlermeldung in den Ergebnissen zurück.
| Name | Typ | Beschreibung |
|---|---|---|
| templateId | Zeichenfolge | SYS-ID der Antwortvorlage, die gerendert werden soll. |
| tableName | Zeichenfolge | Name der Tabelle, die beim Rendern der Variablen in der Antwortvorlage verwendet werden soll. |
| recordId | Zeichenfolge | SYS-ID des Datensatzes, der beim Rendern der Variablen in der Antwortvorlage verwendet werden soll. Dieser Datensatz muss sich in der von angegebenen Tabelle befinden tableName. |
| Fehlerformat | Zeichenfolge | Optional. HTML-Formatierung, die für Fehler verwendet werden soll. Zum Beispiel:
Standard: |
| Optionen | Objekt | Optional. Parameter, die an den Erweiterungspunkt sn_templates_snip.response_template übergeben werden sollen. Format und Inhalt dieser Parameter hängen von der Implementierung des Erweiterungspunkts ab. Weitere Informationen zu Erweiterungspunkten finden Sie unter Erweiterungspunkte verwenden, um die Anwendungsfunktionalität zu erweitern . |
| Typ | Beschreibung |
|---|---|
| Objekt | Ergebnisse des Renderings.
|
Dieses Codebeispiel zeigt, wie eine gerenderte Antwortvorlage für die Incident-Tabelle angefordert wird.
render("5fc1d65993003300a9bc1d1e867ffb9c","incident","ef4225a40a0a0b5700d0b8a790747812", "")Erfolgreiche Antwort:
{
"success": true,
"evaluated_body": "<p>Dear Beth,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.</p>\r\n<p>Regards,</p>\r\n<p>admin</p>"
}
Gleiche Renderanforderung, aber es wird eine Fehlerantwort zurückgegeben.
render("5fc1d65993003300a9bc1d1e867ffb9c","incident","ef4225a40a0a0b5700d0b8a790747812", "")Fehlerantwort:
{
"success": false,
"error": {
"unEvaluatedVariables": "caller.first_name",
"message": "Cannot evaluate following variables: caller.first_name"
},
"evaluated_body": "<p>Dear <span style='color:#ff0000'>${caller.first_name}</span>,</p>\r\n<p>Please note that your incident INC0000049 has been escalated to Hardware. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.</p>\r\n<p>Regards,</p>\r\n<p>admin</p>"
}