--- title: "Environment Variables" slug: "environment-variables" updated: 2026-08-26T21:12:59Z published: 2026-08-26T21:12:59Z canonical: "docs.processmaker.com/environment-variables" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.processmaker.com/llms.txt > Use this file to discover all available pages before exploring further. # Environment Variables > [!TIP] > [**Plan Availability:**](https://www.processmaker.com/products/pricing/) ![Professional](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Standard.png)![Professional](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Professional.png)![Enterprise](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Enterprise.png) In ProcessMaker Platform, an Environment Variable is a secure, abstract proxy for any sensitive information that you need to use in a Process. Any 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 Environment Value represents. The Process designer creates the placeholder for that sensitive information, and then the value for the Environment Value is entered or read via a [Script](/summer-2024/A7mdugENW7gZw1jmnrOv/designer-advanced/what-is-a-script) during a Request. Below are a few examples how to use Environment Variables: - A Request participant's username and password may be entered into a [Screen](/v1/docs/screens) as part of a Task that passes each 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 Environment Variables. - A Request participant's banking information securely interacts with a bank to make transactions securely while following compliance protocols. ### Default Environment Variables ProcessMaker Platform has default Environment Variables: | 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](https://staging-pm4.processmaker.net/api/documentation) calls. | | API_TOKEN | Token a [Script](/summer-2024/A7mdugENW7gZw1jmnrOv/designer-advanced/what-is-a-script) uses to authenticate to 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. | | GOOGLE_API_TOKEN | Google API token uses to authenticate the [Google Place](/v1/docs/google-places-control) control. | | SMART_EXTRACT_DASHBOARD_URL | Defines the [Smart Extract](/v1/docs/smart-extract) dashboard URL used by the Smart Extract panel. Updating this value causes the panel to load from the configured address. | | SMART_EXTRACT_API_HOST | Defines the [Smart Extract](/v1/docs/smart-extract) API host used for Smart Extract service requests. Updating this value routes Smart Extract API calls to the configured endpoint. | | SMART_EXTRACT_CLIENT_ID | Defines the client ID used to authenticate with [Smart Extract](/v1/docs/smart-extract). This value is sensitive and is masked in the UI. Updating this value changes the credentials used during authentication. | | SMART_EXTRACT_CLIENT_SECRET | Defines the client secret used to authenticate with [Smart Extract](/v1/docs/smart-extract). This value is fully masked in the UI, and the current value is never displayed. Only new values can be entered. Updating this value changes the credentials used during authentication. | | SMART_EXTRACT_HITL_ENABLED | Controls whether Human-in-the-Loop review is enabled for [Smart Extract](/v1/docs/smart-extract). When set to `true`, documents with low confidence trigger a manual review task. When set to `false`, manual review is skipped and the process proceeds automatically. | Use a [Script](/summer-2024/A7mdugENW7gZw1jmnrOv/designer-advanced/what-is-a-script) to get the value of these Environment Variables. See [Environment Variable Syntax, Usage, and Examples](/v1/docs/script-editor#processmaker-and-environment-variable-syntax-usage-sdk-and-examples). > [!WARNING] > Please do not delete these default Environment Variables: all features behind them will no longer function if they are deleted. ## View All Environment Variables 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 designers 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. **Permissions** 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](/v1/docs/permission-descriptions-for-users-and-groups#environment-variables) permissions or ask your Administrator for assistance. Follow these steps to view all Environment Variables in your organization: 1. ​[Log on](/v1/docs/participant-basics#log-on-to-processmaker-platform) to ProcessMaker Platform. 2. Click the **Designer** option from the top menu. The [Designer Welcome Screen](/v1/docs/designer-welcome-screen) displays. 3. Click the **Environment Variables** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/44d34538-5c1a-41ec-a5d3-78c83be827ce.png) from the left sidebar. The **Environment Variables** page displays all Environment Variables. ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Environment Variables.png) 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](/v1/docs/profile-settings#change-your-processmaker-settings) **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](/v1/docs/profile-settings#change-your-processmaker-settings) **Time zone** setting is specified. > [!NOTE] > ### Search for an Environment Variable > > Use the [Search](/v1/docs/manage-environment-variables#search-for-an-environment-variable) setting to filter Environment Variables that display. > > ### Create an Environment Variable > > Click the **+Environment Variable** button. See [Create a New Environment Variable](/v1/docs/create-a-new-environment-variable#create-a-new-processmaker-environment-variable). > > ### Edit an Environment Variable > > Click the ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Ellipsis Icon.png) icon, and then select the **Edit Variable** option. See [Edit an Environment Variable](/v1/docs/manage-environment-variables#edit-a-environment-variable). > > ### Use an Environment Variable in a Script > > See [Environment Variable Syntax, Usage, and Examples](/v1/docs/script-editor#processmaker-and-environment-variable-syntax-usage-and-examples) for how to use an Environment Variable in each programming language that ProcessMaker Platform supports. > > ### Delete an Environment Variable > > Click the ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/Ellipsis Icon.png) icon, and then select the **Delete** option. See [Delete an Environment Variable](/v1/docs/manage-environment-variables#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](/v1/docs/organize-your-inbox), including how to sort columns or how many items display per page. ## Related - [Create a New Environment Variable](/create-a-new-environment-variable.md) - [Manage Environment Variables](/manage-environment-variables.md)