Configuring Services
Configuring How Services Appear
You configure the service appearance in the App Builder in the service tab that appears in the Configuration tabs when you select the service (see Working with the App Builder).
Service Configuration Tab
Before configuring a service, you may want to configure the profile and app default configurations for services. Any service property not defined for a specific service inherits its value from the profile default. Any service property not defined for a profile inherits its value from the app default. See Configuring Default Service Properties and Managing Profile Defaults for Services.
The following configuration options are available. You can also work directly with a service's code (see Working with App Code). If you change any service properties, select Save & Publish to publish your changes.
| Field | Description | Values |
|---|---|---|
| Menu Option Config | ||
| Title | Title of the tile when it was created. | Cannot be changed. |
| Metadata Tag | Used to group multiple tags displayed in Analytics. | String values. |
| Recents Icon | The icon that appears in the app's Recents menu for this service.
The icon should be 120x120 pixels, and a maximum size of 50k.
|
Select Browse to select a file from the Assets Manager; see Uploading Files. |
| Roles | The app roles associated with this service. | Select the link. The list of app roles appears in an overlay pane. Select or clear the desired roles and then select away from the pane. |
|
Tags |
The tags associated with this service; see Managing My Profile. |
Select the link. The list of tags appears in an overlay pane. Select or clear the desired tags and then select away from the pane. |
| Disabled | Whether the service is disabled on all platforms. By default, a service is enabled on all platforms.
When a service is disabled, it does not appear in the app for any profiles or app roles. Disabling a service is useful when the app is still under development or has temporarily stopped working.
See also Hide.
|
Select to disable. |
| Android Disabled | Whether the service is disabled on Android. By default, a service is enabled on Android. See Disabled, above. The service is disabled on Android if either this setting or Disabled is selected. | Select to disable. |
| iOS Disabled | Whether the service is disabled on iOS. By default, a service is enabled on iOS. See Disabled, above. The service is disabled on iOS if either this setting or Disabled is selected. | Select to disable. |
| Mandatory | Available only if personalization is enabled for the profile.
Whether the service can be hidden by the end-user. By default, a service is not mandatory. Relevant only when Personalization is selected for the profile (see Managing Profiles).
|
Select to make the service mandatory (cannot be hidden by the end-user). |
| Hidden by default | Available only if personalization is enabled for the profile.
Whether the service is initially hidden by default. By default, a service is not hidden by default. Relevant only when Personalization is selected for the profile (see Managing Profiles).
This enables you to create services that each student can add as required.
|
Select to make the service hidden by default (the end-user must select to make the service visible). |
|
Product Integration
|
Available only if the Tile is created as Product Integrations Tile Indicated the Product Integration instance Description that the tile will access when clicked.
|
Select from available Product Integrations instances within the dropdown. Will be preconfigured with the selected Product Integration on creation.
|
| Tile Config - All fields only appear if they are selected from the Add Property menu. | ||
| Action (URL) | Not available for feed or banner services.
A URL to open if the end-user selects the service's tile.
|
Enter a campusM URL or enter part of a URL and select one from the list. See Working with App URLs. |
|
Available only for feed and banner services. Whether swipe arrows are added to the tile. For banner tiles, the controls are located at the top of the tile by default, but they can be placed at the top or the bottom; see User Controls Location, below.
|
Select to add. |
|
|
Available only for feed and banner services. Whether a Play/Pause control is added to the tile. For banner tiles, the control is located at the bottom-right of the tile by default, but is moved to the top if the user controls are placed at the bottom; see User Controls Location, below.
|
Select to add. |
|
| Background Color | The background color of the service's tile. See also Hover Background Color.
Background Color Selector
 Tile with Background Color
This is typically not used when configuring Image (see below) or Full Width Icon (if the icon is opaque), since the background color will no longer be visible when covered by an opaque image.
|
Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Banners | Available only for banner services.
The banner images. Add all the required images.
A banner is typically 3 tile spaces wide by 1 tile space high (see Tile Height and Tile Width). The images should be sized accordingly (see Image for more information).
Configure Image Fit to determine how the images appear in the banner.
|
Select Add banner. For each banner image select Browse to select a file from the Assets Manager; see Uploading Files.
If you do not select any images, a default banner service is created. Only default banner images associated with the app roles configured for this service appear in the banner (see Configuring Default Banner Service Images).
If you select any images, enter a campusM URL, or enter part of a URL and select one from the list. See Working with App URLs.
Enter a time in seconds in Display Duration to display each image.
To reorder the images, either edit the code (see Working with App Code) or remove the images and re-add them in the correct order.
You can browse and load an icon to indicate the banner's source.
|
| Border Color | Set the tile border color. Also see Hover Border Color. | Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Border Size | Set the tile border width, in pixels. Also see Hover Border Size. | Enter the border size, in pixels |
| Corner Radius | Add a rounded corner to the tiles. | Enter the radius value, in pixels. |
| Description | Description of the tile. This is useful when personalization is enabled; the description appears to end-users who are selecting services to enable/disable. | Enter a text description. |
| Feeds | Available only for feed services.
The feed sources. You can add multiple sources, and items from the various feeds are merged together when presented to the end-user.
|
Select Add Feed and enter the feed description and feed URL to add a feed. If you have configured any default feeds (see Configuring Default RSS Feeds), they appear in a dropdown list as you type. Note that campusM is RSS 2.0 compliant. You can browse and load an icon to indicate the feed's source. If you add an icon, you can choose the position in which it should be placed in the tile – top or bottom, and left, right, or center. If you do not see an example of the live feed in the Device Display Pane, there is a problem with the URL.
|
| Font Size (min)
Font Size (max)
|
The label's minimum and maximum font size. | Select a minimum and maximum font size. |
|
Full-Screen AEK
|
When combined with the right AEK project configuration, this setting causes the AEK tile to expand to fill the whole desktop view. This is only relevant on the web app, when Portal View is not being used.
|
Normal (default) when a proprty is not configured and Full Screen
|
| Full Text Overlay | The shading overlay for labels. Gradient overlay provides a fade from light to dark semi-opaque overlay, which may provide improved visibility.
 |
