Servicekatalog API – ServiceNow Fluent
Die Servicekatalog API definiert Katalogelemente [ sc_Cat_item ], Datensatzersteller [sc_cat_item_producer] und zugehörige Aspekte von Servicekatalogen.
Allgemeine Informationen zu Servicekatalogen finden Sie unter Service Catalog.
Katalogelement-Objekt
Erstellen Sie ein Katalogelement [sc_Cat_item], das Anwender aus einem Servicekatalog anfordern können.
Ein Katalogelement muss auf einen Flow, Workflow oder Ausführungsplan verweisen, der definiert, wie die Elementanforderung erfüllt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstruktionen. Format: |
| Name | Zeichenfolge | Erforderlich. Ein Name für das Element, das im Katalog angezeigt wird. |
| aktiv | Boolean | Kennzeichnung, die angibt, ob der Artikel aktiv und für die Bestellung verfügbar ist. Standardwert: wahr |
| Verfügbarkeit | Zeichenfolge | Der Typ des Geräts, auf dem das Element angezeigt wird. Gültige Werte:
Standard: DesktopOnly |
| Ausgecheckt | Boolean | Kennzeichnung, die angibt, ob das Element zur Bearbeitung ausgecheckt ist. Standardwert: false |
| Beschreibung | Zeichenfolge | Eine detaillierte Beschreibung des Elements, das im Katalog angezeigt wird, wenn ein Anwender das Element oder das zugehörige auswählt Vorschau Link. Sie können Videos, Bilder, Links zu internen Knowledge Base-Artikeln (KB) und Links zu externen Informationsquellen und Anweisungsdokumentation einbetten. |
| Meta | Array | Eine Liste von Metadaten-Tags, die zur Unterstützung von Suchen im Zusammenhang mit dem Element verwendet werden. Hinweis: Die Meta Die Eigenschaft wird nur für die Zing-Textindizierung und die Suchmaschine und nicht für verwendet KI-Suche. |
| Modell | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Produktmodells [cmdb_model], das dem Element zugeordnet ist. Verwenden Sie zum Definieren eines Produktmodells Datensatz-API – ServiceNow Fluent. |
| Reihenfolge | Nummer | Die Reihenfolge, in der das Element innerhalb seiner Kategorie angezeigt wird. Standard: 0 |
| Eigentümer | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Anwenders [sys_user], der das Element besitzt und Bearbeitungszugriff darauf hat. Verwenden Sie zum Definieren eines Anwenders Datensatz-API – ServiceNow Fluent. |
| Rollen | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder sys_IDs von Rollen [sys_user_role], die auf das Element zugreifen können. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. |
| shortDescription | Zeichenfolge | Eine kurze Beschreibung des Elements, das auf der Katalog-Homepage, den Suchergebnissen und der Titelleiste des Bestellformulars angezeigt wird. |
| ShowVariableHelpOnLoad | Boolean | Kennzeichnung, die angibt, ob das Element standardmäßig den variablen Hilfetext anzeigt. Standardwert: false |
| StartGeschlossen | Boolean | Kennzeichnung, die angibt, ob das Element in einem reduzierten Status gestartet werden soll. Standardwert: false |
| Staat | Zeichenfolge | Der Veröffentlichungsstatus des Elements, z. B. „Entwurf“ oder „veröffentlicht“. |
| variables | Objekt | Die Variablendefinitionen für das Element, die Optionen für die Anforderung bereitstellen. Jeder Variablentyp hat eine bestimmte Funktion. Zum Beispiel:Allgemeine Informationen zu Katalogvariablen finden Sie unter Service catalog variables. |
| Version | Nummer | Eine Version des Elements. Standard: 1 |
| Bild | Zeichenfolge | Veraltet. Ein Bild für das Element. |
| icon | Zeichenfolge | Eine Bilddatei, die als Symbol neben dem Elementnamen im Katalog angezeigt wird. Verwenden Sie ein Bild mit 27 x 27 Pixeln. Wenn kein Bild hochgeladen wird, wird das Standardsymbol angezeigt. |
| Bild | Zeichenfolge | Eine Bilddatei, die als Bild des Elements angezeigt werden soll. |
| MobilePicture | Zeichenfolge | Ein Bild, das als Bild des Elements auf Mobilgeräten angezeigt werden soll. Diese Eigenschaft gilt nur, wenn der Wert von MobilePictureType Ist |
| MobilePictureType | Zeichenfolge | Der Typ des Bilds, das für das Element auf Mobilgeräten angezeigt werden soll. Gültige Werte:
Standard: DesktopPicture |
| AusblendenHinzufügen zum Einkaufswagen | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll In den Einkaufswagen legen Schaltfläche. Standardwert: false |
| AusgeblendetAddTWishList | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Zur Wunschliste hinzufügen Schaltfläche. Standardwert: false |
| AusblendenLieferzeit | Boolean | Kennzeichnung, die angibt, ob die Lieferzeit ausgeblendet werden soll. Standardwert: false |
| AusgeblendetQuantitySelector | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Menge Feld. Standardwert: false |
| AusgeblendetSaveAsDraft | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Als Entwurf speichern Schaltfläche. Standardwert: false |
| AusgeblendetSP | Boolean | Kennzeichnung, die angibt, ob ein Element in ausgeblendet werden soll Serviceportal. Standardwert: false |
| ObligatoryAnhang | Boolean | Kennzeichnung, die angibt, ob das Hinzufügen eines Anhangs erforderlich ist, um eine Anforderung zu übermitteln. Standardwert: false |
| AusblendenAnhang | Boolean | Kennzeichnung, die angibt, ob der Anhangsabschnitt ausgeblendet werden soll und das Hinzufügen von Anhängen nicht unterstützt wird. Standardwert: false |
| Zugewiesene Themen | Array | Eine Liste von sys_IDs vorhandener Taxonomiethemen, die die Sichtbarkeit des Elements in steuern Mitarbeiter-Center Portal. Weitere Informationen finden Sie unter Associate a catalog item with a taxonomy topic in Employee Center. Hinweis: Diese Eigenschaft ist nur verfügbar, wenn das Plugin „Taxonomie für Mitarbeiter-Experience“ (sn_ect) aktiv ist. |
| Verfügbar für | Array | Eine Liste von sys_IDs von Anwenderkriterien [user_Criteria], die definieren, wer auf das Element zugreifen kann. |
| Nicht verfügbar für | Array | Eine Liste von sys_IDs von Anwenderkriterien [user_Criteria], die definieren, wer nicht auf das Element zugreifen kann. Diese Eigenschaft überschreibt Verfügbar für Eigenschaft. |
| VariableSets | Array | Eine Liste von Variablenbezeichnern von VariableSet Objekte oder sys_IDs von Variablensätzen [item_option_new_set], die an das Element angehängt werden sollen. Weitere Informationen finden Sie unter VariableSet-Objekt. Format: |
| Flow | Referenz oder Zeichenfolge | Der Variablenbezeichner von Flow Objekt oder sys_ID eines Flows [sys_Hub_Flow], der definiert, wie die Anforderung erfüllt wird. Verwenden Sie zum Definieren eines Flows Flow-API – ServiceNow Fluent. Hinweis: Sie sollten Flows als Erfüllungsmethode für Katalogelemente verwenden. Wann Flow , Workflow , Und ExecutionPlan Sind alle angegeben, verwendet das System den Flow. |
| executionPlan | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Ausführungsplans [sc_cat_item_delivery_plan], der definiert, wie die Anforderung erfüllt wird. Verwenden Sie zum Definieren eines Ausführungsplans Datensatz-API – ServiceNow Fluent. |
| Workflow | Zeichenfolge | Die sys_ID eines Legacy-Workflows [wf_Workflow], der definiert, wie die Elementanforderung erfüllt wird. Verwenden Sie Flow Eigenschaft für neue Implementierungen. |
| Zugriffstyp | Zeichenfolge | Der Anwenderzugriff, der zum anfordern des Elements erforderlich ist. Gültige Werte:
Hinweis: Diese Funktionalität gilt nur, wenn für das Element eine Variable „angefordert für“ vorhanden ist. Standard: Eingeschränkt |
| location | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Standorts [cmn_location], an dem das Element bereitgestellt wird. Verwenden Sie zum Definieren eines Standorts Datensatz-API – ServiceNow Fluent. |
| Lieferant | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Lieferanten, der dem Artikel zugeordnet ist. Verwenden Sie zum Definieren eines Lieferanten Datensatz-API – ServiceNow Fluent. |
| DelieryPlanScript | Skript | Veraltet. Verwenden Sie ExecutionPlan Stattdessen Eigenschaft. |
| Lieferzeit | Objekt | Die geschätzte Zeit bis zur Lieferung des Artikels. Format: |
| TitlementScript | Skript | Ein Skript, das die Berechtigung für das Element definiert. |
| MakeItemnicht konversationsfähig | Boolean | Kennzeichnung, die angibt, ob verhindert werden soll, dass das Element aus einer Konversations-Experience wie angefordert werden kann Virtual Agent. Bei „wahr“ kann das Element über eine Konversations-Experience angefordert werden. Standardwert: false |
| Sichtbares Bündel | Boolean | Kennzeichnung, die angibt, ob das Element in gespeicherten Bündeln sichtbar ist. Standardwert: wahr |
| Sichtbarer Leitfaden | Boolean | Kennzeichnung, die angibt, ob das Element in Bestellleitfäden sichtbar ist. Standardwert: wahr |
| Sichtbares Standalone | Boolean | Kennzeichnung, die angibt, ob die eigenständige Ansicht sichtbar ist. Standardwert: wahr |
| FulfillmentAutomationLevel | Zeichenfolge | Die Ebene der Erfüllungsautomatisierung für Anforderungen. Gültige Werte:
|
| Erfüllungsgruppe | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID der Gruppe [sys_user_Group], die für die Lieferung des Artikels verantwortlich ist. Verwenden Sie zum Definieren einer Anwendergruppe Datensatz-API – ServiceNow Fluent. |
| Kataloge | Array | Eine Liste von sys_IDs der Kataloge [sc_catalog], in denen das Element angezeigt wird. |
| categories | Array | Eine Liste von sys_IDs der Kategorien [sc_category], zu denen das Element gehört. Ein Katalog muss in angegeben werden Kataloge Eigenschaft, bevor Kategorien zugewiesen werden können. Im Serviceportal finden Katalogsuchen nur Elemente, die einer Kategorie zugewiesen sind. Im Mitarbeiter-Center finden Katalogsuchen nur Elemente, die einem Taxonomiethema zugeordnet sind. Weitere Informationen finden Sie unter Associate a catalog item with a taxonomy topic in Employee Center. |
| Kosten | Nummer | Eine Zahl, die die einmaligen Kosten des Artikels angibt. Standard: 0 |
| DisplayPriceProperty | Zeichenfolge | Die Systemeigenschaft, die steuert, wie der Artikelpreis angezeigt wird. |
| IgnorierPreis | Boolean | Kennzeichnung, die angibt, ob der Artikelpreis im Einkaufswagen und in der Katalogeliste ausgeblendet werden soll. Standardwert: wahr |
| MobileHidePrice | Boolean | Kennzeichnung, die angibt, ob der Artikelpreis auf Mobilgeräten ausgeblendet werden soll. Standardwert: false |
| Auslasspreis | Boolean | Kennzeichnung, die angibt, ob der Preis in allen Ansichten des Artikels vollständig ausgelassen werden soll. Standardwert: false |
| Abrechenbar | Boolean | Kennzeichnung, die angibt, ob der Artikel abrechenbar ist. Standardwert: false |
| Preisdetails | Array | Eine Liste von Preiseinträgen für den Artikel. Gültige Werte:
Format: |
| Wiederholungshäufigkeit | Zeichenfolge | Das Zeitintervall, in dem sich der wiederkehrende Preis wiederholt, z. B. monatlich oder jährlich. Diese Eigenschaft ist erforderlich, wenn Preisdetails Enthält |
| Anforderungsmethode | Zeichenfolge | Die Bezeichnung für die Schaltfläche „Übermittlung“ und die Experience für die Auftragsübermittlung. Gültige Werte:
Standard: Reihenfolge |
| CustomCart | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines anwenderdefinierten UI-Makros, der für das Einkaufswagen-Rendering verwendet werden soll. Verwenden Sie zum Definieren eines anwenderdefinierten Einkaufswagens Datensatz-API – ServiceNow Fluent. |
| UseScLayout | Boolean | Kennzeichnung, die angibt, ob das Element verwendet Servicekatalog Layout für die Anzeige. Standardwert: wahr |
| Kein Einkaufswagen | Boolean | Veraltet. Kennzeichnung, die angibt, ob der Einkaufswagen ausgeblendet werden soll. Standardwert: false |
| Keine Reihenfolge | Boolean | Veraltet. Kennzeichnung, die angibt, ob ausgeblendet werden soll Reihenfolge Option. Standardwert: false |
| NoOrderNow | Boolean | Veraltet. Kennzeichnung, die angibt, ob ausgeblendet werden soll Bestellen Sie Jetzt Option. Standardwert: false |
| NoProceedCheckout | Boolean | Veraltet. Kennzeichnung, die angibt, ob der Bezahlvorgang ausgeblendet werden soll. Standardwert: false |
| Keine Menge | Boolean | Veraltet. Kennzeichnung, die angibt, ob ausgeblendet werden soll Menge Feld. Standardwert: false |
| NoSearch | Boolean | Veraltet. Kennzeichnung, die angibt, ob die Suche ausgeblendet werden soll. Standardwert: false |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import { CatalogItem } from "@servicenow/sdk/core";
export const softwareLicenseRequest = CatalogItem({
$id: Now.ID["software_license_request"],
name: "Software License Request",
shortDescription: "Request a software license",
catalogs: [serviceCatalog],
categories: [softwareCategory],
// Attach reusable variable sets
variableSets: [
{ variableSet: contactInfoSet, order: 100 },
{ variableSet: approvalInfoSet, order: 200 }
],
// Item-specific variables
variables: {
software_name: SingleLineTextVariable({
question: "Software Name",
mandatory: true,
order: 100
}),
license_type: SelectBoxVariable({
question: "License Type",
choices: {
individual: { label: "Individual", sequence: 1 },
team: { label: "Team (5 seats)", sequence: 2 },
enterprise: { label: "Enterprise (unlimited)", sequence: 3 }
},
mandatory: true,
order: 200
}),
number_of_licenses: SingleLineTextVariable({
question: "Number of Licenses",
defaultValue: "1",
order: 300
}),
justification: MultiLineTextVariable({
question: "Business Justification",
mandatory: true,
order: 400
})
},
// Pricing with recurring charges
pricingDetails: [
{ amount: 0, currencyType: "USD", field: "price" },
{ amount: 99, currencyType: "USD", field: "recurring_price" }
],
recurringFrequency: "monthly",
flow: "523da512c611228900811a37c97c2014",
deliveryTime: { days: 3, hours: 0 }
})
CatalogItemRecordProducer-Objekt
Erstellen Sie einen Datensatzersteller [sc_cat_item_producer], damit Anwender aufgabenbasierte Datensätze wie Incident- oder Change-Anforderungsdatensätze aus dem Servicekatalog erstellen können.
Sie können einen Datensatzersteller für Tabellen und Datenbankansichten erstellen, die sich in demselben Umfang wie der Datensatzersteller befinden. Sie können auch einen Datensatzersteller für Tabellen erstellen, die den Zugriff von Anwendungen in anderen Bereichen ermöglichen.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstruktionen. Format: |
| Tabelle | Referenz oder Zeichenfolge | Erforderlich. Der Variablenbezeichner von Tabelle Objekt oder Name einer Tabelle, in der der Datensatzersteller Datensätze erstellt, z. B. Incident oder Change_Request. |
| Name | Zeichenfolge | Erforderlich. Ein Name für das Element, das im Katalog angezeigt wird. |
| aktiv | Boolean | Kennzeichnung, die angibt, ob der Artikel aktiv und für die Bestellung verfügbar ist. Standardwert: wahr |
| Verfügbarkeit | Zeichenfolge | Der Typ des Geräts, auf dem das Element angezeigt wird. Gültige Werte:
Standard: DesktopOnly |
| Ausgecheckt | Boolean | Kennzeichnung, die angibt, ob das Element zur Bearbeitung ausgecheckt ist. Standardwert: false |
| Beschreibung | Zeichenfolge | Eine detaillierte Beschreibung des Elements, das im Katalog angezeigt wird, wenn ein Anwender das Element oder das zugehörige auswählt Vorschau Link. Sie können Videos, Bilder, Links zu internen Knowledge Base-Artikeln (KB) und Links zu externen Informationsquellen und Anweisungsdokumentation einbetten. |
| Meta | Array | Eine Liste von Metadaten-Tags, die zur Unterstützung von Suchen im Zusammenhang mit dem Element verwendet werden. Hinweis: Die Meta Die Eigenschaft wird nur für die Zing-Textindizierung und die Suchmaschine und nicht für verwendet KI-Suche. |
| Modell | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Produktmodells [cmdb_model], das dem Element zugeordnet ist. Verwenden Sie zum Definieren eines Produktmodells Datensatz-API – ServiceNow Fluent. |
| Reihenfolge | Nummer | Die Reihenfolge, in der das Element innerhalb seiner Kategorie angezeigt wird. Standard: 0 |
| Eigentümer | Referenz oder Zeichenfolge | Der Variablenbezeichner oder die sys_ID eines Anwenders [sys_user], der das Element besitzt und Bearbeitungszugriff darauf hat. Verwenden Sie zum Definieren eines Anwenders Datensatz-API – ServiceNow Fluent. |
| Rollen | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder sys_IDs von Rollen [sys_user_role], die auf das Element zugreifen können. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. |
| shortDescription | Zeichenfolge | Eine kurze Beschreibung des Elements, das auf der Katalog-Homepage, den Suchergebnissen und der Titelleiste des Bestellformulars angezeigt wird. |
| ShowVariableHelpOnLoad | Boolean | Kennzeichnung, die angibt, ob das Element standardmäßig den variablen Hilfetext anzeigt. Standardwert: false |
| StartGeschlossen | Boolean | Kennzeichnung, die angibt, ob das Element in einem reduzierten Status gestartet werden soll. Standardwert: false |
| Staat | Zeichenfolge | Der Veröffentlichungsstatus des Elements, z. B. „Entwurf“ oder „veröffentlicht“. |
| variables | Objekt | Die Variablendefinitionen für das Element, die Optionen für die Anforderung bereitstellen. Jeder Variablentyp hat eine bestimmte Funktion. Zum Beispiel:Allgemeine Informationen zu Katalogvariablen finden Sie unter Service catalog variables. |
| Version | Nummer | Eine Version des Elements. Standard: 1 |
| Ansicht | Referenz oder Zeichenfolge | Erforderlich. Der Variablenbezeichner oder Name der zutreffenden UI-Ansicht [sys_ui_View] oder der Standardansicht. Verwenden Sie zum Definieren einer UI-Ansicht Datensatz-API – ServiceNow Fluent. Dient zur Verwendung der Standardansicht ( Default_View ), müssen Sie Folgendes importieren: |
| icon | Zeichenfolge | Eine Bilddatei, die als Symbol neben dem Elementnamen im Katalog angezeigt wird. Verwenden Sie ein Bild mit 27 x 27 Pixeln. Wenn kein Bild hochgeladen wird, wird das Standardsymbol angezeigt. |
| Bild | Zeichenfolge | Eine Bilddatei, die als Bild des Elements angezeigt werden soll. |
| MobilePicture | Zeichenfolge | Ein Bild, das als Bild des Elements auf Mobilgeräten angezeigt werden soll. Diese Eigenschaft gilt nur, wenn der Wert von MobilePictureType Ist |
| MobilePictureType | Zeichenfolge | Der Typ des Bilds, das für das Element auf Mobilgeräten angezeigt werden soll. Gültige Werte:
Standard: DesktopPicture |
| Zugewiesene Themen | Array | Eine Liste von sys_IDs vorhandener Taxonomiethemen, die die Sichtbarkeit des Elements in steuern Mitarbeiter-Center Portal. Weitere Informationen finden Sie unter Associate a catalog item with a taxonomy topic in Employee Center. Hinweis: Diese Eigenschaft ist nur verfügbar, wenn das Plugin „Taxonomie für Mitarbeiter-Experience“ (sn_ect) aktiv ist. |
| Verfügbar für | Array | Eine Liste von sys_IDs von Anwenderkriterien [user_Criteria], die definieren, wer auf das Element zugreifen kann. |
| Nicht verfügbar für | Array | Eine Liste von sys_IDs von Anwenderkriterien [user_Criteria], die definieren, wer nicht auf das Element zugreifen kann. Diese Eigenschaft überschreibt Verfügbar für Eigenschaft. |
| VariableSets | Array | Eine Liste von Variablenbezeichnern von VariableSet Objekte oder sys_IDs von Variablensätzen [item_option_new_set], die an das Element angehängt werden sollen. Weitere Informationen finden Sie unter VariableSet-Objekt. Format: |
| AusblendenHinzufügen zum Einkaufswagen | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll In den Einkaufswagen legen Schaltfläche. Standardwert: false |
| AusgeblendetAddTWishList | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Zur Wunschliste hinzufügen Schaltfläche. Standardwert: false |
| AusblendenLieferzeit | Boolean | Kennzeichnung, die angibt, ob die Lieferzeit ausgeblendet werden soll. Standardwert: false |
| AusgeblendetQuantitySelector | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Menge Feld. Standardwert: false |
| AusgeblendetSaveAsDraft | Boolean | Kennzeichnung, die angibt, ob ausgeblendet werden soll Als Entwurf speichern Schaltfläche. Standardwert: false |
| AusgeblendetSP | Boolean | Kennzeichnung, die angibt, ob ein Element in ausgeblendet werden soll Serviceportal. Standardwert: false |
| ObligatoryAnhang | Boolean | Kennzeichnung, die angibt, ob das Hinzufügen eines Anhangs erforderlich ist, um eine Anforderung zu übermitteln. Standardwert: false |
| AusblendenAnhang | Boolean | Kennzeichnung, die angibt, ob der Anhangsabschnitt ausgeblendet werden soll und das Hinzufügen von Anhängen nicht unterstützt wird. Standardwert: false |
| Zulässige Bearbeitung | Boolean | Kennzeichnung, die angibt, ob Anwender den erstellten Datensatz nach der Übermittlung bearbeiten können. Standardwert: false |
| Abbrechen möglich | Boolean | Kennzeichnung, die angibt, ob im Formular „Datensatzersteller“ eine Schaltfläche „Abbrechen“ angezeigt werden soll. Anwender können „Abbrechen“ auswählen, um den Datensatzersteller abzubrechen und zum zuletzt angezeigten Bildschirm zurückzukehren. Standardwert: false |
| PostInsertScript | Skript | Ein serverseitiges Skript, das ausgeführt wird, nachdem der Datensatz in die zugehörige Tabelle eingefügt wurde. Sie können anrufen Aktuell.Update() In diesem Skript.Hinweis: Dieses Skript überschreibt die Zieldatensatzwerte und die Vorlagenwerte des Datensatzerstellers. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
Standard: |
| Umleitungs-URL | Zeichenfolge | Das Umleitungsziel, nachdem der Datensatz generiert wurde. Gültige Werte:
Standard: GeneratedRecord |
| SaveOptions | Zeichenfolge | Erweiterte Konfigurationsoptionen zum Speichern des Datensatzerstellers. |
| SaveScript | Skript | Ein Skript, das bei jedem Speichern im Katalog-Generator ausgeführt wird. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
Standard: |
| Skript | Skript | Ein serverseitiges Skript, das ausgeführt wird, bevor der Datensatz erstellt wird. Verwenden Sie dieses Skript, um Feldern im Datensatz dynamisch Werte zuzuweisen. Nicht anrufen Aktuell.Update() Oder current.insert() In diesem Skript.Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
Standard: |
| Bild | Zeichenfolge | Veraltet. Ein Bild für das Element. |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import { CatalogItemRecordProducer } from "@servicenow/sdk/core";
const serviceCatalog = "e0d08b13c3330100c8b837659bba8fb4";
const itServicesCategory = "d258b953c611227a0146101fb1be7c31";
export const comprehensiveIncidentProducer = CatalogItemRecordProducer({
$id: Now.ID["comprehensive_incident_producer"],
name: "Report Incident with Full Configuration",
shortDescription: "Complete incident producer with variables and scripts",
table: "incident",
catalogs: [serviceCatalog],
categories: [itServicesCategory],
variables: {
short_description: SingleLineTextVariable({
question: "Brief Summary",
mandatory: true,
mapToField: true,
field: "short_description",
order: 100
}),
urgency: SelectBoxVariable({
question: "Urgency",
mandatory: true,
mapToField: true,
field: "urgency",
choices: {
"1": { label: "High", sequence: 1 },
"2": { label: "Medium", sequence: 2 },
"3": { label: "Low", sequence: 3 }
},
order: 200
}),
assignment_group: ReferenceVariable({
question: "Assignment Group",
mapToField: true,
field: "assignment_group",
referenceTable: "sys_user_group",
order: 300
})
},
script: Now.include("../../scripts/rp-pre-insert.js"),
postInsertScript: Now.include("../../scripts/rp-post-insert.js"),
redirectUrl: "generatedRecord",
view: "ess",
allowEdit: true
})
KatalogUiRichtlinienobjekt
Konfigurieren Sie eine Katalog-UI-Richtlinie [catalog_ui_Policy], um das Variablenverhalten in Katalogelementformularen basierend auf Bedingungen zu steuern.
Katalog-UI-Richtlinien können Variablen obligatorisch, schreibgeschützt, sichtbar oder ausgeblendet machen, wenn die angegebenen Bedingungen erfüllt sind. Verwenden Sie für Validierung, Berechnungen oder asynchrone Aufrufe stattdessen Katalog-Client-Skripts.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstruktionen. Format: |
| shortDescription | Zeichenfolge | Erforderlich. Eine kurze Beschreibung der Funktion der Katalog-UI-Richtlinie. |
| Katalogelement | Referenz oder Zeichenfolge | Nur erforderlich, wenn VariableSet Eigenschaft wird nicht verwendet. Der Variablenbezeichner von Katalogelement Oder KatalogItemRecordProducer Objekt oder sys_ID des Katalogelements [sc_Cat_item] oder Datensatzerstellers [sc_cat_item_producer], für das die UI-Richtlinie gilt. Weitere Informationen finden Sie unter Katalogelement-Objekt oder CatalogItemRecordProducer-Objekt. |
| VariableSet | Referenz oder Zeichenfolge | Nur erforderlich, wenn Katalogelement Eigenschaft wird nicht verwendet. Der Variablenbezeichner von VariableSet Objekt oder sys_ID des Variablensatzes [item_option_new_set], für den die UI-Richtlinie gilt. Weitere Informationen finden Sie unter VariableSet-Objekt. |
| appliesTo | Zeichenfolge | Der Umfang, für den die UI-Richtlinie gilt. Gültige Werte:
Standard: Element |
| aktiv | Boolean | Kennzeichnung, die angibt, ob die Katalog-UI-Richtlinie aktiv ist. Standardwert: wahr |
| global | Boolean | Kennzeichnung, die angibt, für welche Ansichten der Tabelle die Katalog-UI-Richtlinie ausgeführt wird. Standardwert: wahr |
| ONLOAD | Boolean | Kennzeichnung, die angibt, ob die Katalog-UI-Richtlinie ausgeführt wird, wenn das Formular geladen wird. Bei „falsch“ gilt die Richtlinie nur, wenn sich Variablenwerte ändern. Standardwert: wahr |
| Rückgängig machen IfFalse | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinienaktionen rückgängig gemacht werden sollen, wenn die Katalogbedingung als „falsch“ ausgewertet wird. Standardwert: wahr |
| Übernahme | Boolean | Kennzeichnung, die angibt, ob die Katalog-UI-Richtlinie geerbt wird. Standardwert: false |
| IsolateScript | Boolean | Kennzeichnung, die angibt, ob die Richtlinienskripts in einem isolierten Bereich ausgeführt werden. Standardwert: wahr |
| Katalogbedingung | Zeichenfolge | Die codierten Abfragebedingungen basierend auf Katalogelementvariablen-Werten, die die UI-Richtlinie auslösen. Zum Beispiel: |
| AnwendungOnKatalogItemView | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinie für Katalogelemente gilt, die auf dem Bestellbildschirm angezeigt werden. Diese Ansicht ist für anfordernde Personen verfügbar. Standardwert: wahr |
| AppliesOnTargetRecord | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinie für Datensätze gilt, die über Datensatzersteller für aufgabenerweiterte Tabellen erstellt wurden. Standardwert: false |
| AnwendungenKatalogaufgaben | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinie für Katalogaufgabenformulare gilt. Diese Ansicht ist für Erfüller verfügbar. Standardwert: false |
| AppesOnRequestedItems | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinie für Formulare für angeforderte Elemente gilt. Diese Ansicht ist für Erfüller verfügbar. Standardwert: false |
| Ausgeführte Skripts | Boolean | Kennzeichnung, die angibt, ob ausgeführt werden soll ExecuteIfTrue Und ExecuteIfFalse Skripts für diese UI-Richtlinie. Verwenden Sie Skripts, um Verhalten anzuwenden, die über schreibgeschützt, obligatorisch oder sichtbar hinausgehen, z. B. die Ausrichtung auf eine bestimmte Rolle. Standardwert: false |
| ExecuteIfTrue | Zeichenfolge | Ein clientseitiges Skript, das ausgeführt wird, wenn die Katalogbedingung als „wahr“ ausgewertet wird. Das Skript muss in einen eingeschlossen werden Funktion onCondition() {} Funktion. |
| ExecuteIfFalse | Zeichenfolge | Ein clientseitiges Skript, das ausgeführt wird, wenn die Katalogbedingung als „falsch“ ausgewertet wird. Das Skript muss in einen eingeschlossen werden Funktion onCondition() {} Funktion. |
| RunScriptsInUiType | Zeichenfolge | Der UI-Typ, auf dem die Richtlinienskripts ausgeführt werden. Gültige Werte:
Standard: Desktop |
| Vaunterstützt | Boolean | Kennzeichnung, die angibt, ob die UI-Richtlinie in Virtual Agent-Konversationen unterstützt wird. Standardwert: false |
| actions | Array | Eine Liste von Variablenaktionen, die ausgeführt werden sollen, wenn die Katalogbedingung erfüllt ist. Weitere Informationen finden Sie unter Aktionsarray. |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import { CatalogUiPolicy } from "@servicenow/sdk/core";
import { hardwareRequestItem } from "./catalog-items/HardwareRequest.now";
export const managerApprovalPolicy = CatalogUiPolicy({
$id: Now.ID["manager_approval_policy"],
shortDescription: "Show manager approval when high priority selected",
catalogItem: hardwareRequestItem,
catalogCondition: `${hardwareRequestItem.variables.priority}=high^EQ`,
actions: [
{
variableName: hardwareRequestItem.variables.manager_approval,
visible: true,
mandatory: true
}
]
})
Aktionsarray
Konfigurieren Sie die Variablenaktionen [catalog_ui_policy_action], die eine Katalog-UI-Richtlinie für Variablen ausführt, wenn ihre Bedingungen erfüllt sind.
Jede Aktion im Array gibt eine Variable an, und die Eigenschaft ändert sich so, dass sie auf diese Variable angewendet wird, wenn die UI-Richtlinienbedingung als „wahr“ ausgewertet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| variableName | Zeichenfolge | Erforderlich. Die Variable, für die die Aktion gilt. |
| Sichtbar | Boolean | Kennzeichnung, die angibt, ob die Variable sichtbar gemacht werden soll. Standardwert: false |
| deaktiviert | Boolean | Kennzeichnung, die angibt, ob die Variable deaktiviert werden soll. Standardwert: false |
| Obligatorisch | Boolean | Kennzeichnung, die angibt, ob die Variable erforderlich gemacht werden soll. Standardwert: false |
| Gelöscht | Boolean | Kennzeichnung, die angibt, ob der Variablenwert gelöscht werden soll, wenn die Bedingung erfüllt ist. Standardwert: false |
| VariableMessage | Zeichenfolge | Eine Nachricht, die in der Variable angezeigt werden soll, wenn die Bedingung erfüllt ist. Diese Eigenschaft gilt nur, wenn VariableMessageType Eigenschaft hat einen Wert. |
| VariableMessageType | Zeichenfolge | Der Typ der Feldnachricht. Gültige Werte:
|
| Wert | Zeichenfolge | Der Wert, der für die Variable festgelegt werden soll, wenn die Bedingung erfüllt ist. Diese Eigenschaft gilt nur, wenn WertAktion Eigenschaft ist auf festgelegt |
| WertAktion | Zeichenfolge | Die Aktion, die für den Variablenwert ausgeführt werden soll, wenn die Bedingung erfüllt ist. Gültige Werte:
|
| Reihenfolge | Nummer | Die Reihenfolge, in der die Aktion relativ zu anderen Aktionen ausgewertet wird. Standard: 100 |
| Monatlich | Boolean | Kennzeichnung, die angibt, ob die Variable schreibgeschützt werden soll. Standardwert: false |
actions: [
{
variableName: laptopRequest.variables.justification,
mandatory: true,
variableMessage: "Justification required for urgent requests",
variableMessageType: "info",
order: 100
},
{
variableName: laptopRequest.variables.manager_approval,
visible: true,
mandatory: true,
order: 200
},
{
variableName: laptopRequest.variables.delivery_date,
visible: true,
order: 300
}
]
KatalogClientScript-Objekt
Konfigurieren Sie ein Katalog-Client-Skript [catalog_script_Client], das auf der Clientseite ausgeführt wird, um das Verhalten eines Katalogelementformulars zu steuern.
Verwenden Sie Katalog-Client-Skripts, um Anwendereingaben zu validieren, Felder automatisch auszufüllen oder Warnungen in Katalogelementformularen anzuzeigen. Verwenden Sie stattdessen Katalog-UI-Richtlinien für einfache ein-/Ausblenden-, obligatorische und schreibgeschützte Logik.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstruktionen. Format: |
| Name | Zeichenfolge | Erforderlich. Ein eindeutiger Name für das Katalog-Client-Skript. |
| Skript | Skript | Das clientseitige Skript, das im Katalogelementformular ausgeführt werden soll. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
|
| Typ | Zeichenfolge | Das Ereignis, das die Ausführung des Client-Skripts auslöst. Gültige Werte:
|
| UiType | Zeichenfolge | Der UI-Typ, auf dem das Client-Skript ausgeführt wird. Gültige Werte:
Standard: Desktop |
| aktiv | Boolean | Kennzeichnung, die angibt, ob das Client-Skript aktiviert ist. Standardwert: wahr |
| appliesTo | Zeichenfolge | Erforderlich, wenn verwendet wird VariableSet Eigenschaft. Der Umfang, für den das Katalog-Client-Skript gilt. Gültige Werte:
Standard: Element |
| Katalogelement | Referenz oder Zeichenfolge | Nur erforderlich, wenn VariableSet Eigenschaft wird nicht verwendet. Der Variablenbezeichner von Katalogelement Oder KatalogItemRecordProducer Objekt oder sys_ID des Katalogelements [sc_Cat_item] oder Datensatzerstellers [sc_cat_item_producer], für das das Client-Skript gilt. Weitere Informationen finden Sie unter Katalogelement-Objekt oder CatalogItemRecordProducer-Objekt. |
| VariableSet | Referenz oder Zeichenfolge | Nur erforderlich, wenn Katalogelement Eigenschaft wird nicht verwendet. Der Variablenbezeichner von VariableSet Objekt oder sys_ID des Variablensatzes [item_option_new_set], für den die UI-Richtlinie gilt. Weitere Informationen finden Sie unter VariableSet-Objekt. |
| variableName | Zeichenfolge | Erforderlich, wenn der Wert von Typ Eigenschaft ist OnChange . Der Name der Katalogvariablen, die das Skript auslöst, wenn sich ihr Wert ändert. |
| AnwendungOnKatalogItemView | Boolean | Kennzeichnung, die angibt, ob das Client-Skript für Katalogelemente gilt, die auf dem Bestellbildschirm des Servicekatalogs angezeigt werden. Diese Ansicht ist für anfordernde Personen verfügbar. Standardwert: wahr |
| AppesOnRequestedItems | Boolean | Kennzeichnung, die angibt, ob das Client-Skript für Formulare für angeforderte Elemente gilt, nachdem das Element angefordert wurde. Diese Ansicht ist für Erfüller verfügbar. Standardwert: false |
| AnwendungenKatalogaufgaben | Boolean | Kennzeichnung, die angibt, ob das Client-Skript für Katalogaufgabenformulare für das Element gilt. Diese Ansicht ist für Erfüller verfügbar. Standardwert: false |
| AppliesOnTargetRecord | Boolean | Kennzeichnung, die angibt, ob das Clientskript für Datensätze gilt, die über Datensatzersteller für aufgabenerweiterte Tabellen erstellt wurden. Standardwert: false |
| global | Boolean | Kennzeichnung, die angibt, ob das Client-Skript im globalen Bereich ausgeführt wird. Standardwert: wahr |
| Vaunterstützt | Boolean | Kennzeichnung, die angibt, ob das Clientskript in Virtual Agent-Konversationen unterstützt wird. Standardwert: false |
| PublishedRef | Zeichenfolge | Die sys_ID eines veröffentlichten Katalogelements [sc_Cat_item] oder Datensatzerstellers [sc_cat_item_producer], auf das dieses Clientskript verweist. |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import { CatalogClientScript } from "@servicenow/sdk/core";
import { laptopRequest } from "../catalog-items/laptop-request.now";
CatalogClientScript({
$id: Now.ID["laptop_onload"],
name: "Laptop Request - OnLoad",
script: Now.include("../../client/laptop-onload.js"),
type: "onLoad",
catalogItem: laptopRequest,
active: true,
appliesOnCatalogItemView: true
});
function onLoad() {
// Set initial field states
g_form.setReadOnly("estimated_cost", true);
g_form.setValue("estimated_cost", "$0");
g_form.setMandatory("justification", true);
}VariableSet-Objekt
Erstellen Sie einen Variablensatz [item_option_new_set], der wiederverwendbare Variablen zur Verwendung für mehrere Katalogelemente und Datensatzersteller gruppiert.
Variablensätze sind wiederverwendbare Sammlungen von Variablen, die an Katalogelemente und Datensatzersteller angehängt werden können. Katalog-UI-Richtlinien und Client-Skripts können durch Festlegen von auf einen Variablensatz festgelegt werden Anwendungzu Eigenschaft bis Festgelegt .
- Variablensätze innerhalb eines Katalogelements dürfen nicht denselben internen Namen haben.
- Innerhalb eines Katalogelements darf der Name einer Variable nicht mit dem Titel oder internen Namen eines Variablensatzes übereinstimmen.
- Katalog-Client-Skripts und Katalog-UI-Richtlinienskripts müssen sich auf den internen Namen eines Variablensatzes beziehen, nicht auf den Titel oder Anzeigenamen.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstruktionen. Format: |
| Titel | Zeichenfolge | Erforderlich. Der Anzeigentitel des Variablensatzes. Dieser Titel wird nur angezeigt, wenn DisplayTitle Eigenschaft ist auf „wahr“ festgelegt. |
| internalName | Zeichenfolge | Der interne Name des Variablensatzes, der für den programmatischen Zugriff über verwendet wird G_Form API- und serverseitige Skripts. Wenn nicht angegeben, wird der interne Name automatisch aus generiert Titel Eigenschaft. |
| Beschreibung | Zeichenfolge | Eine Beschreibung des Variablensatzes und seiner beabsichtigten Verwendung. |
| Typ | Zeichenfolge | Der Typ des Variablensatzes. Gültige Werte:
Standard: SingleRow |
| Layout | Zeichenfolge | Das Spaltenlayout für den Variablensatz. Gültige Werte:
Standard: Normal |
| Reihenfolge | Nummer | Die Reihenfolge, in der ein Variablensatz relativ zu anderen Variablensätzen im Formular angezeigt wird. Standard: 100 |
| DisplayTitle | Boolean | Kennzeichnung, die angibt, ob ein reduzierbarer Abschnittsheader für den Variablensatz angezeigt werden soll. Bei „wahr“ ist der Wert von Titel Eigenschaft wird als reduzierbarer Header angezeigt. Hinweis: Kontrollkästchen-Variablen werden unter dem Standardtitel „Optionen“ gruppiert. Um einen anwenderdefinierten Titel zu verwenden, fügen Sie eine Bezeichnungsvariable mit hinzu Reihenfolge Wert, der ihn direkt über den Kontrollkästchen-Variablen platziert. Standardwert: false |
| Attribute festlegen | Zeichenfolge | Zusätzliche Konfigurationsattribute für die Variable als kommagetrennte Zeichenfolge festgelegt, z. B. max_rows=10,Redusible=wahr . Verwenden Sie max_rows Attribut zum Festlegen der maximalen Anzahl von Zeilen für einen mehrzeiligen Variablensatz.Hinweis: Anhangvariable , ContainerVariable , HtmlVariable , Und Anwenderdefinierte Variable Typen werden in mehrzeiligen Variablensätzen nicht unterstützt. |
| ReadRoles | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder sys_IDs von Rollen [sys_user_role], die den Variablensatz anzeigen können. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. |
| WriteRoles | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder sys_IDs von Rollen [sys_user_role], die Variablenwerte im Satz ändern können. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. |
| CreateRoles | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder sys_IDs von Rollen [sys_user_role], die Zeileninstanzen erstellen können. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. Diese Eigenschaft gilt nur, wenn der Wert von Typ Eigenschaft ist |
| variables | Objekt | Die Variablendefinitionen für das Element, die Optionen für die Anforderung bereitstellen. Jeder Variablentyp hat eine bestimmte Funktion. Zum Beispiel:Allgemeine Informationen zu Katalogvariablen finden Sie unter Service catalog variables. |
| Name | Zeichenfolge | Ein optionaler Name für die zusätzliche Identifizierung des Variablensatzes. |
| Version | Nummer | Die Version des Variablensatzes. Standard: 0 |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import {
VariableSet,
EmailVariable,
SingleLineTextVariable,
ReferenceVariable
} from "@servicenow/sdk/core";
export const contactInfoSet = VariableSet({
$id: Now.ID["contact_info_set"],
title: "Contact Information",
description: "Standard contact information fields",
type: "singleRow",
layout: "2across",
order: 100,
displayTitle: true,
variables: {
email: EmailVariable({
question: "Email Address",
mandatory: true,
order: 100
}),
phone: SingleLineTextVariable({
question: "Phone Number",
mandatory: true,
order: 200
}),
department: ReferenceVariable({
question: "Department",
referenceTable: "cmn_department",
referenceQualCondition: "active=true",
order: 300
})
}
})