This page defines the terminology used with Attraqt Fredhopper Managed Services.
Services
Service = A software product offered as a service
Fredhopper offers the following services:
| Attraqt Fredhopper Services | Short name |
|---|---|
| Onsite Search & Targeting | fas |
| Predictive Targeting - Search Suggest | suggest |
Service Instances
Service Instance = Each unique occurrence of a Service
A Fredhopper Service includes one Service Instance.
Additional Service Instances can be ordered as needed.
| Service Instances | Description |
|---|---|
| live1 | The default Service Instance |
| test1 | An example of an extra Service Instance |
Environment
Environment is a name assigned to a particular set of service instances that fulfill a business function. An example environment "production" could be defined as using the fas:live1, suggest:live1, and upload:live1 service instances.
The customer defines environments, and those are documented in the solution template.
Configuration States
Configuration State = the State of the configuration of a Service Instance, Published or Prepublished
| Configuration State | Description |
|---|---|
| published | Configuration visible to all users |
| prepublished | Configuration visible to users with preview rights (business managers) |
Interfaces
Interface = a way to request functions from a Service
| Interface | Short name | Description |
|---|---|---|
| Query API | query | The Query API is the way to send queries to Fredhopper via SOAP/REST like e.g. Give me all red t-shirt for less than 50 EUR |
| Fredhopper Services API | my | The Attraqt Fredhopper Services API is the way to upload/download data and control processes, like e.g. start re-index |
| Merchandising Studio | bm | The Merchandising Studio is the way for business managers to change the response of the Fredhopper Service, e.g. Add a promotion |
Endpoints
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.
The table below lists common endpoints.
| Endpoint | Description |
|---|---|
| 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 |
Regions
Region = a global area in which a service is provided.
| Region | Description |
|---|---|
| eu1 | Europe |
| us1 | US (west) |
Maintenance Window
Our company uses a regular weekly time frame to apply changes to the managed services infrastructure. For detailed information about this, check the Maintenance Window article.
Comments
0 comments
Please sign in to leave a comment.