Using Targeted Search Filters in a Blueprint Maker Blueprint
Let users select from a pre-existing group of search filters to apply these to the output of a Page Blueprint.
For environments with both Targeted Search and Blueprint Maker, instead of defining your picklist options in the JSON, configure them to come from a Targeted Search Filter Group. In this way, users will be presented with a list whose options (or values) are populated from the Filters in that group. This is a great way to ensure consistent usage of your business vocabulary.
Create a Targeted Search Filter Group
Learn about creating Filter Groups. If you have already created a filter group, take note of its exact name. This will be used in the Blueprint JSON later to identify the Filter Group.
For example, here is a Targeted Search Filter Group called "Offices", with four Filters, like so:
| Filter Group | Filter Name | Label |
|---|---|---|
| Offices | Atlanta | office_atlanta |
| Offices | Chicago | office_chicago |
| Offices | Denver | office_denver |
| Offices | Seattle | office_seattle |
Create your Page Blueprint
Learn about creating a Page Blueprint. If you would like the user's picklist selection to show on the page, create a substitution field and place that on the page where you see fit. Please note that the text outputted on the page will be the label and not the filter name (i.e. human-readable name).
For example, let's use the substitution field [[office-location]].
Access your Blueprint JSON Definition
Read more about Accessing and Editing the JSON File.
Define a pick-list in your Blueprint JSON
Learn about Using a Picklist of Options in a Blueprint. Be sure to reference the substitution field (e.g. [[office-location]]) when crafting your blueprintField object.
Add the "filterGroup" attribute to blueprintField object
Add a new line to your Blueprint Field object definition as follows. Ensure that the "type" attribute has the value "list". Also be sure that the "filterGroup" value is the same name as the Filter Group from Step 1, and in quotations.
So, for example, in our [[office-location]] definition, we want to use "Offices" for the value of "filterGroup".
"blueprintFields" : [
{
"id" : "office-location",
"name" : "Office Location",
"required" : true,
"type" : "list",
"filterGroup" : "Offices",
"multiselect" : true,
"addLabels" : true,
"helpText" : "Select your office location from the list."
},
...
]
Optionally: add "multiselect" and "addLabels" attributes
To allow users to select more than one value, set the "multiselect" attribute in the JSON to true. Learn more about selecting and displaying multiple options in a Blueprint picklist.
And to apply the selections as labels on the page, set the "addLabels" attribute to true. Learn more about applying labels via Blueprint.
Re-Upload your JSON to the Blueprint Definition Page
That's it!
You may now create a page from this blueprint. Check to see that the pick-list options are correct. In our example, the options shown under "Office Location" should be "Atlanta", "Denver", "Chicago", and "Seattle". If the "addLabels" value was true, check to see that the corresponding label was applied to the resulting page.
