ProcessMaker API Documentation
Script Central

View Environment Variables

View the ProcessMaker Environment Variables in your organization.

View All ProcessMaker Environment Variables

ProcessMaker displays all ProcessMaker Environment Variables in one table that Process Owners throughout your organization have created. Any ProcessMaker Environment Variable can be used in any Process in your organization. Since ProcessMaker Environment Variables are abstract proxies to securely maintain sensitive information during in-progress Requests, Process Owners who create or use ProcessMaker 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 ProcessMaker user account or group membership must have the "Environment Variables: View Environment Variables" permission to view the list of ProcessMaker Environment Variables unless your user account has the Make this user a Super Admin setting selected.

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

Follow these steps to view all ProcessMaker 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. The Environment Variables page displays all ProcessMaker Environment Variables.

Environment Variables page displays all Environment Variables in your organization

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

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

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

  • Modified: The Modified column displays the date and time the ProcessMaker 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 ProcessMaker 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 ProcessMaker Environment Variable called GOOGLE_API_TOKEN that contains the Google API token for that ProcessMaker instance. The ProcessMaker Environment Variable does not require configuration or revision after it has been added to your ProcessMaker instance. Please do not delete that ProcessMaker Environment Variable: all Google Place controls added to Form-type ProcessMaker Screens will no longer function it it is deleted.

The Google Places package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Google Places package can be installed in your ProcessMaker instance.

Search for a ProcessMaker Environment Variable

Use the Search setting to filter ProcessMaker Environment Variables that display.

Create an Environment Variable

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

Edit a ProcessMaker Environment Variable

Click the Edit icon. See Edit an Environment Variable.

Delete a ProcessMaker Environment Variable

Click the Delete icon. See Delete an Environment Variable.

No ProcessMaker Environment Variables?

If no ProcessMaker 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