Cloud Apps Manifest
The Cloud App manifest is the file which describes the functionality and technical capabilities of the Cloud App. The information contained in the manifest provides information to the Cloud App framework which determines how the app is displayed in Alma and what the app is permitted to do.
The following describes the properties supported in the manifest file:
Section | Description |
---|---|
title | The app’s title, displayed in the Cloud App list and the header of the app when open. String or translated label. |
subtitle | The app’s subtitle, displayed in the Cloud App list. String or translated label. |
description | The app’s description, displayed in the Cloud App list. String or translated label. Please include any user roles required to use your Cloud App. |
author | The app’s author, displayed in the Cloud App list. |
license | Link to the license for the app |
contentSecurity | Describes the features of the app which require it to leave the sandbox. The following properties are supported:
For more information, see the tutorial on “Reaching outside your app“. |
pages | A list of pages or links which are used in the Cloud App framework. Each value can be either a route in the app (preceded by a /#/) or a link out (preceded by https://). The following properties are supported:
|
icon | The icon used for the app in the Cloud App list and the app title. Supports the following properties:
|
entities | A list of entities (from the EntityType list) supported by the app. When Alma displays an entity of a type listed, the app will be highlighted in the app list. |
fullscreen | An indication if the app supports fullscreen mode. The following properties are available:
|
When developing a Cloud App with the Cloud App CLI, changes to the manifest are applied only when the app is restarted.
Translated label
Descriptive text in the manifest file (title, subtitle, and description) support a translated label. This is an array of objects with the language code and the text:
{ "title": [ { "lang": "en", "text": "This is my title" }, { "lang": "es", "text": "Este es mi titulo" } ] }
Sample
manifest.jsonView on Github