Difference between revisions of "ATC/Current/AdminGuide/Action library"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 3: Line 3:
 
|DisplayName=Action Library
 
|DisplayName=Action Library
 
|TocName=Action Library
 
|TocName=Action Library
|Context=Learn how to create a collection of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_content_offers|display text=content offers}} and {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_webhooks|display text=webhooks}} that you can use with {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_action_maps|display text=action maps}}.
+
|Context=Learn how to create and manage reusable {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_content_offers|display text=content offers}} and {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_webhooks|display text=webhooks}} that {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_action_maps|display text=action maps}} can use.
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Prereq='''Prerequisites'''
 
|Prereq='''Prerequisites'''
  
[https://help.mypurecloud.com/articles/?p=195191 Configure the following permissions in Genesys Cloud:]
+
*[https://help.mypurecloud.com/articles/?p=195191 Configure the following permissions in Genesys Cloud:]
 
+
**'''Journey''' > '''Action Template''' > '''Add''', '''Delete''', '''Edit''', '''View'''
*'''Journey''' > '''Action Template''' > '''Add''', '''Delete''', '''Edit''', '''View'''
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=View actions
 
|sectionHeading=View actions
Line 18: Line 17:
 
|image=ActionLib1.png
 
|image=ActionLib1.png
 
|structuredtext=#In Admin in Genesys Cloud, open the '''Action Library''' page.
 
|structuredtext=#In Admin in Genesys Cloud, open the '''Action Library''' page.
#Use the tabs to switch between types of actions.
+
#To change which action type displays, click its tab.
#To sort the list, click the ascending/descending arrow next to the heading by which you want to sort.
+
#To sort the list, click the ascending or descending arrow next to the column heading by which to sort.
#To see the details of an action, click its row.<br />
+
#To view a description of a column's contents, click the Information icon.
{{NoteFormat|{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_web_chats|display text=Web chat}} and {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=AboutArchFlows|display text=Architect flow actions}} do not appear in the Action Library.|}}
+
{{NoteFormat|{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_web_chats|display text=Web chat}} and {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=AboutArchFlows|display text=Architect flow actions}} are not available in the Action Library.|}}<br />
 +
|structuredtextwide='''Name:''' Descriptive and meaningful action name.
 +
 
 +
'''Status:''' Status of the action.
 +
 
 +
*'''Published:''' Action configuration is complete and the action is available to use in action maps. You can no longer edit the action.
 +
*'''Draft:''' Action configuration is in progress and the action is unavailable to use in action maps.
 +
*'''Archived:''' Action is no longer available to use in new action maps. However, the action continues to work with the action maps that were using it before archival.
 +
 
 +
'''Date Created:''' Date that an administrator created the action.
 +
 
 +
'''Last Modified:''' Most recent date that an administrator modified the action.
 +
 
 +
====Content offers only====
 +
 
 +
*'''Offered:''' Total number of times that {{MintyDocsProduct}} offered this action to web site visitors.
 +
*'''CTR:''' (Click-through rate) Percentage of times that web site visitors clicked the content offer.
 +
 
 +
====Webhooks only====
 +
 
 +
*'''Triggered:''' Webhook initiated a call to the Genesys Cloud integration.
 +
*'''Successful:''' Call to the third-party system completed without error.
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 29: Line 49:
 
|Status=Yes
 
|Status=Yes
 
}}{{Section
 
}}{{Section
|sectionHeading=Action-specific columns
+
|sectionHeading=View action details
 +
|anchor=ViewDetails
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=WebhooksALCols.png
+
|image=ActionDetails.png
|structuredtext=For some actions, the Action Library displays additional columns:
+
|structuredtext=#To view details about an action, click the action.
 
+
#To view an action map that uses the action, click the action map name.
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Content_offers_in_the_Action_Library|display text=Content offers}}
+
#To close the action details view, click the arrow.
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Columns_for_webhooks_in_the_Action_Library|display text=Webhooks}}
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Add an action
+
|sectionHeading=Create an action
|anchor=ActionAdd
+
|anchor=CreateAction
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
 
|image=ActionCreate.png
 