Select full overlay or gradient overlay. |
| Full Width Icon | Not available for feed or banner services.
Whether the icon you add to the tile (see Icon, below) is full width or actual width. Actual width is the default.
This is typically used when also selecting No Label (see below).
 Tile Without Full Width Icon
 Tile With Full Width Icon
|
Select Yes for full width. |
| Hide | Whether to hide the service from the app screen. By default, the service is not hidden.
This is different from disabling the service (see above). The service is still available if, for example, another service links to it.
|
Select Yes to hide. |
| Hide Text | Available only for feed services.
Whether to hide the banner title on the feeds tile.
|
Select Yes to hide. |
| Hover Background Color | The background color of the service's tile when the user hovers the pointer over it. This is relevant only for screens in which a mouse pointer is available, such as the web app.
This is typically not used when configuring a background image (see Image, below), since the background color will no longer be visible when covered by the image.
See also Background Color.
|
Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Hover Border Color | Set the tile hover border color. Also see Border Color. | Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Hover Border Size | Set the tile hover border width, in pixels. Also see Border Size. | Enter the border size, in pixels |
| Hover Text Color | Not available for banner services.
The label color in the service's tile when the user hovers a pointer over it. This is relevant only for screens in which a mouse pointer is available, such as the web app.
See also Text Color.
|
Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Icon | Not available for feed or banner services.
The foreground image of the service's tile. Ex Libris works with you to develop a set of icons for your institution.
An icon should be 120x120 pixels, and a maximum size of 50k.
See Full Width Icon.
Not used for services with dynamic tiles (see Changing App Manager Installation Settings).
|
Select Browse to select a file from the Assets Manager; see Uploading Files. |
| Image | Not available for feed or banner services. For integrated services, this is the same as the Image Icon field you set on the Select AEK menu option to change page (see step 7 in Creating Services).
The background image of the service's tile. This is typically not used when configuring Full Width Icon (if the icon is opaque), since the background image will no longer be visible when covered by an opaque image.
A tile occupying a single space is 180x180 pixels. When using an image for a tile that occupies multiple spaces (see Tile Height and Tile Width), each space adds another 180 pixels in the relevant direction as well as any additional pixels taken up by the tile spacing (see Tile Spacing in Managing Profile Defaults for Services).
|
Select Browse to select a file from the Assets Manager; see Uploading Files. |
| Image Fit | How to fit the background image (see Image) that are larger than a tile in the tile. This field is also used for banner services to configure the images in the banners.
The options are:
|
Select no value, contain, stretch, or crop. See the Device Display Pane to preview the results. |
| No Label | Not available for feed or banner services.
Whether to hide or display the service label in the service's tile. The label appears by default.
This is typically used when the image or icon (see Image and Icon) is self-explanatory.
|
Select hide label to hide the label. |
| Overrides | See Overriding Service Configuration Based on Device Properties. | |
| Pause Time | Available only for feed services. | Time, in seconds, to display each feed item. |
| Text Align | The label's alignment in the service's tile. | Select left, right, or center. |
| Text Color | The label color in the service's tile.
See also Hover Text Color.
|
Select the color icon and select a color or enter a hexadecimal color in the text field to the right of the color icon. |
| Text Overlay | Provides a gradient fill over the top of the tile image, which enables label text to be rendered more accessible. | Select Show Overlay to make the overlay visible or Hide Overlay to remove the gradient fill. |
| Tile Height | The number of tile "spaces" used for the service's width. By default, the height is 2 for a feed service, and 1 for any other service. The maximum is 3 for any mobile device; if you select 4, 3 will be used instead for these devices.
 Service With 1 Width x 2 Height
