Component description

The pipeline-run component creates a button that executes a pipeline or a part of it.

Example

Minimal JSON

{
  "type": "pipeline-run",
  "pipeline": ""
}
{
  "type": "pipeline_run",
  "pipeline": "pipeline_1",
  "activity": "activity_1",
  "afterResponse": {
    "refreshPage": true,
    "refreshLeftMenu": false,
    "refreshObjectContent": false
  },
  "componentId": "pipeline#id",
  "title": "title.pipeline",
  "tooltip": "title.tooltip"
}

Nested properties

PropertyDescriptionValuesMandatory
typepipeline-runstringYes
pipelineKey of the pipeline that should be executed.stringYes
activityKey of the pipeline activity to be executed. Used when the pipeline has multiple activities and we want to specify which one should run.stringNo
afterResponseConfigures which elements are refresh after the button is clicked. Define the following properties: refreshPage: Refreshes the page., refreshLeftMenu: Refreshes the left hierarchy., refreshObjectContent: Refreshes the content on the page. All these parameters are mandatory for the afterResponse property.jsonNo
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template).stringNo
titleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section.stringNo
tooltipTranslation key of the tooltip that appears when hovering over the property. Define in translations to specify how the text is displayed in the UI.