|image=ActionCreate.png
|structuredtext=Select the type of action that you want and then complete the instructions for that action type:
+
|structuredtext=====Create a content offer====
 +
On the '''Content offer''' tab, click '''Create content offer''' and then follow the instructions in {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Content_offers}}.
  
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Content_offers|anchor=CreateOffer|display text=Create a content offer}}.
+
====Create a webhook====
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Build_webhooks|anchor=CreateWebhook}}.
+
On the '''Webhook''' tab, click '''Create webhook''' and then follow the instructions in {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Build_webhooks}}.
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Duplicate an action
+
|sectionHeading=Edit an action
|anchor=ActionDuplicate
+
|anchor=EditAction
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=ActionDuplicate.png
+
|image=ActionEdit.png
|structuredtext=When you duplicate an action, {{MINTYDOCSPRODUCT}} creates an exact copy of the action. The name of the copied action includes -COPY. Change the name of the duplicate action as needed.
+
|structuredtext=On the tab for the action type to modify, click the action and then click the '''Edit''' menu option. For more information about the available options, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Content_offers}} or {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Build_webhooks}}.{{NoteFormat|You can only edit actions that you saved as a draft. You cannot edit published actions. |}}
 
 
If the action is not ready for use with action maps, '''save it as a draft'''. Otherwise, save and publish the action. {{NoteFormat|After you publish an action, you can no longer {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_library|anchor=EditAction|display text=edit it}}. If you no longer need the action, you can archive it.|}}
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Edit an action
+
|sectionHeading=Duplicate an action
|anchor=EditAction
+
|anchor=ActionDuplicate
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=SpaBooking1.png
+
|image=ActionDuplicate.png
|structuredtext=You can only edit actions that you saved as a draft.
+
|structuredtext=To simplify the process of creating an action, you can duplicate an existing one. On the tab for the action type to duplicate, click the action and then click the '''Duplicate''' menu option. The duplicate action displays in edit mode, with -COPY appended to the name. Change the name of the duplicate action and then modify the remaining information as appropriate. For more information about the available options, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Content_offers}} or {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Build_webhooks}}.
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Save an action: draft or publish
+
|sectionHeading=Save an action
 
|anchor=Save
 
|anchor=Save
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=Save.png
+
|image=ActionSave.png
|structuredtext=When you create an action, you can save it as a draft or save and publish it.
+
|structuredtext=When you create or duplicate an action:
  
*To continue editing it later, save it as a '''draft'''.
+
*If you action is not ready to use in action maps, click '''Save as draft'''.
*To make it available for use with an action map, '''publish''' it. You cannot edit a published action.
+
*If the action is ready to use in action maps, click '''Save and publish'''.
 +
{{NoteFormat|You cannot edit published actions. However, you can revert published actions to draft mode and then edit them. |}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Action statuses
+
|sectionHeading=Revert published action to draft
|anchor=ActionStatuses
+
|anchor=RevertAction
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=Statuses.png
+
|image=ActionRevert.png
|structuredtext=At any time, you can change the status of an action by {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_library|anchor=EditAction|display text=editing it}}.
+
|structuredtext=To edit a published action, revert it to draft mode first. On the tab for the action type to revert, click the action and then click the '''Revert to draft''' menu option.
{{{!}} class="wikitable"
 
{{!}}-
 
{{!}}{{!}}'''Status'''
 
{{!}}{{!}}'''Description'''
 
{{!}}{{!}}'''Use with action maps?'''
 
{{!}}{{!}}'''Editable?'''
 
{{!}}-
 
{{!}}{{!}}Published
 
{{!}}{{!}}The action is complete.
 
{{!}}{{!}}Yes
 
{{!}}{{!}}No
 
{{!}}-
 
{{!}}{{!}}Draft
 
{{!}}{{!}}The action is still under construction.
 
{{!}}{{!}}No
 
{{!}}{{!}}Yes
 
{{!}}-
 
{{!}}{{!}}Archived
 
{{!}}{{!}}The action is no longer available for use with new action maps.
 
The action continues to work with any action maps that already use it.
 
{{!}}{{!}}Only for action maps that already use it.
 
{{!}}{{!}}No
 
{{!}}}
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 114: Line 111:
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
|image=Archive.png
+
|image=ActionArchive.png
|structuredtext=After you create an action, you cannot delete it. Instead, edit the action and change its status to '''archived'''.{{NoteFormat|To ensure that no user sees an action after you archive it, be sure to {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Activate_inactivate|display text=deactivate any action map}} that uses it.|}}
+
|structuredtext=If you no longer need an action, deletion is not possible; however, you can archive it. On the tab for the action type to archive, click the action and then click the '''Archive''' menu option. {{NoteFormat|After archiving the action, ensure that you {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Activate_inactivate|display text=deactivate the action maps}} that use it.|}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 121: Line 118:
 
