Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Environment Variables Type

 

Use the environment variables object type to define environment variables for your apps in your app's manifest file.

The environment variables object is not an JSA application type. The following four environment variables are set automatically by JSA and are available to use in your app.

  • JSA_CONSOLE_HOST_NAME--The host name of the console where the app is installed.

  • JSA_CONSOLE_IP--The IP address of where the app is installed.

  • JSA_APPLICATION_BASE_URL--The web URL for the app.

  • LANG--The language code and character encoding that is used by the JSA console UI when the app is installed.

  • HTTP_PROXY / HTTPS_PROXY--If a proxy is configured, this environment variable is the IP address/hostname of the proxy server that JSA uses.

  • PROXY_USERNAME--If a proxy is configured, this environment variable is the username of the HTTPS proxy server that JSA uses.

  • PROXY_PASSWORD_DECRYPTED--If a proxy is configured, this environment variable is the decrypted password of the HTTPS proxy server that JSA uses.

  • PROXY_URL--If a proxy is configured, this environment variable is the IP address/hostname of the proxy server that JSA uses.

  • PROXY_PORT--If a proxy is configured, this environment variable is the port number of the proxy server that JSA uses.

Environment variables that you define in an app's manifest file are specific to that app and haven no effect outside the app container.

The following code sample shows how to configure the environment_variables block in the manifest file.

{ ... "environment_variables":[ { "name":"ENV_VAR1", "value":"1" }, { "name":"ENV_VAR2", "value":"2" }, { "name":"ENV_VAR3", "value":"3" } ], ... }

The following table explains the manifest fields for the environment_variables block.

Field

Type

Description

Required

name

String

The name of the environment variable.

Environment variable names cannot begin with a number, or contain an equals (=) sign.

Yes

value

String

The value of the environment variable.

Yes