Overview
Keyword query strings have multiple characteristics such as the string length, the number of words, uppercase or lowercase status, and so on. For a given keyword query string, the Keyword Characteristics enricher calculates and persists:
- Whether the query contains special characters
- The number of tokens contained in the query
- The number of characters contained in the query
- The use of uppercase and lowercase characters
- The use of meta characters
- A representation of all of the preceding characteristics
Events
The keyword search event, stored in the Context service, triggers the Keyword Characteristics Enricher. The enricher extracts the ID of a KeywordSearch node from the event and associates that node with metadata about the keyword search term in question.
| Triggered by Schema | Payload schema | Payload example |
|---|---|---|
context/commerce/KeywordSearch | Schema | {'eventType': 'KeywordCharacteristicsServiceMessage','payload': {'id':'ID_of_targeted_KeywordSearch_node','consentRefId':'someConsentReferenceId'} } |
The Keyword Characteristics Enricher draws an edge between the session node and the campaign node in the graph database, as shown. For more information, see the Secure Graph service documentation.
| Node or Relation | properties |
|---|---|
nodes/commerce/CharacterCount | |
nodes/commerce/CharacterProperties | |
nodes/commerce/MetaCharacters | |
nodes/commerce/SpecialCharacters | |
nodes/commerce/TokenCount | |
nodes/commerce/UpperLowerCase | |
relations/commerce/KeywordSearch/commerce/CharacterCount/commerce/HAS | |
relations/commerce/KeywordSearch/commerce/CharacterProperties/commerce/HAS | |
relations/commerce/KeywordSearch/commerce/MetaCharacters/commerce/HAS | |
relations/commerce/KeywordSearch/commerce/SpecialCharacters/commerce/HAS | |
relations/commerce/KeywordSearch/commerce/TokenCount/commerce/HAS | |
relations/commerce/KeywordSearch/commerce/UpperLowerCase/commerce/HAS |
Metamodel
Enrichers react to one or more schema events. A schema event references a context, a node, an edge, or a property; for example, a keyword search context, the creation of a new product node, the update of an edge between product and cart nodes, or the update of an edge property. In response to a triggering schema, the enricher retrieves the complete event data from the context service, enriches this data, and updates the graph accordingly. Enrichers can only affect their declared schemas in the graph.
The following interactive graphic displays the schemas that invoke this enricher and the schemas the enricher can affect in the graph.
To zoom in and out of the image, use the scroll wheel on your mouse. To pan the image, click on the background and drag.
Scopes
Scopes are strings that represent permission to access specific resources and/or operations. For example, a scope string may represent permission to write data to a data repository.
Scopes
hybris.profile_graph_view: Use this scope to view data in the graph.
hybris.profile_graph_manage: Use this scope to update data in the graph.
Glossary
| Term | Description |
|---|---|
| authorization | The process of determining whether a given microservice has permission to gain consent. |
| consent | Permission to access (read, write) specific profile data, for example, permission to read/write age estimation or physical address. A consumer and a tenant can grant and revoke consent for subsets of their respective data. |
| consent class | A string alias, defined by developers, that references a set of profile data (also called "schemas") for which consent can be granted and revoked. This string is exposed to users (consumers and tenants) as a reference through which they control consent. For example, the consent class "Purchases" might reference a set of data that includes items purchased, purchase dates, and purchase prices. Toggling consent for "Purchase" would enable and disable consent for that entire set of data. |
| consent reference | A unique, randomized string that serves as a passcode to decrypt data associated with one or more schemas. Various service calls require a consent reference. |
| consumer | The end user whose actions yield profile data in the graph. A profile describes a single consumer. |
| context | Data that affects the state of the graph. This data can be collected from consumer-triggered events or from third-party sources such as weather stations. |
| Context Adapter | A microservice that receives data and, optionally, adapts it for entry into the graph. For example, a context adapter can adapt address data by adding a ZIP code and normalizing the street labels (for example, changing "St" to "Street"). The context adapter then passes the data through the Context service, which caches it so that enrichers can subsequently persist the data in the graph. |
| context repository | A temporary cache for adapted context data, before it is further processed by enrichers and persisted in the graph. |
| context service | An internal microservice that manages the insertion of, and the retrieval of, context data in the Context Repository. |
| encryption key | A unique, randomized string used to encrypt and decrypt specific data in the graph. Each data element is encrypted with a different encryption key. Decryption, using this key, is required to access, view, and alter the data. |
| enricher | A microservice that retrieves data from the Context Repository and/or Graph, possibly alters or extends it, and then persists data in the graph. An enricher can interpret data points, or sets of data points, to yield new data to persist. For example, an enricher can interpret purchasing data and contemporaneous weather station data to yield new data indicating that the consumer is a rainy-day shopper. |
| graph | The database that stores profile data as nodes, edges, and properties, and allows semantic queries. |
| identity | One of many independent units of data used to identify a unique profile, such as an email address, browser type, or version. |
| profile | Data about a single consumer, collected and derived from events that are triggered by, or are logically associated, with that consumer. |
| schema | A string representation of a path in the graph that represents an abstraction, rather than a concrete instance, of a particular data structure. |
| tenant | A registered entity with a shared commercial goal that subscribes to SAP Hybris Profile services and packages to reach that goal. A tenant can also develop and contribute enrichers and context adapters to the SAP Hybris Profile suite. Within YaaS, a tenant is a project. |
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Use our private help channel. Receive updates over email and contact our specialists directly.
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.