Build-test automation
IntroductionScenario 1 - Creating a simple procedureScenario 2 - Creating a procedure that uses an SCMScenario 3 - Notification, scheduling, and reportingScenario 4 - Multi-agent build and test
IntroductionCustomizing the automation platform UIConfiguring CloudBees CD/ROUsing CloudBees CD/RO in your environmentCloudBees CD/RO Installed tools
IntroductionArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingJob step execution environmentPostprocessorsReportsWorkflow overviewWorkspaces overview
IntroductionIntrinsic propertiesReserved wordsProperty shortcutsProperty error codes
IntroductionAdding a link to a jobCalling a subprocedureChecking the outcome of preceding stepsConditional executionCustom parameter layoutsEmail notificationsExecuting tasks on all resources in a poolFactory proceduresPostp extensionPublishing and retrieving an artifactReserving a resource for the job step durationRunning steps in parallelStep timeouts and steps that always runStoring and retrieving properties in a jobWorking with properties stored in a procedure
Using special characters in object names
Introduction
IntroductionDefining entriesCreate new or edit existing privileges
IntroductionArtifact detailsCreate new or edit existing artifactsArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositories
Database configuration
IntroductionCreate new or edit existing configurationsDefect tracking reports
IntroductionCreate new or edit existing email configurationsEmail notifiers
Event log
IntroductionJob configurationShortcutsJobs quick view
IntroductionCloudBees CD/RO job detailsJob step details
IntroductionProcedure runsCreate new or edit existing procedureCreate new or edit existing stepsPublish artifact version stepsRetrieve artifact version stepsSend email stepsCreate new or edit existing parameters
IntroductionProject detailsCreate new or edit existing schedulesCreate new or edit existing credentials
IntroductionNested Property Sheet
Reports
IntroductionResource poolsCreate new or edit existing poolsResource pool details
IntroductionSearch resultsEdit existing property settings
Source control
IntroductionUsersCreate new or edit existing local usersUser detailsEdit user settingsGroupsCreate new or edit existing groupsGroup detailsCreate new or edit existing directory providersSingle sign-onTest directory provider
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
Introduction Create or modify WorkspacesWorkspace file

Custom parameter layouts

2 minute readAutomation

By default, parameters for procedures are displayed in alphabetical order based on the parameter name. Using the ec_parameterForm property allows parameters to be displayed in a specified order, different from the default, alphabetized order by name. This tutorial shows how to create a custom parameter layout for procedures.

To view an example procedure for this tutorial , go to the automation platform UI > Projects > EC-Tutorials- <version> , and click the procedure name.

An explanation of what you see:

  • This procedure implements two parameters.

  • The Action column contains the command to execute. In this case, the action shows the ec_parameterForm property which was attached to the procedure.

  • Notice the check marks in the Req? column, which indicates both parameters are "required" each time this procedure runs.

  • In the Custom Procedure Properties table, notice the " formElement " values supplied to determine the new parameter order.

  • If the procedure is run without the ec_parameterForm property, the parameter input form displays parameters alphabetical order.

Click Run.

On the Run Procedure page, notice you are presented with a Parameter section that shows the parameters in reverse order because values supplied for the ec_parameterForm property were called to create this new order.

The following XML creates the new order for these parameters:

<editor>
  <formElement>
    <property>second parameter</property>
    <label>this is the label for "second parameter"</label>
    <type>entry</type>
    <required>1</required>
  </formElement>
  <formElement>
    <property>first parameter</property>
    <label>this is the label for first parameter</label>
    <type>entry</type>
    <required>1</required>
  </formElement>
</editor>
▼

Click Run to run this sample procedure and see the resulting job status on the Job Details page.

Implementation

This tutorial is intended for viewing, but not modifications within its procedure, and any changes you might make will not be saved when you upgrade CloudBees CD/RO. However, in your own projects, you can use the sample XML above to change the parameter order in any of your procedures.

If you copy and paste the code samples we provided, using the ec_parameterForm property in one or more of your procedures, make sure you replace our example values with your parameter names, labels, and so on. If you have more than two parameters to reorder, create any number of additional <formElement> sections you need.

Related information

Conditional execution
Email notifications