Glossary

The following table outlines common terminology used.

Term
Definition

A/B test

The entity representing all information concerning a test with two or multiple versions of a single page.

Action

A verb explaining the action a user performed on your site, such as: click, view etc.

Activity

An object representing an action a shopper made on a target with all accompanying details.

Analyser

Component invoked in the Merchandising Studio that performs textual modifications on search terms such as stemming or the removal of stop words; each language has its own analyser.

Analytics

The discovery and communication of meaningful patterns in data. Vendors include Google, Coremetrics, and Omniture.

anonymous id

An anonymous ID such as a session id.

Attribute

A type of data construct that is shared across items (e.g. brand, size or colour).

Attribute value

Data assigned against an attribute for a particular item.

Batch of updates

Capability to transfer item catalog updates batched together for the purpose of balancing responsiveness with cost of network.

Category

Capability to group together several products by a similarity. Categories typically have hierarchical relation among each other.

Checkout

Your basket overview/checkout page.

Configuration

Refers to Fredhopper Configuration which holds basic environment settings, search configuration and business rules.

Configuration state

The configuration of a service instance, i.e. published (visible to all users) or pre-published (visible to users with preview rights only).

Custom actions

A list of actions configured specifically for you to serve a special use case.

Data enrichment

The term given to the process of amending / adding value or meaning to an attribute value (e.g. deriving an availability flag based on stock levels) - generally executed in the Data Manager

Data feed

A data enrichment is data which needs to be included together with the catalog during DSP ETL processing. Enrichments are also named feeds to highlight the possibility of various sources of data not necessarily the client: data that is not catalog, or is seen as INC, or coming from partners, or coming from other places than the client itself, or coming separately from the client but not with the main catalog.

Data items

Data items include not only products but also content.

Data Manager (DM)

Fredhopper Data Manager - Enriched version of the ETL tool Pentaho PDI (also known as Pentaho Kettle) Metadata-driven Extraction, Transformation and Loading (ETL) capability.

Data source

A document or product which provides data input to the Data Manager application.

Data transformations

The steps executed in the ETL process, to transform input data (usually csv files) into a Fredhopper readable format, called FAS-XML. Generally executed in the Data Manager.

Data version

A version is a generated or a given Id for stored data. Autogenerated versions are returned to client e.g. when the upload finishes. Clients may sometimes be able to specify under which version Id the data should be stored for purposes of grouping streaming or incremental data together for later reference in some downstream process.

Data workflows

A data workflow is a business operation applied on client accounts and/or environments. E.g. the client wants to use git-similar workflows: branch off one environment, work on this data+config branch, then when ready schedule a merge on the live environment branch.

Endpoint

An endpoint is provided by a service instance for a particular combination of an interface and a configuration state. Not all combinations of interface and configuration state are possible and define a valid endpoint. Common endpoints: - query.published: Endpoint for the query interface of the published configuration state, used by a frontend to query FAS. - query.prepublished: Endpoint for the query interface of the prepublished configuration state, used by a preview/test frontend to query FAS.

Environment

An environment is a distinct entity within a tenant, representing a specific configuration for the deployment and use of the Product Discovery features on customer side. It is used to separate different instances or versions of the application according to the customer’s needs, whether these relate to the development, test or production phase. Some customers may have a specific environment for each country in which they operate. A logically separated environment to be tracked i.e. a version of your website for a particular country/region. A full Fredhopper setup consisting of Data Manager, indexer and query instances which covers the full pipeline from customer data pickup to content delivery

Event

A synonym for activity.

Facet

A property used for navigation/filtering such as color.

FAS

An acronym for "Fredhopper Access Server" - the Fredhopper component which provides a query server.

FAS-XML

The term associated with the file format which represents enriched catalogue information; this is typically constructed by the Data Manager.

Fredhopper (FHR)

Fredhopper - Platform for Search, Navigation and Merchandising.

Full (catalog) update

A full update contains the full catalog of the client. The full update is uploaded by the client and a version is assigned to it. The client may then trigger processing of this catalog version on a given environment. The client may experience this as a delete operation or cleanup of their environment and a fresh setup available with the newly uploaded catalog. A full update may supply new structural attributes compared to a previous version of a catalog, and in the data this may trigger complete reconfiguration of downstream services such as search.

Full Re-Index

A process whereby previous catalogue data in FAS is implicitly deleted and entirely replaced by new data, via the conversion of FAS-XML into indices.

Generic actions

