Genehmigungspunkte

Einen Job anhalten, bis jemand ihn genehmigt

  1. Funktionsweise
  2. Den eigenen Job genehmigen
  3. Attribute
  4. Beispiele
    1. 1) Remove host
    2. 2) Ask for approval in Teams

Funktionsweise

Ein Genehmigungspunkt hält den Job an seiner Stelle im Formular an, bis ein Genehmiger darauf antwortet:

When you want to pause a job and ask for approval first. You can insert an approval point using the approval-object attributes

Den eigenen Job genehmigen

Ab 7.3.0 kann der Benutzer, der einen Job gestartet hat, ihn nicht genehmigen, selbst mit einer der Rollen der Genehmigung; es braucht also eine zweite Person. Ein Admin kann immer genehmigen, auch die eigenen Jobs. Der Starter kann seinen eigenen Job weiterhin ablehnen (zurückziehen). Setzen Sie allowSelf: true, wenn er ihn auch genehmigen darf, etwa in einem Testformular:

approval:
  title: Approve the change
  message: Please approve this change
  roles:
    - approvers
  allowSelf: true

Attribute

Die Attribute eines Genehmigungspunkts:

Attribut Kommentare
title
string

Approval message title
Free text with placeholders

The approval point consists out of a title and message. This is the title attribute, used as the subject of the approval mail.
Without it, the mail gets the default approval subject. A workflow’s approval nodes take the node’s name as title.
Note: This supports placeholders (the placeholders point to extravars)
message
string / erforderlich

Approval message
Free text with placeholders

The approval point consists out of a title and message. This is the message attribute.
Note: This supports placeholders (the placeholders point to extravars)
roles
array / erforderlich

The approver roles
a valid role

Every role in this list will have the power to approve or reject this job.
notifications
array

The approval recipients
a valid email address

Every email-address in this list will receive the approval message by email with the approval link.
channels
array

The approval channels
the name of a notification channel

The notification channels of Connections > Notifications that receive the approval message, with a link to the job, where it is approved or rejected: Slack, Microsoft Teams, Telegram, a webhook.
A mail channel in this list sends the approval mail to the notifications addresses through that server instead of the active one.
A name that is not there is said in the log and skipped. (Added in 7.0.0)
allowSelf
boolean

The requester may approve their own job
true or false

By default the user who launched a job cannot approve it, even with one of the approver roles: another approver must, so every approved job was seen by two people. The requester can still reject (withdraw) their own job. Set allowSelf: true to let the requester approve their own job too. An admin can always approve any job, their own included, whatever this says. (Added in 7.3.0)

Beispiele

Beispiele für Genehmigungspunkte, in YAML:

1) Remove host

Die Definition, in YAML:

approval:
  title: Remove host $(vm.name) ?
  message: |
    You are about to remove vm $(vm.name).<br>
    Esx server: $(cluster.esxhost.name)<br>
    Status: $(vm.status)<br>
    Change request: $(cr.id)
  roles:
  - approvers
  - vmwareadmin
  notifications:
  - vmware@domain.local
  - approvers@domain.local

2) Ask for approval in Teams

Die Definition, in YAML:

approval:
  title: Remove host $(vm.name) ?
  message: You are about to remove vm $(vm.name).
  roles:
  - approvers
  channels:
  - approvers-teams