API de table : ServiceNow Fluent
L’API de table définit les tables [sys_db_object] pour stocker les données dans une application.
Créez une table à l’aide de l’objet Table . À partir de la propriété de schéma , ajoutez des objets Column, tels que StringColumn ou IntegerColumn, pour définir les colonnes.
Pour des informations générales sur les tables, reportez-vous à la section Table administration.
Objet de table
Créer une table [sys_db_object] dans une application.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Requis. Nom de la table commençant par le périmètre de l’application et en lettres minuscules au format suivant : <scope>_<name>. Le nom doit correspondre à l’identificateur de variable de l’objet Table . Remarque : Pour ajouter des colonnes à une table existante dans un périmètre de l’application différent, vous pouvez fournir le nom de la table sans le périmètre de l’application suivi de comme n’importe lequel. Les noms de colonnes doivent plutôt commencer par le périmètre de l’application.Longueur maximale : 80 |
| Schéma | Tableau | Requis. Liste d’objets de colonne . Pour plus d'informations, consultez Objet de colonne. |
| Extensions | Chaîne | Nom de toute autre table sur laquelle la table est basée. Étendre une table de base permet d’intégrer tous les champs de la table d’origine et crée des champs système pour la nouvelle table. S’ils se trouvent dans le même champ d’application ou s’ils peuvent être configurés à partir d’autres champs d’application, vous pouvez étendre les tables marquées comme extensibles. |
| étiquette | Chaîne ou tableau | Étiquette unique pour la table dans les vues de liste et de formulaire. Les étiquettes de champ peuvent être fournies sous forme de chaîne ou de tableau d’objets d’étiquette . Pour en savoir plus, consultez Objet d’étiquette. Longueur maximale : 80 Par défaut : la valeur de la propriété name |
| LicensingConfig | Objet | Configuration de la gestion des licences [ua_table_licensing_config] pour une table. Pour plus d'informations, consultez Objet licensingConfig. |
| affichage | Chaîne | Colonne d’affichage par défaut. Utilisez un nom de colonne à partir de la propriété de schéma . |
| extensible | Booléen | Marqueur indiquant si d’autres tables peuvent étendre la table. Valeurs valides :
Le changement de cette propriété de true à false empêche la création de tables enfants supplémentaires, mais les tables enfants existantes restent inchangées. Valeur par défaut : false |
| liveFeed | Booléen | Marqueur indiquant si des flux en direct sont disponibles pour les enregistrements de la table. Valeurs valides :
Valeur par défaut : false |
| accessible depuis | Chaîne | Périmètres de l’application pouvant accéder à la table. Valeurs valides :
Par défaut : public |
| Accès pour l’appelant | Chaîne | Niveau d’accès pour les demandes entre périmètres. Valeurs valides :
Pour plus d'informations, consultez Paramètres du privilège d’accès restreint pour l’appelant. Par défaut : aucun |
| actions | Tableau | Liste des options d’accès. Valeurs valides :
Par défaut : read |
| allowWebServiceAccess | Booléen | Marqueur indiquant si les services Web peuvent effectuer des appels vers la table. Valeurs valides :
Valeur par défaut : false |
| allowNewFields | Booléen | Marqueur indiquant s’il faut autoriser la configuration au moment de la conception de nouveaux champs sur la table à partir d’autres périmètres de l’application. Valeurs valides :
Valeur par défaut : false |
| allowUiActions | Booléen | Marqueur indiquant s’il faut autoriser la configuration au moment de la conception des actions d’interface utilisateur sur la table à partir d’autres périmètres de l’application. Valeurs valides :
Valeur par défaut : false |
| allowClientScripts | Booléen | Marqueur indiquant s’il faut autoriser la configuration au moment de la conception de scripts clients sur la table à partir d’autres périmètres de l’application. Valeurs valides :
Valeur par défaut : false |
| Auditer | Booléen | Marqueur indiquant s’il faut suivre la création, la mise à jour et la suppression de tous les enregistrements de la table. Valeurs valides :
Valeur par défaut : false |
| readOnly | Booléen | Marqueur indiquant si les utilisateurs peuvent modifier les champs dans la table. Valeurs valides :
Valeur par défaut : false |
| index de texte | Booléen | Marqueur indiquant si les moteurs de recherche indexent le texte dans une table. Valeurs valides :
Valeur par défaut : false |
| attributs | Objet | Paires de clés et de valeurs de tous les attributs de dictionnaire pris en charge [sys_schema_attribute]. Par exemple : |
| Index | Tableau | Liste de références de colonnes pour générer des index dans le XML de métadonnées de la table. La valeur de la propriété element doit correspondre à la clé d’objet utilisée avec l’objet Column . Un index de base de données augmente la vitesse d’accès aux données de la table avec le coût de l’utilisation d’un stockage supplémentaire. |
| numérotation automatique | Objet | Configuration de la numérotation automatique [sys_number] pour une table. Pour plus d'informations, consultez Objet autoNumber. |
| scriptableTable | Booléen | Marqueur indiquant si la table est une table distante qui utilise des données récupérées d’une source externe. Pour plus d'informations, consultez Remote tables. Valeurs valides :
Valeur par défaut : false |
) dans l’en-tête du formulaire.Pour la prise en charge de la suggestion automatique pour les colonnes, affectez l’objet Table à une variable exportée portant le même nom que la propriété name.
import { Table, StringColumn } from "@servicenow/sdk/core";
import { myFunction } from "../server/myFunction.js"
export const x_snc_example_to_do = Table({
name: 'x_snc_example_to_do',
label: 'My To Do Table',
extends: 'task',
schema: {
status: StringColumn({ label: 'Status' }),
deadline: StringColumn({
label: 'Deadline',
active: true,
mandatory: false,
readOnly: false,
maxLength: 40,
dropdown: 'none',
attributes: {
updateSync: false,
},
default: 'today',
dynamicValueDefinitions: {
type: 'calculated_value',
calculatedValue: '',
},
choices: {
choice1: {
label: 'Choice1 Label',
sequence: 0,
inactiveOnUpdate: false,
dependentValue: '5',
hint: 'hint',
inactive: false,
language: 'en',
},
choice2: { label: 'Choice2 Label', sequence: 1 },
},
}),
dynamic1: StringColumn({
dynamicValueDefinitions: {
type: 'calculated_value',
calculatedValue: myFunction,
},
}),
dynamic2: StringColumn({
dynamicValueDefinitions: {
type: 'dynamic_default',
dynamicDefault: `gs.info()`,
},
}),
dynamic3: StringColumn({
dynamicValueDefinitions: {
type: 'dependent_field',
columnName: 'status',
},
}),
dynamic4: StringColumn({
dynamicValueDefinitions: {
type: 'choices_from_other_table',
table: 'sc_cat_item',
field: 'display',
},
}),
},
actions: ['create', 'read'],
display: 'deadline',
accessibleFrom: 'package_private',
allowClientScripts: true,
allowNewFields: true,
allowUiActions: true,
allowWebServiceAccess: true,
extensible: true,
liveFeed: true,
callerAccess: 'none',
autoNumber: {
number: 10,
numberOfDigits: 2,
prefix: 'abc',
},
audit: true,
readOnly: true,
textIndex: true,
attributes: {
updateSync: true,
},
index: [
{
name: 'idx',
element: 'status',
unique: true,
},
],
})Objet de colonne
Ajouter une colonne [sys_dictionary] à une table.
Ajoutez des objets Colonne dans la propriété de schéma de l’objetTable .
Il existe de nombreux types de colonnes basées sur le type de champ. Les objets de colonne utilisent le format <Type>Column où <Type> est le type de champ. Pour en savoir plus sur les types de champs, reportez-vous à la section Field types reference.
Les types de colonnes suivants sont pris en charge : ListColumn, RadioColumn, StringColumn, ChoiceColumn, ScriptColumn, BooleanColumn, ConditionsColumn, DecimalColumn, IntegerColumn, VersionColumn, DomainIdColumn, FieldNameColumn, ReferenceColumn, TableNameColumn, UserRolesColumn, BasicImageColumn, DocumentIdColumn, DomainPathColumn, TranslatedTextColumn, SystemClassNameColumn, TranslatedFieldColumn, GenericColumn, DateColumn, DateTimeColumn, CalendarDateTime, BasicDateTimeColumn, DueDateColumn, CalendarDateTime, IntegerDateColumn, ScheduleDateTimeColumn, OtherDateColumn, Password2Column, GuidColumn, JsonColumn, NameValuePairsColumn, UrlColumn, EmailColumn, HTMLColumn, FloatColumn, MultiLineTextColumn, DurationColumn, TimeColumn, FieldListColumn, SlushBucketColumn, TemplateValueColumn et ApprovalRulesColumn.
| Nom | Type | Description |
|---|---|---|
| étiquette | Chaîne ou tableau | Étiquette unique pour la colonne qui apparaît sur les en-têtes de liste et les champs de formulaire. Les étiquettes de champ peuvent être fournies sous forme de chaîne ou de tableau d’objets d’étiquette . Pour en savoir plus, consultez Objet d’étiquette. Par défaut : clé utilisée pour l’objet de colonne |
| maxLength | Numéro | Longueur maximale des valeurs dans la colonne. Une longueur inférieure à 254 apparaît sous la forme d’un champ de texte d’une seule ligne. Tout texte comptant 255 caractères ou plus apparaîtra comme une zone de texte à plusieurs lignes. Remarque : Pour éviter toute perte de données, ne diminuez la longueur d’un champ de chaîne que lorsque vous développez une nouvelle application et non lorsqu’un champ contient des données. Valeur par défaut : varie en fonction du type de colonne |
| actif | Booléen | Marqueur indiquant s’il faut afficher le champ dans les listes et formulaires. Valeurs valides :
Par défaut : true |
| obligatoire | Booléen | Marqueur indiquant si le champ doit contenir une valeur pour enregistrer un enregistrement. Valeurs valides :
Valeur par défaut : false |
| readOnly | Booléen | Marqueur indiquant si vous pouvez modifier la valeur du champ. Valeurs valides :
Valeur par défaut : false |
| readOnlyOption | Chaîne | Contrôlez la possibilité de modifier des champs en lecture seule en configurant des options en lecture seule. Valeurs valides :
Pour plus d'informations, consultez Configuring read-only security options. |
| par défaut | N'importe lequel | Valeur par défaut du champ lors de la création d’un enregistrement. La valeur doit utiliser le type correct en fonction du type de colonne. |
| choix | Objet | Liste de choix [sys_choice] pour une colonne. Pour plus d'informations, consultez Objet de choix. Cette propriété s’applique uniquement aux objets ChoiceColumn et aux types de colonnes qui étendent les colonnes de choix. Elle peut inclure soit un tableau de valeurs primitives, soit une série d’objets de choix. |
| attributs | Objet | Paires de clés et de valeurs de tous les attributs de dictionnaire pris en charge [sys_schema_attribute]. Par exemple : |
| Définition de fonction | Chaîne | Définition d’une fonction exécutée par le champ, telle qu’une opération mathématique, un calcul de longueur de champ ou un calcul du jour de la semaine. Chaque définition commence par Par exemple, la définition de fonction suivante crée un champ qui affiche la description courte, suivie d’un espace, puis du nom de l’appelant : Pour plus d’informations sur les définitions de fonctions, reportez-vous à la section Function field. |
| dynamicValueDefinitions | Objet | Valeurs par défaut qui sont générées dynamiquement en fonction de filtres dynamiques. Fournissez une combinaison d’un type et d’une clé de comportement associée pour spécifier des valeurs par défaut dynamiques. Les types suivants sont pris en charge :
|
| liste déroulante | Chaîne | Une option pour l’affichage d’une liste de choix pour les vues de liste et de formulaire de la table. Cette propriété s’applique uniquement aux objets ChoiceColumn et aux types de colonnes qui étendent les colonnes de choix. Valeurs valides :
Par défaut : aucun |
schema: {
deadline: DateColumn({ label: 'Deadline' }),
state: StringColumn({
label: 'State',
choices: {
ready: { label: 'Ready' },
completed: { label: 'Completed' },
inProgress: { label: 'In Progress' },
}
}),
task: StringColumn({ label: 'Task', maxLength: 120 }),
}schema: {
x_scope_myColumn: StringColumn({...})
}Objet de choix
Configurez les choix [sys_choice] pour une colonne d’une table.
L’objet choices est une propriété de l’objet Column . Utilisez l’objet choices avec les types de colonne pris en charge dans la propriété schema d’un objet Table . Seuls certains types de colonnes étendent le type de colonne de choix (ChoiceColumn) et peuvent inclure des choix.
| Nom | Type | Description |
|---|---|---|
| étiquette | Chaîne | Requis. Le texte à afficher pour le choix dans la liste. |
| dependentValue | Chaîne | Valeur que vous mappez au dependentField dans la propriété dynamicValueDefinitions de l’objet Column . |
| hint | Chaîne | Une brève description du choix qui s’affiche sous forme d’info-bulle lorsque vous le survolez. |
| language | Chaîne | Le code BCP 47 de la langue pour le choix traduit. Par défaut : en |
| séquence | Entier | Ordre dans la liste des choix dans lequel un choix se produit. |
| inactif | Booléen | Marqueur indiquant s’il faut afficher le choix dans la liste. Valeurs valides :
Valeur par défaut : false |
L’objet choices comprend une série d’objets choice, où les noms des choices sont fournis sous forme de clés d’objet associées aux définitions de choices.
choices: {
choice1: {
label: 'Choice1 Label',
sequence: 0,
inactiveOnUpdate: false,
dependentValue: '5',
hint: 'hint',
inactive: false,
language: 'en',
},
choice2: { label: 'Choice2 Label', sequence: 1 },
}Objet d’étiquette
Configurez une étiquette de champ [sys_documentation] pour une table ou une colonne.
L’objet étiquette est une propriété dans les objets Table et Colonne .
| Nom | Type | Description |
|---|---|---|
| language | Chaîne | Code BCP 47 de la langue de l’étiquette de champ. Une langue ne peut avoir qu’une seule étiquette, chaque langue doit donc être unique dans un tableau d’objets d’étiquette . |
| étiquette | Chaîne | Le texte de l’étiquette du champ dans la langue spécifiée. |
| hint | Chaîne | Description brève qui s’affiche sous forme d’info-bulle lorsque vous survolez l’étiquette du champ. |
| aide | Chaîne | Informations supplémentaires sur le champ. Le texte d’aide n’est pas affiché dans les vues de formulaire ou de liste de la table. |
| pluriel | Chaîne | La forme pluriel de l’étiquette de champ. |
| URL | Chaîne | URL d’une page Web fournissant des informations sur le champ. Lorsqu’une URL est fournie, l’étiquette s’affiche sous forme de lien hypertexte. |
| Cible URL | Chaîne | Non utilisé (déconseillé). |
label: [
{
label: 'English description',
language: 'en',
hint: 'Provide a short description'
},
{
label: 'Description de español',
language: 'es'
},
]Objet licensingConfig
Créez une configuration de gestion des licences [ua_table_licensing_config] pour suivre le nombre d’abonnements pour une table.
L’objet licensingConfig est une propriété de l’objet Table . Si cette propriété n’est pas spécifiée, une configuration de gestion des licences par défaut avec licenseModel défini sur aucun est générée pour la table sur l’instance.
| Nom | Type | Description |
|---|---|---|
| licenseModel | Chaîne | Modèle de suivi de l’utilisation des abonnements. Valeurs valides :
Par défaut : aucun |
| licenseRoles | Tableau | Liste des rôles pour lesquels toutes les opérations sur les enregistrements de la table comptent dans l’abonnement. |
| Supprimer | Booléen | Marqueur indiquant si un abonnement est requis pour supprimer les enregistrements des tables avec le modèle producteur. Valeurs valides :
Par défaut : true |
| Insertion op | Booléen | Marqueur indiquant si un abonnement est requis pour insérer des enregistrements pour les tables avec le modèle de créateur. Valeurs valides :
Par défaut : true |
| Mise à jour de l’op | Booléen | Marqueur indiquant si un abonnement est requis pour mettre à jour les enregistrements des tables avec le modèle de créateur.
Par défaut : true |
| Condition de licence | Chaîne | Requête de filtre qui détermine les conditions de comptabilisation des opérations pour un abonnement. Pour le modèle de prestataire, spécifiez l’ensemble de conditions qui déterminent si l’utilisateur connecté est le prestataire de l’enregistrement. Pour le modèle producteur, spécifiez l’ensemble de conditions qui déterminent si les enregistrements sont comptabilisés dans l’abonnement. |
| Condition de propriétaire | Chaîne | Requête de filtre qui détermine si un utilisateur possède un enregistrement pour le modèle de prestataire. |
| isFulfillment | Booléen | Non utilisé (déconseillé). Marqueur indiquant s’il faut interdire les mises à jour par des utilisateurs qui ne sont pas abonnés à l’application. Valeurs valides :
Valeur par défaut : false |
licensingConfig: {
licenseModel: 'fulfiller',
opInsert: false,
licenseRoles: ['admin'],
}Objet autoNumber
Configurez la numérotation automatique [sys_number] pour une table.
L’objet autoNumber est une propriété de l’objet Table . Pour utiliser le nombre dans une table, vous devez créer une colonne numérique, telle que IntegerColumn, qui utilise le nombre comme valeur par défaut.
| Nom | Type | Description |
|---|---|---|
| Préfixe | Chaîne | Préfixe pour chaque numéro d’enregistrement de la table. Par exemple, INC pour Incident. Par défaut : pré |
| Numéro | Entier | Numéro d’enregistrement de base de cette table. Les numéros d’enregistrement sont automatiquement incrémentés et le numéro suivant est conservé dans la table Compteur [sys_number_counter]. Si vous définissez le numéro de base sur une valeur supérieure au compteur actuel, le numéro d’enregistrement suivant utilise le nouveau numéro de base. Sinon, le numéro d’enregistrement suivant utilise le compteur actuel. Le compteur ne se réinitialise pas à un nombre de base inférieur à lui-même. Valeur par défaut : 1 000 |
| nombre de chiffres | Entier | Nombre minimal de chiffres à utiliser après le préfixe. Des zéros non significatifs sont ajoutés aux numéros automatiques, si nécessaire. Par exemple, INC0001001 contient trois zéros non significatifs. Le nombre de chiffres peut dépasser la longueur minimale. Par exemple, si numberOfDigits a la valeur 2 et que plus de 99 enregistrements sont créés sur la table, les nombres continuent au-delà de 100 (par exemple, INC101). Avertissement : La modification de ce champ peut mettre à jour toutes les valeurs numériques des enregistrements existants dans une table. Soyez prudent lorsque vous modifiez ce champ sur une instance de production. Par défaut : 7 |
autoNumber: {
prefix: 'TODO',
number: 2000,
numberOfDigits: 9,
}number: IntegerColumn({
default: 'javascript:getNextObjNumberPadded();'
})