Usage Analysis

Installation and Configuration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.

These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes or other protected rights.

The dissemination, publication or reproduction hereof is prohibited.

For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.

.

IntroductionPermanent link for this heading

The Usage Analysis records selected actions during seach usage. E.g. Paging on result list, opening the preview. app.telemetry can display those actions. In the future, these data could be used for improving the result ranking.

PreparationPermanent link for this heading

First, in app.telemetry a new log-pool must be created. Name of the pool: “Client Service Query Log”, Application: “Mindbreeze”, Application Tier: “Client Service Query Log”, Database: “telemetrydb”, Database Table Prefix: “client_service_query_log”, Permanent Software-Telemetry Log-Level: “Standard”.

After that, logdefinitions must be imported. For details, see Installation-of-Fabasoft-AppTelemetry-Log-Pools

AnalysisPermanent link for this heading

Now, new usage actions are being recorded in the log-pool.

The following actions are supported:

Search queries

Search constraints

Next page in result list

Preview

Open/Close

Scrolling

Open search result

Columns in the Client Service Query Log Log PoolPermanent link for this heading

Column

Description

Start Time

Start time of action

Duration

Duration of the action in ms, currently only filled by the QUERY-actions

Running

Is the action still running

Service

Name of the triggering Client Services

Agent

Mindbreeze InSpire Appliance of the triggering Client Services

Errors

Always 0

Action Trigger

Always empty

Action

QUERY

Search

QUERY_RESULT

Single result

PAGENEXT

Turn over to next page

PAGING_RESULT

Single result after turning over

PREVIEW

Preview

PREVIEWCLOSED

Preview closed

OPENHREF

Result opened

VOTE

Result rated

SENDFEEDBACK

Feedback

Operation

QUERY

Search

PAGENEXT

Turn over to next page

QUERY_RESULT_ACTION

Action on the result (i.e. by the action PREVIEW and OPENHREF)

Action Target

QUERY

Action concerns the search

RESULT

Action concerns the result

Search User

User name

Session ID

ID of the user session. A new session gets started if:

The search term has been changed AND

The last term was a minute ago

The ID can be the same for multiple users.

The ID can also be assigned multiple times if started from multiple tabs or windows.

Query ID

ID for tracking a search. The ID gets changed if the search term changes.

The ID can be the same for multiple users.

The ID can also be assigned multiple times if started from multiple tabs or windows.

Refinement ID

ID for tracking the restrictions of a search. The ID changes if the restrictions change.

The ID can be the same for multiple users.

The ID can also be assigned multiple times if started from multiple tabs or windows.

Previous Query ID

Query ID of the previous search. For the purpose of tracking a search.

Previous Refinement ID

Refinement ID of the previous search. For the purpose of tracking a search.

Referer

URL of the invoking page

Referer Host

Host name of the invoking page

Referer Port

Port of the invoking page

Referer Path

URL path of the invoking page

Session Description

Field session_description of UserContexts from the search request

Query

Search term

Query Expr

Structured search term

Query Constraint

Used restrictions

Relevance Parameters

Used relevancy parameters

Order By

Sorting criteria

Request Name

Field name of the search

Order Direction

Sorting direction

Results

Amount of delivered results

Total Count

Total amount of findable hits of the current search for the user

Extend Tab ID

Always empty

Tab ID

ID of the selected search tab

No Results

TRUE

No results were found

FALSE

Results were found

Termination Cause

COUNT_LIMIT

Requested amount of results was delivered

NO_MORE_RESULTS

No further results available

TIMEOUT

The search took longer than configured

Result ID

ID of the result

Result Position

Position of the result in the result list

Weight

Weight of the action

Action

Weight

PREVIEW

50

OPENHREF

100

VOTE UP

100

VOTE DOWN

-100

SENDFEEDBACK

Deposited by feedback

Duration (ms)

Duration of the action in the browser (currently filled only by PREVIEWCLOSED)

Scroll position (%)

How much percent of the results has been looked at

FQCategory

fqcategory of the concerned results

Comment

Comment at feedback

Key

Key of the concerned result

User Session

Not in use

ID

ID of row

Custom Property 1 – Custom Property 9

Values for the under Client Service settings “Personalization Setting” configured entries

Custom Properties Mapping CRC

Checksum of the Client Service settings under “Personalization Settings”. For the purpose of recognizing changes of the settings.

Process ID

PID the invoking Client Services

Thread ID

Thread ID the processing thread of the invoking Client Services