API error messages
Introduction
Perl API reference
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

DSL editors

2 minute readReferenceDeveloper productivity

CloudBees CD/RO provides two different DSL editors:

  • DSL IDE: general purpose DSL editor to easily create and evaluate DSL files.

  • DSL inline object editor: available within an object’s visual editor, it provides a convenient way to view or edit the underlying DSL for the object.

Alternatively, use the evalDsl API call from ectool to evaluate DSL code written in a text editor or use the Intellij plugin to edit and apply DSL code.

DSL IDE

The DSL IDE enables users to evaluate DSL directly from the CloudBees CD/RO UI. To access this feature from the CloudBees CD/RO main menu: Navigate to DevOps Essentials  DSL IDE. The DSL IDE editor displays.

IDE editor
Figure 1. DSL IDE

The DSL IDE (Integrated Development Environment) provides access to the following features: code editing, evaluation, importing, and exporting.

  1. Modify DSL code.

    • Import and Export - Import or export DSL code to or from local storage.

    • Undo, Redo, and Clear - Shortcuts for standard editor actions.

    • Format - Select a CloudBees CD/RO DSL format. Choices are:

    • Groovy

    • YAML format is a Preview feature.

      A Preview feature:

      • Has not undergone end-to-end testing with CloudBees products

      • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

      • May impact other stable areas of the product when used

      • May have limited documentation

      • May not be feature complete during the Preview period

      • May graduate from preview state to fully supported or be removed from the product

      • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

      Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

  2. DSL modification assistance features.

    • Seed scripts for several common DSL operations and CloudBees CD/RO objects by selecting an example from the Examples menu options.

    • Use object help features.

      • Access descriptions of editing functions and keyboard shortcuts by selecting the Help icon.

      • View object specific details, attributes, and code examples.

        1. Select the object name in the IDE-DSL editor.

        2. Type Command + H on Mac or CTRL + H on Linux/Windows. The Help displays details, attributes, and syntax for the selected object.

        3. Validate DSL script by selecting the Run button. The results appear in the bottom panel.

DSL inline object editor

The DSL inline object editor is available from within the editors for application, dashboard, environment, environment template, microservice, pipeline, and release. It provides a convenient way to view or edit the underlying DSL for the object.

The DSL editor simplifies the modeling process, by allowing you to run DSL code from the CloudBees CD/RO Deploy UI rather than using an external IDE or commandline interface via the evalDsl API call.

To access the DSL inline object editor.

  1. Navigate to the application, dashboard, environment, environment template, microservice, pipeline, or release editor.

  2. Select DSL editor. The DSL editor displaying the DSL code for the current object.

  3. Modify the DSL code and then select the Save button in the upper right corner of the editor pane. Your changes are applied to the object and saved.

DSL editor
Figure 2. DSL editor
DSL automation as code
Troubleshooting and FAQs