Help Center> CodeArts Pipeline> User Guide> Pipelines> Configuring Pipeline Parameters> Configuring Parameters
Updated on 2024-06-27 GMT+08:00
View PDF

Configuring Parameters

You can create and configure custom parameters and group parameters for pipelines.

Custom Parameters

  1. Log in to CodeArts Pipeline.
  2. Search for the target pipeline, click in the Operation column, and click Edit.
  3. Switch to the Parameter Configuration tab page.

    You can configure the following information.

    Basic Information

    Description

    Create now

    Click Create now to create a parameter.

    Name

    Parameter name. You can specify a parameter name.

    NOTE:

    The specified name cannot be the same as that of a predefined parameter.

    Type

    Parameter types include string, auto-increment, and enumeration.

    Default

    You can enter or select a parameter value.

    Private Parameter

    If a parameter is private, the system encrypts the parameter for storage and decrypts the parameter for usage. Private parameters will not be displayed in run logs.

    Runtime Setting

    If Runtime Setting is enabled, you can change the value of this parameter during task orchestration.

    Description

    Description of a parameter.

    Operation

    You can click to delete a parameter.

  4. Create and configure parameters.

    Click Create now, set the name, type (String by default), and parameter value. You can also set it as a private parameter and enable runtime setting.

    • String

      The parameter value is a string. You can customize the value in the Default column, and enable Private Parameter and Runtime Setting.

    • Enumeration

      After you select Enumeration, the Enumeration dialog box is displayed. You can set the optional value.

      After the setting is complete, you can click the Default drop-down list box to select another value. Or, you can click Enumeration to change the value.

    • Auto-increment

      The parameter value is a string and defaults to 1.0.0. If such a parameter is referenced by a job in the pipeline, the value of this parameter is incremented by 1 each time the pipeline is run.

      If the value of an auto-increment parameter does not end with a digit, the value does not increase automatically after an execution.

Parameter Groups

  1. Log in to CodeArts Pipeline.
  2. Go to the pipeline list page and click Parameter Groups.
  3. Click Create Group.

    Enter a name and description. Click Create now to create custom parameters. For details, see Custom Parameters.

  4. Go to the pipeline editing page, choose Parameter Configuration > Parameter Groups.
  5. Click Associate Now, select a parameter group, and click Confirm to associate the parameter group with the pipeline.

    • Expand the group to check parameter details.
    • Click in the Operation column to diassociate with the parameter group.