ProcessMaker API Documentation
ProcessMaker Examples

What is an Environment Variable?

Understand how to use Environment Variables in ProcessMaker.

Overview

In ProcessMaker, an Environment Variable is a secure, abstract proxy for any sensitive information that you need to use in a Process. Any ProcessMaker Environment Variable can be re-used in any Process to abstract information securely throughout your organization.

You do not need to know the sensitive information that the ProcessMaker Environment Value represents. The Process Owner creates the placeholder for that sensitive information, and then the value for the ProcessMaker Environment Value is entered or read via a ProcessMaker Script during a Request.

Below are a few examples how to use ProcessMaker Environment Variables:

  • A Request participant's username and password may be entered into a ProcessMaker Screen as part of a Task that passes each ProcessMaker Environment Variable's value securely to a third-party service.

  • A Request participant's credit card information securely interacts with an online payment processing service through multiple ProcessMaker Environment Variables.

  • A Request participant's banking information securely interacts with a bank to make transactions securely while following compliance protocols.

ProcessMaker has default Environment Variables:

ProcessMaker Environment Variable

Description

HOST_URL

Domain for the ProcessMaker instance.

API_HOST

ProcessMaker instance API to which to make all ProcessMaker RESTful API calls.

API_TOKEN

Token a ProcessMaker Script uses to authenticate to the ProcessMaker API host. Note that this API token is only valid for the lifetime of the ProcessMaker Script: after the Script runs and the Script Executor's Docker container from which that Script ran, its API token is no longer valid.

Use a ProcessMaker Script to get the value of these Environment Variables. See ProcessMaker and Environment Variable Syntax, Usage, and Examples.

Related Topics