Goedkeuringspunten

Zet een job stil tot iemand hem goedkeurt

  1. Hoe het werkt
  2. Je eigen job goedkeuren
  3. Attributen
  4. Voorbeelden
    1. 1) Remove host
    2. 2) Ask for approval in Teams

Hoe het werkt

Een goedkeuringspunt zet de job stil op zijn plek in het formulier, tot een goedkeurder antwoordt:

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

Je eigen job goedkeuren

Vanaf 7.3.0 kan de gebruiker die een job startte hem niet goedkeuren, ook niet met een van de rollen van de goedkeuring, dus er is een tweede persoon voor nodig; een admin kan altijd goedkeuren, ook zijn eigen jobs. Degene die de job startte, kan zijn eigen job nog wel afwijzen (intrekken). Stel allowSelf: true in wanneer hij hem ook mag goedkeuren, bijvoorbeeld in een testformulier:

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

Attributen

De attributen van een goedkeuringspunt:

Attribuut Opmerkingen
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 / verplicht

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 / verplicht

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)

Voorbeelden

Voorbeelden van goedkeuringspunten, in YAML:

1) Remove host

De definitie, 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

De definitie, in YAML:

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