Self Help Online Studio - Description of an Excel Statistic Extraction File
Last modified on 2022/08/08 16:18
Contents
Extraction profiles are used to generate statistical reports from Self Help projects.
Data retrieved from the server is saved in an Excel file.
Caution
- You must not add any rows to the Excel file. You must not delete any rows from the file.
- You must not modify the header row.
Glossary
- Entry point: First executable procedure from which users start their user journey. As a general rule, the entry point is identical to the current procedure, except if users started by running a sub-procedure.
- Execution: User journey from the Start step to the exit from the procedure instance.
- UID: Unique Identifier of a Self Help project or procedure, irrespective of the published version.
Note:- The UID is different from the ID that changes with each published version.
- In general, the UID is the ID of the first version.
Characteristics of the Excel file
- File in CSV format
- The file is an Excel workbook containing six sheets.
Description of Excel sheets
executions sheet
- This sheet displays information on the execution of entry points.
- Depending on the selected analysis level, each row may correspond to one procedure or to one procedure step in the user journey.
| Column | Name of the column | Description | |
|---|---|---|---|
|
Columns A to Q: Information on the step, procedure, Self Help project and domain related to the execution |
|||
| A | Step ID | Step ID | |
| B | Execution ID | ID of the execution | |
| C | Step Order | Order in which the steps appear
Note: This is used to sort the steps in order to retrace the user journey |
|
| D; E | Page ID; Page name | ID/Name of the visible step | |
| F | Locale | Content language | |
| G to I | Entrypoint UID; Entypoint ID; Entrypoint name | Unique ID/ID/Name of the execution entry point | |
| J to L | Procedure UID; Procedure ID; Procedure name | Unique ID/Version ID/Name of the procedure | |
| M to O | Project Id; Project name; Project version | ID/Name/Version number of the Self Help project | |
| P; Q | Domain ID; Domain name | ID/Name of the domain | |
|
Columns R to T: Information on the user related to the execution |
|||
| R | User Id | ID of the user | |
| S | User name | First and last names of the user
Note: This information is concatenated. |
|
| T | Groups | Groups to which the user belongs
Note: Specify the groups using the following format: [GRP1, GRP2, etc.]. |
|
|
Columns U to Y: Session information |
|||
| U | Session ID | Session ID of the logged-in user | |
| V; W | Execution start time; Execution stop time | Start and end times of the procedure instance | |
| X; Y | Page enter time; Page leave time | Start and end times the visible step was displayed | |
|
Columns Z to AE |
|||
| Z | Post-Its | Number of comments made by users on the visible step | |
| AA | End Type | Information on the type of exit from the procedure instance:
|
|
| AB | SearchUid | ID of the user's search that led to the procedure instance
Note: This is used to define a link with the searchEngine sheet. |
|
| AC | Feedback | Feedback provided in the satisfaction survey:
|
|
| AD | Channel | Mode for viewing the procedure:
|
|
| AE | Agent | Reference of the virtual agent | |
|
Column AF and other columns: Other information |
|||
| One column is created for each variable associated with the extraction profile, other than those already described. | |||
procedures sheet
- This sheet displays information on procedures from the Self Help projects and domains selected when the extraction profile was created.
- Each row corresponds to one visible or invisible step of a procedure version.
| Column | Name of the column | Description | |
|---|---|---|---|
|
Columns A to E: Information on the Self Help project and domain associated with the procedure |
|||
| A; B | Domain ID; Domain name | ID/Name of the domain | |
| C to E | Project Id; Project name; Project version | ID/Name/Version number of the Self Help project | |
|
Columns F to I: Information on the procedure |
|||
| F | Published | Publication status of the procedure:
|
|
| G to I | Procedure UID; Procedure ID; Procedure name | Unique ID/ID/Name of the procedure | |
|
Columns J to N: Information on the writing of the procedure | |||
| J | Creation date | Creation date of the procedure | |
| K | Creation writer | First and last names of the writer who created the procedure
Note: This information is concatenated. |
|
| L | Modification date | Last modification date of the procedure | |
| M | Modification user | First and last names of the writer who last modified the procedure
Note: This information is concatenated. |
|
| N | Entry point | Indicates if the procedure is an entry point and if it can be run by users:
|
|
|
Columns O to Q: Information on the step |
|||
| O; P | Page ID; Page name | ID/Name of the step | |
| Q | Node type | Type of step:
|
|
folders sheet
- This sheet displays information on folders in the Self Help projects and domains selected when the extraction profile was created.
- This information is required for linking execution and writing information with different categories in the Self Help project.
- Each row corresponds to one procedure version present in a folder or subfolder.
- A procedure present in the Start subfolder of the Windows folder will appear twice for each Self Help project version. This is required for calculating indicators that can be grouped by category (level 0 folders) or by sub-category (level 1 folders), etc.
| Column | Name of the column | Description | |
|---|---|---|---|
|
Columns A and B: Information on the procedures in each folder and subfolder |
|||
| A; B | Procedure ID; Procedure UID | ID/Unique ID of the procedure | |
|
Columns C to E: Information on the folder and subfolder |
|||
| C; D | Folder ID; Folder name | ID/Name of the folder | |
| E | depth | Hierarchy level of the folder
|
|
concurrents sheet
- This sheet displays logged activity information.
- Each row corresponds to one event, i.e. start or end of the execution.
- This information can be used to adjust the license usage or to test server load capacity.
| Column | Name of the column | Description | |
|---|---|---|---|
| A | Date | Date of the event, i.e. start or end of the execution | |
| B | Count | Number of sessions opened for the event |
searchEngine sheet
- This sheet displays information on the use of the search engine on the Self Help customer portal.
- Each row corresponds to one procedure returned by the search engine.
- Only the first five procedures returned by a search will be displayed in rows.
example
- The search returns results for three different procedures ==> Three rows will be displayed in the Excel sheet
- The search returns results for ten different procedures ==> Five rows will be displayed in the Excel sheet
| Column | Name of the column | Description | |
|---|---|---|---|
| A | RecordID | ID of the record
Note: This is identical to the search. |
|
| B | SearchTimeMs | Time required for running the search | |
| C | DisplayTimeMs | Time required for displaying the results | |
| D; E | BestRank; WorstRank | Rank awarded by the search engine based on the relevance of the result returned | |
| F | VersionId | ID of the search engine | |
| G; H | UserId; UserLogin | ID/Login of the user who ran the search | |
| I | Session ID | Session ID of the logged-in user | |
| J | Locale | Language used for the search | |
| k | Pattern | Value entered by the user in the search engine | |
| L | DomainId | ID of the domain | |
| M | SearchUid | Unique ID of the search
Note: This is used to link the search to the execution in the executions sheet. |
|
| N | CreationDate | Date and time the search was run | |
| O | CategoriesCount | Number of different categories returned by the search | |
| P | SpellCheck | Search keywords once the NLP engine has made corrections to the spelling
Note: The field is blank if no corrections were made. |
|
| Q | SearchEngineCountResult | Number of results returned by the search tool | |
| R | DecisionCountResult | Number of results returned after analysis based on relevance | |
| S | ResultType | Type of results returned:
|
|
| T | Lemmas | List of significant terms in the user's query | |
| U | Channel | Mode for viewing the procedure:
|
|
| V | Agent | Reference of the virtual agent | |
| W | ScenariosCount | Number of different procedures returned by the search | |
| X; Y | ScenarioUid; ScenarioId | Unique ID/Version ID of the procedure returned by the search engine | |
| Z | ScenarioRank | Rank awarded to the procedure returned by the search engine |
skipped sheet
- This sheet displays the database records that were not included in the extraction.
- An error message describes the problem for each record.
| Column | Name of the column | Description | |
|---|---|---|---|
|
Columns A to K: Information on the execution, Self Help project and domain related to the record |
|||
| A | Execution ID | ID of the execution | |
| B; C | Entrypoint ID; Entrypoint name | ID/Name of the execution entry point | |
| D to F | Project Id; Project name; Project version | ID/Name/Version number of the Self Help project | |
| G | Published | Publication status of the procedure:
|
|
| H; I | Domain ID; Domain name | ID/Name of the domain | |
|
Columns J and K: Information on the record |
|||
| J | Date | Creation date of the record | |
| K | Error message | Error message describing the problem | |