Process as Configuration

• Download a Generic Process

  Syntax:
  download-generic-process <username> <password> <server-url> <process-name> <output-file>

• Example:

    `download-generic-process myuser mypassword https://url:8443 myGenericProcessName myGenericProcess.json`
  
  
    `download-generic-process myuser mypassword https://url:8443 myGenericProcessName myGenericProcess.yaml`
  

• Download all Generic processes
  Syntax:
  download-generic-process-all <username> <password> <server-url> <output-file-type(json/yaml)>
  Example:

    `For Ex(json format): ./download-generic-process-all myuser mypassword https://url:8443 json`
  
    `For Ex(yaml format): ./download-generic-process-all myuser mypassword https://url:8443 yaml`
  

• Download a Component Process
  Syntax:
  download-component-process <username> <password> <server-url> <component-process-name> <component-name> <output-file>
  Example:

    `download-component-process myuser mypassword https://url:8443 myComponentProcessName myComponentName myComponentProcess.json`
  
    `download-component-process myuser mypassword https://url:8443 myComponentProcessName myComponentName myComponentProcess.yaml`
  

• Download all processes for a given component
  Syntax:
  download-component-process-all <username> <password> <server-url> <component-name> <output-file-type(json)>
  Example:

    `For Ex(json format): ./download-component-process-all myuser mypassword https://url:8443 myComponentName json`
  
    `For Ex(yaml format): ./download-component-process-all myuser mypassword https://url:8443 myComponentName yaml`
  

• Download an Application Process
  Syntax:
  download-application-process <username> <password> <server-url> <application-process-name> <application-name> <output-file>
  Example:

    `download-application-process myuser mypassword https://url:8443 myApplicationProcessName myApplicationName myApplicationProcess.json`
  
    `download-application-process myuser mypassword https://url:8443 myApplicationProcessName myApplicationName myApplicationProcess.yaml`
  

• Download all processes for a given application
  Syntax:
  download-application-process-all <username> <password> <server-url> <application-name> <output-file-type(json)>
  Example:

    `For Ex(json format): ./download-application-process-all myuser mypassword https://url:8443 myApplicationName  json`
  
  
    `For Ex(yaml format): ./download-application-process-all myuser mypassword https://url:8443 myApplicationName  yaml`
  

• Download a Component Template Process
  Syntax:
  download-component-template-process <username> <password> <server-url> <component-template-process-name> <component-template-name> <output-file>
  Example:

    `download-component-template-process myuser mypassword https://url:8443 myComponentTemplateProcessName myComponenTemplatetName myComponentTemplateProcess.json`
  
  
    `download-component-template-process myuser mypassword https://url:8443 myComponentTemplateProcessName myComponenTemplatetName myComponentTemplateProcess.yml`
  

• Download an Application Template Process
  Syntax:
  download-application-template-process <username> <password> <server-url> <application-template-process-name> <application-template-name> <output-file>
  Example:

    `download-application-template-process myuser mypassword https://url:8443 myApplicationTemplateProcessName myApplicationTemplateName myApplicationTemplateProcess.json`
  
  
    `download-application-template-process myuser mypassword https://url:8443 myApplicationTemplateProcessName myApplicationTemplateName myApplicationTemplateProcess.yaml`
  

• Upload a Generic Process
  Syntax:
  upload-generic-process <username> <password> <server-url> <input-file>
  Example:

    `upload-generic-process myuser mypassword https://url:8443  myGenericProcess.json`
  
    
    `upload-generic-process myuser mypassword https://url:8443  myGenericProcess.yml`
  

• Upload a Component Process
  Syntax:
  upload-component-process <username> <password> <server-url> <input-file>
  Example:

    `upload-component-process myuser mypassword https://url:8443 myComponentProcess.json`
  
  
    `upload-component-process myuser mypassword https://url:8443 myComponentProcess.yml`
  

• Upload an Application Process
  Syntax:
  upload-application-process <username> <password> <server-url> <input-file>
  Example:

    `upload-application-process myuser mypassword https://url:8443 myApplicationProcess.json`
  
  
    `upload-application-process myuser mypassword https://url:8443 myApplicationProcess.yml`
  

• Upload a component template process
  Syntax:
  upload-component-template-process <username> <password> <server-url> <input-file>
  Example:

    `./upload-component-template-process myuser mypassword https://url:8443 myComponentTemplateProcess.json`
  
  
    `./upload-component-template-process myuser mypassword https://url:8443 myComponentTemplateProcess.yaml`
  

• Upload an application template process
  Syntax:
  upload-application-template-process <username> <password> <server-url> <application-process-name> <application-name> <input-file>
  Example:

    `For Ex: ./upload-application-template-process myuser mypassword https://url:8443 myApplicationTemplateProcess.json`
  
  
    `For Ex: ./upload-application-template-process myuser mypassword https://url:8443 myApplicationTemplateProcess.yaml`
  

• Note: Both .yml and .yaml extensions are supported

• Important Note: Use quotes for process names/application names/component names that contains space
  For Ex. While downloading an application process:
  download-application-process myuser mypassword https://url:8443 "my ApplicationProcess Name" "my Application Name" myApplicationProcess.json

