createFormalParameter

Back to index

Summary

Creates a formal parameter.

projectName

Stringoptional

The name for the project that must be unique among all projects.

reportName

Stringoptional

The name of the report, if the formal parameter is on a report.

formalParameterName

Stringrequired

Name for this parameter; used when the procedure is invoked to specify a value for the parameter.

applicationName

Stringoptional

The name of the application, if the formal parameter is on an application process.

archiveConnectorName

Stringoptional

The name of the archive connector, if the formal parameter is on an archive connector.

catalogItemName

Stringoptional

The name of the catalog item, if the formal parameter is on a catalog item.

catalogName

Stringoptional

The name of the catalog to which the catalog item belongs to.

checkedValue

Stringoptional

Parameter value when the checkbox used to render the parameter is checked. Applicable only for checkbox type.

componentName

Stringoptional

The name of the component, if the formal parameter is on a component process.

dashboardName

Stringoptional

The name of the dashboard, if the formal parameter is on a dashboard.

defaultValue

Stringoptional

If no value is provided for the parameter when the procedure is invoked, this value will be used.

defaultValueDsl

Stringoptional

DSL for default value.

dependsOn

Stringoptional

Comma-separated list of formal parameters that this parameter depends on. Use with cascading drop-down (select) parameters to declare dependency on one or more parameters.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

expansionDeferred

Booleanoptional

True means expansion for this parameter should be deferred: the parameter value will not be expanded when the procedure call is expanded, but can be expanded from a command step instead.

flowName

Stringoptional

The name of the flow to which the flow state belongs to.

flowStateName

Stringoptional

The name of the flow state, if the formal parameter is on a flow state.

gateType

Stringoptional

The type of the gate which contains the task, if the formal parameter is belongs to a task.

Possible values: "POST", "PRE"

label

Stringoptional

Specifies the display label.

microserviceName

Stringoptional

The name of the microservice.

multiSelect

Booleanoptional

Whether or not to use multiselect instead of select.

options

Array<Option>optional

Ordered list of options.

optionsDsl

Stringoptional

DSL for populating drop-down options for select formal parameter type.

optionsFromPropertySheet

Stringoptional

Path to the property sheet containing the options.

orderIndex

Integeroptional

Specifies the display order index (starts from 1).

pipelineName

Stringoptional

The name of the pipeline, if the formal parameter is on a pipeline.

procedureName

Stringoptional

The name of the procedure.

processName

Stringoptional

The name of the process, if the formal parameter is on a process.

processStepName

Stringoptional

The name of the process step, if the formal parameter is on a process step.

projectFormalParameterName

Stringoptional

Used when rendering the formal parameter to identify the formal parameter to use in order to get the owning project name. Applicable only for release, pipeline, application, service or environment parameter type.

propertyReference

Stringoptional

Property or property sheet to use for displaying options.

propertyReferenceType

Stringoptional

Whether the propertyReference value is a property sheet (default) or a property. For property sheet, nested property names are used as options while for property, the property value is used as an option.

Possible values: "plugin", "property", "propertySheet"

releaseName

Stringoptional

The name of the release, if the formal parameter is on a release-scoped pipeline.

renderCondition

Stringoptional

Condition for rendering the formal parameter.

required

Booleanoptional

True means this parameter is required: the procedure will not execute unless a value is given for the parameter.

simpleList

Stringoptional

Pipe-separated list of options, e.g., option1|option2|option3.

stageName

Stringoptional

The name of the stage which contains the task, if the formal parameter is belongs to a task.

stateDefinitionName

Stringoptional

The name of the state definition.

stateName

Stringoptional

The name of a workflow state.

taskName

Stringoptional

The name of the task, if the formal parameter is belongs to a task.

type

Stringoptional

The type of a formal parameter.

uncheckedValue

Stringoptional

Parameter value when the checkbox used to render the parameter is unchecked. Applicable only for checkbox type.

updateFormXml

Booleanoptional

Whether the parameter form XML stored in the procedure property ec_parameterForm should also be updated.

validate

Booleanoptional

If passed 0, then all validations check in the DSL arguments (validationDsl, optionsDsl, defaultValueDsl) are deactivated.

validationDsl

Stringoptional

DSL for validating the formal parameter.

workflowDefinitionName

Stringoptional

The name of the workflow definition.

workflowName

Stringoptional

The name of a workflow.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createFormalParameter(
  formalParameterName: "test-formalParameterName"
  /* optional arguments */
)▼