Environment variables

Use these tutorials to create global and project environment variables, as well as edit or delete them.

Refer to the explanation of environment variables to review the difference between global and project environment variables.

1. Global environment variables

1.1. Create a global variable

Let’s create the global environment variable $DUNDER_PW, where we’ll store the global password, dunder-mifflin.

Let’s assume that you are on a platform where you have the right to create global environment variables.

1.1.1. Navigate to global environment variables

You access global environment variables from the projects library page.

Only global environment variables appear on this list.

  1. Go to the Projects module from the primary navigation menu.

  2. Verify that the breadcrumbs only contain Projects.

  3. Go to Environment variables from the secondary navigation menu.

  4. Select the New variable button.

Navigate to global environment variables

1.1.2. Create your variable

A panel will appear to create your variable.

  1. Enter the name of your variable: DUNDER_PW

  2. Enter a description of your variable: Global password for Dunder Mifflin Paper Company, Inc.

  3. Since this is a password, select the is password checkbox.

  4. In the value field, enter the password: dunder-mifflin

    Note the global label near value.

  5. Select the Save button.

Panel to create a new global environment variable

Your global environment variable can now be used by all projects on this platform.

1.2. Edit a global variable

The password changed for the global environment variable $DUNDER_PW, so let’s change it on your Saagie platform.

1.2.1. Navigate to global environment variables

You access global environment variables from the projects library page.

Only global environment variables appear on this list.

  1. Go to the Projects module from the primary navigation menu.

  2. Verify that the breadcrumbs only contain Projects.

  3. Go to Environment variables from the secondary navigation menu.

  4. Open the environment variable you need to edit (in this case, DUNDER_PW) by selecting anywhere in its row.

Navigate to global environment variables

1.2.2. Edit your variable

A panel will appear to edit your variable.

  1. Don’t change the name or description of the variable.

  2. The is password checkbox should already be checked.

  3. In the value field, enter the updated password: dunder-mifflin-paper

    Note the global label near value.

  4. Select the Save button.

Panel to edit a global environment variable

Your edited global environment variable containing the new password is ready to be used by all projects on the platform.

1.3. Delete a global variable

You no longer need the global environment variable $DUNDER_PW, so let’s delete it.

1.3.1. Navigate to global environment variables

You access global environment variables from the projects library page.

  1. Go to the Projects module from the primary navigation menu.

  2. Verify that the breadcrumbs only contain Projects.

  3. Go to Environment variables from the secondary navigation menu.

  4. Open the environment variable you need to edit (in this case, DUNDER_PW) by selecting anywhere in its row.

    Only global environment variables appear on this list.
Navigate to global environment variables

1.3.2. Delete environment variable

The same panel that opened when editing your variable will open again.

  1. This time, select the Delete button.

  2. A prompt will open to confirm that you’d like to delete your environment variable.

  3. Select the Delete button.

Panel to delete a global environment variable

Your global environment variable is now deleted and can no longer be used.

If your environment variable is used by any jobs or custom apps, deleting it might cause problems for those jobs or apps.

2. Project environment variables

2.1. Create a project variable

Let’s create the project environment variable $SCRANTON_PW, where we’ll store the password for the Scranton Branch, scranton-paper.

Let’s assume that:

  • you’ve created the project Dunder Mifflin Paper Sales, and

  • you have the right to create project environment variables.

2.1.1. Navigate to project environment variables

Access project environment variables from within your project.

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project

  3. Use the breadcrumbs to confirm that you are in your project. In the image, the breadcrumbs read Projects / Dunder Mifflin Paper Sales.

  4. Go to Environment variables from the secondary navigation menu.

    Notice that both global and project environment variables appear on this list.

  5. Select the New variable button.

    Navigate to project environment variables

2.1.2. Create your variable

A panel will appear to create your variable.

  1. Enter the name of your variable: SCRANTON_PW

    Note the project label near scope.

  2. Enter a description of your variable: Project password for the Scranton Branch.

  3. Since this is a password, select the is password checkbox.

  4. In the value field, enter the password: scranton-paper

  5. Select the Save button.

Panel to create a new project environment variable

Your project environment variable is now ready for use within your project.

2.2. Edit a project variable

The password changed for the project environment variable $SCRANTON_PW, so let’s change it on your Saagie platform.

2.2.1. Navigate to project environment variables

Access project environment variables from within your project.

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project

  3. Use the breadcrumbs to confirm that you are in your project. In the image, the breadcrumbs read Projects / Dunder Mifflin Paper Sales.

  4. Go to Environment variables from the secondary navigation menu.

    Notice that both global and project environment variables appear on this list.

  5. Open the environment variable you need to edit (in this case, SCRANTON_PW) by selecting anywhere in its row.

    Navigate to global environment variables

2.2.2. Edit your variable

A panel will appear to edit your variable.

  1. Don’t change the name or description of the variable.

    Note the project label near value.

  2. The is password checkbox should already be checked.

  3. In the value field, enter the updated password: scranton-branch-paper

  4. Select the Save button.

Panel to edit a project environment variable

Your edited project environment variable containing the new password is ready to be used, but only within this project.

2.3. Delete a project variable

You no longer need the project environment variable $SCRANTON_PW, so let’s delete it.

2.3.1. Navigate to project environment variables

Access project environment variables from within your project.

  1. Go to the Projects module from the primary navigation menu.

  2. Go to the Dunder Mifflin Paper Sales project.

    Navigate to your project

  3. Use the breadcrumbs to confirm that you are in your project. In the image, the breadcrumbs read Projects / Dunder Mifflin Paper Sales.

  4. Go to Environment variables from the secondary navigation menu.

    Notice that both global and project environment variables appear on this list.

  5. Open the environment variable you need to edit (in this case, SCRANTON_PW) by selecting anywhere in its row.

    Navigate to global environment variables

2.3.2. Delete environment variable

The same panel that opened when editing your variable will open again.

  1. This time, select the Delete button.

  2. A prompt will open to confirm that you’d like to delete your environment variable.

  3. Select the Delete button.

Panel to delete a project environment variable

Your project environment variable is now deleted and can no longer be used.

If your environment variable is used by any jobs or custom apps, deleting it might cause problems for those jobs or apps.