GlideSPScriptable : inclus dans le périmètre

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 17 minutes de lecture
  • Interagissez avec les données et effectuez des opérations d’enregistrement dans Portail de services les widgets.

    Vous accédez aux méthodes GlideSPScriptable à l’aide de l’objet $sp global.

    GlideSPScriptable inclus dans le périmètre : canReadRecord(GlideRecord now_GR)

    Renvoie la valeur true si l’utilisateur peut lire le GlideRecord spécifié.

    Si le type d’enregistrement est kb_knowledge, sc_cat_item ou sc_category, la méthode vérifie si l’utilisateur peut afficher l’élément.

    Tableau 1. Paramètres
    Nom Type Description
    now_GR GlideRecord Le GlideRecord à vérifier.
    Tableau 2. Renvoie
    Type Description
    Booléen True si l’enregistrement est valide et lisible.

    Script serveur

    //Server script
    data.items = [];
    data.userName = gs.getUserDisplayName();
    var now_GR = new GlideRecord("sc_cat_item");
    now_GR.query();
    while(now_GR.next() && data.items.length < 10) {
        if ($sp.canReadRecord(now_GR)) {
        data.items.push(now_GR.getDisplayValue("name"));
        }
    }
    
    //HTML template
    <div class="panel panel-default">
        <div class="panel-heading">Hi, {{c.data.userName}}!</div>
        <div class="panel-body">
            Here are some things you can order:
            <ul><li ng-repeat="item in c.data.items">{{item}}</li></ul>
        </div>
    </div>

    GlideSPScriptable inclus dans le champ d’application : canReadRecord(String table, String sysId)

    Renvoie la valeur true si l’utilisateur peut lire le GlideRecord spécifié.

    Si le type d’enregistrement est kb_knowledge, sc_cat_item ou sc_category, la méthode vérifie si l’utilisateur peut afficher l’élément.

    Tableau 3. Paramètres
    Nom Type Description
    table Chaîne Nom de la table à interroger.
    sysId Chaîne Sys_id de l’enregistrement à interroger.
    Tableau 4. Renvoie
    Type Description
    Booléen True si l’enregistrement est valide et lisible.

    GlideSPScriptable inclus dans le périmètre : canSeePage(String pageID)

    Renvoie la valeur true si l’utilisateur actuellement connecté a l’autorisation d’afficher la page spécifiée.

    Le système détermine l’autorisation à l’aide des rôles et des critères d’utilisateur. Pour plus d’informations, consultez Configurer la sécurité des pages par critèresd’utilisateur et de rôle pour Service Portal.

    Tableau 5. Paramètres
    Nom Type Description
    ID de page Chaîne ID de page de la table Pages [sp_page].
    Tableau 6. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’utilisateur actuellement connecté a les autorisations nécessaires pour afficher la page spécifiée. Les valeurs comprennent :
    • true : l’utilisateur peut afficher la page.
    • false : soit l’utilisateur ne peut pas afficher la page, soit le pageID donné n’est pas valide, soit l’utilisateur n’est pas connecté.

    Cet exemple ajoute une condition à l’élément de menu Connaissances dans le menu d’en-tête du portail de services pour afficher uniquement l’élément de menu aux utilisateurs qui ont l’autorisation d’afficher la page kb_view2.

    GlideSPScriptable.canSeePage("kb_view2")

    GlideSPScriptable inclus dans le périmètre : getCatalogItem(String sysId)

    Renvoie un modèle et un modèle de vue pour un sc_cat_item ou un sc_cat_item_guide.

    Cette méthode est déconseillée. Utilisez plutôt la méthode getCatalogItem(String sysId, Boolean isOrdering). Cette méthode appelle la méthode getCatalogItem(String sysId, Boolean isOrdering) avec le paramètre défini sur false, ce qui signifie que la isOrdering vérification de sécurité des rôles d’écriture est effectuée.

    Cette méthode est un moyen rapide d’obtenir les données nécessaires pour afficher et commander un élément de catalogue à l’aide de &lt;sp-model />. Si vous avez juste besoin qu’un élément de catalogue affiche son image ou son nom, utilisez GlideRecord pour interroger la table sc_cat_item .

    Tableau 7. Paramètres
    Nom Type Description
    sysId Chaîne sys_id de l’élément de catalogue (sc_cat_item) ou du guide de commande (sc_cat_item_guide).
    Tableau 8. Renvoie
    Type Description
    Objet Objet contenant le modèle de variable d’élément de catalogue, la vue, les sections, la tarification et les scripts clients.
    // Server script
    (function() {
        var sys_id = $sp.getParameter("sys_id")
        data.catItem = $sp.getCatalogItem(sys_id);
    })();
    
    // Client script
    function($http, spUtil) {
        var c = this;
        var submitting = false;
        c.getIt = function() {
            if (submitting) return;
            $http.post(spUtil.getURL('sc_cat_item'), c.data.catItem).success(function(response) {
                if (response.answer) {
                    c.req = response.answer;
                    c.req.page = c.req.table == 'sc_request' ? 'sc_request' : 'ticket';
                }
            });
        }
    }
    
    //SCSS
    .img-bg {
        padding: 5px;
        background-color: $brand-primary;
    }
    
    .img-responsive {
        margin: 0 auto;
    }
    
    .cat-icon {
        display: block;
        margin: -40px auto 0;
    }
    
    // HTML template
    <div class="col-sm-4">
      <div class="panel panel-default">
        <div class="img-bg">
          <img ng-src="{{::data.catItem.picture}}" class="img-responsive" />
        </div>
        <span class="cat-icon fa fa-stack fa-lg fa-3x hidden-xs">
          <i class="fa fa-circle fa-stack-2x text-success"></i>
          <i class="fa fa-desktop fa-stack-1x fa-inverse"></i>
        </span>
        <div class="panel-body">
          <p class="lead text-center">{{::data.catItem.name}}</p>
          <ul class="list-unstyled">
            <li class="text-center" ng-if="::data.catItem.price">${Price}: {{::data.catItem.price}}</li>
          </ul>
          <sp-model form-model="::data.catItem" mandatory="mandatory"></sp-model>
          <p ng-if="c.req" class="text-center text-success">
            ${Request created!} <a href="?id={{c.req.page}}&table={{c.req.table}}&sys_id={{c.req.sys_id}}">{{c.req.number}}</a>
          </p>
          <button ng-if="!c.req" class="btn btn-default btn-block" ng-click="c.getIt()">${Get it}</button>
        </div>
      </div>
    </div>

    GlideSPScriptable inclus dans le périmètre : getCatalogItem(String sysId, Boolean isOrdering)

    Renvoie un modèle et un modèle de vue pour un sc_cat_item ou un sc_cat_item_guide.

    Tableau 9. Paramètres
    Nom Type Description
    sysId Chaîne sys_id de l’élément de catalogue (sc_cat_item) ou du guide de commande (sc_cat_item_guide).
    isOrdering (commande en cours) Booléen Si la valeur est vrai, utilise la vérification de sécurité des rôles de création. Si la valeur est définie sur false, elle utilise la vérification de sécurité des rôles d’écriture.

    Lorsque les utilisateurs commandent un élément ou l’ont dans leur panier, vérifiez à l’aide des rôles de création.

    Si les utilisateurs ne commandent pas, par exemple, si quelqu’un examine un élément demandé pour voir les variables associées à cet élément, vérifiez à l’aide des rôles d’écriture.

    Tableau 10. Renvoie
    Type Description
    Objet Objet contenant le modèle de variable d’élément de catalogue, la vue, les sections, la tarification et les scripts clients.

    GlideSPScriptable inclus dans le périmètre : getDisplayValue(String fieldName)

    Renvoie la valeur d’affichage du champ spécifié (s’il existe et possède une valeur) à partir de l’sp_instance du widget ou de l’enregistrement sp_portal .

    Tableau 11. Paramètres
    Nom Type Description
    Fieldname Chaîne Nom du champ
    Tableau 12. Renvoie
    Type Description
    Chaîne Valeur d’affichage de l’enregistrement sp_instance ou sp_portal .
    //Server script
    (function() {
        data.title = $sp.getDisplayValue("title");
        data.catalog = $sp.getDisplayValue("sc_catalog");
    })();
    
    //HTML template
    <div>
        <h1>sp_instance.title: {{::data.title}}</h1>
        <h1>sp_portal.sc_catalog: {{::data.catalog}}</h1>
    </div>

    GlideSPScriptable inclus dans le périmètre : getField(GlideRecord now_GR, String fieldName)

    Renvoie des informations sur le champ spécifié dans le GlideRecord spécifié.

    Tableau 13. Paramètres
    Nom Type Description
    now_GR GlideRecord Le GlideRecord à vérifier
    Fieldname Chaîne Champ pour lequel rechercher des informations
    Tableau 14. Renvoie
    Type Description
    Objet Objet contenant l’étiquette, la valeur, la valeur displayValue et le type du champ. Renvoie null si le GlideRecord du nom de champ n’est pas valide ou si le champ n’est pas lisible.

    GlideSPScriptable inclus dans le périmètre : getFields(GlideRecord now_GR, String fieldNames)

    Vérifie la liste spécifiée de noms de champs et renvoie un tableau de noms de champs valides.

    Tableau 15. Paramètres
    Nom Type Description
    now_GR GlideRecord Le GlideRecord à vérifier
    Noms des champs Chaîne Liste de noms de champs séparés par des virgules.
    Tableau 16. Renvoie
    Type Description
    Tableau Tableau de champs valides.

    GlideSPScriptable inclus dans le périmètre : getFieldsObject(GlideRecord now_GR, chaîne fieldNames)

    Vérifie la liste spécifiée de noms de champs et renvoie un objet de noms de champs valides.

    Tableau 17. Paramètres
    Nom Type Description
    now_GR GlideRecord Le GlideRecord à vérifier
    Noms des champs Chaîne Liste de noms de champs séparés par des virgules.
    Tableau 18. Renvoie
    Type Description
    Objet Un objet contenant des noms de champs valides.

    GlideSPScriptable inclus dans le champ d’application : getForm(String tableName, String sysId)

    Renvoyer le formulaire.

    Tableau 19. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table
    sysId Chaîne L’sys_id du formulaire
    Tableau 20. Renvoie
    Type Description
    Objet Le formulaire

    GlideSPScriptable inclus dans le champ d’application : getKBCategoryArticles(String sys_id, Number limit)

    Renvoie les articles de la base de connaissances dans la catégorie spécifiée et ses sous-catégories.

    Pour éviter des problèmes de performances, n’utilisez pas cette méthode pour renvoyer des articles de grandes catégories ou des articles avec des images en ligne. Utilisez plutôt getKBArticleSummaries().

    Tableau 21. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id de la catégorie d’article de la base de connaissances.
    limite Numéro Nombre maximal d’articles de la base de connaissances renvoyés.
    Tableau 22. Renvoie
    Type Description
    Tableau Les articles de la catégorie et de ses sous-catégories avec :
    • Un workflow_state de publié.
    • Date de valid_to supérieure ou égale à la date actuelle.
    //Server script 
    (function() {
        data.kbs = $sp.getKBCategoryArticles("0ac1bf8bff0221009b20ffffffffffec", 5);
    })();
    
    //HTML template
    <div>
    articles: {{::data.kbs}}
    </div>
    

    GlideSPScriptable inclus dans le champ d’application : getKBCategoryArticleSummaries(String sys_id, Number limit, Number maxChars)

    Renvoie les résumés des articles de la base de connaissances dans la catégorie spécifiée et ses sous-catégories.

    Tableau 23. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id de la catégorie d’article de la base de connaissances.
    limite Numéro Nombre maximal d’articles de la base de connaissances renvoyés.
    Caractères maxChars Numéro Nombre maximum de caractères à renvoyer à partir du texte de l’article. Pour le texte complet de l’article, définissez la valeur sur -1.
    Tableau 24. Renvoie
    Type Description
    Tableau Les articles de la catégorie et de ses sous-catégories avec :
    • Un workflow_state de publié.
    • Date de valid_to supérieure ou égale à la date actuelle.
    //Server script 
    (function() {
        data.summary = $sp.getKBCategoryArticleSummaries("0ac1bf8bff0221009b20ffffffffffec", 5, 200);
    })();
    
    //HTML template
    <div>
    articles: {{::data.summary}}
    </div>
    

    GlideSPScriptable inclus dans le périmètre : getKBCount(String sys_id)

    Renvoie le nombre d’articles dans la base de connaissances définie.

    Tableau 25. Paramètres
    Nom Type Description
    sys_id Chaîne Sys_id d’un enregistrement de la base de connaissances.
    Tableau 26. Renvoie
    Type Description
    Numéro Nombre d’articles de la base de connaissances dans la base de connaissances définie avec :
    • Un workflow_state de publié.
    • Date de valid_to supérieure ou égale à la date actuelle.
    //Server script 
    (function() {
        data.count = $sp.getKBCount("a7e8a78bff0221009b20ffffffffff17");
    })();
    
    //HTML template
    <div>
    articles: {{::data.count}}
    </div>
    

    GlideSPScriptable inclus dans le périmètre : getListColumns(String tableName, String view)

    Renvoie une liste des colonnes de la table spécifiée dans la vue spécifiée.

    Tableau 27. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table
    vue Chaîne Vue par laquelle filtrer les colonnes
    Tableau 28. Renvoie
    Type Description
    Objet Objet contenant les noms de colonnes.

    GlideSPScriptable inclus dans le périmètre : getMenuItems(String sysId)

    Renvoie un tableau d’éléments de menu pour l’instance spécifiée.

    Tableau 29. Paramètres
    Nom Type Description
    sysId Chaîne sysId de l’instance
    Tableau 30. Renvoie
    Type Description
    Tableau Éléments de menu pour l’instance spécifiée

    GlideSPScriptable inclus dans le périmètre : getMenuHREF(page GlideRecord)

    Renvoie la partie ( ?id=) de l’URL en fonction du type de sp_menu.

    Tableau 31. Paramètres
    Nom Type Description
    Page GlideRecord La page
    Tableau 32. Renvoie
    Type Description
    Chaîne La partie href de l’URL.

    GlideSPScriptable inclus dans le périmètre : getParameter(nom de chaîne)

    Renvoie la valeur du paramètre spécifié.

    Tableau 33. Paramètres
    Nom Type Description
    nom Chaîne Nom de la clé de la chaîne de requête ou du corps de la publication.
    Tableau 34. Renvoie
    Type Description
    Objet Renvoie le paramètre spécifié en tant qu’objet. Renvoie null s’il n’y a pas de demande, de demande JSON ou de widget.

    GlideSPScriptable inclus dans le périmètre : getPortalRecord()

    Renvoie l’enregistrement du portail à partir de la table Portails de services [sp_portal].

    Tableau 35. Paramètres
    Nom Type Description
    Aucun
    Tableau 36. Renvoie
    Type Description
    GlideRecord Enregistrement du portail actuel issu de la table Portails de services [sp_portal].
    //Server script
    (function() {
        var portalGr = $sp.getPortalRecord();
        data.logo = portalGr.getDisplayValue("logo");
        data.homepage = portalGr.getDisplayValue("homepage.id");
    })();
    
    //HTML template
    <div>
        <img ng-src="{{::c.data.logo}}" />
        <a href="?id={{::c.data.homepage}}">Click here to go home</a>
    </div>

    GlideSPScriptable inclus dans le périmètre : getRecord(String table, String sys_id)

    Si des paramètres sont fournis, renvoie le GlideRecord identifié par la table et l’ID système fournis. Si aucun paramètre n’est fourni, renvoie l’enregistrement identifié par l’URL actuelle.

    Tableau 37. Paramètres
    Nom Type Description
    table Chaîne Facultatif. Table de l’enregistrement à renvoyer. Si aucun paramètre n’est inclus, renvoie la table et l’ID système identifiés par l’URL actuelle.
    sys_id Chaîne Facultatif. L’ID système de l’enregistrement à renvoyer. Si aucun paramètre n’est inclus, renvoie l’enregistrement identifié par l’URL actuelle.
    Tableau 38. Renvoie
    Type Description
    GlideRecord Si des paramètres sont fournis, renvoie l’enregistrement identifié par la table et l’ID système fournis.

    Si aucun paramètre n’est fourni, renvoie l’enregistrement identifié par l’URL actuelle.

    Renvoie la valeur null si le widget est incorporé par un autre widget ou si l’enregistrement des paramètres fournis est introuvable.

    //Server script 
    (function(){ 
    var now_GR = $sp.getRecord(); 
    data.tableLabel = now_GR.getLabel(); 
    })(); 
    
    //HTML template 
    <div class="panel-heading"> 
    <h4 class="panel-title">${{{data.tableLabel}} details}</h4> 
    </div>

    GlideSPScriptable inclus dans le périmètre : getRecordDisplayValues(données d’objet, GlideRecord from, noms de chaînes)

    Copie les valeurs d’affichage des champs spécifiés dans le paramètre de données.

    Tableau 39. Paramètres
    Nom Type Description
    données Objet Les valeurs d’affichage des champs spécifiés sont copiées dans cet objet.
    de GlideRecord GlideRecord à traiter.
    noms Chaîne Liste de noms de champs séparés par des virgules.
    Tableau 40. Renvoie
    Type Description
    nul

    GlideSPScriptable inclus dans le champ d’application : getRecordElements(données d’objet, GlideRecord from, noms de chaînes)

    Pour les champs spécifiés, copie le nom, la valeur d’affichage et la valeur de l’élément dans le paramètre de données.

    Tableau 41. Paramètres
    Nom Type Description
    données Objet Le nom de l’élément, la valeur d’affichage et la valeur des champs spécifiés sont copiés dans cet objet.
    de GlideRecord GlideRecord à traiter.
    noms Chaîne Liste de noms de champs séparés par des virgules.
    Tableau 42. Renvoie
    Type Description
    nul

    GlideSPScriptable inclus dans le périmètre : getRecordValues(données d’objet, GlideRecord from, noms de chaînes)

    Copie les valeurs des noms de champs spécifiés à partir du GlideRecord dans le paramètre de données.

    Tableau 43. Paramètres
    Nom Type Description
    données Objet La valeur des champs spécifiés est copiée dans cet objet.
    de GlideRecord GlideRecord à traiter.
    noms Chaîne Liste de noms de champs séparés par des virgules.
    Tableau 44. Renvoie
    Type Description
    nul

    GlideSPScriptable inclus dans le périmètre : getRecordVariables(GlideRecord now_GR, booléen includeNilResponses)

    Renvoie Catalogue de services les variables associées à un enregistrement au format Chaîne.

    Tableau 45. Paramètres
    Nom Type Description
    now_GR GlideRecord Enregistrement pour lequel récupérer Catalogue de services les variables. Il doit s’agir d’un enregistrement avec Catalogue de services des variables définies, comme un enregistrement d’élément demandé [sc_req_item] ou un incident soumis par l’intermédiaire d’un créateur d’enregistrement.
    includeNilResponses (includeNilResponses en anglais) Booléen Facultatif. Si la valeur est vrai, l’API inclut des variables sans valeur définie par l’utilisateur.
    Tableau 46. Renvoie
    Type Description
    Chaîne Catalogue de services Variables associées à l’enregistrement.
    //Server script 
    (function() {
    var itemsGR = new GlideRecord("sc_req_item");
    itemsGR.get('585d1bc44f4f13008a959a211310c77d');
    	
    data.scVars = $sp.getRecordVariables(itemsGR);
    
    })();
    
    //HTML template
    <div>
    Requested item variables: {{::data.scVars}}
    </div>

    Sortie :

    Requested item variables: [
      {
        "display_value":"MetroPCS",
        "name":"carrier",
        "visible_summary":true,
        "id":"585d1bc44f4f13008a959a211310c77c",
        "label":"Allocated carrier",
        "type":"5",
        "value":"metropcs",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"Unlimited",
        "name":"data_plan",
        "visible_summary":true,
        "id":"d05d1bc44f4f13008a959a211310c77c",
        "label":"Monthly data allowance",
        "type":"5",
        "value":"unlimited",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"12 Months",
        "name":"duration",
        "visible_summary":true,
        "id":"d85d1bc44f4f13008a959a211310c77c",
        "label":"Contract duration",
        "type":"5",
        "value":"twelve_months",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"Slate",
        "name":"color",
        "visible_summary":true,
        "id":"545d1bc44f4f13008a959a211310c77c",
        "label":"Color",
        "type":"5",
        "value":"slate",
        "visible_standalone":true,
        "visible_guide":true
      },
      {"display_value":"64GB",
        "name":"storage",
        "visible_summary":true,
        "id":"d45d1bc44f4f13008a959a211310c77c",
        "label":"Storage",
        "type":"5",
        "value":"sixtyfour",
        "visible_standalone":true,
        "visible_guide":true
      }
    ]

    GlideSPScriptable inclus dans le périmètre : getRecordVariablesArray(GlideRecord now_GR, booléen includeNilResponses)

    Renvoie un tableau de Catalogue de services variables associées à un enregistrement.

    Tableau 47. Paramètres
    Nom Type Description
    now_GR GlideRecord Enregistrement pour lequel récupérer Catalogue de services les variables. Il doit s’agir d’un enregistrement avec Catalogue de services des variables définies, comme un enregistrement d’élément demandé [sc_req_item] ou un incident soumis par l’intermédiaire d’un créateur d’enregistrement.
    includeNilResponses (includeNilResponses en anglais) Booléen Facultatif. Si la valeur est vrai, l’API inclut des variables sans valeur définie par l’utilisateur.
    Tableau 48. Renvoie
    Type Description
    Objet Tableau de Catalogue de services variables associées à l’enregistrement.
    //Server script 
    (function() {
    var itemsGR = new GlideRecord("sc_req_item");
    itemsGR.get('585d1bc44f4f13008a959a211310c77d');
    	
    data.scVars = $sp.getRecordVariablesArray(itemsGR);
    
    })();
    
    //HTML template
    <div>
    Requested item variables: {{::data.scVars}}
    </div>

    Sortie :

    Requested item variables: [
      {
        "display_value":"MetroPCS",
        "name":"carrier",
        "visible_summary":true,
        "id":"585d1bc44f4f13008a959a211310c77c",
        "label":"Allocated carrier",
        "type":"5",
        "value":"metropcs",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"Unlimited",
        "name":"data_plan",
        "visible_summary":true,
        "id":"d05d1bc44f4f13008a959a211310c77c",
        "label":"Monthly data allowance",
        "type":"5",
        "value":"unlimited",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"12 Months",
        "name":"duration",
        "visible_summary":true,
        "id":"d85d1bc44f4f13008a959a211310c77c",
        "label":"Contract duration",
        "type":"5",
        "value":"twelve_months",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"Slate",
        "name":"color",
        "visible_summary":true,
        "id":"545d1bc44f4f13008a959a211310c77c",
        "label":"Color",
        "type":"5",
        "value":"slate",
        "visible_standalone":true,
        "visible_guide":true
      },
      {"display_value":"64GB",
        "name":"storage",
        "visible_summary":true,
        "id":"d45d1bc44f4f13008a959a211310c77c",
        "label":"Storage",
        "type":"5",
        "value":"sixtyfour",
        "visible_standalone":true,
        "visible_guide":true
      }
    ]

    GlideSPScriptable inclus dans le périmètre : getStream(String table, String sysId)

    Obtient le flux d’activité pour l’enregistrement spécifié. Cette méthode fonctionne sur les tables qui étendent la table de tâches.

    Tableau 49. Paramètres
    Nom Type Description
    table Chaîne Le nom de table
    sysID Chaîne sys_id de l'enregistrement
    Tableau 50. Renvoie
    Type Description
    Objet Si une table étendant la table de tâches est spécifiée, contient les propriétés display_value, sys_id, short_description, nombre, entrées, user_sys_id, user_full_name, user_login, étiquette, table et journal_fields ; sinon contient la table et les propriétés sys_id.
    Remarque :
    La propriété user_login contient l’ID d’utilisateur de l’utilisateur actuel. Les propriétés user_sys_id et iser_full_name référencent le créateur de l’enregistrement interrogé.

    GlideSPScriptable inclus dans le périmètre : getUserInitials()

    Renvoie les initiales de l’utilisateur.

    Tableau 51. Paramètres
    Nom Type Description
    Aucun
    Tableau 52. Renvoie
    Type Description
    Chaîne Les initiales de l’utilisateur

    GlideSPScriptable inclus dans le périmètre : getValue(nom de chaîne)

    Renvoie la valeur nommée de la demande, de l’instance ou du portail JSON.

    Tableau 53. Paramètres
    Nom Type Description
    nom Chaîne Nom de la demande JSON, de l’instance ou du portail.
    Tableau 54. Renvoie
    Type Description
    Objet Valeur du paramètre spécifié. Null si l’entité spécifiée n’existe pas ou n’a pas un tel paramètre.
    //Server script
    (function() {
        data.title = $sp.getValue("title");
        data.catalog = $sp.getValue("sc_catalog");
    })();
    
    //HTML templage
    <div>
        <h1>sp_instance.title: {{::data.title}}</h1>
        <h1>sp_portal.sc_catalog: {{::data.catalog}}</h1>
    </div>

    GlideSPScriptable inclus dans le périmètre : getValues(données d’objet, noms de chaînes)

    Copie les valeurs de la demande ou de l’instance vers le paramètre de données.

    Tableau 55. Paramètres
    Nom Type Description
    données Objet Reçoit les valeurs des paramètres.
    noms Chaîne Chaîne de noms de champs séparés par des virgules.
    Tableau 56. Renvoie
    Type Description
    nul

    GlideSPScriptable inclus dans le périmètre : getVariablesArray(Boolean includeNilResponses)

    Renvoie un tableau de Catalogue de services variables associées à l’enregistrement dans l’URL.

    Par exemple, si l’URL inclut les paramètres id=form&amp;table=sc_req_item&amp;sys_id=832e9620db4f330083766b984b9619cf, l’API renvoie les variables associées à l’enregistrement donné dans la table Élément demandé [sc_req_item]. Il doit s’agir d’un enregistrement avec Catalogue de services des variables définies, comme un enregistrement d’élément demandé [sc_req_item] ou un incident soumis par l’intermédiaire d’un créateur d’enregistrement.

    Tableau 57. Paramètres
    Nom Type Description
    includeNilResponses (includeNilResponses en anglais) Booléen Facultatif. Si la valeur est vrai, l’API inclut des variables sans valeur définie par l’utilisateur.
    Tableau 58. Renvoie
    Type Description
    Objet Tableau de variables associées à la table.
    //Server script 
    (function() {	
    data.scVars = $sp.getVariablesArray();
    })();
    
    //HTML template
    <div Current record variables: {{::data.scVars}} ></div>

    Sortie :

    Current record variables: [
      {
        "display_value":"unlimited",
        "name":"data","visible_summary":
        true,"id":"472e5620db4f330083766b984b96198a",
        "label":"Data",
        "type":"6",
        "value":"unlimited",
        "visible_standalone":true,
        "visible_guide":true
      },
      {
        "display_value":"Black",
        "name":"color",
        "visible_summary":true,
        "id":"c72e5620db4f330083766b984b96198a",
        "label":"Color",
        "type":"6",
        "value":"Black",
        "visible_standalone":true,
        "visible_guide":true
      }
    ] 

    GlideSPScriptable inclus dans le périmètre : getWidget(String sysID, options de l’objet)

    Obtient un widget par ID ou sys_id, exécute le script serveur de ce widget à l’aide des options fournies, puis renvoie le modèle de widget.

    Tableau 59. Paramètres
    Nom Type Description
    sysID Chaîne Le widget sys_id ou widget_id
    options Objet Un objet à transmettre au script serveur du widget. Référez-vous à cet objet en tant qu’options dans votre script serveur.
    Remarque :
    Toutes les options transmises à cette fonction ne seront disponibles dans le script serveur du widget incorporé que lors de la première exécution de ce script. Tous les appels ultérieurs dans le script serveur à partir du widget incorporé ne contiendront pas les propriétés d’objet transmises.
    Tableau 60. Renvoie
    Type Description
    Objet Modèle de widget à utiliser avec sp-widget.
    //Server script
    data.myWidget = $sp.getWidget('widget_id', {p1: param1, p2: param2});
    
    //HTML
    <sp-widget widget="c.data.myWidget"></sp-widget>

    GlideSPScriptable inclus dans le périmètre : isRTLEnabled()

    Vérifie si le portail associé est activé pour la langue de droite à gauche (RTL) et si la langue de l’utilisateur actuel est la langue de l’utilisateur actuel est la langue de direction RTL.

    Utilisez cette méthode pour déterminer s’il est nécessaire d’utiliser un CSS spécifique à RTL dans l’interface utilisateur du portail.

    Tableau 61. Paramètres
    Nom Type Description
    Aucun
    Tableau 62. Renvoie
    Type Description
    Booléen Marqueur indiquant si le marqueur RTL est activé et si la langue de la session de l’utilisateur actuel est directionnelle RTL.

    Valeurs possibles :

    • true : le marqueur RTL est activé.
    • false : l’indicateur RTL n’est pas activé.

    Type de données : booléennes

    L’exemple de code suivant montre comment utiliser cette méthode pour déterminer le type d’icône à afficher sur la page du portail.

    // Server script  
    (function() {
      data.isRTLEnabled = $sp.isRTLEnabled();
     })(); 
    
    // HTML template 
    <div> <i ng-class="c.data.isRTLEnabled ? 'fa fa-arrow-right' : 'fa fa-arrow-left'"></i> </div> 

    GlideSPScriptable inclus dans le périmètre : isUserCriteriaEnabled()

    Renvoie la valeur true si les critères d’utilisateur sont activés.

    Cette méthode renvoie la valeur true si le module d’extension Service Portal User Criteria Support (com.glide.service-portal.user-criteria) est actif et si la propriété système Activer l’utilisation des enregistrements de critères d’utilisateur au lieu des champs Rôles pour les autorisations Service Portal (glide.service_portal.user_criteria_enabled) est définie sur vrai.

    Tableau 63. Paramètres
    Nom Type Description
    Aucun
    Tableau 64. Renvoie
    Type Description
    Booléen Vrai si les critères d’utilisateur sont activés.

    GlideSPScriptable inclus dans le périmètre : log(message d’objet)

    Consigne la sortie dans la table Entrées de journal du portail de services [sp_log]. L’utilisateur connecté doit avoir le rôle sp_admin ou admin.

    Tableau 65. Paramètres
    Nom Type Description
    message Objet Objet ou chaîne JavaScript représentant le message à envoyer en tant que sortie sur une Portail de services page.
    Tableau 66. Renvoie
    Type Description
    Néant

    L’exemple suivant montre comment consigner une erreur prédéfinie si elle se produit.

    var demo_data = null;
    var params = null;
    if (gr.getValue("demo_data")) {
       try {
    	demo_data = JSON.parse(gr.getValue("demo_data"));
    	params = (demo_data.options) ? demo_data.options : null;
    	} catch(e) {
    	$sp.log(e);
       }
    }

    GlideSPScriptable inclus dans le périmètre : mapUrlToSPUrl(String url)

    Transforme une URL demandant une liste ou un formulaire dans l’interface utilisateur de la plateforme en URL de la page du Service Portal correspondante id=list ou id=form .

    Utilisez cette méthode pour effectuer des tâches telles que rediriger un utilisateur après s’être connecté à la page Service Portal appropriée lorsqu’il demande un formulaire d’interface utilisateur de la plateforme ou une URL de liste. Notez que les cibles de page id=list et id=form ne sont pas personnalisables.
    Remarque :
    Les valeurs Table, sys_id et sysparm_query sont conservées à partir de l’URL d’origine. sysparm_view ne l’est pas.
    Tableau 67. Paramètres
    Nom Type Description
    URL Chaîne URL de l’interface utilisateur de la plateforme
    Tableau 68. Renvoie
    Type Description
    Chaîne URL du portail de services transformée.

    Si l’URL transmise ne demande pas de liste ou de formulaire dans l’interface utilisateur de la plateforme, une valeur null est renvoyée.

    Exemple de liste

    GlideSPScriptable().mapUrlToSPUrl("http://demo.service-now.com/task_list.do?sysparm_userpref_module=1523b8d4c611227b00be8216ec331b9a&sysparm_query=assigned_to=javascript:getMyAssignments()&sysparm_clear_stack=true"))

    Renvoie

    id=list&table=task&filter=assigned_to=javascript:getMyAssignments()&sys_id=&v=

    Exemple de formulaire

    GlideSPScriptable().mapUrlToSPUrl("incident.do?sys_id=12bc12bc12bc12bc12bc12bc12bc12bc")

    Renvoie

    id=form&table=incident&filter=&sys_id=12bc12bc12bc12bc12bc12bc12bc12bc&v=

    GlideSPScriptable inclus dans le périmètre : userCanSeeSearchSourceByCriteria(String searchSourceID)

    Renvoie la valeur true si l’utilisateur actuel peut voir une source de recherche spécifiée par searchSourceID.

    Renvoie la valeur true si l’utilisateur n’est pas limité par des critères d’utilisateur. Pour plus de détails sur la façon dont les critères d’utilisateur affectent les actifs de Service Portal, consultez Critères d’utilisateur de Service Portal.
    Remarque :
    Cette méthode n’évalue pas les autorisations basées sur les rôles de la source de recherche et ne doit être utilisée que si les critères d’utilisateur sont activés.
    Tableau 69. Paramètres
    Nom Type Description
    searchSourceID Chaîne Sys_id de l’enregistrement de la source de recherche.
    Tableau 70. Renvoie
    Type Description
    Booléen Vrai si l’utilisateur actuel dispose d’un accès en lecture à la source de recherche.