Custom queries create Excel downloads of DevResults data as you want it presented, and can be run on-demand. You'll work with one of our Data Scientists to confirm what you need, we'll write it for you, and then save it in your site for you to run whenever you need it. This page walks you through how to request a custom query and set up appropriate permissions for other users to access it.
Requesting a New Custom Query
To request a new custom query, follow these steps:
- Download this template.
- In the first row, enter the column headings as you'd like them to appear in the query.
- In the second row, tell us which page in the site this information should come from (e.g. All Activities, Activity Overview, Activity Geography, Indicator Definition, etc.)
- In the third row, tell us which field on that page the information should come from (e.g. Code, Reference #, Title, Tags, etc.)
- Email this template to firstname.lastname@example.org with subject line: Custom Query Request. Let us know which DevResults site you want the query for and what you want the query to be named.
- We will review your request and get back to you with any clarifying questions, build the query, and make it available in your site.
Please note: in general, it takes us at least 10 business days between your initial request and return of a finalized custom query.
Who Can View or Use the Custom Query?
We support two different levels of permissions for all custom queries:
- All groups with the View permissions on the Custom Queries role can see all reports (default)
- Individual reports can be assigned to a subset of the groups with the Custom Queries role (advanced)
Default Permissions: Custom Queries Group Role
Access to custom queries is granted at the group level. Any group that needs to access custom queries must have View access to the Custom Queries role in the group's permissions page:
Groups without this permission won't see the Custom Queries option in the Administration menu. By default, only the Owners group is given these permissions, but Owners may assign them to any other group. See this page for instructions on editing group permissions.
Advanced Permissions: Query Limited to Selected Groups
While most of the time this Custom Queries role is sufficient, you may have different reports that are relevant to different groups. For example, while generally Managers should be able to access custom queries, perhaps the query we've been working with should only be visible to Owners.
Site owners can edit permissions for individual reports using the Permissions button on the Custom Queries page:
This will open a pop-up to set permissions (by default, the default setting of All groups with the Custom Queries role is selected):
To limit this to only the Owners group, click on the circle next to Only selected groups and then check the box next to the groups we want. (Owners is always selected):
Click Done to close the window; the permissions will now be updated for the report.
How Do I Know Whether a Report Uses the Role or Selected Groups?
When you're viewing the Custom Queries page that shows all your queries, all Groups with access to view the query are listed in the "Groups" column. Here's how you can tell the difference as to whether the default or advanced permissions are enabled:
- Default permissions (all groups with the Custom Queries role): Groups column will show All with Custom Queries permissions and there will be a (?) icon in the right of the cell--hovering over this will show you all groups that have the Custom Queries permission:
- Advanced permissions (selected groups with the Custom Queries role): Groups column will only show specific group names and there will be no icon:
Didn't answer your question? Please email us. We're here to help!