component-manual-task

Format

component-manual-task step "foo" is
    -- users that can approve the task; required
    -- approval restriction to the deploying user
    restrict-approval-to deploying-user

    -- name of notification template; optional
    notification-template "TaskCompleted"

    -- property-definition establishes a property definition; optional, repeatable

    -- a text property definition with all options
    property-definition p1-text is text with
        -- label for the property definition; optional
        -- common to all property defintion types
        label "p1-label"

        -- description for the property definition; optional
        -- common to all property defintion types
        description "p1-description"

        -- regex pattern for the property definition's property values; optional
        -- an empty pattern is equivalent to ".*"
        -- common to all property defintion types
        pattern "p1-pattern-.*"

        -- a value is required for property defined by this property definition; optional
        -- common to all property defintion types
        required true

        -- default value for text properties created by this property definition; optional
        default "p1-pattern-default"
    end

    -- a text property definition with no options
    property-definition p2-text-simple is text

    -- a text area property definition with all options
    property-definition p3-textarea is text-area with
        -- common options; optional
        label "p3-label"
        description "p3-description"
        pattern ".*"
        required true

        -- default value for text area properties created by this property definition; optional
        default
            """
            p3-default-line1
            p3-default-line2
            p3-default-line3
            """
    end

    -- a text area property definition with no options
    property-definition p4-textarea-simple is text-area

    -- a text area property definition with all options
    property-definition p5-secure is secure with
        -- common options; optional
        label "p5-label"
        description "p5-description"

        -- default value for secure properties created by this property definition; optional
        -- currently, default values for secure properties do not function properly and their use is not recommended
        default "p5-pattern-default"
    end

    -- a secure property definition with no options
    property-definition p6-secure-simple is secure

    -- a checkbox property definition with all options
    property-definition p7-checkbox is checkbox with
        -- common options; optional
        label "p7-label"
        description "p7-description"
        pattern "true|false"
        required true

        -- default value for checkbox properties created by this property definition; optional
        -- permitted values are 'true' or 'false'
        default true
    end

    -- a checkbox property definition with no options
    property-definition p8-checkbox-simple is checkbox

    -- a date-time property definition with all options
    property-definition p9-datetime is date-time with
        -- common options; optional
        label "p9-label"
        description "p9-description"
        pattern ""
        required true

        -- default value for date-time properties created by this property definition; optional
        -- time is specified as milliseconds from 1970-01-01 00:00:00 UTC.
        default millis 1594814965125
    end

    -- a date-time property with an xml schema format default value
    property-definition p10-datetime-xml is date-time with
        -- default value for date-time properties created by this property definition; optional
        -- time is format is specified at https://www.w3.org/TR/xmlschema-2/#dateTime
        default xml "2000-01-20T12:00:00+12:00"
    end

    -- a date-time property definition with no options
    property-definition p11-datetime-simple is date-time

    -- a select property definition with all options
    -- at least one value must be supplied
    -- at most one value may be selected as the default value
    property-definition p12-select is select of
        -- a possible value in for the property; optional, repeatable
        value "p12-value1"

        -- a value with an optional label
        value "p12-value2" as "Value 2"

        -- a value with a label and optionally selected as the default value
        value "p12-value3" as "Value 3" selected
    with
        -- common otptions; optional
        label "p12-label"
        description "p12-description"
        pattern "p12-value.*"
        required true
    end

    -- a select property definition with an unlabeled value selected as the default and no common options
    property-definition p13-select-default-unlabeled is select of
        value "p13-value1" selected
        value "p13-value2"
        value "p13-value3"
    end

    -- a select property definition with no options
    property-definition p14-select-simple is select of
        value p14-value1
        value p14-value2
        value p14-value3
    end

    -- a multi-select property definition with all options
    -- a date-time property definition with all options
    -- one or more values may be selected as the default value
    property-definition p15-multiselect is multi-select of
        -- a possible value in for the property; optional, repeatable
        value "p15-value1"

        -- a value with a label and optionally selected as one of the default values
        value "p15-value2" as "Value 2" selected

        -- a value with a label and optionally selected as a second default value
        value "p15-value3" as "Value 3" selected
    with
        -- common options; optional
        label "p15-label"
        description "p15-description"
        pattern "p15-value.*"
        required true
    end

    -- a select property definition with an unlabeled values selected as the defaults and no common options
    property-definition p16-multiselect-default-unlabeled is multi-select of
        value "p16-value1" selected
        value "p16-value2" selected
        value "p16-value3"
    end

    -- a select property definition with a single unlabeled value selected as the default and no common options
    property-definition p17-multiselect-one-default is multi-select of
        value "p17-value1" selected
        value "p17-value2"
        value "p17-value3"
    end

    -- a multi-select property definition with no options
    property-definition p18-multiselect-simple is multi-select of
        value "p18-value1"
        value "p18-value2"
        value "p18-value3"
    end
on success
    finish
end

component-manual-task step "bar" is
    -- approval restricted to certain application roles
    -- if present, at least one role must be supplied
    restrict-approval-to application-roles of
        -- role name on the standard resource type; optional, repeatable
        -- before 7.1.1.0, the role must be specified with a database ID
        role "role1"

        -- role on a custom resource type; optional, repeatable
        -- before 7.1.1.0, the resource type must be specified with a database ID
        role "role2" for "resourcetype1"
    end
end

component-manual-task step "baz" is
    -- approval restricted to certain environment roles
    -- if present, at least one role must be supplied
    restrict-approval-to environment-roles of
        role "role3"
        role "role4" for "resourcetype2"
    end
end

component-manual-task step "quux" is
    -- approval restricted to certain component roles
    -- if present, at least one role must be supplied
    restrict-approval-to component-roles of
        role "role5"
        role "role6" for "resourcetype3"
    end
end

component-manual-task step "quuux" is
    -- approval restricted to any user
    restrict-approval-to any-user
end