PEC-OU/Current/CXContact/useractions - Revision history

WikiSysop at 16:46, June 29, 2022

2022-06-29T16:46:29Z

WikiSysop at 10:01, June 3, 2022

2022-06-03T10:01:14Z

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:33:43Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:46:58Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Bgrenon: Published

2020-06-08T14:25:57Z

Published

New page

{{Article
|Standalone=No
|DisplayName=User Actions Dashboard
|TocName=User Actions Dashboard
|Context=Learn about the User Actions Dashboard.
|ComingSoon=No
|Platform=PureEngage
|Prereq=
|Section={{Section
|sectionHeading=
|anchor=
|alignment=Vertical
|Media=
|image=
|structuredtext=The User Actions dashboard [[File: User Actions index icon.png|link=|35px]] contains data about user events (that is, who did what and exactly when).

In addition to the numerous {{Link-SomewhereInThisManual|topic=createpanel|anchor=top|display text=panels}} that can be created for the User Actions Dashboard, this dashboard contains an '''Audit Trail Log''' A user's activity is logged for 31 days in the '''Audit Trail Log''' panel. After 31 days the activity in the Audit Trail Log is deleted.

User Actions records can contain data associated with one or more of the following fields (Audit Trail log):
{{{!}}
! width="200px"{{!}}'''Field'''
! width="200px"{{!}}'''Type'''
! width="200px"{{!}}'''Description'''
{{!}}-
{{!}}id
{{!}}keyword
{{!}}Unique identifier
{{!}}-
{{!}}requestID
{{!}}keyword
{{!}}Used to track specific API requests (for example, customer scripting troubleshooting purposes). This field contains the Request ID. The Request ID can be provided via the x-request-id header in the API CX Contact request. The Request ID must be generated by the client and can be used to track specific API requests (for example, for customer scripting troubleshooting purposes).
{{!}}-
{{!}}@timestamp
{{!}}date
{{!}}The date/time when an action started (for example, when the request arrived in the system).
{{!}}-
{{!}}userName
{{!}}keyword
{{!}}The login user name that initiated the logged action.
{{!}}-
{{!}}@endtime
{{!}}date
{{!}}The date/time when the action was completed.
{{!}}-
{{!}}duration
{{!}}integer
{{!}}The duration of the action (@endtime - @timestamp) in milliseconds.
{{!}}-
{{!}}action
{{!}}keyword
{{!}}Indicates the type of CX Contact object or entity action:

*CREATE – Object or entity has been created.
*EDIT - Object or entity has been modified.
*DELETE – Object or entity has been deleted.
*ALTER - Indicate that the underlying physical object (for example, calling list table) has been modified.
*EXECUTE - Any action over Campaign Group in OCS (for example, Load or Start).
*SEARCH - Search for a contact or suppression entry.
*READ - Used for Contact or Suppression Lists exports.
*TEST – Used for List Automation Jobs test executions.
*LOGIN – Used for user logins into the system.
*LOGOUT - Used for user logouts out of the system.
{{!}}-
{{!}}actionDetails
{{!}}keyword
{{!}}Provides additional details about the action. These values are dependent on the CX Contact object or entity.

*Import
*Export
*Add Entry
*Add Batch
*Purge
*Delete Entry
*Delete Batch
*Logout Manual
*Logout Automatic
*Start
*Stop
*Pause
*Pre-load
*Duplicate
*Edit Entry
*Abort
{{!}}-
{{!}}objectType
{{!}}keyword
{{!}}The type of object. For example, Campaign Group, Contact List, Suppression List, Time Zones Map, Compliance Rule, List Rule, List Automation, and so on. For details, refer to the {{Link-SomewhereInThisManual|topic=useractions|anchor=objecttype|display text=Object Types and Related Sub-types}} section.
{{!}}-
{{!}}objectSubtype
{{!}}keyword
{{!}}A sub-classification of the object type. For example, Attempt Rule, Location Rule, Filtering rule, Selection Rule Contact, Upload Rule Contact, and so on. For details, refer to the {{Link-SomewhereInThisManual|topic=useractions|anchor=objecttype|display text=Object Types and Related Sub-types}} section
{{!}}-
{{!}}objectName
{{!}}keyword
{{!}}The name of the object as stored in the configuration.
{{!}}-
{{!}}objectID
{{!}}integer
{{!}}The DBID of the object as stored in the configuration.
{{!}}-
{{!}}apicall
{{!}}boolean
{{!}}Appears as '''True''' if the executed action is performed via an API call and '''False''' if the executed action is performed via the user interface. This field enables you to see if a change was manually performed by a user or automatically by the system. For example, if the change was manually performed by a user the apiCall is false and if the change was automatically made from a 3rd party system or external system using an API call to run the command remotely the apiCall is true.
{{!}}-
{{!}}successful
{{!}}boolean
{{!}}Appears as '''True''' if the action was completed successfully and '''False''' if the action was not completed successfully.
{{!}}-
{{!}}errorMessage
{{!}}text
{{!}}An error message (as displayed in the user interface or returned as an API response) when the request execution was not successful.
{{!}}-
{{!}}details
{{!}}text
{{!}}An additional textual description of the action when available.
{{!}}-
{{!}}endPoint
{{!}}text
{{!}}The API end point that was called.
{{!}}-
{{!}}changeSet
{{!}}object
{{!}}Contains details about what was changed (for example, a new option value, a new dialing mode, and so on) in JSON format. '''Note:''' The Change Set is only stored when the changes are successful and only for objects represented in the configuration(for example, EDIT action).
{{!}}}

{{AnchorDiv|objecttype}}
====Object Types and Related Sub-types====

{{{!}} class="genesystable" width="100%" {{!}}
! width="200px"{{!}}'''Object Type'''
! width="200px"{{!}}'''Object Sub-types'''
{{!}}-
{{!}}Campaign Group
{{!}}
*Voice
*SMS
*Email
{{!}}-
{{!}}Campaign Template
{{!}}
*Voice
*SMS
*Email
{{!}}-
{{!}}Dialing Profile
{{!}}
*Voice
*SMS
*Email
{{!}}-
{{!}}Session Profile
{{!}}
*Voice
*SMS
*Email
{{!}}-
{{!}}Contact List
{{!}}
*Contact List
*Original File
*Rejects File
*Message File
{{!}}-
{{!}}Suppression List
{{!}}
*Suppression List Voice
*Suppression List SMS
*Suppression List Email
*Original File
*Rejects File
*Message File
{{!}}-
{{!}}Time Zones Map
{{!}}
{{!}}-
{{!}}Compliance Rule
{{!}}
*Attempt Rule
*Location Rule
*Custom Rules
*Contact Times
*Contact Dates
{{!}}-
{{!}}List Rule
{{!}}
*Filtering Rule
*Upload Rule Contact
*Upload Rule Suppression
*Selection Rule Contact
*Selection Rule Suppression
*Selection Rule Advanced
{{!}}-
{{!}}List Automation
{{!}}
*Import File
*Send Campaign Group
*Import Suppression
*Export Contact List
{{!}}-
{{!}}Label
{{!}}
{{!}}-
{{!}}Specification File
{{!}}
{{!}}-
{{!}}Data Mapping
{{!}}
*For Import
{{!}}-
{{!}}Settings
{{!}}
*General
*Security
*Pacing
{{!}}-
{{!}}Analytics
{{!}}
*Dashboard
*Panel
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Related Topics
|anchor=RelatedTopics
|alignment=Vertical
|Media=
|image=
|structuredtext=*{{Link-SomewhereInThisManual|topic=dashboardconfiguration|anchor=top|display text=Configure a Dashboard}}
*{{Link-SomewhereInThisManual|topic=dashboardrowconfig|anchor=top|display text=Configure a Dashboard Row}}
*{{Link-SomewhereInThisManual|topic=createpanel|anchor=top|display text=Create an Analytics Dashboard Panel}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 28: / Line 28: @@
 {{!}}@timestamp
 {{!}}date
-{{!}}The timestamp (default timezone from settings) indicating when the Elasticsearch index was submitted for the event.
+{{!}}The timestamp (default timezone from settings) indicating when the Elasticsearch index was submitted for the event. Please note that this is not the time when the actual event occurred.
 {{!}}-
 {{!}}userName

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |alignment=Vertical
 |structuredtext=The User Actions dashboard [[File: User Actions index icon.png|link=|35px]] contains data about user events (that is, who did what and exactly when).
@@ Line 33: / Line 28: @@
 {{!}}@timestamp
 {{!}}date
-{{!}}The date/time when an action started (for example, when the request arrived in the system).
+{{!}}The timestamp (default timezone from settings) indicating when the Elasticsearch index was submitted for the event.
 {{!}}-
 {{!}}userName
@@ Line 220: / Line 215: @@
 *Panel
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 227: / Line 220: @@
 |anchor=RelatedTopics
 |alignment=Vertical
 |structuredtext=*{{Link-SomewhereInThisManual|topic=dashboardconfiguration|anchor=top|display text=Configure a Dashboard}}
 *{{Link-SomewhereInThisManual|topic=dashboardrowconfig|anchor=top|display text=Configure a Dashboard Row}}
 *{{Link-SomewhereInThisManual|topic=createpanel|anchor=top|display text=Create an Analytics Dashboard Panel}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn about the User Actions Dashboard.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section