CatCategory : dans le champ d’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture

    • L’API CatCategory fournit des méthodes qui vous permettent de créer et de modifier des catégories de catalogue de services à l’aide de scripts.

    Cette API s’exécute dans l’espace de noms sn_sc .

    Important :
    Cette API est accessible ; toutefois, l’implémentation recommandée est l’API REST de Catalogue de services.

    CatCategory : availableForUserCriteria(action de chaîne, tableau criteriaIDs)

    Ajoute les Available For critères d’utilisateur à la catégorie de catalogue actuelle.

    Tableau 1. Paramètres
    Nom Type Description
    action Chaîne Action à effectuer.
    • add : ajoute les critères d’utilisateur à la liste Disponible pour .
    • supprimer : supprime les critères d’utilisateur de la liste Disponible pour .
    critèresID Tableau Tableau des critères d’utilisateur sys_ids.
    Tableau 2. Renvoie
    Type Description
    nul 
    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
item.availableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

    CatCategory : canView(Boolean isMobile, String userSysId)

    Détermine si un utilisateur spécifié peut afficher une catégorie spécifiée sur un appareil mobile ou un ordinateur de bureau.

    Tableau 3. Paramètres
    Nom Type Description
    isMobile Booléen Marqueur indiquant s’il faut vérifier l’utilisateur pour l’accès sur un appareil mobile ou un ordinateur de bureau.
    • vrai : valide pour mobile.
    • faux : valider pour le bureau.
    userSysId Chaîne Sys_id de l’utilisateur à valider.
    Tableau 4. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’utilisateur peut afficher la catégorie associée.
    • vrai : l’utilisateur peut afficher la catégorie.
    • faux : l’utilisateur ne peut pas afficher la catégorie.
    		 
    var scopedCategoryObj = new sn_sc.CatCategory('7b1262b9530033007444ddeeff7b12ae');
scopedCategoryObj.canView(false, '62826bf03710200044e0bfc8bcbe5df1');

    CatCategory : create(Boolean standardUpdate)

    Insérez la catégorie définie.

    Tableau 5. Paramètres
    Nom Type Description
    Mise à jour standard Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activer les moteurs et le workflow.
    • faux : n’activez pas les moteurs et le workflow.
    Tableau 6. Renvoie
    Type Description
    Chaîne Sys_id de l’enregistrement de variable insérée. 
    var categoryCreate = new sn_sc.CatCategory();
categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
var categorySysId = categoryCreate.create();
var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

    CatCategory : deleteRecord(Boolean standardUpdate)

    Supprime l’enregistrement de catégorie sur lequel la classe CatCategory a été initialement instanciée.

    Tableau 7. Paramètres
    Nom Type Description
    Mise à jour standard Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activer les moteurs et le workflow.
    • faux : n’activez pas les moteurs et le workflow.
    Tableau 8. Renvoie
    Type Description
    nul 
    var categoryDelete = new sn_sc.CatCategory(categorySysId);
categoryDelete.deleteRecord();
var category = new sn_sc.CatCategory(categorySysId);
values = category.read({"title" : "", "sc_catalog":""}, false);
global.Assert.assertEquals("", values.title,"Category should title");

    CatCategory : getID()

    Renvoie le sys_id de la catégorie actuelle.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Sys_id de la catégorie actuelle.

    Exemple :

    var cart = new sn_sc.CatCategory("2809952237b1300054b6a3549dbe5dd4");
var categoryID = cart.getID();
gs.info(categoryID);

    Sortie :

    2809952237b1300054b6a3549dbe5dd4

    CatCategory : notAvailableForUserCriteria(action de chaîne, Array[] criteriaIDs)

    Ajoute les Not Available For critères d’utilisateur à une catégorie de catalogue.

    Tableau 11. Paramètres
    Nom Type Description
    action Chaîne Action à effectuer.
    • add : ajoute les critères d’utilisateur à la liste Non disponible pour .
    • supprimer : supprime les critères d’utilisateur de la liste Non disponible pour .
    Tableau 12. Renvoie
    Type Description
    nul 
    var item = new sn_sc.CatCategory("31bea3d53790200044e0bfc8bcbe5dec");
item. notAvailableForUserCriteria("add", ["0c441abbc6112275000025157c651c89"]);

    CatCategory : read(colonnes d’objets, booléen standardUpdate)

    Renvoie un mappage de la catégorie.

    Tableau 13. Paramètres
    Nom Type Description
    colonnes Objet Ensemble de colonnes pour lesquelles vous souhaitez obtenir les valeurs.
    Mise à jour standard Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activer les moteurs et le workflow.
    • faux : n’activez pas les moteurs et le workflow.
    Tableau 14. Renvoie
    Type Description
    Objet Mappage des noms de colonnes aux valeurs. 
    var category = new sn_sc.CatCategory("a96277509f300200b407b89a442e704e");
var values = category.read({"title" : ""}, true);
gs.log(values.title);

    CatCategory : setAttributes(attributs d’objet)

    Définit les valeurs d’attribut pour cette catégorie.

    Tableau 15. Paramètres
    Nom Type Description
    attributs Objet Attributs pour les nouvelles paires de valeurs et de champs.
    Tableau 16. Renvoie
    Type Description
    nul 
    var categoryCreate = new sn_sc.CatCategory();
categoryCreate.setAttributes({"title" : "test a scoped category", "sc_catalog" : "e0d08b13c3330100c8b837659bba8fb4"});
var categorySysId = categoryCreate.create();
var isValidSysId = categorySysId.match(/^[0-9a-fA-F]{32}$/) == null ? false : true;
global.Assert.assertEquals(true, isValidSysId,"CategorySysId: ["+ categorySysId +"] is not valid", true, isValidSysId);

    CatCategory : setTableName(String tableName)

    Définit le nom de table pour cette catégorie.

    Tableau 17. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table qui étend sc_category.
    Tableau 18. Renvoie
    Type Description
    nul 
    var categoryRead = new sn_sc.CatCategory(categorySysId);
categoryRead.setTableName("test_category");
var values = categoryRead.read({"title" : "", "sc_catalog":"", "test": ""}, false);
gs.info(categorySysId);
gs.info(values.title);
gs.info(values.test);
global.Assert.assertEquals("testValue", values.test,"Category extends sc_category and stores its extended value");

    CatCategory : update(Object, columnValues, booléen, standardUpdate)

    Met à jour la catégorie actuelle avec les paires nom-valeur spécifiées.

    Tableau 19. Paramètres
    Nom Type Description
    columnValues Objet Mappage des noms de colonnes aux valeurs.
    Mise à jour standard Booléen Marqueur indiquant s’il faut activer l’exécution des moteurs et du workflow.
    Valeurs valides :
    • true : activer les moteurs et le workflow.
    • faux : n’activez pas les moteurs et le workflow.
    Tableau 20. Renvoie
    Type Description
    nul 
    var categoryUpdate = new sn_sc.CatCategory(categorySysId);
categoryUpdate.update({"title" : "test changed scoped category"}, true);
values = categoryUpdate.read({"title" : "", "sc_catalog":""}, false);
global.Assert.assertEquals("test changed scoped category", values.title,"Category should title");