Pipeline variables in Cloud Manager

Last update: October 14, 2024
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • Admin
  • Developer

Your build process might rely on specific configuration variables that should not be stored in the Git repository. Or, you may need to adjust them between pipeline runs on the same branch. Cloud Manager lets you manage these settings as pipeline variables.

About pipeline variables

Using Cloud Manager you can configure pipeline variables in several different ways.

Variables may be stored as either plain text or encrypted at rest. In either case, variables are made available inside the build environment as an environment variable, which can then be referenced from inside the pom.xml file or other build scripts.

Add a pipeline variable through Cloud Manager

Pipeline variables can be configured and managed through the Cloud Manager user interface. They help streamline pipeline management, especially when varying configurations are required across different steps.

You must have permissions to edit the pipeline to add, edit, and delete pipeline variables.

If a pipeline is running, variable management is blocked.

To add a pipeline variable through Cloud Manager:

  1. When managing your pipelines, click Ellipsis - More icon of the pipeline for which you want to create pipeline variables.

  2. From the drop-down menu, click View/Edit variables.

    View/Edit pipeline variables

  3. In the Variables Configuration dialog box, enter the details in the first row of the table.

    FieldDescription
    Name

    A unique name of the configuration variable. It identifies the specific variable that is used in the pipeline. It must adhere to the following naming conventions:

    • Variables can only contain alphanumeric characters and the underscore (_).
    • The names should be all upper-case.
    • There is a limit of 200 variables per pipeline.
    • Each name must be 100 characters or less.
    • Each string variable value must be less than 2048 characters.
    • Each secretString type variable value must be 500 characters or less.
    ValueThe value that the variable holds.
    Step Applied

    Required. The step in the pipeline to which the variable applies:

    • Build - The variable is applied during the build process.
    • Functional testing - The variable is used during the functional testing step.
    • UI testing - The variable is used during the UI testing phase.
    TypeSelect if the variable is plain text or encrypted as a secret.

    Add variable

  4. Click Add.

    Add additional variables as needed.

  5. Click Save.

Edit a pipeline variable

  1. When managing your pipelines, click Ellipsis - More icon of the pipeline for which you want to edit pipeline variables.

  2. In the drop-down menu, click View/Edit variables.

    View/Edit pipeline variables

  3. In the Variables Configuration dialog box, click Ellipsis - More icon of the variable that you want to change.

  4. In the drop-down menu, click Edit.

    Edit variable

  5. Update the value of the variable as required.

    Only the variable’s value can be changed.

  6. Do one of the following:

    • Click Apply - Checkmark icon to apply the change.
    • Click Undo icon to revert the change.

  7. Click Save.

Delete a pipeline variable

  1. When managing your pipelines, click Ellipsis - More icon of the pipeline for which you want to delete pipeline variables.

  2. In the drop-down menu, click View/Edit variables.

    View/Edit pipeline variables

  3. In the Variables Configuration dialog box, click Ellipsis - More icon of the variable you want to remove, then click Delete.