GSBot Commands (Slack Bot used to access Jira data)
1 like606 views
The document provides a comprehensive guide on using gsbot commands, outlining the syntax and common scenarios for commands related to Jira, graphs, and Google Docs. It details how to manipulate data, generate visualizations, and create PDF documents using specific command structures. The document also includes practical examples to illustrate how to find and retrieve information, particularly in cases involving user-specific queries.
GSBot Commands (Slack Bot used to access Jira data)
- 1. GSbot commands How to use it?
- 2. About the presentation Logical parts of the presentation ● GSbot essentials ● Syntax of few GSbot commands ● Common scenario
- 3. GSbot Essentials ● GSbot command anatomy: @gsbot {command} {attribute} {params} ● Every command must start with “@gsbot” ● “@gsbot help” will list all the basic commands ● Use the keyword “help” as a general approach for getting help from GSbot for all commands ● GSbot in most cases is case-sensitive
- 4. Some common GSbot commands Syntax, how to find help, common scenarios ● jira ● graph ● gdocs
- 5. jira essentials Syntax: @gsbot jira {attribute name} Get Help: @gsbot jira help Description: Manipulate JIRA data
- 6. graph essentials Syntax: @gsbot graph {attribute name} Get Help: @gsbot jira help Description: Extend and visualize graphs with various types of diagrams.
- 7. jira search essentials Syntax: @gsbot jira search {type} {what to search} Description: Search through jira items Get Help: @gsbot jira search Example: @gsbot jira search people Vasil Tips ● {what to search} have to be one keyword only ● {what to search} have to be full word not a substring of a word
- 8. jira issue essentials Syntax: @gsbot jira issue {jira key} Description: Getting jira issue details Get Help: @gsbot jira issue help Example: @gsbot jira issue GSP-181
- 9. jira links essentials Syntax: @gsbot jira links {jira key} {direction} {depth} Description: Getting jira items related to the specified jira key Get Help: @gsbot jira links help Examples: @gsbot jira links GSP-181 all 1 @gsbot jira links GSP-181 down 2 ● all ● up ● down ● children ● parents ● 1 ● 2 ● 3 ● 4 ● n (n belongs to )
- 10. graph show essentials Syntax: @gsbot graph show {graph_name} {diagram_type} Description: Visualize previously created graph Get Help: @gsbot show Examples: @gsbot graph show graph_7O6 @gsbot graph show graph_7O6 viva_graph ● plantuml ● vis_js ● viva_graph ● go_js
- 11. gdocs pdf essentials Syntax: @gsbot gdocs pdf {document_id} Description: Generate PDF document from all types of documents provided by G Suite. Get Help: / Examples: @gsbot gdocs pdf 122TjA3Uu-kenHROGmTlCvN05plqaWo-Kq_ME8KW5j_0
- 12. Scenario 1 USED GSBOT COMMANDS ● jira search ● jira issue ● jira links ● graph show ● gdocs pdf Find what information JIRA has about Vasil
- 13. SCENARIO 1: Step 1 Need: You need to find the JIRA identifier (id) for the person Vasil. Command: @gsbot jira search people vasil Result: Graph that includes people with name Vasil was Created. One of them is focus of interest (GSP-181). A graph has been created Use the graph_name/id extend further results you need
- 14. SCENARIO 1: Step 2 Need: View details about the person Vasil. Command: @gsbot jira issue GSP-181 Result: Details about Vasil stored in JIRA in a key - value table as a image.
- 15. SCENARIO 1: Step 3 Need: Get related items (JIRA issues of various types) for Vasil. Command: @gsbot jira links GSP-181 all 1 Result: All first level items related to Vasil
- 16. SCENARIO 1: Step 4 Command: @gsbot jira links GSP-181 all 2 Result: All items with depth 2 relations related to Buraliev
- 17. SCENARIO 1: Step 5 Command: @gsbot graph show graph_7O6 Result: 4 different visualization types of a same graph were generated. plantuml vis_js go_jsviva_graph
- 18. Thank you! ...and if you want the slides in PDF format, just call mr.GSbot: @gsbot gdocs pdf {document_id}