Self Help Online Studio - Analytics Menu


The Analytics menu groups project analysis and monitoring functionalities for a given period.

For example, it generates statistical reports that enable you to:

  • Perform a detailed analysis of specific data such as the usage frequency of procedures, in order to optimize Self Help project operations.
  • Analyze the searches run and results returned, in order to optimize keywords associated with the procedures or suggestions proposed to the user by the virtual agent..

Operating principles

  • Statistical reports are generated using a set of criteria defined in extraction profiles. These profiles are used to:
    • Define the scope of data extraction for each report by selecting Self Help domains and projects. By default, all domains and projects on the Self Help administration server are included.
    • Select the type of data to be included in the report, e.g. procedure instance data, search history, etc.
  • Statistical reports are generated in Excel files. They can be sent by email to the relevant recipients or incorporated in a Tableau report.

Notes

  • Server administrators can only access data on the servers they are authorized to manage.
  • Domain administrators can only access data for their Self Help domains.
  • Writers can only access data in the Self Help domains where they have read access rights.
  • You can define several extraction profiles with different criteria.
  • Emails sent to recipients always contain a link for downloading the statistical reports.
    • Users can download them in the Online Studio, provided they have read access rights to the domains analyzed in the statistical reports.
    • The Excel file is automatically attached to the email to be sent if its size does not exceed 3 MB. This enables users to view reports even if they do not have the right to access the Online Studio.
       

Which elements are taken into account when running an extraction profile?

  • Procedure instances run in test mode in the Desktop Studio will be excluded from statistical reports.
  • If the Search Engine or Executions option is selected, only procedures that have been run at least once will be extracted with the associated folders.
  • If the Procedures option is the only one selected, all procedures and associated folders will be extracted.

Caution

  • To modify the report template, a monthly subscription to the Tableau software is required. The Tableau Reader software just enables you to view and manipulate reports.
        Open url.png Download Tableau Reader

Best Practice

  • If you want to extract data on a regular basis, you should schedule the corresponding extraction profile. Open url.png See the procedure.
  • To avoid performance bottlenecks on the Self Help server, you should delay the immediate execution of the extraction profiles if the data volume to be extracted is large. You can specify a start date and time to delay the task.

Description of screens

Extracts sub-menu

This displays the list of reports generated with the name of the extraction profile and the extraction date.
Note: The file name is made up of these two elements.
         Analytics menu - Extraction.png

  • You can sort the list by clicking one of the column headers.
  • The number of tasks in progress is displayed at the top of the list.
  • You can group reports using a specific criterion by clicking the Group By link at the top of the list.
  • You can apply a filter to the names of reports by clicking the Filter link at the top of the list.
  • Click the name of a report to see its details.
    • Click See next to the Profile Name field to display the details of the extraction profile in the Extraction profiles sub-menu.
    • Click See next to the Job Name field to display the details of the task in the Scheduling sub-menu.
               Analytics menu - Extraction - Details.png

Functionalities available in the toolbar

  • Send statistical reports by email to recipients.
  • Delete one or more reports.
  • Download one or more reports.

Extraction profiles sub-menu

This displays the list of extraction profiles. Each profile is used to define the characteristics of the reports to be generated, e.g. data extraction scope, language used, type of data to  be included.
        Analytics menu - Extraction profiles.png

  • You can sort the list by clicking one of the column headers.
  • You can group extraction profiles using a specific criterion by clicking the Group By link at the top of the list.
  • You can apply a filter to the names of extraction profiles by clicking the Filter link at the top of the list.
  • Click the name of an extraction profile to see its details.
            Analytics menu - Extraction profiles - Details.png

Functionalities available in the toolbar

  • Create a new extraction profile. Open url.png See the procedure.
  • Delete one or more extraction profiles. Data can no longer be extracted using these deleted profiles.
    Note:
    • All tasks associated with these extraction profiles will be deleted in the Scheduling sub-menu.
    • Reports already generated using these extraction profiles will remain available in the Extracts sub-menu.
  • Execute an immediate extraction profile. Open url.png See Scheduling principles and the procedure.
    Note: You can delay the immediate execution of the extraction by specifying a start date and time.
  • Schedule the execution of an extraction profile. Open url.png See Scheduling principles and the procedure.
    Note: You can modify the scheduled start date subsequently in the Scheduling sub-menu.
  • Modify an extraction profile, e.g. Self Help project, domain, type of data to be included, etc.
    Note: Your modifications will be taken into account for new reports generated using the extraction profile.

Scheduler sub-menu

This displays the list of scheduled tasks with the name of the extraction profile and data extraction period.
Note: Once a scheduled task has been executed, it will appear in the Extracts sub-menu. The name of the generated file indicates the execution date.
        Analytics menu - Extraction scheduling.png

  • You can sort the list by clicking one of the column headers.
  • You can group tasks using a specific criterion by clicking the Group By link at the top of the list.
  • You can apply a filter to the names of tasks by clicking the Filter link at the top of the list.
  • The name of the task indicates its frequency and start date.

    example

    • MyProfile.Daily.now ==> Task associated with the MyProfile extraction profile, scheduled daily after the first immediate execution.
    • MyProfile.Weekly.2019-10-29 ==> Task associated with the MyProfile extraction profile, scheduled weekly with a first execution on 29/10/2019.
  • The names of immediate execution tasks contain the words, immediate-exec.
  • Click the name of a task to see its details.
    • Click See next to the Profile Name field to display the details of the extraction profile in the Extraction profiles sub-menu.
               Analytics menu - Extraction scheduling - Details.png

