createFormalParameter

if (args.parameters['paramName1'] != 'test1' && args.parameters['paramName1'] != 'test2') {
  // return an appropriate error message in case the validation failed
  return "'paramName1' parameter value is not valid"

} else {
  // an empty or null response is construed as a validation success
  return null
}
▼

// Get the formal parameter that the validation logic
// for the parameter 'state' depends on.
def selectedCountry = args.parameters['country']

def valid = true
if (selectedCountry == 'US') {
  if (args.parameters['state'] != 'CA' &&
      args.parameters['state'] != 'CO') {

    valid = false

  }
} else if (selectedCountry == 'Canada') {
  if (args.parameters['state'] != 'BC' &&
      args.parameters['state'] != 'ON') {

    valid = false
  }
}

if (!valid) {
  // Return an appropriate error message since
  // the validation failed
  return "'state' parameter value is not valid"
}
▼

pipeline 'Test', {
  projectName = 'Default'

  formalParameter 'Use Existing Project', {
    type = 'checkbox'
    checkedValue = 'true'
    uncheckedValue = 'false'
  }

  formalParameter 'Existing Project', {
    type = 'project'
    renderCondition = '${Use Existing Project} == \'true\''
  }

  formalParameter 'New Project Name', {
    type = 'entry'
    renderCondition = '${Use Existing Project} == \'false\''
  }
}
▼

pipeline 'Test', {

  projectName = 'Default'
  formalParameter 'projectParam', defaultValue: null, {
    expansionDeferred = '0'
    label = 'Project to Use'
    orderIndex = '1'
    required = '0'
    type = 'project'
  }
  formalParameter 'appParam', defaultValue: null, {
    expansionDeferred = '0'
    label = 'Select Application'
    orderIndex = '2'
    projectFormalParameterName = 'projectParam'
    required = '0'
    type = 'application'
  }
}
▼

def options = []

// The parameter and the procedure for which we are retrieving the options
// may be accessed as follows if needed:
def parameterName = args.formalParameterName
def procedureName = args.procedureName

// Get all projects and loop over the list considering only those that
// have the property 'customFlag' defined and set to '5'.

def projects = getProjects()

projects.each { p ->
  // Check if the custom property is set on the project
  // and that its value is equal to '5'. If so, add the
  // project as the options result.
  // DSL tip: The groovy Elvis operator can be used
  // to do an existence check and then get a property
  // value if the property exists like this.
  if(p.customFlag?.value == '5') {

      // Add the project name to the options list.
      // The projects will be displayed in the order
      // in which they are added to the list.
      // Sort the options list before returning to
      // display them in a sorted order.
    options<< p.projectName
  }
}

// Finally return the options list
// 'return' is not needed in groovy. The response of the last
// statement is returned automatically
options.sort()
▼

$cmdr->createFormalParameter("Sample Project", "Branch Name",
  {required => 1 });
▼

ectool createFormalParameter "Sample Project" "Branch Name" --required 1
▼

ectool createFormalParameter --formalParameterName "Active users"
  --projectName "CD" --pipelineName "CD Ppieline"
▼

ectool createFormalParameter --projectName $projectName
  --pipelineName $pipelineName
  --formalParameterName $parameter_name
  --type "checkbox" --defaultValue "true" --checkedValue true
  --uncheckedValue false
▼

ectool createPipeline 'Default' 'Test'

ectool createFormalParameter 'Default' 'Use Existing Project' --pipelineName Test --type checkbox
                              --checkedValue 'true' --uncheckedValue = 'false'

ectool createFormalParameter 'Default' 'Existing Project' --pipelineName Test --type project
                              --renderCondition "${Use Existing Project} == 'true'"

ectool createFormalParameter 'Default' 'New Project Name' --pipelineName Test --type project
                              --renderCondition "${Use Existing Project} == 'false'"
▼