App Spec Reference

An App Spec describes an App to the platform and dictates how Studio UI is set up, amongst other things.

Property	Description	Mandatory	Default
name	App name	yes
id	Unique app id. All versions of the same app have the same id.	yes
version	App version. Only one app with the same id and version can be available within LViS.	yes
base_apps_url	Base URL for App location.	yes
listings	Number of past and future events to include in listings. If not set then the values can be set via Studio UI.	no
project_settings	Project level settings spec URL.	no	no settings
event_settings	Event level settings spec URL.	no	no settings
elements	Elements spec URL.	no	no Elements
fields	Fields spec URL.	no	no fields
embed_url	App embed URL.	no
dash_image	App image URL. Image has to be 100 x 100 px. Make sure it works via HTTPS. This is the image displayed on the dashboard.	no	default app image
extensions	List of extensions required by application. Each extension may have additional configuration.	no	empty list
curation	App requires social curation to be activated	no	false
schedule	App requires Event scheduling functionality	no	true
analytics	App requires Analytics functionality	no	true
live_activity	App requires Live Activity section on Timeline and Analytics pages	no	true
localisation	App supports localisation	no	false
element_categories	List of element categories	no	empty list

Anatomy of an App Spec

The App Spec has a root and then child JSON files which describe the application. Filenames can be whatever you choose to specify, with the hierarchy as follows:

• Root spec.json - Contains top level settings and references to other JSON documents comprising the App Spec.

  • Elements elements.json List of Elements this App supports along with settings for each element.

  • Fields fields.json - All of Project, Event and Element level settings refer to fields described in this document.

  • Project Settings project_settings.json

  • Event Settings event_settings.json

Element categories

List of element categories, keys from which can be used for categories attribute in element spec.

"element_categories": [
  {
    "key": "trivia",
    "label": "Trivia"
  },
  {
    "key": "poll",
    "label": "Polling & Voting",
    "documentation_url": "https://monterosa.co/documentation"
  },
  {
    "key": "editorial",
    "label": "Editorial"
  }
]