Executing an Application Workflow from a Pipeline in Jenkins

  1. Go to the main page and create a new pipeline (New Item > Pipeline) or use an existing one.
  2. Open the Pipeline Syntax.
  3. In the sample step field, select the execAppInWkf: CDA Execute Application Workflow step from the dropdown list.
  4. Do one of the following:
    • Select the Use Centralized CDA Connection Parameters checkbox to authenticate with the centralized connection details . See: Configuring CDA Centralized Connection Details).
    • Enter the connection details:

      • Server

        Example:

        http://192.000.000.00/cda

      • Full Username

        Examples:

        • 1000/USER/DEP
        • AUTOMIC/1000/USER/DEP

      • Password

  5. Click Test connection to ensure that the connection succeeds.
  6. Once the connection has been checked, review or edit the other fields as follows:

    1. Enter the name of the CDA Application.

      Notes:

      • This value can also contain variables. Variables must start with $.
      • Archived Applications are not supported.

    2. Enter the name of the CDA Workflow.

      Notes:

      • This value can also contain variables. Variables must start with $.
      • Archived Workflows are not supported.
    3. Enter the name of an existing Package.

      Notes:

      • This value can also contain variables (for example: Build environment variable). Variables must start with $.
      • Archived Packages are not supported.
    4. Enter the name of the Deployment Profile (the entity that links the Application to one specific environment).

      Notes:

      • Not applicable for provisioning Workflows.
      • This value can also contain variables. Variables must start with $.
      • Archived Profiles are not supported.
    5. Select the execution start time:
      • Now
      • At: if selected, specify the planned start time (yyyy-MM-dd HH:mm)

        Notes:

        • Entered date-time values must be in the future and in UTC format
        • This value can also contain variables (for example: Build environment variable). Variables must start with $.

          Example: $date_time

      • Queue: if selected, specify the queue (the container for Workflow executions) where you want to add the execution

        Notes:

        • This value can also contain variables. Variables must start with $.
        • Inactive Queues are not supported.
    6. Manual Confirmation: select if manual confirmation is required for the execution.
    7. User/Group: if manual confirmation is needed, you have to define either a user or a group to confirm the execution.

      Notes:

      • Inactive users/ user groups are not supported.
      • This value can also contain variables. Variables must start with $.
    8. Installation Mode: you can specify whether you want already successful installations to be overwritten or skipped. The decision whether a Component is installed or skipped is based on the installation records, which are automatically created during all deployments.
    9. Dynamic Properties: optionally, click Check for Dynamic Properties to know whether dynamic properties for the selected Workflow are required or not.

      Click Set Dynamic Property and manually enter the name and value of the dynamic properties to apply them to the execution Workflow and override the existing ones.

      Note: This value can also contain variables. Variables must start with $.

      Example: $Dynamic_Key = $Value

  7. Click Generate Pipeline Script. A string containing the Execution definition is generated.
  8. Copy the generated content.
  9. Click Back at the top left and select Configuration.
  10. Select the Pipeline tab and paste the copied content to the Script field.
  11. Save your changes.