How to Create a HipChat Room to Communicate About a High Priority Ticket

Configure user defined substitution variables

In this step, you will be defining a user defined substitution variable for the Run CLI Actions in JIRA add-on. By defining this information once as a user defined substitution variable, you can re-use it on a workflow or the Run CLI Actions screen to tell it how to connect to your HipChat instance.

To do this, log on to your JIRA instance as a JIRA Administrator and do the following:

1. From the Cog menu (), choose Add-ons.
2. In the Run CLI Actions in JIRA section of the left navbar, click Configure. The Configure RUN CLI Actions in JIRA screen will be displayed.
3. Define a new entry with the parameters set as shown to the right.
   1. The Name parameter defines the name of the entry, which you will later reference when running a CLI action from a workflow (as in this recipe) or the Run CLI Actions screen.
   2. The Value parameter defines how to access your HipChat instance.
      
      1. Replace <URL> with the URL to your HiipChat instance.
      2. Replace <TOKEN> with the token of the HipChat user you want to "own" the HipChat room that will be created when a Blocker ticket is opened.
4. Click Save to save the user defined substitution variable.

Configure Run CLI Actions in JIRA screen, after defining new variable:

Create a JIRA project to use with this recipe

In this step, you are going to create a project you will use when making and testing the workflow change that creates a HipChat room.

1. From the Projects menu, choose Create Project.
2. In the Select Project Type screen, select Simple Issue Tracking and click Next.
3. The second screen shows the Issue Types that will be used (Task and Sub-task). Click Select.
4. The third screen prompts you to supply a Name and Key for your new JIRA project.
   1. Use Run CLI Actions in JIRA as the Name.
   2. Use RCAIJ as the Key.
   3. Click Submit to create the project, with you set as its Project Lead.
5. If you click Create and choose Run CLI Actions in JIRA as the Project and Task as the Issue Type, you will see a Create Issue screen like the one shown to the right. Only 3 fields (Project, Issue Type, and Summary) are required, as indicated by the red asterisk next to their field labels. There are 2 optional fields: Priority and Description. Click Cancel to close this screen.

Add Assignee to the Create screen

In this step, you will add the Assignee field to the Create screen to ensure it can be input. By default, the project is configured to set the default Assignee to "Unassigned."

1. From the Cog menu (), choose Projects.
2. Click the Run CLI Actions in JIRA
   link to display the Project Summary page which shows how the project is configured.
3. In the left navbar, click Screens to go to the Screens page.
4. Next to the "Create issue" operation, click the RCAIJ: Simple Issue Tracking Create Issue Screen link to open the Configure Screen for the Create screen used for this project.
5. In the dropdown at the bottom of the screen, select Assignee.
6. Click and drag the grabber bar to the left of the Assignee field and drag it above the Attachment field. Your screen should now look like the screenshot shown to the right.
7. Click the button to return to the Screens page.

Create a draft workflow

In this step, you will edit the workflow used by the Run CLI Actions in JIRA project so you can begin the process of adding the Run CLI Actions post function that will create a HipChat room when a Blocker ticket is opened.

1. From the Cog menu (), choose Projects.
2. Click the Run CLI Actions in JIRA
   link to display the Project Summary page which shows how the project is configured.
3. In the Workflows section of the page, click the pencil icon () next to the RACIJ: Simple Issue Tracking Workflow link to edit that workflow.
4. Click the Image Modified button so that the workflow is shown in Text mode rather than Diagram mode.
5. Click the To Do link in the Step Name column. The Step: To Do screen is displayed.
6. Click the Create link shown to the left of the To Do step to open the Transition: Create screen.

Transition: Create screen:

Add a post function on the Create transition

In this step, you will add a post function on the Create transition. In a later step, you will configure this post function.

From the Transition: Crreate screen, do the following:

1. Click the Post Functions tab to display the post functions. Your screen
2. Click the Add post function link to display the Add Post Function To Transition screen.
3. Select CLI action and then click Add.
4. The Add Parameters To Function screen will be displayed.

Add Post Function To Transition screen:

Configure the post function, part 1

In this step, you will begin configuring the post function you just added to the Create transition so that tickets of the highest priority will trigger the creation of a HipChat room.

From the Add Parameters To Function screen, do the following:

