Introduction
This is the third exercise of the Advanced Level. The main goal of this exercise is to show you how to set up and manage Xporter Workflow Post Functions.
Workflow Post Functions allow administrators to set parameters that will make the Xporter Multi-Action Post Function automatically generate documents based on the Status Transitions of issues, along with customizations of File Names and File destinations.
For more information on Jira Workflow Post Functions, please refer to the Atlassian documentation here.
In order to perform the initial setup, on Jira Administration navigate to Issues, click Workflows on the sidebar, and Edit the Workflow of the Academy Project. On the next page, on Step Name (id) To Do, under the Transitions (id) column, click In Progress. On the next page, click the Post Functions tab and then Add post function.
On the Add Post Function To Transition page, the following will be displayed, along with other options:
- the Xporter Multi-Action selector, to create a document and save/attach the generated file.
Workflow Post Functions are not limited by Permission Schemes.
Exercises
Adding an Xporter Multi-Action Post Function
On the Add Post Function To Transition page of the transition mentioned earlier, tick the Xporter Multi-Action Post Function option and the Parameters page will be displayed.
You can include mappings in the filename, the same mappings that are used inside the templates, with a slightly different notation: start with $ and the name of the field. Examples:
- document_$Key.pdf
- document_$Key_$Updated.pdf
- document_$Key_$Updated_$Status.pdf
1. Attach to a file
Select any Template and Output from the selectors, the filename is optional but you can put document_$Key_$Status.
Notice that the file extension will be added automatically, based on the Output format previously selected.
Configure a new post action selecting the Attach File option on the action dropdown.
The default filename can be ticked off to use the default filename defined before.
However, you can tick on and choose a different one.
The mappings in the filename are restricted by the maximum characters allowed. If the size of the filename is too long, the file will not be created.
Click Add, and as you're navigated back to the Transition page, your Workflow Post Function is now displayed under Post Functions.
At the top of your current page, click Publish Draft, and then Publish.
Then, navigate to an issue of the Academy project with the Status To Do and click Start Progress.
After that action, check the issue attachments. The generated file will be attached to the issue named as you've defined.
2. Upload to a File Server
Select any Template and Output from the selectors, the filename is optional but you can put document_$Key_$Status.
Notice that the file extension will be added automatically, based on the Output format previously selected.
Configure a new post action selecting the Upload File option on the action dropdown and choose the File Server desired.
File Server
You need to have at least one file server configured. See here how you can define one.
The default filename can be ticked off to use the default filename defined before or ticked on to use a different one.
Click the Add button, and as you're navigated back to the Transition page, your Workflow Post Function is now displayed under Post Functions.
At the top of your current page, click Publish Draft, and then Publish.
Navigate to an issue of the Academy project with the Status To Do and click Start Progress.
After that action, check your File Server. There, you'll find the generated report, named as you defined it.
3. Send by Email
Select any Template and Output from the selectors, the filename is optional but you can put document_$Key_$Status.
Notice that the file extension will be added automatically, based on the Output format previously selected.
Configure a new post action selecting the Send Email option on the action dropdown and fill the required fields.
Enter your email address in To. On the Subject, enter Xporter Report from ${Key} - ${CurrentDate}.
On the Body, enter ${Key} generated file is attached.
You can use emails, mappings, Usernames or User Ids on the Attachment file name, To, Subject, Cc, Bcc and Body fields.
The mappings you include are the same mappings that are used inside the templates with the same notation.
You can also use the following Xporter for Jira format functions:
Click the Add button, and as you're navigated back to the Transition page, your Workflow Post Function is now displayed under Post Functions.
Navigate to an issue of the Academy project with the Status To Do and click Start Progress.
After that action, check your email, and you'll find its Subject and Body filled as you've defined, along with the generated Report as an attachment.
Congratulations! You've completed the Configuration Advanced level. 
If you like this exercise, please leave a comment or a 
. Your feedback is very important to us.
Thank you in advance. Enjoy our product. 