• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Application Property File

The application property file is an XML formatted file structured similary to the Application Service configuration file. However, the XML elements used are not restricted to the ones mentioned here. Elements can't have attributes.

In the following tables, the properties describe the properties that are system defined and public.

Required properties
Element Description
ApplicationType This is the application type to support multiple applications. There are three types for it.
  • primary: Portal application.
  • noninteractive: Application without input focus.
  • secondary: Application with input focus but not a portal.
Name The name of the application.
Run This is a string with the path and all arguments to the application to run.
Common optional properties
Element Default value Description
AppStoragePath - This is the application storage path which can be used to store persistent data. The value shall be a directory name and not a full path since the platform will manage the base location. When read from application service the full path to the storage location will be returned.
AutoRestart false AutoRestart is used to tell whether an application should be automatically restarted (move from the stopped state to the starting state) if it fails. Possible values: true, false.
Container - The name (not full path) of the LXC container directory which defines the container in which the application should be run.
IsPlatformApplication true This element tells whether the application is platform aware or not. If set to false, the platform doesn't require the application to register or implement any TOI interfaces. Possible values: true, false.
KillInvisible false KillInvisible is used to tell whether an application should be automatically killed when it becomes invisible (changing state from visible or active). The AutoRestart option is ignored when this happens. Possible values: true, false.
PingTimeout 1 s This is the time the Application Service will wait for a ReportPing() message from an application it has called Ping() on. If the application has not called ReportPing() within this time, the Application Service will terminate it and possibly restart it.
RegisterUri - RegisterUri is used to register URI and MIME types or combinations with the URI loader. The value must be on the form "uritype=http", "mimetype=text/html" or "uritype=http;mimetype=text/html". Any number of RegisterUri elements may be added to the property file.
StartingState ACTIVE StartingState is used to tell whether an application wants to be visible and receive user input (ACTIVE), or just be visible, without user input (VISIBLE), or be invisible (INVISIBLE).
StartTimeout 5 s This is the maximum time that the Application Service will wait for an application that is being started until it should have called the ReportStarted() function in IToiApplicationService interface.
StopTimeout 4 s This is the maximum time that the Application Service will wait for an application that is being terminated to respond to the SIGTERM signal sent to it.
SubscriptionKeyMap -. Only required for primary applications This is the key map that maps application key identifier and KreaTv input key code. Primary application has to set this property with a valid key map file in the rootdisk.

A typical property file could look like this:

<?xml version="1.0"?>
  <ApplicationProperties>
  <Name>WWW</Name>

  <Run>/usr/applications/web/web</Run>
  <AutoRestart>true</AutoRestart>
  <KillInvisible>false</KillInvisible>
  <StartTimeout>10</StartTimeout>
  <ApplicationType>secondary</ApplicationType>
  <RegisterUri>uritype=http;mimetype=text/html</RegisterUri>
  <RegisterUri>uritype=http</RegisterUri>
  <RegisterUri>mimetype=text/html</RegisterUri>
</ApplicationProperties>

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.