Structure of a Process file

• A process file has below a structure

    {
      // "<.. process configuration block..>"        
      "[component | application]": "[ <name of the component> | <name of the application>] ", // Field not required/generated for Generic process
      "process-name": "<name of the process>",
      "process": {
            //"<...json body of the process step definitions ...>"
        }
    }

    # "<.. process configuration block..>"  
    "[component | application]": "[ <name of the component> | <name of the application> ]"  # Field not required/generated for Generic process
    process-name: "<name of the process>"
    process:
      # <...yaml body of the process step definitions ...>

• A process in the above structure is mapped to a json that has multiple process step definitions. there are multiple types of steps that are supported in Devops Deploy

Process step definitions

• 'Devops-Deploy' processes are composed of different steps that are made up of json. The steps ideally start from the 'Start' step and terminate at the last user defined step. Unlike in the UI, there's no need for an explicit 'Finish' step.

• There are different types of steps, and many of them are contextual in nature and may not apply to all types of processes. One way to verify is to see if the step you are trying to add is available in the palette in the process design page in the UI

• The structure of a step is composed of step-data that defines the type of step and its attributes and the step workflow data that tells what is the target of the step upon successful (or) unsuccessful termination of the step. Target can be another defined step or be the finish step.

    { 
      "<name of the step>" : {
          " ..step data.. "
          "  .."
          "  .."
        },
        "on" : {
            "..step Termination events data.."
        }
      }

    "<name of the step>":
      step_data: " ..."
      another_field: " ..."
  
    on:
      step_termination_events_data: " ..."

Termination Events within in a Process

The step termination event tells the possible termination possibilities of a step and attach a target step based on the type of the termination event. The three types of termination events are

1. success — upon successful completion of this step
2. failure - upon unsuccessful completion of this step
3. complete - upon completion of the current step irrespective of successful or unsuccessful execution

• The events contain data to complete the workflow by defining what the next step is post the completion of the current step. the events can either start an array of one or more steps defined in the process or can terminate at the finish step

Termination event Examples

1. Example of events calling other steps in successful and unsuccessful scenarios of the current step

     { 
       "on" : {
         "success" : {
             "start" : ["some-step", "some other step"]
         },
         "failure" : {
             "start" : ["some step"]
         }
       }
     }

     on:
       success:
         start:
           - "some-step"
           - "some other step"
       failure:
         start:
           - "some step"

2. Examples of events calling the finish step

• Example-1

    {
    "on" : {
      "success" : {
          "finish" : ""
        }
    }
    }

    on:
      success:
        finish: ""

• Example-2

    {
      "on" : {
        "success": {
          "start": [
            "start-server"
          ]
        },
        "failure": {
          "finish": ""
        }
      }
    }

    on:
      success:
        start:
          - "start-server"
      failure:
        finish: ""

Note that in the above examples, the finish attribute has no value. The finish step does not need a definition and hence there is no need for a target step value.

Process configurations

Component Process Configurations

• Available from 8.X versions