A list of actions available by default necessary for proper tracking with our services.

Identity

An ID representing the user in our system for tracking user journeys.

Identity repository

A representation of storage for an identity type in our system.

Identity slug

An identifier/name for an identity, such as "sessionId" for a session id.

Incremental (catalog) update

An incremental contains a small update to the client s catalog. The method can vary: streaming, mini-batches, a zip. The INC is always done on top of an existing FULL state or baseline, which means any structural attributes and data stay more stable, compared to how a Full update may impact the system services.

Indexer

The name given to an offline server in the Fredhopper deployment which encompasses the Data Manager; Merchandising Studio and a query server too. Business rules and catalogue data are propagated to the query servers from this location.

Indices

A binary data structure which contains indexed data provided via the FAS-XML; this is the data source referenced by the query server.

Insights

The analytics component of the FHR platform.

Instance

An instance represents a single occurrence of an installation (e.g. a Data Manager instance or a Fredhopper instance). The instance is based on the functionality of the installation, but will have a configuration specific to it.

Item

Entities which can be searched or browsed for. An item encompasses the concept of master products (products) and - optionally - SKUs (variants).

Item store

An index file which contains all attributes and attribute values for items defined within FAS-XML.

Lister page

A catch-all term for navigation/search results pages, i.e. a non-product detail page.

Live attribute

The term associated with an attribute defined within the Merchandising Studio to be included in the navigation index. An attribute must be 'live' in order to power a navigation facet.

Load Balancing

Computer networking method to distribute workload across a cluster of servers. In a Fredhopper deployment, this is the software or hardware which forwards incoming queries across all of the active query servers.

Locale

A country / language combination expressed in a standardised format, for example, en_GB for English for Great Britain; en_US for English for the US.

Localisation

The ability to present different attribute values for different locales.

Logged-in (known) ID

A known ID for identifying the user between journeys corresponding to an internal ID in your system, such as an ecommerce id.

Managed Services

The term associated with Fredhopper software provided as a Service.

Merchandising

Refers to the variety of products available for sale and the display of those products in such a way that it stimulates interest and entices customers to make a purchase.

Merchandising Studio

The front-end application used for managing your FHR integration.

Minimum coverage

A configurable display condition setting within the Merchandising Studio relative to navigation facets; restrains display unless a certain percentage of items in the Fredhopper response has a value for a particular attribute.

Monitoring

The process of collecting and actively analysing deployment state data. Relative to Fredhopper, typical activities can be verifying the status of a re-index or availability of a query server.

Navigation index

An index (indice) file which contains all attribute values for live attributes

Navigation page

A page reached via the navigation on your side, such as opening a category.

On premise

The term associated with Fredhopper software being deployed on a non Fredhopper hosted environment.

Path (Merchandising Studio)

A count of query interactions relative to the homepage. For example, clicking on a facet value or a pagination link both correspond to +1 in terms of the path count. This functionality can be used to dictate when a facet should be displayed or indeed when Fredhopper should switch from servicing responses with a summary path template to a lister page template.

PIM

An acronym for "Product Information Management" - this is typically an application which hosts product information content.

Presentation field

The term associated with any attribute defined to be returned as part of the Fredhopper response.

Product

The entity of an item (which may or may not be referenced by variants) that resides within a primary universe.

Product detail page

A page with details for a concrete product.

Product hierarchy

Capability to categorize products based on hierarchical decomposition. For example, some products can be "electronics" with further categorization in "computer" and "camera". where all cameras belong to electronics as well.

Professional Services (PS)

The branch of Fredhopper that provides consultants who support and assist clients in implementing Fredhopper software.

Publishing

The act of broadcasting business rules from the indexer to the query servers in the Fredhopper deployment topology.

QPS

An acronym for "Queries Per Second" - this is a numeric metric which shows, on average, the traffic load presented to Fredhopper from a front-end application.

Query engine

The layer of any Fredhopper instance (online or offline) which parses incoming query API requests and generates the Fredhopper response.

Ranking

The name given to a rule within the Merchandising Studio which defines the metric(s) or relationship which governs the relative sequence by which items should be returned within the Fredhopper query response.

Ranking Cocktail

The term given to the process of merging multiple input metrics to create a single output metric for the purpose of ranking. Unlike traditional ranking approaches, ranking cocktails should avoid the threat of attribute starvation.

Redirect

The name given to a rule within the Merchandising Studio which, for a given set of terms, will return a user defined URL in the Fredhopper response - rather than a search result set of items - for a given input search term. Common redirect input search terms configured to be redirects are: 'contact', 'open times' and 'careers'.

