ProcessMaker API Documentation
ProcessMaker Examples

View Environment Variables

View the Environment Variables in your organization.

View All ProcessMaker Environment Variables

ProcessMaker displays all Environment Variables in one table that Process Owners throughout your organization have created. Any Environment Variable can be used in any Process in your organization. Since Environment Variables are abstract proxies to securely maintain sensitive information during in-progress Requests, Process Owners who create or use Environment Variables in their Processes do not have access to that sensitive information. This makes it easy to manage sensitive information used in Requests.

Your user account or group membership must have the "Environment Variables: View Environment Variables" permission to view the list of Environment Variables unless your user account has the Make this user a Super Admin setting selected.

See the Environment Variable permissions or ask your Administrator for assistance.

Follow these steps to view all Environment Variables in your organization:

  1. Log on to ProcessMaker.

  2. Click the Designer option from the top menu. The Processes page displays.

  3. Click the Environment Variables icon from the left sidebar. The Environment Variables page displays all Environment Variables.

Environment Variables page displays all Environment Variables in your organization

The Environment Variables page displays the following information in tabular format about Environment Variables:

  • Name: The Name column displays the name of the Environment Variable.

  • Description: The Description column displays the description about the Environment Variable.

  • Modified: The Modified column displays the date and time the Environment Variable was last modified. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.

  • Created: The Created column displays the date and time the Environment Variable was created. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.

The Google Places package adds a Environment Variable called GOOGLE_API_TOKEN that contains the Google API token. The Environment Variable does not require configuration or revision after it has been added to your ProcessMaker instance. Please do not delete that Environment Variable: all Google Place controls added to Form-type Screens will no longer function if it is deleted.

Search for an Environment Variable

Use the Search setting to filter Environment Variables that display.

Create an Environment Variable

Click the +Environment Variable button. See Create a New Environment Variable.

Edit an Environment Variable

Click the Edit icon. See Edit an Environment Variable.

Use an Environment Variable in a Script

See Environment Variable Syntax, Usage, and Examples for how to use an Environment Variable in each programming language that ProcessMaker supports.

Delete an Environment Variable

Click the Delete icon. See Delete an Environment Variable.

No Environment Variables?

If no Environment Variables exist, the following message displays: No Data Available.

Display Information the Way You Want It

Control how tabular information displays, including how to sort columns or how many items display per page.

Related Topics