1. Set the parameters as shown to the right.

   1. Condition 1 indicates that the post function should be executed only when the ticket being created as a Priority = Highest.
      

      Note
      title Highest vs. Blocker priorities
      Beginning with JIRA 6.4, the highest priority is now named Highest. In earlier versions, it was named Blocker. If you are using a version of JIRA earlier than 6.4, please substitute "Blocker" wherever you see "Highest" in this recipe. You might want to view the priority values defined in your instance to ensure you are specifying the correct and exact name. Please note that this name is case sensitive when supplying it in the post function parameters.

   2. Product indicates that HipChat CLI commands will be executed.
   3. Action indicates that the run action will executed so multiple commands (as defined in the Data parameter) can be invoked. The %variable_hipchat% indicates to substitute the Value you provided for the hipchat variable defined on the User Defined Substitution Variables screen in step 1.
   4. Data defines the commands to be invoked, with each appearing on their own line.
      1. Line 1 creates a new HipChat room with a name that contains the key of the Blocker issue and a description that indicates it is to be used to discuss the ticket.
      2. Line 2 adds the reporter as a member to the new HipChat room. "@" is inserted prior to the %original_reporter% substitution variable since the @mention name of the HipChat user is what matches the JIRA username.
         

      3. Line 3 adds the assignee as a member to the new HipChat room. "@" is inserted prior to the %original_assignee% substitution variable since the @mention name of the HipChat user is what matches the JIRA username.
         

         Info
         The Simple Issue Tracking Workflow, by default, uses "Unassigned" as the default Assignee. When this is the case, Line 3's command will not work as intended as "" (the value after the substitution occurs) is not a valid name of any HipChat user.

      4. Line 4 writes an initial message to the room to reiterate its purpose to the members and ask that they invite others to join this room as appropriate.
   5. Notes is an internal comment that serves to document what the post function does.
2. Click Add to save your changes to the parameters and add the Create Issue post function. You will be returned to the Transition: Create screen.
3. Your screen should now look like the screenshot shown to the right.

Condition 1
Product	HipChat
Action	--action run %variable_hipchat%
Data	Line 1: --action createRoom --room "%original_key% Room" --topic "Discussion of %original_summary%" Line 2: --action addRoomMembers --room "%original_key% Room" --name "@%original_reporter%" Line 3: --action addRoomMembers --room "%original_key% Room" --name "@%original_assignee%" Line 4: --action sendMessage --room "%original_key% Room" --message "This room is to discuss this Highest priority issue created on %original_created(yyyy-MM-dd)%: %original_key%. Please invite others to join this room as appropriate."
Notes	This post function creates a new HipChat room for any new Highest priority ticket so that any conversation about it can be centralized and communicated to interested parties.

Transition: Create screen, after adding the Create Issue post function:

Configure the post function, part 2

In this step, you will move the new Create Issue post function so it is executed after the Blocker issue is created and then you will publish the workflow so you can test it.

From the Transition: Create screen, do the following:

1. Repeatedly click the Down Arrow icon () next to the CLI Action post functoin until the post function is below the "Creates the issue originally" post function. This will ensure the Blocker issue is created before the CLI Action post function is executed.
2. Your screen should now look like the screenshot shown to the right.
3. Publish your draft workflow by clicking the Publish Draft button at the top of the screen. The Publish Draft Workflow screen will appear.
4. When prompted whether to save a backup copy, click Yes and then click Publish.

Test the post function

In this step, you will verify the post function is working as intended.

1. Click the Create button to create a new issue. The Create Issue screen will appear.
2. Fill in the fields as shown on te right and click Create. A popup window similar to the one shown on the right will appear to confirm the issue was created.

Create a reusable CLI script

Div
class time
Status title Optional Estimated Time: 2 min

If you'd like to save your CLI commands for later reuse, you can save them as a CLI script file.

Using an editor capable of producing a plain text file, such as Notepad (Windows) or TextEdit (Mac), create a script file named:

• For Windows: monitorRooms.bat
• For OS X/Linux: monitorRooms

Save it in the same folder to which you installed the HipChat and Confluence CLI clients and make sure it has permissions so that you can read, write and execute it.

Follow these steps in your command window to execute the script file you just created:

1. Navigate to the folder to which you installed the HipChat and Confluence CLI clients.

2. Type the name of the script file as shown on the right and press Enter.

The script will run, showing the result of executing each action.

hipchat --action runFromRoomList --common "--action getRoomHistoryList --room \"@room@\" --file chatreferences.csv --append --regex \".*\b(?:acquire|acquisition|acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.*\" " 
confluence --action addAttachment --space "EGM" --title "HipChat Monitoring" --file chatreferences.csv 

Command to execute reusable script file:

monitorRooms