• Syntax

  {
    // --- Common Fields: Always Present ---
    // These fields are fundamental and required for all process definitions.
    description: "[[String: A brief, descriptive summary of the process's purpose, e.g., 'Deploy web application to production', 'Uninstall database service', 'Apply configuration changes to server']]",
    defaultWorkingDir: "[[String: The default working directory for the process execution. Often uses placeholders for dynamic paths, e.g., '${p:resource/work.dir}/${p:component.name}']]",
    status: "[[String: The current status of this process definition. Typically 'Active' or 'Inactive'.]]",
    
    // --- Property Definitions (propDefs): Rule 1 ---
    // This array holds definitions for custom properties that can be configured for this process.
    //  This array can have 0 or more nested JSON objects. If no custom properties are needed, provide an empty array: `[]`.
    propDefs: [
      {
         index: "[[Integer: A zero-based index defining the display order of this property in the UI, e.g., 0, 1, 2]]",
         name: "[[String: The internal, unique identifier for the property (e.g., 'text-prop', 'databasePort', 'deploymentStrategy'). This is often used in scripts/plugins to reference the property's value.]]",
         type: "[[String: The data type and UI control type for the property. Allowed values: 'TEXT', 'DATETIME', 'TEXTAREA', 'BOOLEAN', 'SELECT', 'MULTI_SELECT', 'CHECKBOX'..]]",
         inherited: "[[Boolean: Set to `true` if this property's value can be inherited from a parent object (e.g., component or application level). Set to `false` otherwise.]]",
         isHidden: "[[Boolean: Set to `true` if this property should not be visible in the standard UI forms (useful for internal or advanced properties). Set to `false` for visible properties.]]",
         required: "[[Boolean: Set to `true` if a value for this property must be provided before the process can be executed. Set to `false` if it's optional.]]",
         label: "[[String: The user-friendly label displayed next to the property in the UI (e.g., 'Application Name', 'Database Port Number').]]",
         description: "[[String: A detailed explanation of what the property is used for and what kind of value is expected (e.g., 'Full path to the application's WAR file', 'The port number for the database connection').]]",
         pattern: "[[String: An optional regular expression pattern for validating the property's value. Can be an empty string `''` if no pattern validation is needed.]]",
         value: "[[String|Boolean: The default value for this property. The data type (String, Number, Boolean, or null) must correspond to the `type` field. For example, if `type` is 'DATETIME', this might be a timestamp as a string '1744100280000'. If `type` is 'TEXT', it could be 'initial data'. If `type` is 'BOOLEAN', it's `true` or `false`.]]",
      },
      // Add more property definition objects here as needed.
    ],
    
    // --- Required Role Names (requiredRoleNames) ---
    // This array specifies the names of roles that a user must possess to be authorized to execute this process.
    // This array can be empty `[]` if no specific role restrictions apply beyond general system permissions.
    requiredRoleNames: [
      'Deployer', 'Admin',
    ],
    
    // --- Conditional Fields Based on UI Process Type ---
    // The following fields (`takesVersion`, `inventoryActionType`, `configActionType`)
    // will be present or absent, and have specific values, depending on the "Process Type"
    // selected in the User Interface for this process.
    // Uncomment and configure ONLY ONE of the scenarios below based on your UI selection.
  
    // Scenario 1: UI Process Type is "Deployment" (or "Install")
    takesVersion: true, // Indicates if this deployment process requires or consumes a version.
    inventoryActionType: "ADD", // Denotes that this process adds an item to inventory.
    configActionType: "ADD",    // Denotes that this process applies configuration changes.
  
    // Scenario 2: UI Process Type is "Uninstall"
    inventoryActionType: "REMOVE", // Denotes that this process removes an item from inventory.
    // DO NOT include "configActionType" or "takesVersion" fields for this scenario.
  
    // Scenario 3: UI Process Type is "Configuration"
    configActionType: "ADD", // Denotes that this process applies configuration changes.
    // DO NOT include "inventoryActionType" or "takesVersion" fields for this scenario.
  
    // Scenario 4: UI Process Type is "Operational-with-version"
    takesVersion: true, // Indicates this operational process is tied to a specific version.
    // DO NOT include "inventoryActionType" or "configActionType" fields for this scenario.
  
    // Scenario 5: UI Process Type is "Operational-without-version"
    takesVersion: false, // Indicates this operational process is NOT tied to a specific version.
    // DO NOT include "inventoryActionType" or "configActionType" fields for this scenario.
  }

    # --- Common Fields: Always Present ---
    # These fields are fundamental and required for all process definitions.
    description: "[[String: A brief, descriptive summary of the process's purpose, e.g., 'Deploy web application to production', 'Uninstall database service', 'Apply configuration changes to server']]"
    defaultWorkingDir: "[[String: The default working directory for the process execution. Often uses placeholders for dynamic paths, e.g., '${p:resource/work.dir}/${p:component.name}']]"
    status: "[[String: The current status of this process definition. Typically 'Active' or 'Inactive'.]]"
    
    # --- Property Definitions (propDefs) ---
    # This array holds definitions for custom properties that can be configured for this process.
    propDefs:
    # Example property definition object. Add more items as needed.
    - index: "[[Integer: A zero-based index defining the display order of this property in the UI, e.g., 0, 1, 2]]"
      name: "[[String: The internal, unique identifier for the property (e.g., 'text-prop', 'databasePort', 'deploymentStrategy'). This is often used in scripts/plugins to reference the property's value.]]"
      type: "[[String: The data type and UI control type for the property. Allowed values: 'TEXT', 'DATETIME', 'TEXTAREA', 'BOOLEAN', 'SELECT', 'MULTI_SELECT', 'CHECKBOX'.]]"
      inherited: "[[Boolean: Set to `true` if this property's value can be inherited from a parent object (e.g., component or application level). Set to `false` otherwise.]]"
      isHidden: "[[Boolean: Set to `true` if this property should not be visible in the standard UI forms (useful for internal or advanced properties). Set to `false` for visible properties.]]"
      required: "[[Boolean: Set to `true` if a value for this property must be provided before the process can be executed. Set to `false` if it's optional.]]"
      label: "[[String: The user-friendly label displayed next to the property in the UI (e.g., 'Application Name', 'Database Port Number').]]"
      description: "[[String: A detailed explanation of what the property is used for and what kind of value is expected (e.g., 'Full path to the application's WAR file', 'The port number for the database connection').]]"
      pattern: "[[String: An optional regular expression pattern for validating the property's value. Can be an empty string `''` if no pattern validation is needed.]]"
      value: "[[String|Number|Boolean|null: The default value for this property. The data type (String, Number, Boolean, or null) must correspond to the `type` field. For example, if `type` is 'DATETIME', this might be a timestamp as a string '1744100280000'. If `type` is 'TEXT', it could be 'initial data'. If `type` is 'BOOLEAN', it's `true` or `false'.]]"
    # Add more property definition objects here as needed.
    
    # --- Required Role Names (requiredRoleNames) ---
    # This array specifies the names of roles that a user must possess to be authorized to execute this process.
    # This array can be empty `[]` if no specific role restrictions apply beyond general system permissions.
    requiredRoleNames:
    - "role1"
    - "role2"
    
    # --- Conditional Fields Based on UI Process Type ---
    # The following fields (`takesVersion`, `inventoryActionType`, `configActionType`)
    # will be present or absent, and have specific values, depending on the "Process Type"
    # selected in the User Interface for this process.
    # IMPORTANT: Uncomment and configure ONLY ONE of the scenarios below based on your UI selection.
    # Ensure that fields marked "DO NOT include" are completely omitted from your final YAML.
    
    # Scenario 1: UI Process Type is "Deployment" (or "Install")
    takesVersion: true # Indicates if this deployment process requires or consumes a version.
    inventoryActionType: "ADD" # Denotes that this process adds an item to inventory.
    configActionType: "ADD"    # Denotes that this process applies configuration changes.
    
    # Scenario 2: UI Process Type is "Uninstall"
    inventoryActionType: "REMOVE" # Denotes that this process removes an item from inventory.
    # DO NOT include `configActionType` or `takesVersion` fields for this scenario.
    
    # Scenario 3: UI Process Type is "Configuration"
    configActionType: "ADD" # Denotes that this process applies configuration changes.
    # DO NOT include `inventoryActionType` or `takesVersion` fields for this scenario.
    
    # Scenario 4: UI Process Type is "Operational-with-version"
    takesVersion: true # Indicates this operational process is tied to a specific version.
    # DO NOT include `inventoryActionType` or `configActionType` fields for this scenario.
    
    # Scenario 5: UI Process Type is "Operational-without-version"
    takesVersion: false # Indicates this operational process is NOT tied to a specific version.
    # DO NOT include `inventoryActionType` or `configActionType` fields for this scenario.

