×

Please give details of the problem

Skip to content

User interface tags

A tag is a label attached to a user interface for the purpose of identification or to give other information. The signification of each tag is meaning free depending of the customer usage.

Table of Contents

Goal of the tags

Tags give the opportunity to classify, order, group or simply identify a user interface. Tags can help to present a list of user interfaces by keywords for instance (one tag would be a keyword in this example).

How to tag an application?

How to handle tags in user interface Really simple. As you can see in the figure juste above, in the first tab of the configuration of one web interface (tab "Implementation"), you can add or remove the tags. It's as simple as "write the tag", "click on Add button" and "save the user interface".

How to retrieve application tags?

Today, the only packaged way to retreive the tags of one application is with the Freemarker method get_applications. You have to use this method with the last parameters set to true, this method will return a JSONObject representing a list of user interface group by tag. You can use this method like that:

${get_applications(true)} retreive the list of user interfaces accessible for the connected user in the current execution mode and current context (context can be web, tablet or mobile).

${get_applications(login, true)} retreive the list of user interfaces accessible for given user in the current execution mode and current context (context can be web, tablet or mobile).

${get_applications(login, context, true)} retreive the list of user interfaces accessible for given user in the current execution mode and given context (context can be web, tablet or mobile).

${get_applications(login, context, mode, true)} retreive the list of user interfaces accessible for given user in the given execution mode and given context (context can be web, tablet or mobile).

Example:

var applications = ${get_applications(true)};
alert(applications["Administration"][0].title);    // Alert the title of the first application tagged "Administration".

/** get_applications(true) return a structure containing the following values:
 *      {                                           
 *      "NO_TAG":[                                  // List of un-tagged applications
 *      {                                           
 *          "tags":"<>",                            // List of tags for this application 
 *          "id":1,                                 // Id of the application 
 *          "icon":"",                              // Url of the icon
 *          "title":"My first app",                 // Title of the application
 *          "visibility":"PRIVATE",                 // Visibility of the application (PRIVATE or PUBLIC)
 *          "favicon":"",                           // Url of the favicon
 *          "description":"This is an application", // Description of the application
 *          "url":"live/12345/appli/1"},            // Url of the application
 *      {
 *          "tags":"<>",
 *          "id":2,
 *          "icon":"",
 *          "title":"My second app",
 *          "visibility":"PRIVATE",
 *          "favicon":"",
 *          "description":"","url":"live/12345/appli/2"},
 *      ],
 *      "Administration":[                          // List of applicationo with the tag "Administration"
 *      {
 *          "tags":"<\"Administration\">",
 *          "id":3,
 *          "icon":"",
 *          "title":"Administration",
 *          "visibility":"PRIVATE",
 *          "favicon":"",
 *          "description":"My admin",
 *          "url":"live/12345/appli/3?"}
 *      ]
 *      }
 */

info_1 The method get_applications doesn't work in TEST execution mode.

get_applications method

How to create an homepage