Posted Jan 07 by AppWorks Developer.
Updated Jan 07.

Introduction to the mechanism of AppWorks App audiences that allows to control what apps or components users see.

3098 views. 0 comments.

Author: Eric de la Chevrotiere, Software Developer, OpenText

What Are App Audiences?

App audiences allow you to control what apps or components users see. Defining audiences for an app or component is meant for controlling the presentation of apps for the user, not for security. There are currently two ways to define audiences, by Runtime and by Users/Groups. The concept of a user/group runtime is straight forward: you can specifically target a particular user or group of users who are allowed to see/use an app. However the runtime audience may require a bit more explanation.

First we'll need to have a good understanding of what the “runtime” is. A runtime is the actual iOS, Android, or other App which you install on your device. It is the container app which houses all the AppWorks Gateway apps. A good example of two different runtimes which will help paint a better picture is to consider two different AppWorks runtimes, the OTE runtime, and the Ignite runtime.

Consider the iOS case: there are two different iOS apps, the OTE App, and the Ignite App. Both apps are fundamentally the same, however when the user signs in, the Ignite App will report to the server its runtime as Ignite, and similarly the OTE app will report its runtime as OTE.

What this allows is for both runtimes to hit the same AppWorks Gateway server, but be served two completely different sets of apps. For example, the sales employees will use the iOS Ignite App, and only be presented with AppWorks apps that are meaningful to them, and similarly, users that use the OTE runtime will only see the apps that are specific to OTE.

A system administrator is responsible to determine what AppWorks apps are displayed in each runtime. With a good understanding of what a runtime and user/group audience are, defining the audiences is made very simple using the AppWorks Admin UI.

App audiences configuration

Defining App Audiences

Defining a Runtime Audience

Defining a runtime audience lets you specify which client runtime shows which app. For example. The AppWorks OTAG client has a runtime of “AppWorks”, and the Ignite OTAG client has a runtime of “Ignite”. In this case, using the runtime audience configuration, you can specify that your app should only appear in Ignite, and not AppWorks.

To define the runtime audience, Log into the AppWorks, and click on the “gear” icon beside the app you wish to restrict. Click on the “Audience” tab, and expand the “Runtime Audience” section. Here specify that your app is available in all runtimes, or alternatively, uncheck “Available in all runtimes” and check off any individual runtimes you like. You can also define new runtimes here as well, by typing the name of your runtime in the “Add Runtime” box, and pressing the key. Remember to click “Save Changes” to complete the configuration.

Additionally, apps can specify what runtime(s) they belong to in app.properties file, by adding the following line:

runtimes=example,example2

The previous line declares that your app is available in the “example” runtime, as well as the “example2” runtime. If those runtimes have not been defined yet in the AppWorks Gateway, they will be created automatically when your app is installed.

Defining an User/Group Audience

To define an audience by user and/or group, Log into the AppWorks, and click on the “gear” icon beside the app you wish to restrict. Click on the “Audience” tab, and expand the “User and Group Audience” section. Here you can search for users and groups using the text box provided. Start typing in the user or group you wish to add and a list of matches will appear below the search box. Once you've typed enough of the username or group to narrow down the results enough, check off that user or group.

Once you've checked off the user, you are safe to modify your search to find additional users or groups. When you start typing in the search box a second time, the user(s)/group(s) you checked off in the first search will be added above the search box, but won't be committed until you click “Save Changes”.

Top of page


Table of Contents

Your comment

To leave a comment, please sign in.