KasperskyOS Community Edition 1.3

List of runConfiguration objects

The list of runConfiguration objects includes keys containing information about the possible startup configurations of the program. A list of these keys is provided in the table below.

List of keys for describing a startup configuration instance for the list of runConfiguration objects

Key name

Value type

Description

Required

Example

id

String

Startup configuration ID that is unique within the specific KPA package.

Yes

"id": "app"

name

String

Startup configuration name.

This is a localized string.

Yes

"name": "application"

or

"name": "@runConfigurationLocalizedName@"

type

String

Startup configuration type:

  • gui – process with a graphical user interface.
  • service – endpoint process.

Yes

"type": "service"

args

List of strings

List of arguments in the form of a string array.

No

"args":

[

"networkSpeed=4096",

"nthreads=2"

]

envVariables

List of objects

List of environment variables.

No

"envVariables":

{

"name": "IMAGES"

"value": "images"

}

 

name

String

Environment variable name.

Yes (if envVariables is used)

value

String

Environment variable value (can be an empty string).

Yes (if envVariables is used)

primary

Logical

Indicates whether the startup configuration is the primary one during program startup: true means that it is primary, and false means that it is not.

Yes

"primary": true

autorun

Logical

Indicates whether this configuration is started automatically: true means that it is started automatically, and false means that it is not. The default value is false.

No

"autorun": false

eiid

String

Program security class. Required for the KasperskyOS security module.

No

"eiid": "application.Application"

path

String

Path to the KPA package component file. The path is defined relative to /<application_id>.

Yes

"path": "bin/application"

usesService

List of objects

List of startup configurations on which this startup configuration depends. Not supported in the current version of KasperskyOS Community Edition.

No

"usesService":

{

"name": "database"

"useType": "child"

}

 

name

String

Name of the utilized startup configuration. If the startup configuration is in another KPA package, the value of this field must have the format "<package_name>:<startup_configuration_name>". If the startup configuration is in this KPA package, the field may have a value in the format "<package_name>:<startup_configuration_name>" (<package_name> corresponds to the current package) or only "<startup_configuration_name>".

Yes (if usesService is used)

useType

String

Startup configuration usage type:

  • child – the program can start the specified startup configuration as a child process.
  • serviceCanUse – the program may require the specified endpoint.
  • serviceActive – the specified endpoint must be active when the program is started.

Yes (if usesService is used)