Home
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
Process-as-code feature
Programmatically manage processes with PAC language.
Generic process steps
Lists the various generic steps that can be used in a process.
add-process-warning
The add-process-warning step adds a warning message to the executing process

Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- Plug-ins
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.
- Process-as-code feature
  Programmatically manage processes with PAC language.
  - Using the PAC commands
    Use the PAC language to create HCL DevOps Deploy (Deploy) processes.
  - Understanding the PAC file format
  - Application process steps
    Lists the various application steps that can be used in a process.
  - Core component process steps
    Lists the various core component steps that can be used in a process.
  - Generic process steps
    Lists the various generic steps that can be used in a process.
    - add-process-warning
      The add-process-warning step adds a warning message to the executing process
    - acquire-lock
      The acquire-lock step allows acquisition of a process lock.
    - generic-manual-task
      The generic-manual-task step pauses the process until a manual approval is completed. This step is only valid in a generic process.
    - plugin
      The plugin step allows you to execute a plug-in command. Note that this step is not valid for an application process.
    - run-generic-process
      The run-generic-process step executes a generic process and waits for it to complete.
    - run-generic-process-for-each-affected-resource
      The run-generic-process-for-each-affected-resource step executes a generic process for each resource affected by the application process and waits for it to complete. This step is only valid in an application process.
    - set-final-process-status
      The set-final-process-status step that also appears as Set Status in the Web UI, forces the outcome status of a process to success or failure.
    - shell
      The shell step is a shortcut for the plugin step that specifies the Shell plug-in and the Shell command. Note that this step is not valid in an application process.
    - start
      The start step is a pseudo-step that defines the beginning of the process. As it is not a true step, it does not use the step keyword. The only completion condition is success. So, on success is not required or permitted.
    - switch
      The switch step allows decision logic in the process. It expands a variable by name or evaluates an expression containing a 'p' expression to a value. Based on the value, one case is selected and its actions are carried out.

add-process-warning

The add-process-warning step adds a warning message to the executing process

Format

add-process-warning step "foo" is
    -- a string in the body defines the warning; required
    "Warning: process partially successful"
on success
    finish
end

Example

start is

    start A

end



add-process-warning step A is

    "warning"

on success

    finish

end