Difference between revisions of "ATC/Current/AdminGuide/Apply"

From Genesys Documentation
Jump to: navigation, search
(Published)
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(21 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=Apply an action map to specific webpages
 
|DisplayName=Apply an action map to specific webpages
−
|TocName=Apply to pages
+
|TocName=Specify webpages to trigger on
 
|Context=Learn how to specify the webpages where an action map triggers.
 
|Context=Learn how to specify the webpages where an action map triggers.
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=PureEngage, PureConnect, PureCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Prereq='''Prerequisites'''
 
|Prereq='''Prerequisites'''
  
−
*[https://help.mypurecloud.com/articles/altocloud-permissions-overview Configure the following permissions in PureCloud:]
+
*[https://help.mypurecloud.com/articles/?p=195191 Configure the following permissions in Genesys Cloud CX:]
−
**'''Journey '''>''' Action Map '''>''' Add''', '''Delete''', '''Edit''', and '''View''' permissions (to create action maps)
+
**'''Journey '''>''' Action Map '''>''' Add''', '''Delete''', '''Edit''', and '''View''' (to create action maps)
−
**'''Journey '''>''' Action Target '''> '''View''' permission (to select a team to handle interactions from the action map)
+
**'''Journey '''>''' Action Target '''> '''View''' (to select a team to handle interactions from the action map)
−
*{{#mintydocs_link:topic=Segments|anchor=CreateSegment|link text=Create segments}}.
+
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Manage_segments|display text=Create segments}}.
−
*{{#mintydocs_link:topic=Outcomes|anchor=CreateOutcome|link text=Create outcomes}}.
+
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Manage_outcomes|display text=Create outcomes}}.
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Apply an action map to webpages
 
|sectionHeading=Apply an action map to webpages
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
−
|image=PageChecker1.png
+
|image=ApplyToWebpages.png
−
|structuredtext=When you {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps|anchor=Create|display text=create an action map}} that uses a {{GlossaryTooltip|term=web action}}, build an expression that determines on which webpages the action map should or should not trigger:
+
|structuredtext=When you {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps|display text=create an action map}} that uses a web action, you can define an expression that determines on which webpages the action map should or should not trigger. The expression includes one or more {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=URLConditionsOperators|display text=operators}}, a corresponding operand, and one or more {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=Conditions|display text=conditions}}. After you define the expression, {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=CheckTargeting|display text=verify that the expression is valid}}.
−
 
 
−
#Under '''Apply to selected pages''', click '''Add page'''.
 
−
#In the '''Show this action map if the page URL''' list, select the appropriate {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=URLConditionsOperators|display text=operator}}.
 
−
#In the '''some path or keyword''' box, type the appropriate value (as needed by the operator you selected).
 
−
#Do one of the following:
 
−
#*To add an OR condition, next to the '''some path or keyword''' box, click the '''+'''. For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps#ORConditions|display text=OR conditions}}.
 
−
#*To add an AND condition, under the boxes, click '''Add'''. For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps#ANDConditions|display text=AND conditions}}.<br />
 
−
#{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=CheckTargeting|display text=Verify that the expression is valid}}.
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=Operators for URL conditions
+
|sectionHeading=About conditions
−
|anchor=URLConditionsOperators
+
|anchor=Conditions
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{{!}} class="wikitable"
+
|structuredtext=You can add as many conditions as you need. For OR conditions, the action map triggers when either condition is true. For AND conditions, the action map triggers when both conditions are true.  
−
{{!}}-
 
−
{{!}}{{!}}'''Operator'''
 
−
{{!}}{{!}}'''Matches'''
 
−
{{!}}{{!}}'''Description'''
 
−
{{!}}{{!}}'''Notes'''
 
−
{{!}}-
 
−
{{!}}{{!}}equals
 
−
{{!}}{{!}}a full URL only
 
−
{{!}}{{!}}The action map triggers only when the visitor is on a website page with a URL that exactly matches all of the characters you define.
 
  
−
 
