- 08 Sep 2023
- 3 Minutes to read
- Print
- DarkLight
17.2.10. Query Object App
- Updated on 08 Sep 2023
- 3 Minutes to read
- Print
- DarkLight
Summary
Used for: Looking into Salesforce to find data, usually based on a phone number
Container: Action
Call Policy: ✔
Data Analytics Policy: ✔
Configuration Details
The Query Object app searches a user's Salesforce for information and inserts the data into a result set that can be referred to later in the policy anywhere a macro can be used.
Policy Type
Call | Data Analytics |
---|---|
Available | Available |
Location
The Query Object app is found in the Action container:
Configuration
The options for this app consist of Name this item and Configure this Item:
Configure This Item
The first part of this configuration shows what the Result Set should be named, when its creation should be triggered, and a clickable button to test it once it has been configured.
Built In Property | Value (*default) | Notes |
---|---|---|
Result Set | Pre-filled text field** MyData* | Enter a name for the Result Set that will be recognisable for when it needs to be used later in the policy. |
Test Query | Clickable button | Click this button when the query has been configured to test that it works correctly. The query will run and populate a result set named as configured, and return a result set (as named above) based on the configured criteria. |
Trigger When | Records found*/Records not found/Error Returned | Select the appropriate check box(es) as to when to trigger this query to build a result set. |
The second part of the this configuration requires either the Builder or SOQL tab to be selected, and the query itself is created therein. The following pre-populated properties are those that are available when using the Builder. The SOQL tab enables the query to be written by hand in SQL.
In the SOQL tab, the macro selector icon appears in the text field. This can be clicked to insert a macro, either from the macro selector or from scratch.
Built In Property | Value (*default) | Notes |
---|---|---|
Record Type | Dropdown list: Account* | The name of the Salesforce table from which the user wishes to extract data |
Show Salesforce API Names | Checkbox (unchecked*) | Check this checkbox to show the Salesforce API names for the fields where it is applicable in the Record Type dropdown list, above. |
Filter Results | Click Add Field (AND) to add a field. Within an added field, it is also possible to add an (OR) field if desired. As many of these as is required can be added. | This filters the results depending on what is entered. The three fields are Field (a dropdown list populated in accordance with the selection made in Record Type), Operator (a dropdown list of operators that apply to the selection in Field) and Value (a blank text field, in which macros can be used). |
Return Fields | This field is populated with options depending on what is selected in the Record Type field. | On first creating the query, the left box (Available Fields) is fully populated and the right box (Selected Fields) is empty. Select the required field(s) from a box and click the left/right/up/down arrows to make sure the Selected Fields box is populated as required. These are the fields (in order) that will be returned. |
Order by | Dropdown list: Account ID* | This is field by which the result set is ordered. |
| Dropdown list: Ascending*/Descending | The direction in which the result set is displayed, for example, A-Z or Z-A. |
Maximum Results | 1* - 9999 | The maximum number of rows the user wishes to be returned in the result set. Maximum is 9999. |
Results
After a call has passed through this app, it either links to a new container linked from this app (if the app was triggered), or passes on the the next app within the container or the container itself (if the app was not triggered).
If the app is triggered but there is no link to a follow up container, the call is hung up as a default. |
---|
The information collected by this app can then used later in the policy wherever a macro can be used, for example, Connect a Call, Hunt Group or Get Extension.