Region

A global area in which a service is provided, e.g. eu1 (Europe), us1 (US (west)), ap2 (Australia (Sydney)).

Reporting dashboard

The front-end application used for viewing the analytics provided by Insights.

Result Modification

Functionality within the Merchandising Studio which allows a user to overrule the outcome of a navigation or search query. For example, blocking, promoting or demoting products or groups of products.

Search index

An index file which contains analysed attribute values for attributes used in search.

Search pass

A particular phase of the overall search algorithm. Typically these are configured to meet a particular purpose, e.g. ID search.

Search profile

A means of querying Fredhopper behind a virtual 'mask'. Search profiles can be defined to ignore particular search passes of even attributes.

Search refinements

Phrase associated with the user action of selecting facet values during navigation

Search results page

A page with search results reached via searching on your site.

Service type

Fredhopper offers multiple services: Fredhopper Access Server (FAS), Suggest as well as the Upload Service.

session id

The default ID necessary for tracking activites. Corresponds to a user and a device.

Sorting

Similar to ranking; however we define sorting to be the user controlled activity performed on the generated page, while ranking is a business user activity performed in the Merchandising Studio. For example, Mens > Sale may be configured to be ranked by a combination of unit sales and margin as part of a business rule. We would define that to be ranking. When the user opts to view items by price in ascending order, we call this sorting.

Staging

The environment in a Fredhopper deployment that is used for integration testing purposes.

Standard CSV Set

Term used to describe the basic data input format expected by Fredhopper. Consists of four CSV files (no variants) or six files (variants present) that describe the relationship between categories, items and attributes. Can be read by the Standard Transformations (see Standard Transformations).

Standard JSON Set

Term used to describe the basic data input format expected by Fredhopper. Consists of two JSON files (no variants) or three files (variants present) that describe the relationship between categories, items and attributes. Can be read by the Standard Transformations (see Standard Transformations).

Standard transformations

A standardised set of Transformations (see Data Transformations), that work for standardised data input files (see Standard CSV Set or Standard JSON Set). For advanced functionality or different input formatting, customisation of this set is mandatory.

Streaming API

Capability to ingest parallel streams of data at high rate, scalable. Capability to ingest granular updates, e.g., for product items - single attribute value update on a single product. Capability to timestamp for consistency recovery.

Synonym

A word or phrase that means exactly or nearly the same as another word or phrase in the same language. Used to rectify search queries that lead to poor results.

Target

The target of the action such as a page, product, facet etc.

Targeting

The term associated with the process of reacting to a defined situation. Example triggers may be current browsing behaviour (such as visiting a specific catalogue location) or - more commonly - past preferences or transaction history

Technical Consultant (TC)

A rather technical person in Attraqt who helps the customer integrate against APIs. They are our technical specialist in contact with the client.

Tenant

A tenant represents a customer or group of customers using Product Discovery features. It is a distinct entity with its own users, service accounts, environments and specific configurations. This allows for the segmentation and management of resources and permissions in an isolated and secure way for each customer or group of customers.

Tracker key

A unique identifier provided to you by Attraqt which corresponds to a single environment.

Trigger

An event upon which actions can be executed. There are two types of triggers that are used in the Fredhopper context: Internal triggers that are dependent on the result that is generated upon a request to Fredhopper; and external triggers - the latter are defined URL parameters (and their values) which can be delivered together with a Fredhopper Location inside a query (the Location itself can also be used for triggering). Typically, internal triggers are fixed while external triggers can be customized to the your needs.

Universe

A Universe is the highest level of a hierarchy which contains all the items in a web store; in other words, its catalogue. A universe can be further broken down into categories, sub-categories, and so on. Typical Fredhopper implementations feature just one universe, though multiple universe deployments are also supported. Universes are strictly segregated - they cannot communicate with each other or interact in any way. The documentation refers to catalog01 as the name of the universe in most examples.

User

The shopper accessing your website.

User journey

A chain of actions a user performs in one visit on your webite.

User Location

Refers to a particular catalogue location combination. For example, the following two user locations are different: home > mens > sale and home > sale > mens.

Variant

The entity of an item which must reference a product that resides within a secondary universe.

Variant/variation

A version of a page linked to a particular A/B test.

Weight (of a variant)

The percentage of users which will be assigned to that variant.

XO

The Experience Orchestrator platform.

Last updated