Fonctions JavaScript prédéfinies

CA Service Catalog fournit plusieurs options permettant d'effectuer des tâches automatisées pour des champs de formulaires, y compris les objets de données de rapport, les expressions et les fonctions JavaScript. Cette rubrique répertorie les fonctions JavaScript prédéfinies et présente les modalités d'utilisation possibles d'automatisation des tâches dans des champs.

Pour spécifier les valeurs des opérandes utilisées dans plusieurs fonctions JavaScript prédéfinies, procédez comme suit. Pour la plupart des fonctions, les deux premiers opérandes de la liste suivante sont requis ; les autres sont facultatives. Pour obtenir les opérandes qui s'appliquent à fonction spécifique, vérifiez sa syntaxe.

• Pour formId, indiquez la valeur de l'attribut _id du formulaire sur lequel vous voulez exécuter la fonction.
• Indiquez la valeur de l'attribut _id de l'élément de ce formulaire pour lequel vous voulez exécuter la fonction.
• Indiquez les valeurs des attributs de nom, de valeur et d'index de l'élément sur lequel la fonction est exécutée.
• D'autres opérandes sont cités (par ex. applicable) pour des fonctions spécifiques. Par exemple, l'attribut Index s'applique uniquement à certains éléments (par ex. : un groupe de sélection).

_.serviceoption.status( )

Renvoie le statut de l'élément de ligne auquel le formulaire en cours appartient. Utilisez cette fonction pour spécifier des attributs de formulaire de façon dynamique en fonction du statut de l'élément de ligne. Par exemple, pour masquer certains champs du formulaire lorsque leur statut de ligne est défini sur Terminé, définissez l'attribut Masqué comme suit : _.serviceoption.status() == 200.

Remarque : Vous pouvez également utiliser cette fonction pour masquer ou désactiver un élément d'option de service. Pour ce faire, utilisez cette fonction dans la zone de texte masquée ou désactivée.

De même, cette fonction est particulièrement utile pour le statut Mettre en attente/Reprendre. Dans les deux cas, vous pouvez en expliquer les raisons dans des messages.

Remarque : Cette fonction ne requiert aucun paramètre.

ca_fdDoFieldLookup(fieldId, reportId),

Exécute l'objet de données de rapport, l'associe au champ de recherche et copie les données renvoyées par l'objet de données dans les champs correspondants du formulaire. Vous pouvez effectuer ces actions pour renseigner des champs, en fonction des données saisies par l'utilisateur dans un objet de données de rapport.

Pour fieldId, spécifiez la valeur de l'attribut _id du champ de consultation.

Pour reportId, indiquez la valeur de l'objet de données que vous avez créé précédemment.

ca_reportQuery(reportId, variables, onSuccess, onFailure)

Exécute un objet de données de rapport (objet de données) qui interroge la source de données (par ex. : la MDB) pour rechercher des données que vous spécifiez et renvoie les résultats.