Functionalities available in the toolbar

  • Reschedule an extraction task.
    Note: Only the scheduled start date will be reinitialized. To modify the other criteria such as the execution frequency or the sending of an email, you should do so in the extraction profile of the task by selecting Extraction profiles > Schedule.
  • Delete one or more extraction tasks.
    Note: Reports already generated using the deleted extraction tasks will remain available in the Extracts sub-menu.

API Dashboard sub-menu

This displays the list of procedure instances run in the Content API.

The sub-menu enables you to see the number of times Self Help project procedures were run via the API based on the third-party environment calling them.

  • Each row corresponds to a given procedure and a given execution environment.

Scheduling principles for extraction profiles

Immediate execution

  • You perform an immediate execution by selecting Extraction profiles > Execute.
  • A single task will appear in the Scheduling sub-menu.
    • The task name is made up of the words, immediate-exec and the execution date.

      example  immediate-exec.20191029_14:40:57 ==> Report generated on 29/10/2019 at 14h40mn57sec

  • Once the data has been extracted, the generated report will appear in the Extracts sub-menu.
    • The file name is made up of the extraction profile name and the execution date.

      example  MyProfile.20191029_14:40:57 ==> Report generated using the MyProfile extraction profile on 29/10/2019 at 14h40mn57sec

    • The task will remain visible in the Scheduling sub-menu.

Scheduling

  • You define a scheduled extraction by selecting Extraction profiles > Schedule.
  • You can define several schedules for a given extraction profile with different criteria.
    • Each scheduling will create a different task that will appear in the Scheduling sub-menu.
    • The task name is made up of the extraction profile name, the execution frequency and the scheduled start date.

      example

      • MyProfile.Daily.now ==> Task associated with the MyProfile extraction profile, scheduled daily after the first immediate execution.
      • MyProfile.Weekly.2019-10-29 ==> Task associated with the MyProfile extraction profile, scheduled weekly with a first execution on 29/10/2019.
  • Once the scheduled task has been run, the generated report will appear in the Extracts sub-menu.
    • The file name is made up of the extraction profile name and the report generation date.

      example  MyProfile.20191029_13:50:43 ==> Report generated using the MyProfile extraction profile on 29/10/2019 at 13h50mn43sec

    • The scheduled task will remain visible in the Scheduling sub-menu.
  • You can modify the scheduled start date subsequently in the Scheduling sub-menu.

Procedures

How to create an extraction profile

Step 1: Create a new extraction profile.

1. Open the Online Studio.

2. Select Analytics > Extraction profiles in the menu.

3. Click + New profile.

Step 2: Enter the information on the new extraction profile.

1. Enter the name of the new profile.Note: The name must be unique.

2. Select the generated report format.

3. Select the report language.

4. Select the execution format. This provides different analysis levels of the results returned.

  • Steps: Used to retrieve a record in each visible step of the user journey.
  • Executions: Used to retrieve a record each time an entry point is run by the user.
  • Stepsdebug: Debug format used by the Support team for retrieving additional records.

5. Select the type of data to be included in the reports, e.g. procedure instance data, search history, sessions, or procedures.

  • If you select the Search Engine option, the Executions and Procedures options will automatically be selected. You cannot unselect this.
  • If you select the Executions option, the Procedures option will automatically be selected. You cannot unselect this.

6. (optional) Select the Self Help projects and domains to filter data by clicking Add icon.png and Add next to each list.
Note: By default, data will be extracted for all Self Help projects and domains on the Self Help administration server.

7. (optional) Specify the variables to be extracted by clicking Add icon.png and Add.

8. Click Save.
The extraction profile is created.

How to execute an extraction profile immediately

Step 1: Select the extraction profile you want.

1. Open the Online Studio.

2. Select Analytics > Extraction profiles in the menu.

3. Select the extraction profile for immediate execution.

Step 2: Execute the extraction profile.

1. Click Execute.

2. Specify the data extraction period.

3. (optional) Select the Execution delay box to delay the execution of the extraction profile to a specified date and time.

4. (optional) Select the Send mail after execution box to send the report generated by the extraction profile to a recipient. Next, specify the email address.
The email will contain a link for downloading the report.

5. Click Yes.

  • The extraction profile will be executed immediately or delayed.
  • The generated report will appear in the Extracts sub-menu. Its name indicates the generation date.

How to schedule an extraction profile

Step 1: Select the extraction profile you want.

1. Open the Online Studio.

2. Select Analytics > Extraction profiles in the menu.

3. Select the extraction profile to be scheduled.

Step 2: Schedule the extraction profile.

1. Click Schedule.

2. Enter a name for the new scheduled task.
Note: The name must be unique. By default, it is made up of the extraction profile name, the execution frequency and the word, now.

example  MyProfile.Daily.now; MyProfile.Weekly.now

2. Select the execution frequency.

  • Daily, Weekly, Monthly:
    • Specify the scheduled start date using the calender or manually with the following format, DD/MM/YYYY.
  • Custom:
    • Specify the scheduled start date using the calender or manually with the following format, DD/MM/YYYY.
    • Specify the start and end dates.

3. (optional) Select the Send mail after execution box to send the report generated by the extraction profile to a recipient. Next, specify the email address.
The email will contain a link for downloading the report.

4. Click Schedule.

  • A task associated with the scheduled extraction profile will appear in the Scheduling sub-menu.
  • Its name indicates the execution frequency and the scheduled start date.
Tags:
Last modified by Unknown User on 2021/10/25 14:54
Created by Administrator XWiki on 2020/12/07 11:17

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021