5. Using the automated Text Replacement feature in issues

Goal

This section shows the instructions to use macro Text Replacement feature.

Pre-requisites

This tutorial was written considering that :

• you have a Gaia Activity instance installed and running on your server;
• you have rights to create new Activity Templates and Issue Templates;

Feature

Gaia Activity for JIRA allows you to replace variable text you add in your Jira issues XML file by a Text Macro to be decided at creation time and following this syntax: ##TextToReplace##

Example

Add Macro Text in your issues

Let's say that an Activity Template is a Test Template, and that some text contained in the sime Jira issues of a Jira Issue Component Template needs to be automatically replaced with the name of the regressions. For instance then, we may want the issue summaries or descriptions to contain the text "Regression Alpha", for identifying the Alpha Regression, and the next would be "Regression Beta", and so on. Therefore, we may "encode" the issue summary in the issue component template like this : ##RegressionIdentifier##.

This may look like this: 

You may add as many different macros as you wish in any fields, and export your issues as usual.

2. Specify the value of those macros at creation time

At creation time, any ##RegressionIdentifier## found will be replaced with the proper value entered by the user.

3. Check in the issues created

When issue creation is done, you may look at the instantiated issues to find back the values you specified. 

Built-in Text Macro

Additionally to User-defined Text Macros, some default Text Macro may be used at anytime as well:

• ##ACTIVITY_NAME##
• ##PROJECT_NAME##
• ##PROJECT_KEY##
• ##SPACE_NAME##
• ##DATE##

Restrictions

• You may only use alphanumerical character to describe your macro identifiers.