293004fdc6
* Splits documentation over multiple folders * Editor guide documentation intro * Adds segment dashboard documentation * Adds editor documenation regarding segment creation * Adds logo with padding for the documentation * Updates usage guide documentation * Splits sandbox and custom rules documentation * Improves ‘Create a variant’ documentation * Adds documentation regarding streamfield and template tags * Consistent StreamField references * Feedback from M. Dingjan * Remove ‘coming soon’ section * Enable sandbox debug toolbar * Updated documentation
85 lines
2.9 KiB
ReStructuredText
85 lines
2.9 KiB
ReStructuredText
Creating a segment
|
|
==================
|
|
|
|
To create a segment, go to the "Segments dashboard" and click "Add segment".
|
|
You can find the segments dashboard in the administration menu on the left of
|
|
the page.
|
|
|
|
.. figure:: ../_static/images/segment_dashboard_header.png
|
|
:alt: The segment dashboard header containing the "Add segment" button.
|
|
|
|
On this page you will be presented with two forms. One with specific information
|
|
about your segment, the other allowing you to choose and configure your
|
|
rules.
|
|
|
|
|
|
Set segment specific options
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. figure:: ../_static/images/edit_segment_specifics.png
|
|
:alt: The form that allows you to configure specific segment options.
|
|
|
|
1. Enter a name for your segment
|
|
|
|
Choose something meaningful like "Newsletter campaign visitors". This will
|
|
ensure you'll have a general idea which visitors are in this segment in
|
|
other parts of the administration interface.
|
|
|
|
2. Select the status of the segment *Optional*
|
|
|
|
You will generally keep this one **enabled**. If for some reason you want
|
|
to disable the segment, you can change this to **disabled**.
|
|
|
|
3. Set the segment persistence. *Optional*
|
|
|
|
When persistence is **enabled**, your segment will stick to the visitor once
|
|
applied, even if the rules no longer match the next visit.
|
|
|
|
4. Select whether to match any or all defined rules. *Optional*
|
|
|
|
**Match any** will result in a segment that is applied as soon as one of
|
|
your rules matches the visitor. When **match all** is selected, all rules
|
|
must match before the segment is applied.
|
|
|
|
5. The segment type *Required*
|
|
|
|
**Dynamic**: Users in this segment will change as more or less meet the
|
|
rules specified in the segment.
|
|
|
|
**Static**: If the segment contains only static compatible rules the segment
|
|
will contain the members that pass those rules when the segment is created.
|
|
Mixed static segments or those containing entirely non static compatible
|
|
rules will be populated using the count variable.
|
|
|
|
6. The segment count *Optional*
|
|
|
|
If this number is set for a static segment users will be added to the set
|
|
until the number is reached. After this no more users will be added.
|
|
|
|
7. Randomisation percentage *Optional*
|
|
|
|
If this number is set each user matching the rules will have this percentage
|
|
chance of being placed in the segment.
|
|
|
|
Defining rules
|
|
^^^^^^^^^^^^^^
|
|
|
|
.. figure:: ../_static/images/edit_segment_rules.png
|
|
:alt: The form that allows you to set the rules for a segment.
|
|
|
|
5. Choose the rules you want to use.
|
|
|
|
Wagxperience comes with a basic set of :doc:`../default_rules` that allow
|
|
you to get started quickly. The rules you define will be evaluated once a
|
|
visitor makes a request to your application.
|
|
|
|
The rules that come with Wagxperience are as follows:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
../default_rules
|
|
|
|
Click "save" to store your segment. It will be enabled by default, unless
|
|
otherwise defined.
|