• Below is an example for an "install type" component process configuration

    {
      "description": "Process description",
      "defaultWorkingDir": "${p:resource\/work.dir}\/${p:component.name}",
      "takesVersion": true,
      "inventoryActionType": "ADD",
      "configActionType": "ADD",
      "status": "Active",
      "propDefs": [
            {
            "index": 0,
            "name": "text-prop",
            "type": "TEXT",
            "inherited": false,
            "isHidden": false,
            "required": false,
            "label": "label testing",
            "description": "text property changed",
            "pattern": "",
            "value": "some data"
            },
            {
            "index": 1,
            "name": "Date Time prop",
            "type": "DATETIME",
            "inherited": false,
            "isHidden": false,
            "required": true,
            "label": "Date Time prop",
            "description": "date time prop",
            "pattern": "",
            "value": "1744100280000"
            }
      ]
      "requiredRoleNames": [
          "custom_role",
          "Deployer"
      ]
    }
    // rest of the process

    ---
    description: "test-3"
    defaultWorkingDir: "${p:resource/work.dir}/${p:component.name}"
    takesVersion: true
    inventoryActionType: "ADD"
    configActionType: "ADD"
    status: "Active"
    propDefs:
    - index: 0
      name: "text-prop"
      type: "TEXT"
      inherited: false
      isHidden: false
      required: false
      label: "label testing"
      description: "text property changed"
      pattern: ""
      value: "some data"
      - index: 1
        name: "Date Time prop"
        type: "DATETIME"
        inherited: false
        isHidden: false
        required: true
        label: "Date Time prop"
        description: "date time prop"
        pattern: ""
        value: "1744100280000"
    requiredRoleNames:
      - "custom_role"
      - "Deployer"
    active: true
    # rest of the process 
  
    ```

Application process configuration

• Available from 8.X versions

• Syntax

  {
    "inventoryManagementType": "[[String: Type of inventory management. Allowed values: 'AUTOMATIC', 'ADVANCED']]",
    "offlineAgentHandling": "[[String: How offline agents are handled. Allowed values: 'FAIL_BUT_CONTINUE', 'PRE_EXECUTION_CHECK', 'ALLOW_OFFLINE']]",
    "description": "[[String: A brief description of the process or definition.]]",
    "disableSnapshots": "[[Boolean: true if snapshots are disabled, false otherwise.]]",
    
    "propDefs": [
        // This array can contain 0 or more property definition objects.
        // If no custom properties are needed, provide an empty array: []
        {
            "index": "[[Integer: The display order index of the property (e.g., 0, 1, 2).]]",
            "name": "[[String: The internal name of the property (e.g., 'prop-1', 'text-prop').]]",
            "type": "[[String: The data type of the property. Examples: 'TEXT', 'DATETIME', 'TEXTAREA', 'SELECT', 'MULIT_SELECT'.]]",
            "inherited": "[[Boolean: true if inherited, false otherwise.]]",
            "isHidden": "[[Boolean: true if the property should be hidden in the UI, false otherwise.]]",
            "required": "[[Boolean: true if the property is mandatory, false otherwise.]]",
            "label": "[[String: The user-friendly label for the property in the UI.]]",
            "description": "[[String: A detailed description of the property.]]",
            "pattern": "[[String: A regular expression pattern for validation (can be empty '').]]",
            "value": "[[String|Number|Boolean|null: The default or current value of the property. Type depends on the 'type' field. E.g., 'prop-value', '1744100280000', true, null.]]"
        }
    ],
    
    "versionPresets": [
        // This array defines component version selectors. It can contain one or more objects.
        {
            "component": "[[String: The name of the component]]",
            "selector": "[[String: The version selector strategy. should use one of the below:
            'latestWithStatus/[status-name]',
            'version/[[ String: version-name]]',
            'latestVersion/',
            'allWithStatus/[[String: status-name]]',
            'allInEnvironment/[[String: inventory-status]]',
            'reverseAllInEnvironment/[[String: inventory-status]]']]"
        }
    ],
    
    // "requiredRoleNames": "[[Optional Array of Strings: Role names required to execute. This field is optional. If present and no roles are needed, provide an empty array: []]]"
    "requiredRoleNames": [
        "[[String: Name of a required role, e.g., 'Administrator', 'Automation Engineer']]",
    ]
  }

    # --- Core Configuration Fields ---
    # These fields are fundamental and are always present in the process definition.
    inventoryManagementType: "[[String: Defines how inventory is managed. Possible values: 'AUTOMATIC', 'ADVANCED']]"
    offlineAgentHandling: "[[String: Specifies the behavior when an agent is offline. Possible values: 'FAIL_BUT_CONTINUE', 'PRE_EXECUTION_CHECK', 'ALLOW_OFFLINE']]"
    description: "[[String: A brief textual description of this process configuration, e.g., 'test-1']]"
    disableSnapshots: "[[Boolean: Set to `true` to disable snapshots for this process; set to `false` to enable them.]]"
    
    # --- Property Definitions (propDefs) ---
    # This section defines custom properties that can be used within the process.
    # This array can contain 0 or more property definition objects.
    # If no custom properties are needed, simply use an empty array: `propDefs: []`.
    propDefs:
    # Example of a single property definition object. Add more items as needed.
    - index: "[[Integer: A zero-based integer representing the display order of this property, e.g., 0, 1, 2]]"
      name: "[[String: The internal, unique identifier for the property, e.g., 'prop-1', 'text-prop']]"
      type: "[[String: The data type and corresponding UI control for the property. Valid options include: 'TEXT', 'DATETIME', 'TEXTAREA', 'SELECT', 'MULTI_SELECT'.]]"
      inherited: "[[Boolean: Set to `true` if this property's value can be inherited from a higher-level object (e.g., component or application). Set to `false` otherwise.]]"
      isHidden: "[[Boolean: Set to `true` to hide this property from standard UI forms (useful for internal or advanced settings); set to `false` to make it visible.]]"
      required: "[[Boolean: Set to `true` if a value for this property must be provided before process execution; set to `false` if it is optional.]]"
      label: "[[String: The user-friendly label displayed in the UI for this property, e.g., 'Property One', 'Database Port'.]]"
      description: "[[String: A detailed explanation of the property's purpose and expected values, e.g., 'This field takes the database connection string.']]"
      pattern: "[[String: An optional regular expression pattern used for validating the property's value. Use an empty string `''` if no pattern validation is required.]]"
      value: "[[String|Number|Boolean|null: The default value for this property. The data type must match the `type` field. Examples: 'some data', 1744100280000 (for DATETIME), true, null.]]"
    # Add more `- index: ...` blocks here for additional properties.
    
    # --- Version Presets ---
    # This section defines how component versions are selected for the process.
    # This array typically contains one or more objects, each specifying a component and its version selector.
    versionPresets:
    # Example of a single version preset. Add more items if multiple components are involved.
    - component: "[[String: The name of the component for which the version is being selected, e.g., 'PAC-COMP', 'ZOSCOMP']]"
      selector: "[[String: The strategy for selecting the component version. Examples from samples include:
        'latestWithStatus/[status-name]',
        'version/[[ String: version-name]]',
        'latestVersion/',
        'allWithStatus/[[String: status-name]]',
        'allInEnvironment/[[String: inventory-status]]',
        'reverseAllInEnvironment/[[String: inventory-status]]']]"
      The exact format depends on available version selection methods.]]"
    # Add more `- component: ...` blocks here for additional version presets.
    
    # --- Required Role Names (requiredRoleNames) ---
    # This array specifies the names of roles that a user must possess to be authorized to execute this process.
    # This array is optional. If present, it can be empty `[]` if no specific role restrictions apply beyond general system permissions.
    # If this field is not present in the YAML, it implies no specific roles are required beyond base access.
    # Uncomment the following lines if `requiredRoleNames` is needed for a specific process configuration.
    # requiredRoleNames:
    #   # Example role names. Add more items as needed.
    #   - "[[String: Name of a required role, e.g., 'Administrator', 'Automation Engineer']]"
    #   - "[[String: Another required role name]]"

• Below is an example for an application process configuration

    {
      "inventoryManagementType": "ADVANCED",
      "offlineAgentHandling": "ALLOW_OFFLINE",
      "description": "test-1",
      "disableSnapshots": true,
      "propDefs": [
          {
            "index": 0,
            "name": "prop-1",
            "type": "TEXT",
            "inherited": false,
            "isHidden": false,
            "required": false,
            "label": "prop-1",
            "description": "description changed for demo",
            "pattern": "",
            "value": "prop-value"
          },
          {
            "index": 1,
            "name": "MULTI-SELECT",
            "type": "MULTI_SELECT",
            "inherited": false,
            "isHidden": false,
            "required": true,
            "label": "LABEL FOR MULTI SELECT",
            "description": "MULTI-SELECT",
            "pattern": "",
            "allowedValues": [
                {
                    "value": "HARNESS",
                    "label": "HARNESS"
                },
                {
                    "value": "UCD",
                    "label": "UCD"
                },
                {
                    "value": "DD",
                    "label": "DD"
                }
            ],
            "value": "HARNESS"
        }
      ],
      "requiredRoleNames": [
        "Administrator",
        "Automation Engineer"
      ],
      "versionPresets": [
          {
            "component": "ZOSCOMP",
            "selector": "reverseAllInEnvironment\/Active"
          }
      ]
    }

    ---
    inventoryManagementType: "ADVANCED"
    offlineAgentHandling: "ALLOW_OFFLINE"
    description: "test-1"
    disableSnapshots: true
    propDefs:
    - index: 0
      name: "prop-1"
      type: "TEXT"
      inherited: false
      isHidden: false
      required: false
      label: "prop-1"
      description: "description changed for demo"
      pattern: ""
      value: "prop-value"
    - index: 1
      name: "MULTI-SELECT"
      type: "MULTI_SELECT"
      inherited: false
      isHidden: false
      required: true
      label: "LABEL FOR MULTI SELECT"
      description: "MULTI-SELECT"
      pattern: ""
      allowedValues:
      - value: "HARNESS"
        label: "HARNESS"
      - value: "UCD"
        label: "UCD"
      - value: "DD"
        label: "DD"
        value: "HARNESS"
    requiredRoleNames:
    - "Administrator"
    - "Automation Engineer"
    versionPresets:
    - component: "ZOSCOMP"
      selector: "reverseAllInEnvironment/Active"

Process configurations for Generic processes

• Syntax

    {
        "properties": [
        // It MUST contain a property object with "name": "workingDir".
        // It MAY optionally contain a property object with "name": "defaultResourceId".
        // No other 'name' values are allowed within this 'properties' array.
            {
              "name": "workingDir",
              "value": "[[String: The working directory for the process execution. MANDATORY. Can include placeholders like '${p:resource/work.dir}/${p:process.name}'.]]"
            }
            // --- Optional Property: defaultResourceId ---
            // Uncomment the following block if 'defaultResourceId' is needed.
            /*
            , {
              "name": "defaultResourceId",
              "value": "[[String: The ID of the default resource. OPTIONAL. MUST be a UUID (e.g., '196f310a-45fc-6941-e488-d4a0a87a7f38').]]"
            }
            */
        // No other property objects are allowed in this array.
        ],
        "description": "[[String: A textual description for this configuration. Can be an empty string ' ' or a detailed text.]]",
        
        // --- Optional Fields ---
        // The following fields might be present or absent depending on the specific configuration.
        
        "propDefs": [
          // This array defines custom properties that can be configured for this item.
          // This entire 'propDefs' array is OPTIONAL. If not needed, omit it entirely or provide an empty array: [].
            {
              "index": "[[Integer: A zero-based index for display order, e.g., 0, 1, 2.]]",
              "name": "[[String: The internal name of the property, e.g., 'TextProperty', 'select-property', 'checkbox'].]",
              "type": "[[String: The data type and UI control type. Examples: 'TEXT', 'SELECT', 'CHECKBOX', 'DATETIME', 'MULTI_SELECT'.]]",
              "inherited": "[[Boolean: true if inherited, false otherwise.]]",
              "isHidden": "[[Boolean: true if the property should be hidden in the UI, false otherwise.]]",
              "required": "[[Boolean: true if the property is mandatory, false otherwise.]]",
              "label": "[[String: The user-friendly label displayed in the UI, e.g., 'TextProperty-label', 'checkbox property label'.]]",
              "description": "[[String: A detailed description of the property's purpose.]]",
              "pattern": "[[String: An optional regular expression pattern for validation. Can be an empty string '']]",
              "value": "[[String|Boolean|Number|null: The default or current value of the property. The type should match the 'type' field. E.g., 'DEFAULT-VALUE', 'true', 123, null.]]"
              // "allowedValues": "[[Optional Array of Objects: ONLY present if 'type' is 'SELECT']]"
              // If 'type' is "SELECT", this field is required and structured as:
              // "allowedValues": [
              //   { "value": "[[String: The actual value to be stored]]", "label": "[[String: The display label for the value]]" },
              //   { "value": "DD", "label": "DD" },
              //   { "value": "WD", "label": "WD" }
              // ]
            }
          // Add more property definition objects as needed.
        ],
        
        "webhooks": [
        // This array defines webhooks to be triggered by certain events.
        // This entire 'webhooks' array is OPTIONAL. If not needed, omit it entirely or provide an empty array: [].
            {
              "url": "[[String: The URL to which the webhook request will be sent, e.g., 'http://git.com', 'http://exec.com']]",
              "proxyHost": "[[String: Optional proxy host. Can be a placeholder like '${p?:system/proxyHost}' or an empty string '']]]",
              "proxyPort": "[[String: Optional proxy port. Can be a placeholder like '${p?:system/proxyPort}' or an empty string '']]]",
              "webhookTemplate": {
              "name": "[[String: The name of the webhook template, e.g., 'webhooktemplate']]",
              "description": "[[String: A description for the webhook template. Can be empty '']]",
              "body": "[[String: The body content of the webhook request.]]",
              "type": "[[String: The type of event that triggers the webhook. Example: 'PROCESS_FAILURE'. Other types may exist.]]"
            }
        // Add more webhook objects as needed.
        ],
        
        "teamMappings": [
          // This array defines mappings to specific teams for permissions or notifications.
          // This entire 'teamMappings' array is OPTIONAL. If not needed, omit it entirely or provide an empty array: [].
          {
            "resourceTypeId": "[[String: The ID of the resource type being mapped, e.g., '20000000000000000000000000000109']]",
            "resourceTypeName": "[[String: The name of the resource type, e.g., 'Process']]",
            "teamId": "[[String: The unique ID of the team, e.g., '18f70a02-67bd-8ac4-7c5a-fcddeecfd8df']]",
            "teamLabel": "[[String: The display label of the team, e.g., 'Deployer-team']]"
          }
        // Add more team mapping objects as needed.
        ]
    }

    # --- Core Configuration Fields ---
    # These fields define fundamental aspects of the process configuration.
    
    properties:
      # This array contains key-value pairs defining specific properties for the process or resource.
      # It MUST include a property with `name: "workingDir"`.
      # It MAY optionally include a property with `name: "defaultResourceId"`.
      # No other property names are allowed within this array.
      - name: "workingDir"
        value: "[[String: The working directory for the process execution. This field is MANDATORY. Examples: '${p:resource/work.dir}/${p:process.name}', '/opt/app/myproject']]"
      # --- Optional Property: defaultResourceId ---
      # Uncomment the following block if `defaultResourceId` is required for your configuration.
      # If present, its value MUST be a valid UUID.
      # - name: "defaultResourceId"
      #   value: "[[String: MUST be a valid UUID (e.g., '196f310a-45fc-6941-e488-d4a0a87a7f38').]]"
    
    description: "[[String: A textual description for this configuration. Can be an empty string `''` or a detailed text. Examples: 'some description', 'Process configuration for application deployment.']]"
    
    # --- Property Definitions (propDefs) ---
    # This section defines custom properties that can be configured and managed for this item.
    # This entire `propDefs` array is OPTIONAL. If no custom properties are needed, omit this section entirely or provide an empty array: `propDefs: []`.
    propDefs:
      # Example of a single property definition object. Add more items as needed.
      - index: "[[Integer: A zero-based index representing the display order of this property in the UI, e.g., 0, 1, 2]]"
        name: "[[String: The internal, unique identifier for the property (e.g., 'TEXT-PROPERTY', 'select-property', 'checkbox').]]"
        type: "[[String: The data type and corresponding UI control for the property. Valid options include: 'TEXT', 'SELECT', 'CHECKBOX', 'DATETIME', 'MULTI_SELECT'.]]"
        inherited: "[[Boolean: Set to `true` if this property's value can be inherited from a higher-level object; set to `false` otherwise.]]"
        isHidden: "[[Boolean: Set to `true` to hide this property from standard UI forms (useful for internal/advanced settings); set to `false` to make it visible.]]"
        required: "[[Boolean: Set to `true` if a value for this property must be provided before process execution; set to `false` if it is optional.]]"
        label: "[[String: The user-friendly label displayed in the UI for this property, e.g., 'TEXT-PROPERTY', 'checkbox property label'.]]"
        description: "[[String: A detailed explanation of the property's purpose and expected values. Can be an empty string `''`.]]"
        pattern: "[[String: An optional regular expression pattern used for validating the property's value. Use an empty string `''` if no pattern validation is required.]]"
        value: "[[String|Boolean|Number|null: The default value for this property. The data type must match the `type` field. Examples: 'some default value', 'true', 123, null.]]"
        # --- Conditional Field for 'SELECT' type properties ---
        # If `type` is "SELECT", this `allowedValues` array is REQUIRED.
        # It defines the list of predefined options for the dropdown.
        # allowedValues:
        #   - value: "[[String: The actual value to be stored when this option is selected, e.g., 'DD']]"
        #     label: "[[String: The display label for this option in the UI, e.g., 'DD']]"
        #   - value: "WD"
        #     label: "WD"
        #   - value: "HARNESS"
        #     label: "HARNESS"
      # Add more `- index: ...` blocks here for additional custom properties.
    
    # --- Webhooks ---
    # This entire `webhooks` array is OPTIONAL. If not needed, omit this section entirely or provide an empty array: `webhooks: []`.
    webhooks:
      # Example of a single webhook configuration. Add more items if multiple webhooks are needed.
      - url: "[[String: The URL endpoint to which the webhook request will be sent, e.g., '[http://call.com](http://call.com)', '[http://exec.com](http://exec.com)']]"
        proxyHost: "[[String: Optional proxy host. Can be a placeholder like '${p?:system/proxyHost}' or an empty string `''`.]]"
        proxyPort: "[[String: Optional proxy port. Can be a placeholder like '${p?:system/proxyPort}' or an empty string `''`.]]"
        webhookTemplate:
          name: "[[String: The name of the webhook template used, e.g., 'webhooktemplate']]"
          description: "[[String: A description for the webhook template. Can be empty `''`.]]"
          body: "[[String: The raw body content of the webhook request.]]"
          type: "[[String: The type of event that triggers this webhook. Example: 'PROCESS_FAILURE'. Other types may exist depending on system capabilities.]]"
      # Add more `- url: ...` blocks here for additional webhooks.
    
    # --- Team Mappings ---
    # This entire `teamMappings` array is OPTIONAL. If not needed, omit this section entirely or provide an empty array: `teamMappings: []`.
    teamMappings:
      # Example of a single team mapping. Add more items if multiple team mappings are needed.
      - resourceTypeId: "[[String: The unique ID of the resource type being mapped, e.g., '20000000000000000000000000000109']]"
        resourceTypeName: "[[String: The name of the resource type, e.g., 'Process', 'Component'.]]"
        teamId: "[[String: The unique ID of the team being mapped, e.g., '18f70a02-67bd-8ac4-7c5a-fcddeecfd8df']]"
        teamLabel: "[[String: The display label of the team, e.g., 'Deployer-team', 'Custom_Team'.]]"
      # Add more `- resourceTypeId: ...` blocks here for additional team mappings.

• Example of a generic process configuration

    {
        "properties": [
            {
                "name": "workingDir",
                "value": "${p:resource\/work.dir}\/${p:process.name}"
            },
            {
                "name": "defaultResourceId",
                "value": "196f310a-45fc-6941-e488-d4a0a87a7f38"
            }
        ],
        "description": "generic porcess",
        "propDefs": [
            {
                "index": 0,
                "name": "TextProperty",
                "type": "TEXT",
                "inherited": false,
                "isHidden": false,
                "required": false,
                "label": "TextProperty-label",
                "description": "prop-description",
                "pattern": "",
                "value": "DEFAULT-VALUE"
            },
            {
                "index": 1,
                "name": "select-property",
                "type": "SELECT",
                "inherited": false,
                "isHidden": false,
                "required": true,
                "label": "sp label",
                "description": "SP",
                "pattern": "",
                "allowedValues": [
                    {
                        "value": "DD",
                        "label": "DD"
                    },
                    {
                        "value": "WD",
                        "label": "WD"
                    },
                    {
                        "value": "HARNESS",
                        "label": "HARNESS"
                    }
                ],
                "value": "WD"
            },
            {
                "index": 2,
                "name": "chekbox",
                "type": "CHECKBOX",
                "inherited": false,
                "isHidden": false,
                "required": false,
                "label": "checkbox properrty label",
                "description": "CHECKBOX PROP",
                "pattern": "",
                "value": "true"
            }
        ],
        "webhooks": [
            {
                "url": "http:\/\/git.com",
                "proxyHost": "${p?:system\/proxyHost}",
                "proxyPort": "${p?:system\/proxyPort}",
                "webhookTemplate": {
                    "name": "webhooktemplate",
                    "description": "",
                    "body": "sdfs",
                    "type": "PROCESS_FAILURE"
                }
            },
            {
                "url": "http:\/\/exec.com",
                "proxyHost": "${p?:system\/proxyHost}",
                "proxyPort": "${p?:system\/proxyPort}",
                "webhookTemplate": {
                    "name": "webhooktemplate",
                    "description": "",
                    "body": "sdfs",
                    "type": "PROCESS_FAILURE"
                }
            }
        ],
        "teamMappings": [
            {
                "resourceTypeId": "20000000000000000000000000000109",
                "resourceTypeName": "Process",
                "teamId": "18f70a02-67bd-8ac4-7c5a-fcddeecfd8df",
                "teamLabel": "Deployer-team"
            },
            {
                "resourceTypeId": "20000000000000000000000000000109",
                "resourceTypeName": "Process",
                "teamId": "19560231-d660-d0fa-a390-5b0431d04946",
                "teamLabel": "custom_team"
            }
    }
    // rest of the process

    ---
    properties:
    - name: "workingDir"
      value: "${p:resource/work.dir}/${p:process.name}"
      - name: "defaultResourceId"
        value: "19642f2e-59b5-6af5-765b-575fb18de966"
    description: " some description"
    propDefs:
      - index: 0
        name: "TEXT-PROPERTY"
        type: "TEXT"
        inherited: false
        isHidden: false
        required: false
        label: "TEXT-PROPERTY"
        description: ""
        pattern: ""
        value: "some default value"
    webhooks:
      - url: "http://call.com"
        proxyHost: "${p?:system/proxyHost}"
        proxyPort: "${p?:system/proxyPort}"
        webhookTemplate:
        name: "webhooktemplate"
        description: ""
        body: "sdfs"
        type: "PROCESS_FAILURE"
    teamMappings:
      - resourceTypeId: "20000000000000000000000000000109"
        resourceTypeName: "Process"
        teamId: "18f70a02-67bd-8ac4-7c5a-fcddeecfd8df"
        teamLabel: "Deployer-team"
  
    # rest of the process

---

See also: For a complete reference of all process step types (Plugin Step, Switch, Rollback, Install, Manual Task, and more), see Process Step Definitions.