Formatting code for SendMessageCriteriaInfo
==[[PhplistDocumentation Phplist Documentation]] » [[MessageFunctionsInfo Message functions]] » [[SendMessageInfo Send a message]] » ==
----
=====Send a Message: Criteria tab=====
Other tabs:
[[SendMessageInfo Content tab]]
[[SendMessageFormatInfo Format tab]]
[[SendMessageAttachInfo Attach tab]]
[[SendMessageSchedulingInfo Scheduling tab]]
Criteria tab
[[SendMessageListsInfo Lists tab]]
[[SendMessageMiscInfo Misc tab]]
===Description===
Depending on your [[PhplistInstallation system configuration]], you can use a basic or advanced criteria selection process. In both cases, the **choice of criteria is important if you wish to reach the proper audience** for your message: choose the criteria and the rules between the different criteria wisely by taking the time to understand the logic outlined below.
The **attributes** which are available depend on the attributes which exist in your system. The **values** for each attribute also depend on the values you have chosen for each attribute.
**Important**: Only 'select', 'radio', 'checkbox', 'checkboxgroup' and 'date' attributes can be used. Also 'date' can only be used in the advance criteria mode. You cannot use 'textline' or 'textarea' attributes as a criterion. For more, see [[ConfigureAttributesInfo Configure Attributes]].
**Note**: The number of criteria available for selection is defined by the ''NUMCRITERIAS'' setting in your ##config.php## file.
===Basic criteria selection===
**Procedure:**
%%Select the criteria for this message:
to use a criteria, check the box next to it
then check the radio button next to the attribute you want to use
then choose the values of the attributes you want to send the message to
Note: Messages will be sent to people who fit to Criteria 1 AND Criteria 2 etc%%
Note that the **only** operator between several criteria is **AND**.
Also, please note that you can select **several values for each attribute**, in which case the operator will be **OR**, but you cannot choose the same attribute twice as a criterion (you cannot choose 'Criterion one: Country' AND 'Criterion two: Country').
//Example://
Imagine your system contains four attributes (the type of attribute is in parentheses):
-Name (textline)
-Country (select)
-Sex (radio)
-Allergies (checkboxgroup)
You can choose the following combination:
-Criterion one: Country
-Value: Papua New Guinea
-Value: Australia
-Criterion two: Sex
-Value: Female
-Criterion three: Allergies
-Value: pollen
-Value: cat hair
This will send a message ONLY to {Females} {who live either in Papua New Guinea OR in Australia}, AND {who are allergic to pollen OR cat hair}.
===Advanced criteria selection===
To enable Advanced criteria selection you need to change the constant STACKED_ATTRIBUTE_SELECTION in the [[PhpListConfiguration phplist Configuration File]] from 0 (the default setting) to 1.
%%(php)
# stacked attribute selection
# this is a new method of making a selection of attributes to send your messages to
# to start with, it doesn't seem to work very well in Internet Explorer, but it works fine
# using Mozilla, Firefox, Opera (haven't tried any other browsers)
# so if you use IE, you may not want to try this.
# stacked attribute selection allows you to continuously add a selection of attributes
# to your message. This is quite a bit more powerful than the old method, but it can also
# cause very complex queries to be constructed that may take too long to calculate
# If you want to try this, set the value to 1, and give us feedback on how it's going
# if you want to use dates for attribute selections, you need to use this one
define("STACKED_ATTRIBUTE_SELECTION",1);%%
===Procedure===
%%Match all of these rules [radiobutton] Match any of these rules [radiobutton]
['select attribute' pulldown menu] ['rule' pulldown menu]%%
~1) Select an **attribute** in the pulldown menu
~1) select the **value(s)** for this attribute. Please note that you can select several values for each attribute, in which case the operator between the different values will be **or**.
~1) select a **rule** you will apply to this attribute The rules which are available are:
is : the equivalent of AND
is not : the equivalent of NOT
is before : useful when you use a 'date' type attribute
is after : useful when you use a 'date' type attribute
#%Add criterion#% **button**
~Self-explanatory.
At any time, you can **remove** one of the criteria by clicking on the ##Remove## link. This link appears only after you have selected at least one criterion.
At any time, you can **calculate** the number of users which match the criteria which you have selected by clicking on the ##CALCULATE## link. This link appears only after you have selected at least one criterion.
//Example://
Imagine your system contains four attributes (the type of attribute is in parentheses):
-Name (textline)
-Country (select)
-Sex (radio)
-Allergies (checkboxgroup)
You can send a message with the following combination:
-Match ALL of these rules
- Attribute: 'Country' IS NOT Value: 'Australia'
- Attribute: 'sex' IS Value: 'Female'
- Attribute: 'Allergies' IS Value: 'pollen', 'cat hair'
This combination will send a message ONLY to {Females} {who live anywhere EXCEPT Australia}, AND {who are allergic to pollen OR cat hair}.
===Test message===
#%Send test message#% button ##to email address(es): [empty field]
(comma separate addresses - all must be users)##
~This feature allows you to send a test message to the email addresses typed in the empty field (use commas to separate addresses). All email addresses must correspond to a [[UserInfo user]] in your system. See [[SendMessageInfo Content tab]] for more.
**NOTE**: criteria are **not** taken into account when you send a test message.
#%Save changes#% button
~**DO NOT FORGET TO SAVE CHANGES** by clicking on this button before proceeding to the other tab(s).
**Related pages:**
~[[ConfigureAttributesInfo Configure Attributes]]
----
CategoryDocumentation
----
=====Send a Message: Criteria tab=====
Other tabs:
[[SendMessageInfo Content tab]]
[[SendMessageFormatInfo Format tab]]
[[SendMessageAttachInfo Attach tab]]
[[SendMessageSchedulingInfo Scheduling tab]]
Criteria tab
[[SendMessageListsInfo Lists tab]]
[[SendMessageMiscInfo Misc tab]]
===Description===
Depending on your [[PhplistInstallation system configuration]], you can use a basic or advanced criteria selection process. In both cases, the **choice of criteria is important if you wish to reach the proper audience** for your message: choose the criteria and the rules between the different criteria wisely by taking the time to understand the logic outlined below.
The **attributes** which are available depend on the attributes which exist in your system. The **values** for each attribute also depend on the values you have chosen for each attribute.
**Important**: Only 'select', 'radio', 'checkbox', 'checkboxgroup' and 'date' attributes can be used. Also 'date' can only be used in the advance criteria mode. You cannot use 'textline' or 'textarea' attributes as a criterion. For more, see [[ConfigureAttributesInfo Configure Attributes]].
**Note**: The number of criteria available for selection is defined by the ''NUMCRITERIAS'' setting in your ##config.php## file.
===Basic criteria selection===
**Procedure:**
%%Select the criteria for this message:
to use a criteria, check the box next to it
then check the radio button next to the attribute you want to use
then choose the values of the attributes you want to send the message to
Note: Messages will be sent to people who fit to Criteria 1 AND Criteria 2 etc%%
Note that the **only** operator between several criteria is **AND**.
Also, please note that you can select **several values for each attribute**, in which case the operator will be **OR**, but you cannot choose the same attribute twice as a criterion (you cannot choose 'Criterion one: Country' AND 'Criterion two: Country').
//Example://
Imagine your system contains four attributes (the type of attribute is in parentheses):
-Name (textline)
-Country (select)
-Sex (radio)
-Allergies (checkboxgroup)
You can choose the following combination:
-Criterion one: Country
-Value: Papua New Guinea
-Value: Australia
-Criterion two: Sex
-Value: Female
-Criterion three: Allergies
-Value: pollen
-Value: cat hair
This will send a message ONLY to {Females} {who live either in Papua New Guinea OR in Australia}, AND {who are allergic to pollen OR cat hair}.
===Advanced criteria selection===
To enable Advanced criteria selection you need to change the constant STACKED_ATTRIBUTE_SELECTION in the [[PhpListConfiguration phplist Configuration File]] from 0 (the default setting) to 1.
%%(php)
# stacked attribute selection
# this is a new method of making a selection of attributes to send your messages to
# to start with, it doesn't seem to work very well in Internet Explorer, but it works fine
# using Mozilla, Firefox, Opera (haven't tried any other browsers)
# so if you use IE, you may not want to try this.
# stacked attribute selection allows you to continuously add a selection of attributes
# to your message. This is quite a bit more powerful than the old method, but it can also
# cause very complex queries to be constructed that may take too long to calculate
# If you want to try this, set the value to 1, and give us feedback on how it's going
# if you want to use dates for attribute selections, you need to use this one
define("STACKED_ATTRIBUTE_SELECTION",1);%%
===Procedure===
%%Match all of these rules [radiobutton] Match any of these rules [radiobutton]
['select attribute' pulldown menu] ['rule' pulldown menu]%%
~1) Select an **attribute** in the pulldown menu
~1) select the **value(s)** for this attribute. Please note that you can select several values for each attribute, in which case the operator between the different values will be **or**.
~1) select a **rule** you will apply to this attribute The rules which are available are:
is : the equivalent of AND
is not : the equivalent of NOT
is before : useful when you use a 'date' type attribute
is after : useful when you use a 'date' type attribute
#%Add criterion#% **button**
~Self-explanatory.
At any time, you can **remove** one of the criteria by clicking on the ##Remove## link. This link appears only after you have selected at least one criterion.
At any time, you can **calculate** the number of users which match the criteria which you have selected by clicking on the ##CALCULATE## link. This link appears only after you have selected at least one criterion.
//Example://
Imagine your system contains four attributes (the type of attribute is in parentheses):
-Name (textline)
-Country (select)
-Sex (radio)
-Allergies (checkboxgroup)
You can send a message with the following combination:
-Match ALL of these rules
- Attribute: 'Country' IS NOT Value: 'Australia'
- Attribute: 'sex' IS Value: 'Female'
- Attribute: 'Allergies' IS Value: 'pollen', 'cat hair'
This combination will send a message ONLY to {Females} {who live anywhere EXCEPT Australia}, AND {who are allergic to pollen OR cat hair}.
===Test message===
#%Send test message#% button ##to email address(es): [empty field]
(comma separate addresses - all must be users)##
~This feature allows you to send a test message to the email addresses typed in the empty field (use commas to separate addresses). All email addresses must correspond to a [[UserInfo user]] in your system. See [[SendMessageInfo Content tab]] for more.
**NOTE**: criteria are **not** taken into account when you send a test message.
#%Save changes#% button
~**DO NOT FORGET TO SAVE CHANGES** by clicking on this button before proceeding to the other tab(s).
**Related pages:**
~[[ConfigureAttributesInfo Configure Attributes]]
----
CategoryDocumentation
