Configuring Parameters of an Application

Creating and Configuring a Parameter

This section describes how to create and configure user-defined parameters in an application.

1. Select the target application, click , and click Edit. The Deployment Actions page is displayed.
2. Click Parameters.

   The following parameters are provided.

   Basic Information	Description
   Create Parameter	You can click Create Parameter to add a parameter.
   Name	Parameter name. You can change the name of a custom parameter. NOTE: The name of a custom parameter cannot be the same as that of a predefined parameter.
   Type	Parameter types include string, enumeration, and environment.
   Default Value	Enter or select a parameter value. NOTE: If no environment is available when you select an environment type, you need to manually create an environment.
   Private Parameter	If a parameter is private, the system encrypts the input for storage and only decrypts the parameter when using it. Runtime Settings cannot be set.
   Runtime Settings	If this parameter is enabled, the parameter value can be changed during application deployment and the parameter value will be reported to the application. Runtime parameters need to be entered during execution.
   Description	Parameter description.
   Operation	Click to delete a parameter.

3. Click Create Parameter to add a parameter. Customize the parameter name, type (String by default), and default value as required, and set private parameters and runtime settings.
   • String

     The parameter value is a character string. You can customize the value in the Default Value column, and enable the private parameter or runtime settings.

     

   • Enumeration

     After you set the type to Enumeration, the enumeration dialog box is displayed for you to set Available Values. To set multiple values, click the icon. To delete a value, click .

     

     After the setting, select a value from the Default Value drop-down list, as shown in the following figure.

     

   • Environment

     Select an environment from the Default Value drop-down list. You can select an environment created in the application from the drop-down list.

     NOTE:

     If there is no option in the drop-down list, create an environment on the Environment Management tab page. Then return to the parameter configuration page and click to refresh the environment to the drop-down list.

4. After modifying all information, click Save.

Editing a Parameter

1. Select the target application, click , and click Edit. The Deployment Actions page is displayed.
2. Click Parameters.
   • Edit a parameter.

     You can edit Name, Type, Default Value, Private Parameter, Runtime Settings, and Description of the existing parameters. You can also click to drag parameters to change their order.

   • Add a parameter.

     Click Create Parameter to add a parameter. You can also click in the Operation column to add a new parameter and edit it under the current parameter.

   • Delete a parameter.

     Click to delete an existing parameter.

Using a Parameter

This section uses an example to describe how to use custom parameters.

1. Select the target application, click , and click Edit. The Deployment Actions page is displayed.
2. Click Parameters, create custom parameters of Environment, Enumeration, and String respectively and enable their Runtime Settings.
3. Click Deployment Actions and reference custom parameters in the actions details.

   The parameter reference format is ${Parameter name}. Enter $ in the text box and the parameter list will be displayed. Select the parameter as required.

   For example, when configuring the Software Package item, enter $ to display the configured package_url parameter, and then select this parameter.

   

4. Click Save and Deploy. In the dialog box that is displayed, assign values to the parameters again.
5. Click OK to save and deploy the application.

NOTE:

1. When CodeArts Pipeline is associated with an application, parameters can be dynamically bound.
2. When CodeArts Pipeline is running, the entered parameter values will be replaced in the application and run.
3. After you add a task action of the deployment type to the pipeline task and select an application with Runtime Settings parameters, parameters can be dynamically configured when the pipeline is executed.