Difference between revisions of "GetEnv"

From AgileApps Support Wiki
imported>Aeric
 
imported>Aeric
Line 16: Line 16:
|-
|-
| ENV.USER.ID || Logged in user's ID
| ENV.USER.ID || Logged in user's ID
|-
| ENV.USER.EMAIL || Logged in user's email
|-
|-
| ENV.USER.USER_NAME || Logged in user's username
| ENV.USER.USER_NAME || Logged in user's username
Line 24: Line 22:
|-
|-
| ENV.USER.COMPANY_NAME || Logged in user's company name
| ENV.USER.COMPANY_NAME || Logged in user's company name
|-
| ENV.USER.EMAIL || Logged in user's email
|-
| ENV.USER.TENANT_ID || The ID of the tenant the user is logged in to
|-
|-
| ENV.USER.TIME_ZONE || Logged in user's timezone
| ENV.USER.TIME_ZONE || Logged in user's timezone
Line 42: Line 44:
|-
|-
| ENV.ISV.RECAPTCHA_PUBLIC_KEY || Key used when verifying that the system is interacting with a person. ''Learn more: [http://google.com/recaptcha/learnmore recaptcha].
| ENV.ISV.RECAPTCHA_PUBLIC_KEY || Key used when verifying that the system is interacting with a person. ''Learn more: [http://google.com/recaptcha/learnmore recaptcha].
<!--
  FUTURE
|-
|  ENV.ISV.RECAPTCHA_PUBLIC_KEY_ALT1 || Alternate key for use with an alternate server.
-->
|}
|}



Revision as of 23:09, 25 July 2011

getEnv(String key)
Description
Gets the environment variable value for the key via the Java API

Syntax

String = Functions.getEnv(String variable)

Environment Variable Constants

The following constants can be used as keys to access the environment variables:
Key Variable
ENV.USER.ID Logged in user's ID
ENV.USER.USER_NAME Logged in user's username
ENV.USER.FULL_NAME Logged in user's full name
ENV.USER.COMPANY_NAME Logged in user's company name
ENV.USER.EMAIL Logged in user's email
ENV.USER.TENANT_ID The ID of the tenant the user is logged in to
ENV.USER.TIME_ZONE Logged in user's timezone
ENV.COMMUNITY.TENANT.ID The community tenant ID
ENV.MSP.ID The ID of the MSP for this tenant. Blank if the current tenant is not under an MSP.
ENV.SESSION.ID ID of the logged in user's session
ENV.ISV.RECAPTCHA_PUBLIC_KEY Key used when verifying that the system is interacting with a person. Learn more: recaptcha.

Return

The value of the environment variable as a String.
Example
This example calls getEnv to get the current user's identifier.
String userID = Functions.getEnv(ENV.USER.ID);