Environment Variables
The environment variables view allows you to define custom variables that are automatically set at the beginning of a session on the virtual machine. These variables are useful to configure you working environment, such as setting paths, credentials, or other runtime configurations.
At the end of the session, all environment variables are automatically unset during cleanup to ensure no residual configurations persist on the VM, guaranteeing a clean and secure environment for subsequent sessions.
The environment variables defined here are tied to your personal user profile and are only available in sessions initiated by you. If you are working with organization-level or group-level tokens, you can configure environment variables as described in the Access-Tokens-Environment-Variables section. This ensures flexibility and consistency when managing environment configurations across different contexts.
Add Environment Variables to Your Profile
Steps
1. Open the Environment Variables View
- Click the profile page in the right corner of the navigation bar and open the Environment Variables view.
2. Add an Environment Variable
- Click the Add Button in the upper right corner of the Environment Variables Table. Fill out the Form and confirm by clicking Add.
Info
The value can include paths, credentials, or any configuration data required for your application.
Edit or Delete a Environment Variable
You can edit or delete the Environment Variable with the or icon.
Info
If you want change the name of the variable, you must delete the existing variable and create a new one with the desired name. Name changes cannot be made directly in the edit dialog.
Variables Set by vHaaS
vHaaS sets a few variables on the VM itself, so a tool running in a session can reach the vHaaS API without anything being hardcoded. They are listed read-only in the Set by vHaaS section of the Environment Variables view and are removed at the end of the session along with your own.
| Variable | Contents |
|---|---|
| VHAAS_TOKEN | API token for this session. Send it in the private-token request header. It acts with your own permissions and is revoked when the session ends. |
| VHAAS_URL | Base URL of this vHaaS instance, without a trailing slash or an /api suffix. |
| VHAAS_ORGANIZATION_ID | Organization owning the assembly. Most API paths are organization-scoped. |
| VHAAS_SESSION_ID | This session. Quote it in support requests and use it for session-scoped API calls. |
| VHAAS_USER_ID | Your vHaaS user. |
| VHAAS_ASSEMBLY_REF | Reference of the assembly this session runs on. |
| VHAAS_ASSEMBLY_PROFILE_PATH | Path of the assembly profile JSON file on the VM. |
| ALM_USERNAME, ALMPLUS_USERNAME | Your ALM+ account name, taken from your login. Both names carry the same value. Absent if your identity provider does not supply it. |
Info
Some of these are also set under an older VEHAAS_ spelling so existing scripts keep working. Use the VHAAS_ names in anything new.
Warning
You cannot create a variable of your own under one of these names — the name field rejects it, including a differently cased spelling of it, because Windows variable names are case-insensitive.