+
As you define conditions, {{MINTYDOCSPRODUCT}} checks for syntax errors, including a valid protocol, spaces and extra special characters. If there are syntax errors, {{MINTYDOCSPRODUCT}} displays an error message. For more information, see the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=URLConditionsOperators|display text=notes for the operator that you are using}}.{{NoteFormat|If the action map isn't working as expected, check your URL conditions.|}}{{NoteFormat|To remove a condition, rest your mouse on it and then click the '''x''' that appears.|2}}
−
'''Note:''' You must specify the protocol, either http: or https:.
+
<br />
−
 
+
|Status=No
−
{{!}}{{!}}If you define an '''equals''' condition you cannot define any other AND conditions.
+
}}{{Section
−
'''Correct''':
+
|sectionHeading=Verify that the expression is valid
−
 
+
|anchor=CheckTargeting
−
*equals <nowiki>http://abc.com OR http://def.com OR http://xyz.com </nowiki>
+
|alignment=Horizontal
−
 
+
|Media=Image
−
'''Incorrect''':
+
|image=Verify_conditions.png
−
 
+
|structuredtext=After you define an expression, ensure that the expression is valid for all the webpages that you specified. Expressions are not case-sensitive. {{NoteFormat|If you see, "No" when you check a webpage, it means that the URL doesn't match the specified conditions. Check your expression:
−
*equals abc.com OR def.com
+
* If you are using the '''equals''', or '''not equals''' operators, ensure that you specified a full URL.
−
*equals abc.com AND equals xyz.com
+
* If you are using the '''equals''', '''not equals''', or '''starts with''' operators, ensure that you specified the protocol.
−
{{!}}-
+
|}}<br />
−
{{!}}{{!}}not equals
 
−
{{!}}{{!}}a full URL only
 
−
{{!}}{{!}}The action map triggers only when the visitor is on a website page with a URL that exactly matches all of the characters you define.
 
−
 
 
−
 
 
−
'''Note:''' You must specify the protocol, either http: or https:.
 
−
 
 
−
{{!}}{{!}}If you define a '''not equals''' condition you cannot define any other AND conditions.
 
−
 
 
−
<br />'''Correct''':
 
−
 
 
−
*not equals <nowiki> http://abc.com OR http://def.com OR http://xyz.com<br /></nowiki>
 
−
 
 
−
'''Incorrect:'''
 
−
 
 
−
*equals abc.com OR def.com<br />
 
−
*equals abc.com AND equals xyz.com
 
−
{{!}}-
 
−
{{!}}{{!}}like
 
−
{{!}}{{!}}a "substring match"
 
−
{{!}}{{!}}The action map triggers only when the visitor is on a website page with a URL that contains some of the characters you define.
 
−
 
 
−
 
 
−
 
 
−
 
 
−
This is useful when you want to target a unique query string parameter (a keyword) that appears in multiple URLs.
 
−
{{!}}{{!}}You can build conditions containing multiple '''like''' and '''not like''' operators.
 
−
 
 
−
'''Correct''':
 
−
 
 
−
*like insurance AND like auto OR home OR health
 
−
{{!}}-
 
−
{{!}}{{!}}not like
 
−
{{!}}{{!}}a "substring match"
 
−
{{!}}{{!}}The action map triggers only when the visitor is on a website page with a URL that does not contains any of the characters you define.<br />
 
−
{{!}}{{!}}
 
−
 
 
−
{{!}}-
 
−
{{!}}{{!}}starts with
 
−
{{!}}{{!}}identical characters starting from the beginning of the string up to and including the last character in the string
 
−
{{!}}{{!}}Use the '''starts with''' operator when your URLs are generally unvarying but can include query string parameters at the end that you want to exclude.
 
−
 
 
−
 
 
−
'''Note:''' You must specify the protocol, either http: or https:.
 
−
 
 
−
{{!}}{{!}}You can have one '''starts with '''or one '''ends with''' operator per condition.
 
−
 
 
−
 
 
−
'''Correct''':
 
−
 
 
−
*starts with http://abc.com OR http://xyz.com AND Like keyword1 or keyword2
 
−
 
 
−
'''Incorrect''':
 
−
 
 
−
*starts with abc.com OR xyz.com AND starts with abc.com OR xyz.com
 
−
 
 
−
{{!}}-
 
−
{{!}}{{!}}ends with
 
−
 
 
−
{{!}}{{!}}identical characters starting from the end of the string up to and including the first character in the string
 
−
{{!}}{{!}}Use the '''ends with''' operator when you want to match a specific query string parameters at the end of the URL.
 
−
 
 
−
 
 
−
 
 
−
 
 
−
For example, you can match shopping cart pages that use /thankyou.html at the end of their URLs.
 
−
 
 
−
{{!}}{{!}}You can have one '''ends with''' operator per condition.
 
−
{{!}}}
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=GPE-5839 Updates Operators for URL conditions
+
|sectionHeading=Operators for URL conditions
 +
|anchor=URLConditionsOperators
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=<br />
+
|structuredtext=<br />{{NoteFormat|&nbsp;
 +
* Separate a list of values with commas
 +
* Available operators depend on the object type that you are configuring. |2}}
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}'''Operator'''
 
{{!}}{{!}}'''Operator'''
−
{{!}}{{!}}'''Matches'''
+
{{!}}{{!}}'''Action map triggers when the page URL...'''
−
{{!}}{{!}}'''The action map triggers when the visitor is on a webpage with a URL that contains...'''
+
{{!}}{{!}}'''Comments'''
−
{{!}}{{!}}'''Notes'''
 
 
{{!}}-
 
{{!}}-
 
{{!}}contains all
 
{{!}}contains all
 +
{{!}}contains all the characters that you specify
 
{{!}}
 
{{!}}
−
{{!}}all of the characters you define
 
−
{{!}}You must specify the protocol, either http: or https:.
 
 
{{!}}-
 
{{!}}-
 
{{!}}contains any
 
{{!}}contains any
−
{{!}}
+
{{!}}contains one or more characters that you specify
−
{{!}}any of the characters you define
 
 
{{!}}
 
{{!}}
 
{{!}}-
 
{{!}}-
 
{{!}}does not contain all
 
{{!}}does not contain all
−
{{!}}
+
{{!}}does not contain all the characters that you specify
−
{{!}}some, but not all, of the characters you define<br />
 
 
{{!}}
 
{{!}}
 
{{!}}-
 
{{!}}-
 
{{!}}does not contain any
 
{{!}}does not contain any
−
{{!}}
+
{{!}}does not contain any of the characters that you specify
−
{{!}}none of the characters you define
 
 
{{!}}
 
{{!}}
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}equals
 
{{!}}{{!}}equals
−
{{!}}{{!}}the exact URL you define
+
{{!}}{{!}}matches the full URL that you specify exactly, including case
−
{{!}}{{!}}an exact match to the characters you define<br />
+
{{!}}{{!}}Specify the full URL, including the protocol; either "http:" or "https:".
−
{{!}}{{!}}You must specify the protocol, either http: or https:.
+
 
−
If you define an '''equals''' condition you cannot define any other AND conditions.
+
If you define an '''equals''' condition, you cannot define an AND condition.
 +
 
 
'''Correct''':
 
'''Correct''':
  
−
*equals <nowiki>http://abc.com OR http://def.com OR http://xyz.com </nowiki>
+
*equals <nowiki>http://abc.com</nowiki> OR <nowiki>http://def.com</nowiki> OR <nowiki>https://xyz.com</nowiki>
  
 
'''Incorrect''':
 
'''Incorrect''':
Line 172: Line 85:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}not equals
 
{{!}}{{!}}not equals
−
{{!}}{{!}}a full URL only
+
{{!}}{{!}}does not match the full URL exactly as you specify, including case
−
{{!}}{{!}}The action map triggers only when the visitor is on a website page with a URL that exactly matches all of the characters you define.
+
{{!}}{{!}}Specify the full URL, including the protocol; either "http:" or "https:".
−
{{!}}{{!}}You must specify the protocol, either http: or https:.
+
If you define a '''not equals''' condition, you cannot define an AND condition.
−
If you define a '''not equals''' condition you cannot define any other AND conditions.
+
 
 
'''Correct''':
 
'''Correct''':
  
−
*not equals <nowiki> http://abc.com OR http://def.com OR http://xyz.com<br /></nowiki>
+
*not equals <nowiki>http://abc.com</nowiki> OR <nowiki>http://def.com</nowiki> OR <nowiki>https://xyz.com</nowiki><nowiki><br /></nowiki>
  
 
'''Incorrect:'''
 
'''Incorrect:'''
  
−
*equals abc.com OR def.com<br />
+
*equals abc.com OR def.com
 
*equals abc.com AND equals xyz.com
 
*equals abc.com AND equals xyz.com
 
{{!}}-
 
{{!}}-
−
{{!}}greater than
+
{{!}}{{!}}like
−
{{!}}
+
{{!}}{{!}}matches some of the characters that you specify
−
{{!}}
+
{{!}}{{!}}This operator is useful when you want to target a unique query string parameter (a keyword) that appears in multiple URLs.
−
{{!}}
+
You can define conditions containing multiple '''like''' and '''not like''' operators.
 +
 
 +
'''Correct''':
 +
 
 +
*like insurance AND like auto OR home OR health
 
{{!}}-
 
{{!}}-
−
{{!}}greater than or equal
+
{{!}}{{!}}not like
−
{{!}}
+
{{!}}{{!}}does not match any of the characters that you specify
−
{{!}}
+
{{!}}{{!}}
−
{{!}}
+
 
−
{{!}}-
 
−
{{!}}less than
 
−
{{!}}
 
−
{{!}}
 
−
{{!}}
 
−
{{!}}-
 
−
{{!}}less than or equal
 
−
{{!}}
 
−
{{!}}
 
−
{{!}}
 
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}starts with
 
{{!}}{{!}}starts with
−
{{!}}{{!}}identical characters starting from the beginning of the string up to and including the last character in the string
+
{{!}}{{!}}matches the characters that you specify, starting from the beginning of the string, up to and including the last character in the string
−
{{!}}{{!}}Use the '''starts with''' operator when your URLs are generally unvarying but can include query string parameters at the end that you want to exclude.
+
{{!}}{{!}}Use this operator when your URLs are generally unvarying but can include query string parameters at the end that you want to exclude.
 +
Specify the protocol; either "http:" or "https:". You can have one '''starts with '''or one '''ends with''' operator per condition.
  
−
{{!}}{{!}}You must specify the protocol, either http: or https:.
+
'''Correct''':  
−
You can have one '''starts with '''or one '''ends with''' operator per condition.
 
−
'''Correct''':
 
  
 
*starts with http://abc.com OR http://xyz.com AND Like keyword1 or keyword2
 
*starts with http://abc.com OR http://xyz.com AND Like keyword1 or keyword2
  
−
'''Incorrect''':
+
'''Incorrect''':  
  
 
*starts with abc.com OR xyz.com AND starts with abc.com OR xyz.com
 
*starts with abc.com OR xyz.com AND starts with abc.com OR xyz.com
 +
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}ends with
 
{{!}}{{!}}ends with
−
{{!}}{{!}}identical characters starting from the end of the string up to and including the first character in the string
 
−
{{!}}{{!}}Use the '''ends with''' operator when you want to match a specific query string parameters at the end of the URL.
 
−
For example, you can match shopping cart pages that use /thankyou.html at the end of their URLs.
 
−
{{!}}{{!}}You can have one '''ends with''' operator per condition.
 
−
{{!}}}
 
−
|Status=Yes
 
−
}}{{Section
 
−
|sectionHeading=Condition errors
 
−
|anchor=ConditionErrors
 
−
|alignment=Horizontal
 
−
|Media=Image
 
−
|image=ErrorCond.png
 
−
|structuredtext=As you build your condition, {{MINTYDOCSPRODUCT}} automatically checks for syntax errors, including a valid protocol, spaces and extra special characters. If there are syntax errors, {{MINTYDOCSPRODUCT}} displays an error message. For more information see the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Apply|anchor=URLConditionsOperators|display text=notes for the operator you are using}}.
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=OR conditions
 
−
|anchor=ORConditions
 
−
|alignment=Horizontal
 
−
|Media=Image
 
−
|image=URLORCondition.png
 
−
|structuredtext=You can add as many OR conditions as you need for each operator. For information on the available operators, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps#URLConditionsOperators|display text=Operators for URL conditions.}}
 
  
−
{{NoteFormat|If you use an "OR" condition, the action map triggers if either of the conditions is true.}}
+
{{!}}{{!}}matches the characters that you specify, starting from the end of the string, up to and including the first character in the string
−
|Status=No
+
{{!}}{{!}}Use this operator when you want to match a specific query string parameter at the end of the URL.
−
}}{{Section
+
For example, you can match shopping cart pages with URLs that end with "/thankyou.html".
−
|sectionHeading=AND conditions
 
−
|anchor=ANDConditions
 
−
|alignment=Horizontal
 
−
|Media=Image
 
−
|image=URLAND.png
 
−
|structuredtext=You can add as many AND conditions as you need for each operator.  For information on the available operators, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_maps#URLConditionsOperators|display text=Operators for URL conditions.}} {{NoteFormat|If you use an "AND" condition, the action map triggers only if both conditions is true.}}
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=Remove a condition
 
−
|anchor=ConditionRemove
 
−
|alignment=Horizontal
 
−
|Media=Image
 
−
|image=CondRemove.png
 
−
|structuredtext=To remove a condition, hover over it and click the '''x''' that appears.
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=Verify that the expression is valid
 
−
|anchor=CheckTargeting
 
−
|alignment=Horizontal
 
−
|Media=Image
 
−
|image=PageCheckerAI155.png
 
−
|structuredtext=After you define the expression to apply an action map to a webpage, check to be sure that the expression is valid.
 
  
−
#Under '''Check if the action map targets the web page(s'''), type the first URL to check in the box.
+
You can have one '''ends with''' operator per condition.
−
#To check another URL, click '''+''' and type the next URL.
+
{{!}}}
−
#When you have specified all of the pages to check, click '''Check'''.
 
−
#Review the results.<p>
 
−
{{NoteFormat|If you see, "No" when you check a webpage, it means that the URL doesn't match the specified conditions. Check your expression:
 
−
* If you are using the '''equals''', or '''not equals''' operators, be sure you have specified a full URL.
 
−
* If you are using the '''equals''', '''not equals''', or '''starts with''' operators, be sure you have specified the protocol.
 
−
}}<br />
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 21:28, November 9, 2021

This topic is part of the manual Genesys Predictive Engagement Administrator's Guide for version Current of Genesys Predictive Engagement.

Learn how to specify the webpages where an action map triggers.

Prerequisites

Apply an action map to webpages

When you create an action map that uses a web action, you can define an expression that determines on which webpages the action map should or should not trigger. The expression includes one or more operators, a corresponding operand, and one or more conditions. After you define the expression, verify that the expression is valid.

About conditions

You can add as many conditions as you need. For OR conditions, the action map triggers when either condition is true. For AND conditions, the action map triggers when both conditions are true.

As you define conditions, Genesys Predictive Engagement checks for syntax errors, including a valid protocol, spaces and extra special characters. If there are syntax errors, Genesys Predictive Engagement displays an error message. For more information, see the notes for the operator that you are using.
Important
If the action map isn't working as expected, check your URL conditions.
Tip
To remove a condition, rest your mouse on it and then click the x that appears.


Verify that the expression is valid

After you define an expression, ensure that the expression is valid for all the webpages that you specified. Expressions are not case-sensitive.
Important
If you see, "No" when you check a webpage, it means that the URL doesn't match the specified conditions. Check your expression:
  • If you are using the equals, or not equals operators, ensure that you specified a full URL.
  • If you are using the equals, not equals, or starts with operators, ensure that you specified the protocol.

Operators for URL conditions


Tip
 
  • Separate a list of values with commas
  • Available operators depend on the object type that you are configuring.
Operator Action map triggers when the page URL... Comments
contains all contains all the characters that you specify
contains any contains one or more characters that you specify
does not contain all does not contain all the characters that you specify
does not contain any does not contain any of the characters that you specify
equals matches the full URL that you specify exactly, including case Specify the full URL, including the protocol; either "http:" or "https:".

If you define an equals condition, you cannot define an AND condition.

Correct:

  • equals http://abc.com OR http://def.com OR https://xyz.com

Incorrect:

  • equals abc.com OR def.com
  • equals abc.com AND equals xyz.com
not equals does not match the full URL exactly as you specify, including case Specify the full URL, including the protocol; either "http:" or "https:".

If you define a not equals condition, you cannot define an AND condition.

Correct:

  • not equals http://abc.com OR http://def.com OR https://xyz.com<br />

Incorrect:

  • equals abc.com OR def.com
  • equals abc.com AND equals xyz.com
like matches some of the characters that you specify This operator is useful when you want to target a unique query string parameter (a keyword) that appears in multiple URLs.

You can define conditions containing multiple like and not like operators.

Correct:

  • like insurance AND like auto OR home OR health
not like does not match any of the characters that you specify
starts with matches the characters that you specify, starting from the beginning of the string, up to and including the last character in the string Use this operator when your URLs are generally unvarying but can include query string parameters at the end that you want to exclude.

Specify the protocol; either "http:" or "https:". You can have one starts with or one ends with operator per condition.

Correct:

Incorrect:

  • starts with abc.com OR xyz.com AND starts with abc.com OR xyz.com
ends with matches the characters that you specify, starting from the end of the string, up to and including the first character in the string Use this operator when you want to match a specific query string parameter at the end of the URL.

For example, you can match shopping cart pages with URLs that end with "/thankyou.html".

You can have one ends with operator per condition.

Retrieved from "https://all.docs.genesys.com/ATC/Current/AdminGuide/Apply (2024-10-06 22:38:31)"
Comments or questions about this documentation? Contact us for support!