• Pour reportId, indiquez l'objet de données que vous voulez interroger.
• Pour les variables, spécifiez la correspondance JavaScript avec les noms des variables et les valeurs. Par exemple : {var1":"foo","var2":"bar","var3":_.user.id}. Ces variables correspondent à celles que vous interrogez dans l'objet de données de rapport.
• Pour onSuccess, indiquez la fonction JavaScript à exécuter lorsque la demande renvoie les données qui conviennent. La fonction onSuccess doit comprendre un opérande. Cet opérande est défini avec un tableau de correspondances, chacune représentant une ligne, renvoyée par la requête.
• Pour onFailure, spécifiez la fonction JavaScript à exécuter en cas d'échec de l'appel.

Vous pouvez préremplir des champs sur la base d'un objet de données de rapport et de fonctions JavaScript.

ca_fdValidateCC(numéro de carte de crédit, type de carte de crédit)

Valide le format d'un numéro de carte de crédit saisi par l'utilisateur dans un formulaire que vous avez créé.

ca_fdShowField(formId, _id)

S'applique à un seul champ.

Permet de rechercher le formulaire (formId) et le champ (_id) spécifiés. De même, il rend ce champ visible, s'il ne l'est pas déjà.

ca_fdShowFields(formId, _ids)

S'applique à plusieurs champs.

Permet de rechercher le formulaire (formId) et le champ (_ids) spécifiés. De même, il rend ces champs visibles, s'ils ne le sont pas déjà.

Le deuxième paramètre est un tableau contenant les _ids de plusieurs champs sur le formulaire, tel qu'illustré dans l'exemple pour ca_fdHideFields(formId, _ids).

ca_fdHideField(formId, _id)

S'applique à un seul champ.

Permet de rechercher le formulaire (formId) et le champ (_id) spécifiés. De même, il permet de masquer ce champ, s'il ne l'est pas déjà.

ca_fdHideFields(formId, _ids)

S'applique à plusieurs champs.

Permet de rechercher le formulaire (formId) et les champs (_ids) spécifiés. De même, il permet de masquer les champs, s'ils ne le sont pas déjà.

Le deuxième paramètre est un tableau contenant les _ids de plusieurs champs sur le formulaire. Par exemple, vous voulez masquer les champs Nom et Prénom d'un formulaire. De même, l'ID (_id) du formulaire est name_form et les valeurs de _id des champs sont first_name et last_name. Dans ce cas, utilisez le code suivant :

ca_fdHideFields("name_form", ["first_name","last_name"]

ca_fdDisableField(formId, _id)

S'applique à un seul champ.

Permet de rechercher le formulaire (formId) et le champ (_id) spécifiés. De même, il permet de désactiver le champ, s'il ne l'est pas déjà.

ca_fdDisableFields(formId, _ids)

S'applique à plusieurs champs.

Permet de rechercher le formulaire (formId) et les champs (_ids) spécifiés. De même, il permet de désactiver les champs, s'ils ne le sont pas déjà.

Le deuxième paramètre est un tableau contenant les _ids de plusieurs champs sur le formulaire, tel qu'illustré dans l'exemple pour ca_fdHideFields(formId, _ids).

ca_fdEnableField(formId, _id)

S'applique à un seul champ.

Permet de rechercher le formulaire (formId) et le champ (_id) spécifiés. De même, il permet d'activer le champ, s'il ne l'est pas déjà.

ca_fdEnableFields(formId, _ids)

S'applique à plusieurs champs.

Permet de rechercher le formulaire (formId) et les champs (_ids) spécifiés. De même, il permet d'activer les champs, s'ils ne le sont pas déjà.

Le deuxième paramètre est un tableau contenant les _ids de plusieurs champs sur le formulaire, tel qu'illustré dans l'exemple pour ca_fdHideFields(formId, _ids).

ca_fdSelectOption(formId, _id, name, value) et ca_fdSelectOptionByIndex(formId, _id, index)

Pour sélectionner une valeur dans une boîte de sélection à l'aide d'un programme, vous pouvez utiliser l'une de ces fonctions. Ces fonctions produisent le même effet et diffèrent uniquement par leur nom :

• ca_fdSelectOption : permet de sélectionner l'option avec l'attribut _id, le nom et la valeur spécifiés dans le champ de sélection.
• ca_fdSelectOptionByIndex : permet de sélectionner l'option avec l'attribut _id et la valeur d'index spécifiés dans le champ de sélection.

Considérez les exemples suivants :

Exemple 1

Dans cet exemple, la première option de la boîte de sélection est sélectionnée. Cet exemple utilise les valeurs suivantes :

• Attribut _id du formulaire : form_id
• Attribut _id de la boîte de sélection : memory_select

  ca_fdSelectOption(‘form_id’, ‘memory_select’, 1) :
  

Exemple 2

Dans cet exemple, la première option de la boîte de sélection du formulaire en cours est sélectionnée. Cet exemple utilise les valeurs suivantes :

• Attribut de _id du formulaire : ca_fd.formId
• Attribut _id de la boîte de sélection : memory_select

  ca_fdSelectOption(ca_fd.formId, ‘memory_select’, 1) :
  

Si la boîte de sélection spécifiée est introuvable, l'appel sera ignoré et aucune erreur ne sera signalée.

Exemple 3

Vous pouvez récrire les exemples précédents avec des valeurs explicites pour les options, comme suit :

ca_fdSelectOption(‘form_id’, ‘memory_select’, ‘option1’, ‘option1_value’), ca_fdSelectOption(ca_fd.formId, ‘memory_select’, ‘option1’, ‘option1_value’):

option1

Spécifie le nom d'une option tel qu'il apparaît dans l'arborescence du concepteur de formulaires. La valeur de cette option est option1_value.

ca_fdUnselectOption(formId, _id, name, value)

Permet de désélectionner l'option possédant le nom et la valeur indiqués dans le champ de sélection comportant l'attribut _id correspondant.

ca_fdUnselectOptionByIndex(formId, _id, index)

Permet de désélectionner l'option au niveau de l'index correspondant dans le champ de sélection comportant l'attribut _id correspondant.

ca_fdUnselectAllOptions(formId, _id)

Permet de désélectionner toutes les options du champ de sélection avec l'attribut de _id correspondant.

ca_fdGetSelectedOptions(formId, _id)

Renvoie un tableau de nombre entiers indiquant les index des options sélectionnées.

ca_fdGetSelectedOptionValues (formId, _id)

Renvoie un tableau de chaînes indiquant les valeurs des options sélectionnées. Sélectionnez la valeur de la première option comme suit.

ca_fdGetSelectedOptionValues(formId, _id)[0]

Sélectionnez la valeur de la deuxième option en indiquant 1 à la place du 0 ; sélectionnez la valeur de la troisième option en indiquant 2 à la place de 1, et ainsi de suite.

Cette fonction est particulièrement utile pour utiliser les données saisies par l'utilisateur afin de préremplir une boîte de sélection.

ca_fdSelectRadio(formId, name, _id)

Sélectionne le bouton radio possédant l'_id correspondant dans le groupe de boutons radio comportant l'attribut de nom associé.

ca_fdIsSelectRadio (formId, name, _id)

Informe si le bouton radio indiqué est sélectionné.

ca_fdSelectCheckBox(formId,_id)

Sélectionne la case à cocher possédant l'attribut _id correspondant.

ca_fdUnselectCheckBox(formId, _id)

Efface la case à cocher possédant l'attribut _id correspondant.

ca_fdIsSelectedCheckBox(formId,_id)

Indique si la case à cocher sélectionnée est sélectionnée.

ca_fdSetDateFieldValue(formId, _id, date) et les fonctions associées

Définit la valeur du champ de date spécifié avec l'attribut _id correspondant. Cette fonction peut requérir les valeurs Nul(le), Chaîne ou Longs nombres entiers pour le paramètre Date.

Pour effacer la valeur du champ, utilisez une chaîne vide et nul.

Spécifiez les chaînes non vides au format spécifié pour le champ Date/Heure (élément du formulaire) comme suit :

• Si la partie Heure du champ Date/Heure est masquée, spécifiez les chaînes au format de date uniquement. Utilisez l'attribut Format du champ Date/Heure ou le format de date de l'unité business.
• Si la partie Heure du champ Date et Heure est visible, spécifiez les chaînes dans le format de date et d'heure spécifié par ce champ.

Dans les deux cas, séparez les chaînes multiples par un espace.

Les fonctions JavaScript associées pour définir la date sont les suivantes. Le texte précédent pour la fonction ca_fdSetDateFieldValue(formId, le _id, date) s'applique aussi à ces fonctions.

• ca_fdSetDateFieldMinValue(formId, _id, date) - Définit la valeur minimale de la date.
• ca_fdSetDateFieldMaxValue(formId, _id, date) - Définit la valeur maximale de la date.

De plus, pour toutes les fonctions ca_fdSetDateField* JavaScript, vous pouvez définir la date en millisecondes à partir d'epoch, c'est-à-dire l'heure standard de base de minuit (00:00:00) GMT au 1er janvier 1970. Pour plus d'informations sur cette méthode de définition de la date, reportez-vous à la référence votre programmation standard Java, par exemple le site Web d'Oracle (oracle.com).

ca_fdGetDateFieldValue(formId, _id, date) et les fonctions associées

Obtient la valeur du champ de date spécifié sous forme de chaîne formatée d'après le formatage défini pour le champ de date.

Les informations sur le champ Date et Heure pour la fonction précédente (ca_fdSetDateFieldValue(formId, _id, date)) s'appliquent aussi à cette fonction.

Les fonctions JavaScript associées pour obtenir la date sont les suivantes. Le texte précédent pour la fonction ca_fdGetDateFieldValue(formId, le _id, date) s'applique aussi à ces fonctions.

• ca_fdGetDateFieldValueInMillis(formId, _id, date) - Obtient la valeur de la date en millisecondes.
• ca_fdGetDateFieldMinValue(formId, _id, date) - Obtient la valeur minimale de la date.
• ca_fdGetDateFieldMinValueInMillis(formId, _id, date) - Obtient la valeur minimale de la date en millisecondes.
• ca_fdGetDateFieldMaxValue(formId, _id, date) - Obtient la valeur maximale de la date.
• ca_fdGetDateFieldMaxValueInMillis(formId, _id, date) - Obtient la valeur maximale de la date en millisecondes.

De plus, pour toutes les fonctions ca_fdGetDateField* JavaScript, vous pouvez définir la date en millisecondes à partir d'epoch, c'est-à-dire l'heure standard de base de minuit (00:00:00) GMT au 1er janvier 1970. Pour plus d'informations sur cette méthode d'obtention de la date, reportez-vous à la référence de votre programmation standard Java, par exemple le site Web d'Oracle (oracle.com).

ca_fdSetTextFieldValue(formId, _id, text)

Définit le texte du champ de texte possédant l'attribut _id correspondant ; il peut s'agir d'un champ de texte et d'une zone de texte.

ca_fdGetTextFieldValue(formId, _id)

Obtient le texte du champ de texte possédant l'attribut _id correspondant ; il peut s'agir d'un champ de texte et d'une zone de texte.

ca_fdFetchSelectData(formId,_id)

Cette fonction permet à la boîte de sélection ayant le _id spécifié d'extraire à nouveau l'objet de données de rapport. Elle est particulièrement utile lorsque l'objet de données de rapport tient compte des données saisies par l'utilisateur. Il est conseillé d'appeler cette fonction lorsque ces données saisies changent, afin d'assurer que la boîte de sélection affiche les données correctes.

Cette fonction est particulièrement utile pour utiliser les données saisies par l'utilisateur afin de préremplir une boîte de sélection.

Les fonctions suivantes s'appliquent uniquement aux formulaires système.

• custom_onPriorityChange(newPriority)
• custom_onDateRequiredChange(newDateRequired)
• custom_onRequestedForChange(type, id, nom, shippingAddress)