Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
namePage Info
id278129461
classwatermark-layer
Content Column
namePage Body
width100.00001%
id278129463
Content Block
background-colortransparent
namePrompt
id494677873
classtight manual-prompt-flex

TODOLet users select from a pre-existing group of search filters to apply these to the output of a Page Blueprint.

Content Block
nameOutcome
rich-link-hoverstrue
id1042866408
classtight manual-outcome-flex

Replace me with a more complete explanation of what this how-to accomplishesFor 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.

Content Block
nameSteps
rich-link-hoverstrue
id494842117
classsteps-block numbered manual-steps-flex

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 GroupFilter NameLabel
OfficesAtlantaoffice_atlanta
OfficesChicagooffice_chicago
OfficesDenveroffice_denver
OfficesSeattleoffice_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. Doing so requires some additional syntax added to the substitution field. Please see Displaying Filter Selections from a Blueprint Picklist.

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".

Code Block
languagejs
"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

Use h4 for section headings

If you don't want numbers in the section headings, simply remove the "numbered" class from this block.

Note/Tip/Warning/Info blocks below are collapsed by default. If you want to use any of these, try to keep to just one per page. You may use two if necessary, but in general, try to limit these.


Content Block
nameNote
rich-link-hoverstrue
id495965127
classmanual-note-flex
collapsiblecollapse
Note

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the Steps block above to narrow the gap between the two blocks.
Content Block
nameTip
rich-link-hoverstrue
id894522670
classmanual-tip-flex
collapsiblecollapse
Tip

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Block
nameWarning
rich-link-hoverstrue
id894530759
classmanual-warning-flex
collapsiblecollapse
Warning

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Block
nameInfo
rich-link-hoverstrue
id894537203
classmanual-info-flex
collapsiblecollapse
Info

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Layer
background-color$lightGrayColor
nameRelated
id888168050
Content Column
nameRelated
width100%
id888168051
Content Block
rich-links-hide-descriptiontrue
rich-link-hoverstrue
rich-links-columns4
rich-links-verticaltrue
rich-links-image-height100px
rich-links-hide-site-icontrue
rich-links-details-padding10px
nameRelated
rich-links-enabletrue
border-width0
rich-links-details-alignmentleft
rich-links-margin20px 30px 0 0
id496234544
classrelated-block clean manual-related-flex