The main idea of the system is to parse defined pieces of text (called "tags"). Tags reflect such issue fields as summary, description or assignee. For example if you want to use an issue summary in your document, you should insert the $$summary$$ tag that will add a proper content to the document.
While adding a new template, a full list of tags is available on the screen.
Apart from typical Jira fields, the Automated Attachments plugin gives you the opportunity to use custom fields. They are used similarly to ordinary tags. Each user field (all standard types provided by Jira are supported) can be added to the document template simply by using the tag $$customfield_xxxxx$$ where "xxxxx" is a field ID (e.g. you can use the tag $$customfield_10001$$ for a custom field with the ID = 10001). If you want to know how to obtain the user ID field, please click here.
Some solutions require more sophisticated parsing mechanism. In order to meet these expectations we have created an advanced mechanism for separating fragments of JIRA issue fields. For instance: if the field stores the user's email address, and you want to use only the domain name, you can do that through this mechanism, as in the following example.
If the field (customfield_10001)contains email@example.com, and you want to insert only a domain name into the document, you just need to use the tag $$customfield_10001[@][1:2][:]$$.
Sounds complicated? We assure you that after several attempts you will be proficient in the use of this mechanism.
Sometimes it is necessary to verify how your tag will be parsed before you create a template. You can do it using the testing tags mechanism available in the plugin Options menu. Just enter your issue key and the tag you want to check.