Creating, Running, and Saving Viewpoint Queries
You create and run viewpoint queries from the query pane in a viewpoint. You can save a query as a private query, which can only be viewed and run by the user who created it. Users with Data Manager or Metadata Manager permission on the viewpoint can promote a private query to a public query, which can be viewed and run by all users who have access to the viewpoint in the query.
Creating and Running Viewpoint Queries
To create and run a query in a viewpoint:
- From an open viewpoint, click Actions
next to the viewpoint tab name and then select Query, or else click the Query Viewpoint
tab on the left side of the page.
- In the Query Viewpoint pane, select a viewpoint to query using the top drop down selector. You do not have to query the viewpoint that you are currently viewing. If you select a different viewpoint from the drop down menu, that view is displayed.
- Select the nodes to search:
- Hierarchy viewpoints:
- All Nodes: Search the entire viewpoint.
- Below Selected Node: Limit the query to
the nodes below the currently selected node.
When searching below a selected node, hover over the
icon to display the selected node.
- Orphan Nodes: Search for nodes that are in the node types used by the hierarchy set but that aren't a top node or a descendant of a top node in the node set.
- List viewpoints: All Nodes: Search the entire viewpoint.
- Hierarchy viewpoints:
- If the viewpoint uses multiple node types, select Any Node Type to search across all node types, or select a specific node type to query on in the drop down menu. The list of properties available for use by a query filter is limited to properties for the selected node types only.
- Click Add a Filter.
Note:
A filter is required when querying All Nodes or Below Selected Node, above. You do not need to add a filter if you have selected Orphan Nodes. - Select a property to add a filter for. The property must meet all of the conditions described in the Considerations section, above.
- Select an operator for the filter. The operators that you can choose from are
specific to the data type of the property that you selected. The following table
lists the operators that are available for each data type.
Note:
For values that you specify (for example, when entering a Contains value for a string), the text that you enter is not case-sensitive.Table 5-1 Operators by Property Data Type
Property Data Type Operators Boolean - Is True
- Is False
- Is Blank
- Is Not Blank
Date, Timestamp - Equals
- Before
- Between
- After
- Is Blank
- Is Not Blank
Integer, Float - Equals
- Between
- Greater Than
- Less Than
- Is Blank
- Is Not Blank
List - Contains
Note:
You can specify a single list value to check per filter. You can add a second filter to query for another list value. - Is Blank
- Is Not Blank
Node - Equals (use the node selector to pick a node)
- Is Blank
- Is Not Blank
String, Numeric String, Memo, Sequence - Contains
You can specify multiple words (separated by a space) in the query. The search matches on the beginning of each word.
For example, when searching for "Net Income Current Year":
- Query containing "Net Income" will match on "Net" and "Income"
- Query containing "Curr" will match on "Current"
- Query containing "rent" will not match on the beginning of any string
- Equals
- Is Blank
- Is Not Blank
- Similar To: Performs a fuzzy search on the text that
you enter.
Enter a value to search for and, optionally, a prefix length that specifies the number of characters at the beginning of the string that must exactly match. The prefix length can be used to reduce the query results to only those that have the same characters at the beginning of the string.
For example, for a similar to value of "House", if you do not specify a prefix length, the search can return "House", "Mouse", and "Blouse". If you specify a prefix length of 1, however, the first character of the similar to value must match. Therefore, the search will return only "House".
For best results, use Similar To on a complete string, rather than a partial string.
- Select a value for the filter. The value that you select is specific to the data
type of the property in the filter. For example, you select a date from a
calendar for the Date data type, and you enter a string value for a
list.
Note:
For properties that use an allowed values list, the specified value is evaluated against both the Value and the Label for the property. - Optional: Repeat steps 4-7 to add additional filters.
Note:
When you add multiple filters, use the And or Or toggle to specify how to join the filters. The join method (And or Or) applies to all query filters. You cannot use And for some filters and Or for others. - When you have finished adding query filters, click Run
to run the query.
The results are displayed in the query pane.
- Optional: In the query results, perform an action:
-
For queries other than Orphan Nodes: Click a node in the search results to navigate to that node in the viewpoint. Nodes that meet the query criteria are also indicated by a
icon in the viewpoint.
-
For Orphan Nodes query results: Click the Action icon
next to a node in the search results, and then select Insert Node to open the node selector and select the parent for the node. You can also drag and drop the node from the query results to a parent node in the viewpoint. You must be in the context of a request to insert the node.
Note:
If the orphan node has children, the number of children is indicated in the query results. If you insert the orphan node under a parent, the children of the orphan node will be inserted as well.
-
- Optional: To download the results to an Excel file, in the Query Panel,
click Actions
, and then select Download Query Results.
The viewpoint is downloaded and filtered to the nodes in the query results. The file contains a column for each property that is configured to display in the viewpoint.
Note:
The downloaded query results may exceed the number of results that are displayed on the screen.
After you run a viewpoint query, the query filters are collapsed so that more query
results can be displayed. Click Expand
to display the query filters again.
To rerun the query, click Refresh
.
Editing and Removing Query Filters
To edit a query filter, click on the filter in the query pane. You can change the
property, operator, and value for the filter, and then click
Run
to run the modified query.
Note:
If you change the selected node when searching with the Below Selected Node option, you are prompted to select whether you want to run the same query with the original selected node or a new query with the currently selected node.To remove a query filter, click the X on the filter and then
click Run
to run the modified query.
Saving Queries and Running Saved Queries
To save a query:
- In the Query Panel, click Actions
, and then select Save.
- Enter a name, and optionally a description, and then click
Save.
Note:
The Visibility field indicates that the query is saved as a private query. If you have Data Manager or Metadata Manager permission on the viewpoint you can promote it to a public query so that other users can view and run it.
To run a saved query:
- From the Query Panel, select the query that you want to run.
Tip:
If you already have a query open and you want to run a different saved query, click the Query Viewpointtab to return to the list of saved queries.
Private queries are indicated by a Locked
icon. Public queries are indicated by an Unlocked
icon.
- Optional: Edit the saved query filters.
- Click Run
to run the saved query.
- Optional: If you have changed the query filters and you want to save the
changed query, in the Query Panel, click Actions
, and then select Save.
Note:
You can save changes to your private queries. Only users with Data Manager or Metadata Manager permission on the viewpoint can save changes to public queries.