How to Create a HipChat Room to Communicate About a Blocker High Priority Ticket | Div |
---|
| Estimated Time: 2-3 1 min |
In this step, you will be defining variables 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-on so that it knows use it on a workflow or the Run CLI Actions screen to tell it how to connect to your HipChat instance. I Turn this into a regular expression (aka Regex expression) that searches for any occurrence of the named words, by separating each word with a pipe ('|') character and then adding .*/\b(?: before it and )\b.* after it. Anchor |
---|
| step1 | step1 | Example expression: No Format |
---|
.*\b(?:acquire|acquisition||acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.* |
How to Create a HipChat Room to Communicate About a Blocker Ticket | Create HipChat CLI command Div |
---|
| Image Removed Estimated Time: 2 min |
Use the command shown on the right to invoke the HipChat CLI to scan the chat history of public HipChat rooms to find any references to your list of words and write the results to a file. hipchat indicates to invoke the HipChat CLI client.The runFromRoomList action indicates to retrieve a list of public HipChat rooms and then, for each room, run the action indicated by the --common parameter. (Note that the value of the --common parameter extends up to the final double quote (") character.)- The
getRoomHistoryList action that is executed for each room returned by the runFromRoomList action includes these parameters:--room indicates to access the current HipChat room--file indicates to save the references to the words you're monitoring into a file named chatreferences.csv. This file will be saved to the same folder to which you installed the HipChat CLI client. If this is not what you want, you can specify a full path to the file, enclosing it within double quotes:
No Format |
---|
--file "../yourfolder/chatreferences.csv" |
--append indicates to append the output to the chatreferences.csv file if it already exists. This is important since the references may be written from multiple HipChat rooms.
--regex provides the Regex expression you prepared earlier. Note that this expression is inserted between \" and \" since it must be quoted but appears within the entire --common parameter which is also quoted.
| Anchor |
---|
step2 | step2 | Example command: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| hipchat --action runFromRoomList --common "--action getRoomHistoryList --room \"@room@\" --file chatreferences.csv --append --regex \".*\b(?:acquire|acquisition|acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.*\" " |
How to Create a HipChat Room to Communicate About a Blocker Ticket | Execute HipChat CLI command Div |
---|
| Image Removed Estimated Time: 1 min |
In your command window, type the command from the previous step and press Enter. The command will run, showing the result of executing the GetRunHistoryList action against each public HipChat room (3 rooms in our example). Per the HipChat CLI instructions, your hipchat.bat or .sh file contains a --token parameter which supplies the API Access token of a HipChat user. Be sure to use the token of a user who has access to all of the public rooms you wish to monitor. | Anchor |
---|
step3 | step3 | Example output: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| Run: --action getRoomHistoryList --room "ExampleGear Engineering" --file chatreferences.csv --append --regex ".*\b(?:acquire|acquisition|acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.*"
2 history entries in list appended to file: chatreferences.csv
Run: --action getRoomHistoryList --room "ExampleGear HR" --file chatreferences.csv --append --regex ".*\b(?:acquire|acquisition|acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.*"
1 history entries in list appended to file: chatreferences.csv
Run: --action getRoomHistoryList --room "ExampleGear Marketing" --file chatreferences.csv --append --regex ".*\b(?:acquire|acquisition|acquisitions|merger|mergers|aquire|aquisition|aquisitions)\b.*"
0 history entries in list
Run completed successfully. 3 actions were successful |
Example CSV file: Code Block |
---|
language | text |
---|
theme | DJango |
---|
title | chatreferences.csv file |
---|
linenumbers | true |
---|
| "Room","Message Id","Date","Type","Message Format","Message Color","Message","From Id","From Name","From Mention Name","Link Name","Link URL","Link Type"
"ExampleGear Engineering","d75f884d-f5b0-4aa4-ba2c-d273d9da682b","2015-03-25T10:54:04.082-0400","message","","","That'll look great to Acme's auditors as they try to decide whether to follow-thru on the acquisition!","1928057","Hank Johnson","hjohnson","","",""
"ExampleGear Engineering","218e7533-b2b5-40da-91f4-6ff1f9534940","2015-03-25T12:29:59.647-0400","message","","","Whoops, @hjohnson! Everything is hush hush about that subject. There can be absolutely no talk about mergers or acquisitions in public rooms.","1915328","Jasmine Stone","JasmineStone","","",""
"ExampleGear HR","ed202752-f46f-40a9-85a8-ea6c09accda0","2015-03-25T10:42:10.755-0400","message","","","When the acquisition goes through, will HR provide training and guidance to managers on how to communicate the details to their staff?","1915328","Jasmine Stone","JasmineStone","","","" |
How to Create a HipChat Room to Communicate About a Blocker Ticket | Create Confluence page Div |
---|
| Image Removed Estimated Time: 2 min |
Create a Confluence page that will display the chatreferences.csv file in a table so others can easily review what your language monitoring revealed. The page consists of 2 items: - An introductory paragraph that describes the purpose of the page or anything else the viewer ought to know.
- The CSV macro, which is part of the Advanced Tables for Confluence add-on, configured with the parameters shown on the right.
Save the page, and take note of the space key and the page title. The space key appears in the URL of the page after you've saved, immediately after "display/". For instance, in the URL http://wiki.examplegear.com/display/EGM/HipChat+Monitoring , the space key is EGM . | Anchor |
---|
step4 | step4 | CSV Macro parameters:Output format | html | Location of CSV data | ^chatreferences.csv | Auto number each row | selected | Show sort icon | selected | Auto sort column | Date | Column types | S,S,M,S,S,S,S,S,S,S,S,S |
Edit view of the page: Image Removed
| | | How to Create a HipChat Room to Communicate About a Blocker Ticket | Create Confluence CLI command Div |
---|
| Image Removed Estimated Time: 1 min |
Use the command shown on the right to attach the chatreferences.csv to the Confluence page you just created, confluence indicates to invoke the Confluence CLI client.The addAttachment action indicates to attach a file to a Confluence page.- The
--title parameter provides the Confluence page's title. - The
--file parameter provides the name of the file to be attached. (This will generally match what you used on the previous HipChat CLI command.)
| Anchor |
---|
step5 | step5 | Example command: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| confluence --action addAttachment --space "EGM" --title "HipChat Monitoring" --file chatreferences.csvTo do this, log on to your JIRA instance as a JIRA Administrator and do the following: - From the Cog menu (Image Added), choose Add-ons.
- 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.
- Define a new entry with the parameters set as shown to the right.
- 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.
- The Value parameter defines how to access your HipChat instance.
- Replace
<URL> with the URL to your HiipChat instance. - 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.
- Click Save to save the user defined substitution variable.
| User Defined Substitution Variables:Name | hipchat | Value | --server <URL> --token <TOKEN> --autoWait |
Configure Run CLI Actions in JIRA screen, after defining new variable: Image Added
|
| How to Create a HipChat Room to Communicate About a High Priority Ticket | Create a JIRA project to use with this recipe Div |
---|
| Image Added Estimated Time: 1 min |
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. - From the Projects menu, choose Create Project.
- In the Select Project Type screen, select Simple Issue Tracking and click Next.
- The second screen shows the Issue Types that will be used (Task and Sub-task). Click Select.
- The third screen prompts you to supply a Name and Key for your new JIRA project.
- Use Run CLI Actions in JIRA as the Name.
- Use RCAIJ as the Key.
- Click Submit to create the project, with you set as its Project Lead.
- 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.
| Create Issue screen: Image Added Expand |
---|
title | View all screens for the Create Project wizard... |
---|
| First screen: Image Added Second screen: Image Added Third screen: Image Added |
|
| How to Create a HipChat Room to Communicate About a High Priority Ticket | Create a draft workflow Div |
---|
| Image Added Estimated Time: 1 min |
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. - From the Cog menu (Image Added), choose Projects.
- Click the Run CLI Actions in JIRA
link to display the Project Summary page which shows how the project is configured. - In the Workflows section of the page, click the pencil icon (Image Added) next to the RACIJ: Simple Issue Tracking Workflow link to edit that workflow.
- Click the Image Added button so that the workflow is shown in Text mode rather than Diagram mode.
- Click the To Do link in the Step Name column. The Step: To Do screen is displayed.
- Click the Create link shown to the left of the To Do step to open the Transition: Create screen.
| Step: To Do screen: Image Added Transition: Create screen: Image Added |
| How to Create a HipChat Room to Communicate About a High Priority Ticket | Add a post function on the Create transition Div |
---|
| Image Added Estimated Time: 2 min |
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: - Click the Post Functions tab to display the post functions. Your screen
- Click the Add post function link to display the Add Post Function To Transition screen.
- Select CLI action and then click Add.
- The Add Parameters To Function screen will be displayed.
| Transition: Create screen, before any changes: Image Added
Add Post Function To Transition screen:
Image Added
|
| How to Create a HipChat Room to Communicate About a High Priority Ticket | Configure the post function, part 1 Div |
---|
| Image Added Estimated Time: 3-4 min |
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: - Set the parameters as shown to the right.
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. |
- Product indicates that HipChat CLI commands will be executed.
- 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. - Data defines the commands to be invoked, with each appearing on their own line.
- 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.
- Line 2 adds the reporter as a member to the new HipChat room.
- Line 3 adds the assignee as a member to the new HipChat room.
- 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.
- Notes is an internal comment that serves to document what the post function does.
- 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.
- Your screen should now look like the screenshot shown to the right.
| Post Function parameters:Condition 1 | Image Added | 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%: %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: Image Added |
| How to Create a HipChat Room to Communicate About a Blocker High Priority Ticket | Execute Confluence CLI commandConfigure the post function, part 2 Div |
---|
| Estimated Time: 1 min |
In your command window, type the command from the previous step and press Enter. The command will run, showing the result of executing the addAttachment action. Per the Confluence CLI instructions, your confluence.bat or .sh file contains credentials for a Confluence user. Be sure to use credentials of a user who has read/write access to your Confluence page. Anchor |
---|
| step6 | step6 | Example output: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| Attachment 'chatreferences.csv' of type 'text/csv' added to page 'HipChat Monitoring' in space 'EGM', id: 557107, url: http://wiki.examplegear.com/download/attachments/557100/chatreferences.csv?version=2&modificationDate=1427900084733&api=v2this 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: - Repeatedly click the Down Arrow icon (Image Added) 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.
- Your screen should now look like the screenshot shown to the right.
- Publish your draft workflow by clicking the Publish Draft button at the top of the screen. The Publish Draft Workflow screen will appear.
- When prompted whether to save a backup copy, click Yes and then click Publish.
Transition: Create screen, after moving the CLI Action post function: Image Added Expand |
---|
title | View the Publish Draft Workflow screen... |
---|
| Image Added |
|
| How to Create a HipChat Room to Communicate About a Blocker High Priority TicketReview Confluence page | Test the post function Div |
---|
| Estimated Time: 1 min |
In Confluence, navigate to the page you created to verify the chatreferences.csv file is now attached to the page and it reflects the contents of that file.lIf this page was already open in your browser, you may need to refresh the pagethis step, you will verify the post function is working as intended. - Click the Create button to create a new issue. The Create Issue screen will appear.
- 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.
| Image RemovedCreate Issue fields:
Project | Run CLI Actions in JIRA (RCAIJ) | Issue Type | Task | Summary | System crash due to xxx | Priority | Blocker |
|
| How to Create a HipChat Room to Communicate About a Blocker High Priority Ticket | Create a reusable CLI script Div |
---|
| 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: - Navigate to the folder to which you installed the HipChat and Confluence CLI clients.
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. | Contents of example CLI script file: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| 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: Code Block |
---|
language | text |
---|
theme | DJango |
---|
linenumbers | true |
---|
| monitorRooms |
|
|