|anchor=TroubleshootAction
 
|anchor=TroubleshootAction
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=See the following articles for troubleshooting information:
+
|structuredtext=For troubleshooting information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Troubleshoot}}.
 
 
*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Troubleshoot}}
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 19:10, December 9, 2020

Learn how to create and manage reusable content offers and webhooks that action maps can use.

Prerequisites

View actions

  1. In Admin in Genesys Cloud, open the Action Library page.
  2. To change which action type displays, click its tab.
  3. To sort the list, click the ascending or descending arrow next to the column heading by which to sort.
  4. To view a description of a column's contents, click the Information icon.
Important
Web chat and Architect flow actions are not available in the Action Library.

Name: Descriptive and meaningful action name.

Status: Status of the action.

  • Published: Action configuration is complete and the action is available to use in action maps. You can no longer edit the action.
  • Draft: Action configuration is in progress and the action is unavailable to use in action maps.
  • Archived: Action is no longer available to use in new action maps. However, the action continues to work with the action maps that were using it before archival.

Date Created: Date that an administrator created the action.

Last Modified: Most recent date that an administrator modified the action.

Content offers only

  • Offered: Total number of times that Genesys Predictive Engagement offered this action to web site visitors.
  • CTR: (Click-through rate) Percentage of times that web site visitors clicked the content offer.

Webhooks only

  • Triggered: Webhook initiated a call to the Genesys Cloud integration.
  • Successful: Call to the third-party system completed without error.

AI-303 Replace note in above section

Important
Web chat, web messaging, and Architect flow actions do not appear in the Action Library.

View action details

  1. To view details about an action, click the action.
  2. To view an action map that uses the action, click the action map name.
  3. To close the action details view, click the arrow.

Create an action

Create a content offer

On the Content offer tab, click Create content offer and then follow the instructions in Create a content offer.

Create a webhook

On the Webhook tab, click Create webhook and then follow the instructions in [[ATC/Current/AdminGuide/Build_webhooks|]].

Edit an action

On the tab for the action type to modify, click the action and then click the Edit menu option. For more information about the available options, see Create a content offer or [[ATC/Current/AdminGuide/Build_webhooks|]].
Important
You can only edit actions that you saved as a draft. You cannot edit published actions.

Duplicate an action

To simplify the process of creating an action, you can duplicate an existing one. On the tab for the action type to duplicate, click the action and then click the Duplicate menu option. The duplicate action displays in edit mode, with -COPY appended to the name. Change the name of the duplicate action and then modify the remaining information as appropriate. For more information about the available options, see Create a content offer or [[ATC/Current/AdminGuide/Build_webhooks|]].

Save an action

When you create or duplicate an action:

  • If you action is not ready to use in action maps, click Save as draft.
  • If the action is ready to use in action maps, click Save and publish.
Important
You cannot edit published actions. However, you can revert published actions to draft mode and then edit them.

Revert published action to draft

To edit a published action, revert it to draft mode first. On the tab for the action type to revert, click the action and then click the Revert to draft menu option.

Archive an action

If you no longer need an action, deletion is not possible; however, you can archive it. On the tab for the action type to archive, click the action and then click the Archive menu option.
Important
After archiving the action, ensure that you deactivate the action maps that use it.

Troubleshoot

For troubleshooting information, see [[ATC/Current/AdminGuide/Troubleshoot|]].

Comments or questions about this documentation? Contact us for support!