Manage your Environment Variables as a Process designer.
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new Environment Variable that can be re-used in any Process.
ProcessMaker Platform has default Environment Variables. Do not create your own Environment Variables for the following:
Instead, use a Script to get the value of these Environment Variables. See Environment Variable Syntax, Usage, and Examples.
Your user account or group membership must have the following permissions to create a Environment Variable unless your user account has the Make this user a Super Admin setting selected:
Environment Variables: Create Environment Variables
Environment Variables: View Environment Variables
See the Environment Variable permissions or ask your Administrator for assistance.
Follow these steps to create a new Environment Variable:
View your Environment Variables. The Environment Variables page displays.
Click the +Environment Variable button. The Create Environment Variable page displays.
In the Name setting, enter the unique name for the Environment Variable. The Environment Variable name can only contain letters, numbers, and hyphens (-
). This is a required setting.
In the Description setting, enter a description for the Environment Variable. This is a required setting.
Optionally, in the Value setting, enter the value for the Environment Variable. Entering a value is optional since Environment Variables are secure, abstract proxies for sensitive information you assign to contain a value that can be determined during an in-progress Request.
Click Save. The screen closes and the following message displays: The environment variable was created. The Environment Variables page displays with your new Environment Variable.
View the Environment Variables in your organization.
ProcessMaker Platform displays all Environment Variables in one table that Process designers 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 desgners 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:
​Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
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 Platform 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 Platform 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 Platform 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.
Use the Search setting to filter Environment Variables that display.
Click the +Environment Variable button. See Create a New Environment Variable.
See Environment Variable Syntax, Usage, and Examples for how to use an Environment Variable in each programming language that ProcessMaker Platform supports.
If no Environment Variables exist, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Click the Environment Variables icon from the left sidebar. The Environment Variables page displays all Environment Variables.
Click the ellipses icon, and then select the Edit Variable option. See Edit an Environment Variable.
Click the ellipses icon, and then select the Delete option. See Delete an Environment Variable.
ProcessMaker Platform Environment Variable
Description
HOST_URL
Domain for the ProcessMaker Platform instance.
API_HOST
ProcessMaker Platform instance API to which to make all our RESTful API calls.
API_TOKEN
Token a Script uses to authenticate to the our API host. Note that this API token is only valid for the lifetime of the Script: after the Script runs and the Script Executor's Docker container from which that Script ran, its API token is no longer valid.
Filter all Environment Variables in your organization to find that one you need.
Use the Search function to filter all Environment Variables from the Environment Variables page based on your entered text.
Your user account or group membership must have the "Environment Variables: View Environment Variables" permission to search for 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 search for a Environment Variable:
View your Environment Variables. The Environment Variables page displays.
Enter in the Search setting the text to filter Environment Variables using any of the following criteria:
Name: Filter by the Environment Variable name that displays in the Name column.
Description: Filter by the Environment Variable description that displays in the Description column.
As you enter text into the Search setting, Environment Variables display that match your entered text.
See Environment Variable Syntax, Usage, and Examples for how to use an Environment Variable in each programming language that ProcessMaker Platform supports.
If there are no search results, the following message displays: No Results.
Edit the sensitive information that an Environment Variable represents.
Your user account or group membership must have the following permissions to edit a Environment Variable unless your user account has the Make this user a Super Admin setting selected:
Environment Variables: Edit Environment Variables
Environment Variables: View Environment Variables
See the Environment Variable permissions or ask your Administrator for assistance.
Follow these steps to edit an Environment Variable:
View your Environment Variables. The Environment Variables page displays.
Edit the following information about the Environment Variable as necessary:
In the Name setting, edit the unique name of the Environment Variable. The Environment Variable name can only contain letters, numbers, and hyphens (-
). This is a required setting.
In the Description setting, enter the description of the Environment Variable. This is a required setting.
Optionally, in the Value setting, edit or enter the Environment Variable value. Entering or editing a value is optional since Environment Variables are secure, abstract proxies for sensitive information you assign to contain a value that can be determined during an in-progress Request.
Click Save.
See Environment Variable Syntax, Usage, and Examples for how to use an Environment Variable in each programming language that supports.
Delete an Environment Variable from being used in all processes in your organization.
Your user account or group membership must have the following permissions to delete a Environment Variable unless your user account has the Make this user a Super Admin setting selected:
Environment Variables: Delete Environment Variables
Environment Variables: View Environment Variables
The data that an Environment Variable maintains secure remains so for completed Requests associated with Processes that reference a deleted Environment Variable. However, in-progress and future Requests that reference a deleted Environment Variable no longer have a secure environment for that data. Be extremely cautious when considering deleting a Environment Variable.
Deleting an Environment Variable from the Environment Variables page cannot be undone.
Follow these steps to delete an Environment Variable:
Click Confirm.
Click the ellipses icon, and then select the Edit Variable option for the Environment Variable to edit. The Edit page displays.
See the permissions or ask your Administrator for assistance.
The Environment Variables page displays.
Click the ellipses icon, and then select the Edit Variable option for the Environment Variable to delete. The Caution screen displays to confirm the deletion of the Environment Variable.