Difference between revisions of "PEC-REP/Current/RPRT/HRCXIGetStarted"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(4 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|DisplayName=Generate historical reports
 
|DisplayName=Generate historical reports
 
|TocName=Generate historical reports
 
|TocName=Generate historical reports
|Context=Navigate in Genesys CX Insights so that you can access and run/generate historical reports, and control what data is included in reports.
+
|Context=Navigate in Genesys CX Insights to access and run/generate historical reports, and control what data appears in reports.
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=GenesysEngage-cloud
 
|Platform=GenesysEngage-cloud
 
|Role=Administrator, Supervisor
 
|Role=Administrator, Supervisor
 
|Application=Reporting GCXI
 
|Application=Reporting GCXI
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Video: Generate Historical Reports using Genesys CX Insights
 
|sectionHeading=Video: Generate Historical Reports using Genesys CX Insights
Line 15: Line 14:
 
|Media=Video
 
|Media=Video
 
|image=229633305
 
|image=229633305
|structuredtext=This video describes how to generate historical reports using Genesys CX Insights, a component of Genesys Engage cloud.
+
|structuredtext=This video describes how to generate historical reports using Genesys CX Insights, a component of Genesys Multicloud CX.
  
 
<br />
 
<br />
 
|structuredtextwide={{NoteFormat|'''What is a Historical Report?'''<br/><br/>
 
|structuredtextwide={{NoteFormat|'''What is a Historical Report?'''<br/><br/>
'''Historical Reports''' are reports that track contact center and agent performance over a period of time. How far back in time you can look varies depending on the size and complexity of your contact center. By contrast, '''Real-time Reporting''' provides information about interactions that are taking place ''right now'' in the contact center.  If you are looking for real-time reporting, or want to learn more about what the difference is, see {{Link-Standalone|topic=PEC-REP/HIW|display text=What's the difference? — real-time and historical reporting}}|2}}
+
'''Historical Reports''' are reports that track contact center and agent performance over a period of time. How far back in time you can look varies depending on the size and complexity of your contact center. By contrast, '''Real-time Reporting''' provides information about interactions that are taking place ''right now'' in the contact center.  If you are looking for real-time reporting, or want to learn more, see {{Link-Standalone|topic=PEC-REP/HIW|display text=What's the difference? — real-time and historical reporting}}|2}}
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=
 
 
|anchor=AccessReports
 
|anchor=AccessReports
 
|alignment=Horizontal
 
|alignment=Horizontal
 
|Media=Image
 
|Media=Image
 
|image=HRGCXIOpenAReport.png
 
|image=HRGCXIOpenAReport.png
|structuredtext=If you are already comfortable using CX Insights, go straight to a {{Link-SomewhereInThisManual|topic=HRCXIIncludedReports|anchor=top|display text=complete list}} of available reports.
+
|structuredtext=If you are already comfortable using CX Insights, go straight to a {{Link-SomewhereInThisManual|topic=HRCXIIncludedReports|display text=complete list}} of available reports.
  
Information on this page applies to ''both'' reports and dashboards, but for simplicity, refers to them simply as ''reports''.  
+
Information on this page applies to ''both'' reports and dashboards, but for simplicity, refers to them as ''reports''.  
  
 
#On the Genesys Portal, click the '''Reporting GCXI''' button on the '''All Apps''' or '''User''' tab.
 
#On the Genesys Portal, click the '''Reporting GCXI''' button on the '''All Apps''' or '''User''' tab.
#If a page appears where you can select a server, choose the server on which to view reports (you probably have only one, but if more than one appears, and you are not sure which one to select, contact your administrator).
+
#If a page appears where you can select a server, choose the server on which to view reports. You probably have only one server, but if more than one appears, and you are not sure which one to select, contact your administrator.
 
#If prompted, enter your user name and password.
 
#If prompted, enter your user name and password.
 
#The Genesys CX Insights page appears. Click '''Shared Reports''' > '''CX Insights'''.
 
#The Genesys CX Insights page appears. Click '''Shared Reports''' > '''CX Insights'''.
#Reports are divided into subfolders based on function; select a sub-folder, for example '''Business Results'''.
+
#Reports are divided into subfolders based on function; select a subfolder, for example '''Business Results'''.
 
#From the listed reports and dashboards, either double-click, or right-click and choose '''Run'''. For example, '''Business Metrics Executive Report'''. The prompts for that report appear.
 
#From the listed reports and dashboards, either double-click, or right-click and choose '''Run'''. For example, '''Business Metrics Executive Report'''. The prompts for that report appear.
 
#Select a date or date range, and optionally make selections for other prompts.
 
#Select a date or date range, and optionally make selections for other prompts.
 
#Click '''Run Report''' (or '''Run Dossier''', for a dashboard).
 
#Click '''Run Report''' (or '''Run Dossier''', for a dashboard).
#:The report appears. Note that you can filter, drill, and otherwise interact with many report values.
+
#:The report appears. You can filter, drill, and otherwise interact with many report values.
 
|structuredtextwide=Many reports offer a long list of prompts, but you don't have to make selections at all those prompts.
 
|structuredtextwide=Many reports offer a long list of prompts, but you don't have to make selections at all those prompts.
  
For most reports, you can simply select a Report Date (or Start Time/Date and End Time/Date, depending on the report), or a value from the Pre-set Day Filter list, and click '''Run Report''' to generate the report. Note that selecting a Pre-set Day Filter value overrides any Report Date or Start / End selections.  
+
For most reports, you can select a Report Date (or Start Time/Date and End Time/Date, depending on the report), or a value from the Pre-set Day Filter list, and click '''Run Report''' to generate the report. Selecting a Pre-set Day Filter value overrides any Report Date or Start / End selections.  
  
 
For more information about prompts, see {{Link-SomewhereInThisManual|topic=HRCXIGetStarted|anchor=ControlWhatData|display text=Controlling what data appears in a report}}.
 
For more information about prompts, see {{Link-SomewhereInThisManual|topic=HRCXIGetStarted|anchor=ControlWhatData|display text=Controlling what data appears in a report}}.
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 54: Line 50:
 
|Media=Image
 
|Media=Image
 
|image=HRGCXPrompts.png
 
|image=HRGCXPrompts.png
|structuredtext=In many cases, you may want to restrict what data is gathered into a report; for example:
+
|structuredtext=You can restrict what data GCXI gathers into a report; for example:
  
*If your environment contains a very large amount of data, some reports can become very long.
+
*If your environment contains a large amount of data, some reports can become excessively long.
*You might want to see a report about just one aspect of the contact center, such as a single agent group.
+
*You require a report that focuses on just one aspect of the contact center, such as a single agent group.
  
 
When you open any report, the report prompts appear, where you can customize the data that is taken into the report. The prompts available are specific to each report&mdash;the example shown here pertains to the Agent Conduct Report:
 
When you open any report, the report prompts appear, where you can customize the data that is taken into the report. The prompts available are specific to each report&mdash;the example shown here pertains to the Agent Conduct Report:
  
*For each prompt, enter or select appropriate values.  Each prompt provides either a drop-down list or a search field and accompanying button.
+
*For each prompt, enter or select appropriate values.  Each prompt provides either a list or a search field and accompanying button.
*Use the Index, to the left of the prompts input area, to quickly jump to any section of the prompts.
+
*Use the Index, on the left side of the prompts input area, to go to any section of the prompts.
|structuredtextwide=In many cases, the default values are appropriate; if in doubt about a given prompt's effect, see the descriptions given below, or try running the report with default values to get a better idea of the result.  
+
|structuredtextwide=The default values are often appropriate. If you are unsure about a prompt's effect, see the descriptions given below, or try running the report with default values to get a better idea of the result.  
  
 
For example, for the '''Agents / Agent Conduct Report''', you can make the following selections:
 
For example, for the '''Agents / Agent Conduct Report''', you can make the following selections:
Line 89: Line 85:
 
{{!}}}
 
{{!}}}
 
Each report has a unique set of prompts from which you can select values for the attributes used in the report.
 
Each report has a unique set of prompts from which you can select values for the attributes used in the report.
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 97: Line 92:
 
|Media=Image
 
|Media=Image
 
|image=HRGCXISubscribeReport.png
 
|image=HRGCXISubscribeReport.png
|structuredtext={{AnchorDiv|schedulereport}}You may find that you want to run a given report regularly--every day, or every week, for example. Genesys CX Insights enables you to create ''Subscriptions'', which schedule the delivery of one or more reports into your Genesys CX Insights ''History List'', or send them to you automatically by email.  
+
|structuredtext={{AnchorDiv|schedulereport}}You can run a report regularly--every day, or every week, for example. Genesys CX Insights enables you to create ''Subscriptions'', which schedule the delivery of one or more reports into your Genesys CX Insights ''History List'', or send them to you automatically by email or SFTP.
 
+
|structuredtextwide=<br />
Depending on your access level and restrictions in your environment, and whether your email address is already configured in Genesys CX Insights, you may be able to schedule a report by following these steps. However, you must be an administrator (or a member of the group “CX Insights report developers” or “CX Insights report editors”) to configure an email address. If your email address is not configured, contact your administrator to complete steps 2 and 3 for you (steps are provided by MicroStrategy, in the article [https://community.microstrategy.com/s/article/KB30581-How-to-subscribe-other-users-to-reports-with KB30581]).
+
===Scheduling email delivery===
 +
Depending on your access level and restrictions in your environment, and whether your email address is already configured in Genesys CX Insights, you may be able to schedule a report by following this procedure. However, you must be an administrator (or a member of the group “CX Insights report developers” or “CX Insights report editors”) to configure an email address. If your email address is not configured, contact your administrator to complete steps 2 and 3 for you (steps are available on the MicroStrategy website, in the article [https://community.microstrategy.com/s/article/KB30581-How-to-subscribe-other-users-to-reports-with KB30581]).
  
 
#Log in to CX Insights.
 
#Log in to CX Insights.
Line 111: Line 107:
  
 
In some scenarios, email messages that notify you about scheduled reports can contain unexpected characters in the email subject line. If you encounter this issue, contact your administrator.
 
In some scenarios, email messages that notify you about scheduled reports can contain unexpected characters in the email subject line. If you encounter this issue, contact your administrator.
|structuredtextwide=
+
{{AnchorDiv|SFTP}}
|FAQHeading=
+
===Schedule FTP delivery===
 +
Beginning with release 100.0.021.00, Genesys CX Insights supports scheduled delivery of the standard reports using FTP / SFTP. 
 +
{{NoteFormat|This feature is not intended to be used as a data dump tool to reliably extract large volumes of data. This is because report export can fail, or can occur not-on-schedule, due to maintenance activities, or simply due to a large volume of data. If you need to reliably transport Genesys Info mart data, use the Genesys Info Mart  {{Link-AnywhereElse|product=PEC-REP|version=Current|manual=RPRT|topic=GIM|display text=Data Export}} feature (also known as BI Data Feed).|}}
 +
 
 +
#Configure FTP delivery by setting FTPDEF* variables in '''gcxi.properties''', for example:
 +
#:<source lang="bash">
 +
FTPDEF1=DeviceName=myFTP1;Protocol=2;ServerName=ftp_server_name_1;Port=22;RemoteDir=/subs/files/location;UserName=user_name_with_access;FTPServerPassword=password;CreateFolders=true;AppendUserPath=true;OverwriteFiles=false;AppendToFile=false;AppendTimestampToFileName=true;UseBackUpLocation=false;PassiveMode=false;MaxConnections=-1
 +
FTPDEF2=DeviceName=myFTP2;Protocol=2;ServerName=ftp_server_name_2;Port=22;RemoteDir=/GCXi/files/location;UserName=user_name_with_access;FTPServerPassword=;CreateFolders=true;AppendUserPath=true;OverwriteFiles=false;AppendToFile=false;AppendTimestampToFileName=true;UseBackUpLocation=false;PassiveMode=false;MaxConnections=-1
 +
</source>
 +
#In MicroStrategy Developer:
 +
##From the Developer '''Folder List''', expand '''Administration''', expand '''Delivery Managers''', and select '''Devices'''.
 +
##Right-click in the '''Device List''' area, select '''New''', and then '''Device'''.
 +
##Select '''FTP''' and click '''OK'''.
 +
##Select '''SFTP''' as the protocol type, and enter the information required to connect to your SFTP server.
 +
##Click '''OK'''.
 +
##If you are previously authenticated into Genesys CX Insights, you must refresh your login session to make  the device available.
 +
#In Genesys CX Insights:
 +
##Open the '''Shared Reports''' folder, and navigate to the report you want to schedule.
 +
##Hover over the report name/description, and several options appear below the description. Click '''Subscriptions'''.
 +
##On the '''My Subscriptions''' page, scroll down and click '''Add FTP subscription'''. The '''FTP Subscription''' options appear.
 +
##Enter appropriate values for '''Schedule''', '''Location''', '''Delivery Format''', and other values as required.
 +
##Click '''OK'''.
 +
#Optionally, you can provide FTP credentials using the file '''gcxi-secrets.yaml'''. For example:
 +
#:<source lang="bash"><...>
 +
FTPDEF1__FTPServerPassword: <password1>
 +
FTPDEF2__FTPServerPassword: <passwords>
 +
FTPDEF1__UserName: <username>
 +
</source>
 +
#:where &lt;password1&gt;, &lt;passwords&gt;, and &lt;username&gt;  are appropriate values. Note that two underscores are required after the prefix (FTPDEF*__).  For example:
 +
#:<source lang="bash">
 +
FTPDEF1__FTPServerPassword: R2VuZXN5c18w
 +
FTPDEF2__FTPServerPassword: R2VuZXN5czE=
 +
FTPDEF1__UserName: Z2N4aQ==
 +
</source>
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Related Topics
 
|sectionHeading=Related Topics
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=*View a {{Link-SomewhereInThisManual|topic=HRCXIIncludedReports|anchor=top|display text=complete list of available reports}}.
|image=
+
*Learn how to {{Link-SomewhereInThisManual|topic=HRCXIGetStarted|anchor=top|display text=generate historical reports}}.
|structuredtext=*See a {{Link-SomewhereInThisManual|topic=HRCXIIncludedReports|anchor=top|display text=complete list of available reports}}.
+
*Learn how to {{Link-SomewhereInThisManual|topic=HRCXIReadReports|anchor=top|display text=read and understand reports}}.
*Learn how to {{Link-SomewhereInThisManual|topic=HRCXICustomizingReports|anchor=top|display text=customize reports}}.
+
*Learn how to {{Link-SomewhereInThisManual|topic=HRCXICustomizingReports|anchor=top|display text=create or customize reports}}.
*Learn more about how to {{Link-SomewhereInThisManual|topic=HRCXIReadReports|anchor=top|display text=read and understand reports}}.
+
To view more detailed information about the metrics and attributes used in the reports, and about other metrics and attributes that you can use to customize reports, see the ''{{Link-AnywhereElse|product=PEC-REP|version=Current|manual=GCXIMCPRG|display text=Genesys CX Insights Multicloud Projects Reference Guide}}''.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
|Status=No
 
|Status=No
 
}}
 
}}

Latest revision as of 13:31, June 30, 2022

This topic is part of the manual Work with Genesys CX Insights Reports for version Current of Reporting.

Navigate in Genesys CX Insights to access and run/generate historical reports, and control what data appears in reports.

Video: Generate Historical Reports using Genesys CX Insights

This video describes how to generate historical reports using Genesys CX Insights, a component of Genesys Multicloud CX.


Tip
What is a Historical Report?

Historical Reports are reports that track contact center and agent performance over a period of time. How far back in time you can look varies depending on the size and complexity of your contact center. By contrast, Real-time Reporting provides information about interactions that are taking place right now in the contact center. If you are looking for real-time reporting, or want to learn more, see What's the difference? — real-time and historical reporting

If you are already comfortable using CX Insights, go straight to a complete list of available reports.

Information on this page applies to both reports and dashboards, but for simplicity, refers to them as reports.  

  1. On the Genesys Portal, click the Reporting GCXI button on the All Apps or User tab.
  2. If a page appears where you can select a server, choose the server on which to view reports. You probably have only one server, but if more than one appears, and you are not sure which one to select, contact your administrator.
  3. If prompted, enter your user name and password.
  4. The Genesys CX Insights page appears. Click Shared Reports > CX Insights.
  5. Reports are divided into subfolders based on function; select a subfolder, for example Business Results.
  6. From the listed reports and dashboards, either double-click, or right-click and choose Run. For example, Business Metrics Executive Report. The prompts for that report appear.
  7. Select a date or date range, and optionally make selections for other prompts.
  8. Click Run Report (or Run Dossier, for a dashboard).
    The report appears. You can filter, drill, and otherwise interact with many report values.

Many reports offer a long list of prompts, but you don't have to make selections at all those prompts.

For most reports, you can select a Report Date (or Start Time/Date and End Time/Date, depending on the report), or a value from the Pre-set Day Filter list, and click Run Report to generate the report. Selecting a Pre-set Day Filter value overrides any Report Date or Start / End selections.

For more information about prompts, see Controlling what data appears in a report.

Controlling what data appears in a report

You can restrict what data GCXI gathers into a report; for example:

  • If your environment contains a large amount of data, some reports can become excessively long.
  • You require a report that focuses on just one aspect of the contact center, such as a single agent group.

When you open any report, the report prompts appear, where you can customize the data that is taken into the report. The prompts available are specific to each report—the example shown here pertains to the Agent Conduct Report:

  • For each prompt, enter or select appropriate values. Each prompt provides either a list or a search field and accompanying button.
  • Use the Index, on the left side of the prompts input area, to go to any section of the prompts.

The default values are often appropriate. If you are unsure about a prompt's effect, see the descriptions given below, or try running the report with default values to get a better idea of the result.

For example, for the Agents / Agent Conduct Report, you can make the following selections:

Prompt Description
Report Date Select the day for which to generate a report. (This report describes activity for a single day.)
Agent Group Optionally, restrict the report to show information about specific groups.
Agent Name Optionally, restrict the report to show information about specific agents.
Media Type Optionally, restrict the report to show information only for specific Media Types.
Interaction Type Optionally, restrict the report to show information only for specific Interaction Types.
Tenant Name In multi-tenant environments, you can optionally restrict the report to show information only for the selected tenant.

Each report has a unique set of prompts from which you can select values for the attributes used in the report.

Subscribing to reports

You can run a report regularly--every day, or every week, for example. Genesys CX Insights enables you to create Subscriptions, which schedule the delivery of one or more reports into your Genesys CX Insights History List, or send them to you automatically by email or SFTP.


Scheduling email delivery

Depending on your access level and restrictions in your environment, and whether your email address is already configured in Genesys CX Insights, you may be able to schedule a report by following this procedure. However, you must be an administrator (or a member of the group “CX Insights report developers” or “CX Insights report editors”) to configure an email address. If your email address is not configured, contact your administrator to complete steps 2 and 3 for you (steps are available on the MicroStrategy website, in the article KB30581).

  1. Log in to CX Insights.
  2. Click your user name, select Preferences, and click E-mail Addresses.
  3. In the Email Addresses list, click Add a New Address. Enter the Address Name (a short name to identify the account), the Physical Address (the email address), and choose the Device (the type of email, such as Microsoft Outlook). Click Save.
  4. In the breadcrumbs, click CX Insights to return to the Home page.
  5. Open the Shared Reports folder, and navigate to the report you want to schedule.
  6. Hover over the report name/description, and several options appear below the description. Click Subscriptions.
  7. On the My Subscriptions page, scroll down and click Add email subscription. The E-mail Subscription options appear, as shown in the adjoining figure.
  8. Choose an option from the Schedule, and To lists. Optionally, select Send a preview now to test the subscription (if you do, an email typically arrives within a few minutes). Click OK.

In some scenarios, email messages that notify you about scheduled reports can contain unexpected characters in the email subject line. If you encounter this issue, contact your administrator.

Schedule FTP delivery

Beginning with release 100.0.021.00, Genesys CX Insights supports scheduled delivery of the standard reports using FTP / SFTP.

Important
This feature is not intended to be used as a data dump tool to reliably extract large volumes of data. This is because report export can fail, or can occur not-on-schedule, due to maintenance activities, or simply due to a large volume of data. If you need to reliably transport Genesys Info mart data, use the Genesys Info Mart Data Export feature (also known as BI Data Feed).
  1. Configure FTP delivery by setting FTPDEF* variables in gcxi.properties, for example:
    FTPDEF1=DeviceName=myFTP1;Protocol=2;ServerName=ftp_server_name_1;Port=22;RemoteDir=/subs/files/location;UserName=user_name_with_access;FTPServerPassword=password;CreateFolders=true;AppendUserPath=true;OverwriteFiles=false;AppendToFile=false;AppendTimestampToFileName=true;UseBackUpLocation=false;PassiveMode=false;MaxConnections=-1
    FTPDEF2=DeviceName=myFTP2;Protocol=2;ServerName=ftp_server_name_2;Port=22;RemoteDir=/GCXi/files/location;UserName=user_name_with_access;FTPServerPassword=;CreateFolders=true;AppendUserPath=true;OverwriteFiles=false;AppendToFile=false;AppendTimestampToFileName=true;UseBackUpLocation=false;PassiveMode=false;MaxConnections=-1
  2. In MicroStrategy Developer:
    1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Devices.
    2. Right-click in the Device List area, select New, and then Device.
    3. Select FTP and click OK.
    4. Select SFTP as the protocol type, and enter the information required to connect to your SFTP server.
    5. Click OK.
    6. If you are previously authenticated into Genesys CX Insights, you must refresh your login session to make the device available.
  3. In Genesys CX Insights:
    1. Open the Shared Reports folder, and navigate to the report you want to schedule.
    2. Hover over the report name/description, and several options appear below the description. Click Subscriptions.
    3. On the My Subscriptions page, scroll down and click Add FTP subscription. The FTP Subscription options appear.
    4. Enter appropriate values for Schedule, Location, Delivery Format, and other values as required.
    5. Click OK.
  4. Optionally, you can provide FTP credentials using the file gcxi-secrets.yaml. For example:
    <...>
     FTPDEF1__FTPServerPassword: <password1>
     FTPDEF2__FTPServerPassword: <passwords>
     FTPDEF1__UserName: <username>
    where <password1>, <passwords>, and <username> are appropriate values. Note that two underscores are required after the prefix (FTPDEF*__). For example:
     FTPDEF1__FTPServerPassword: R2VuZXN5c18w
     FTPDEF2__FTPServerPassword: R2VuZXN5czE=
     FTPDEF1__UserName: Z2N4aQ==

Related Topics

To view more detailed information about the metrics and attributes used in the reports, and about other metrics and attributes that you can use to customize reports, see the Genesys CX Insights Multicloud Projects Reference Guide.

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