Try our new app Smart Attachments for Confluence. Store your project documents, artifacts, and media assets in the shareable space storage in Confluence. See the app in action.
Starting from version 1.9.0, Smart Attachments add-on supports workflow validators.
Validators
Validators allow you to verify that any action performed to the transition is valid prior to the issue being moved to the next workflow step. If validation fails, transition to the next workflow step is rejected and the transition's post functions are not performed.
Validator Types
The following validators are available:
Validator | Description | Configuration |
---|---|---|
File Uploader is User | Validates that there is at least one attachment uploaded by one of the selected users. | Selection of one or multiple users. |
File Uploader is in Group | Validates that there is at least one attachment uploaded by the user from the selected user group. | Selection of a user group |
File Uploader is in Project Role | Validates that there is at least one attachment uploaded by the user with the selected project role. | Selection of a project role |
Category is not Empty | Validates that the specified category contains at least one attachment. Please consider the specifics of the condition while checking one or multiple categories, as follows:
| Manual entry of one or multiple category names for checking. Optionally, you can define verification of attachment availability, as follows:
|
Verify Number of Attachments in Category | Checks that the specified number of attachments is available in the category. | Manual entry of the category name and the number of attachments that should be available in it. Optionally, you can define verification of attachment availability, as follows:
You can also enable the option to treat document revisions as distinct attachments. |
All validators allow you to set only one criterion per validator. If you want to validate several criteria at once during transition, you should create separate validators, one per each criterion. The only exception is the File Uploader is User validator that allows you to select multiple users at once.
Adding Validators
- Open the project workflow which you want to add a validator for.
- Switch the project workflow to the edit mode.
- Locate the appropriate transition (arrowed line) and click Validators in the properties panel. Alternatively, you can select the target workflow step (when working with the text version of the workflow). You are redirected to the page listing the validators.
- Click Add validator.
- On the opened page, select the appropriate validator type.
- Click Add.
- Configure the workflow validator.
- Click Add.
- In the notification block, click Publish Draft.
Note that validators are executed one by one and not all at once.
Editing Validators
- Open the workflow step containing validators you want to modify.
- On the Validators tab, locate the validator for editing.
- Click Edit icon.
- Make the required modifications.
- Click Update.
Deleting Validators
- Open the workflow step containing validators you want to modify.
- On the Validators tab, locate the validator for removal.
- Click Delete icon.
Using name patterns and regular expressions
Smart Attachments add-on allows you to use the name patterns and regular expressions for verifying attachments stored in categories.
Name Patterns
Name patterns allows you to quickly enumerate the full or partial file names, or file formats of attachments that should be verified by the validator. You can enter one or multiple words or file formats for verification by the validator. In case of multiple items, you need to separate them with the comma.
For example, you want to verify only attachments containing the word 'contract'. Enter the word 'contract' into the corresponding text field.
If you want to verify the specific file formats (for example, DOC and PDF files), you should enter 'doc, pdf' into the corresponding text field.
Regular Expressions
Regular expressions allow you to quickly enter the flexible query for verifying specific attachments in categories.
For example, you want to verify only attachments with *.docx and *.pdf formats. You need to enter the following regular expression '(.+?)(.docx|.pdf)$'.