Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
J1QL Visual Query Builder - AskJ1 Community
<main> <article class="userContent"> <p>JupiterOne Visual Query Builder (VQB) provides a no-code, drag-and-drop, visual interface for building JupiterOne queries without needing to learn JupiterOne Query Language (J1QL) syntax.</p> <h3 data-id="permissions">Permissions</h3> <p>You must have at least the accessLanding and readGraph roles to use VQB.</p> <h3 data-id="prerequisites">Prerequisites</h3> <p>Your organization must have already used an integration to import your data in to JupiterOne.</p> <h3 data-id="creating-queries-using-vqb">Creating Queries Using VQB</h3> <p>To access VQB, from the Search for Anything landing page, click <img src="https://us.v-cdn.net/6035534/uploads/65KFY70XVNEU/vqb-button.png" alt="" class="embedImage-img importedEmbed-img"></img>.</p> <p><img src="https://us.v-cdn.net/6035534/uploads/TSN8CUT3BPP3/vqb-access.png" alt="" class="embedImage-img importedEmbed-img"></img></p> <p>The VQB workspace consists of a:</p> <ul><li><p>Left pane containing:</p> <ul><li>Default asset classes</li> <li>J1QL-specific, data model asset types</li> <li>Other entities, including text search and * wildcard <br><strong>Note:</strong> You cannot use a text search asset and a wildcard asset in the same query.</li> </ul></li> <li><p>Center canvas pane</p></li> <li>Right information pane that contains contextual details based on what is on the center canvas, including a query preview window</li> </ul><ol><li><p>Drag an asset from the left pane to the center canvas to start.</p> <p><img src="https://us.v-cdn.net/6035534/uploads/E76VGYW7IHAD/vqb-drag-asset.png" alt="Drag assets from left to right" class="embedImage-img importedEmbed-img"></img></p> <p></p> <p>As you place items in the center canvas, a query starts to build in the Query Preview window of the right pane.</p> <p>If you want your query to do a full-text search of your entire graph on a custom text string, click <strong>Other</strong> in the left pane and drag over the Text asset. You are prompted to enter your custom text. You can only do this step at the very beginning of your query build because the custom text string must be the root asset.<br> </p></li> <li><p>Drag over all the Class and Type assets between which you want to build relationships.</p></li> </ol><ul><li>If you want to group assets, drag assets on top of each other to form a group.</li> <li>Each asset or asset group has a J1 alias identifier in the top-left corner.</li> <li>Click the asset group to see its details in the right information pane.</li> <li>The first asset you drag over or asset group you create becomes the root asset or asset group, unless it is a text asset from the Other menu.</li> </ul><ol start="3"><li><p>Click and drag from one asset or asset group box to another asset or asset group box to create a relationship.</p> <ol><li>Each relationship has an identifier.</li> <li>Click the relationship identifier to see its details in the right information pane.</li> <li>Relationship classes default to all available verbs. J1QL shows all the verbs that you can apply to that relationship. You can toggle between relationship classes to determine how you want the query to search.<br> <br><strong>Note</strong>: The verb RELATES TO covers any and all relationship verbs. However, It is highly recommended to use specific relationship verbs for faster query performance.</li> </ol></li> </ol><p><img src="https://us.v-cdn.net/6035534/uploads/IUVU9GE8XUGB/vqb-relationship.png" alt="" class="embedImage-img importedEmbed-img"></img></p> <ol start="4"><li>Continue to drag over assets and create groups and the relationships between them.</li> </ol><h4 data-id="using-wildcards">Using Wildcards</h4> <p>There is a wildcard asset that you can use to represent a relationship with anything. Click *<strong>(any entity)</strong> and drag it to the canvas. Then, in the right pane deselect the relationships that you do not want in your query. If you use the wildcard asset, it overrides all child assets in an asset group of which the wildcard asset is a member.</p> <p>For example, in the following example, the text asset Security is the root asset. The query does a full text search on all alerts and all JupiterOne alerts assets with the word security in any of the properties. The wildcard asset lists all possible relationships, from which you can toggle on or off the options listed in the right pane according to the information you are seeking.</p> <p><img src="https://us.v-cdn.net/6035534/uploads/UNE59ZNDFZ3A/vqb-wildcard.png" alt="" class="embedImage-img importedEmbed-img"></img></p> <p><strong>Note:</strong> When connecting relationships between assets or asset groups, you must start with the root asset (<img src="https://us.v-cdn.net/6035534/uploads/818DAK9OX7F0/root.png" alt="root" class="embedImage-img importedEmbed-img"></img>) and drag it to the related asset (such as e4), and then connect the other assets as required.</p> <h3 data-id="filtering">Filtering</h3> <p>You can create filters that are based on all the properties you have for the selected asset on the canvas. You can also apply AND OR conditions to the filters.</p> <p><img src="https://us.v-cdn.net/6035534/uploads/QSWOYELGQ25H/vbq-filters.png" alt="" class="embedImage-img importedEmbed-img"></img></p> </article> </main>
.png)