|
Select 1, 2, 3, or 4. |
| Tile Type | Appears for feed or banner services only. | N/A |
| Tile Width | The number of tile "spaces" used for the service's height. By default, the height is 2 for a feed service, 3 for a banner service, and 1 for any other service. | Select 1, 2, 3, or 4. |
| User Controls Location |
Appears for banner services only. If Add User Controls is selected for a banner tile, select the placement of the controls. When a Play/Pause Control is also included in the banner, it is placed in the opposite location.
Banner User Controls on the Top (Play/Pause Control on the Bottom)
|
Select Top or Bottom. |
| Sidebar Config | ||
| Hide | Hides the Menu Option from the sidebar | Hide Don't Hide |
| Text Transformation | Transforms the way the menu Option Title text displays in the sidebar | None Capitalize Uppercase |
| Text Align | Changes the Menu Option Title text alignment in the sidebar | Left Right Center |
| Font Weight | Changes the font-weight of the Menu Option Title text in the sidebar | Normal Bold Bolder |
| Hover Font Weight | Changes the font-weight of the Menu Option Title text in the sidebar when hovering over the text | Normal Bold Bolder |
| Font Size (px) | Changes the font size of the Menu Option Title text in the sidebar | Pixels |
| Text Color | Changes the text color of the Menu Option Title text in the sidebar | Selection palette or hash code |
| Hover Text Color | Changes the text color of the Menu Option Title text in the sidebar when hovering over the text | Selection palette or hash code |
| Background Color | Changes the background color of the Menu Option in the sidebar | Selection palette or hash code |
| Hover Background Color | Changes the background color of the Menu Option in the sidebar when hovering over the text | Selection palette or hash code |
| Spacing (px) | Changes the spacing above the Menu Option in the sidebar | Pixels |
| Side Padding (px) | Changes the left-hand side padding of the Menu Option Text in the sidebar | Pixels |
| Icon | Add icon to the side of the Menu Option Text in the sidebar | Browse Asset Manager or Image URL |
| Icon Width | Changes the width of the icon as it appears in the sidebar | Pixels |
| Icon Position | Defines the position of the icon in relation to the Menu Option text in the sidebar | Before Text After Text |
| Icon Only | Defines if only the icon should show (hide the Menu Option Text) in the sidebar | False True |
| Right Side Gutter % of Screen | Changes the guttering of full page screens on the right-hand side of the screen | 0%-100% |
Overriding Service Appearance Based on Device Properties
You can configure different service properties for different types of devices, based on the device's platform, type, and/or screen sizes.
To configure a service property based on device properties:
- In the App Builder, in the Tile Config area of the service tab, select Add Property > Overrides. An Overrides pane is added to the Tile Config area. If this pane already exists, expand it.
- Select Add Override to add a new device conditions/override property pair.
Overrides Pane - Select one or more conditions and select one or more values for the conditions or enter a value for the condition. The possible conditions are:
All of the conditions must be true (AND) for the override to take effect. For example, if you select platform iOS and Android, and you select minimum height 100 pixels and minimum width 200 pixels, the override will take effect if the device is iOS or Android and the height is at least 100 pixels and the width is at least 200 pixels: platform = (iOS OR Android) AND height > 100 AND width > 200.
- Platforms - Select one or more: iOS, Android, or Web. The condition applies if the device matches any (OR) of these platforms.
- Device Types - Select one or more: Phone, Desktop, or Tablet. The condition applies if the device matches any (OR) of these types.
- Max/Min Device Area - Enter the maximum or minimum total device area (height x width), in pixels. This setting is not commonly used; the best practice is to specify the max/min device height/width (see the next setting).
- Max/Min Device Height/Width - Enter the maximum or minimum screen height or width, in pixels.
- Select one or more properties to override if the condition matches. For more information, see Configuring Services.
When you are done, save your changes.
For more information, see How to Set an Override for a Tile.
Configuring Default Banner Service Images
For regular banner services, you can associate the entire service to specific app roles, enabling you to display or hide the entire service for these roles. The default banner service enables you to associate app roles with each image in the banner, which means that you can display or hide each image for specific app roles. Similarly, the default banner service enables you to configure different URLs for each image.
The default banner service appears if you add a banner service and do not define any images for the service. See Creating Services and Configuring Services.
To configure default banner service images:
You add, edit, and delete default banner service images on the Select home page banner to change pages (App Settings > News/Events/Comms > Home Page Banners). This page presents a list of image entries; for information about working with lists, see Working with Lists. You can reorder the entries on this page using the up and down arrows.
Select Home Page Banner to Change Page
For each entry, configure:
- Description - A name for the entry.
- Image - Select the image from the Asset Manager; see Uploading Files.
- Display duration - How long to display this image, in seconds.
- Action - Not in use.
- Advert url - A URL to open if the end-user selects the image. See Working with App URLs.
- Menu option - Not in use.
- Content - Not in use.
- Profile owner - Optionally select a profile. When selected, the image will only appear in services associated with this profile.
- Roles - Select the roles for which this image appears. Note that you must select the app roles for each image AND the banner service.
Rearranging Services in the App
In the App Builder, you can drag and drop services in the Device Display Pane (see Working with the App Builder) to change the location of the service in the app's window.
To view how the app appears on various devices and screen orientations (vertical or horizontal), select the device type and/or orientation in the Device Selection Menus.
Moving a service changes its location for all device types and for all orientations.