Workflow - Approval Flows
Flow Process
Flow
The overall approval flow can be described as a few steps:
User comments
User submits comment
Comment is marked as submitted
Mail notification is sent to Approver
Approver reviews comment
Approver approves comment
Comment is marked as approved
Steps
When a user has completed commenting on a slice of data (for example combination of month and project), the user submit the comment which marks it in the writeback database for state "Submitted".
Submitting a comment will trigger mail notifications to be sent to the configured list of Workflow Receivers.
A Workflow Receiver must then review the comment. If the comment can be accepted, the user must then approve it. This marks it in the writeback database for state "Approved".
Configuration
Comment state is saved in the writeback table column specified with setting "Approval State". This column must be of type integer.
Approvers are specified as a semicolon-separated list of e-mail addresses with the formatting setting "Workflow Receivers".
Fields "Subject Template" and "Notification Template" can be used to specify templates for mail notification subject and body, respectively.
Setting | Description |
Workflow Receivers | Semicolon-separated list of e-mail addresses |
Subject Template | Used to specify templates for mail notification subject See elaboration in section "Templates" below |
Notification Template | Used to specify templates for mail notification body See elaboration in the section "Templates" below |
Report Name | Display name of the current report |
Report URL | URL of the current report
|
Templates
Designing these templates a set of tokens can be included. These tokens will be replaced with contextual values during processing of the flow.
Token Name | Replaced With |
#ReportName# | Will be replaced with name of the current report |
#FilterValues# | Will be replaced with concatenated string of key/value for each configured transaction key: "<key>"="<value>" |
#ReportContextUrl# | Will be replaced with the URL of the current report, as specified with setting "Report URL" - the specified URL will be appended with query parameters for pre-filtering using values from transaction keys |
If utilizing tokens "#ReportName#" and "#ReportContextUrl#" their respective values must be provided through the settings "Report Name" and "Report URL".
If templates are not configured, default templates will be used for settings "Subject Template" and "Notification Template".
Subject Template
Comments for report #ReportName# submitted (#FilterValues#)
Notification Template
Please review submitted comments for report #ReportName# (#FilterValues#):
#ReportContextUrl#