### Glossary entries for the Synerise documentation site.
### Each entry has the following fields:
###   id         - unique identifier, used to reference the term in other entries or pages
###   title      - display name of the term
###   short      - one-sentence plain-text definition, used in tooltips and previews
###   long       - full definition with Markdown formatting (supports lists, links, bold, etc.)
###   link       - internal docs path for "Learn more" links (optional)
###   components - list of Synerise UI components this term belongs to (optional)
###   seealso    - list of related entry `id` values (optional)
### Entries are grouped by product area with section comments (e.g. ### AUTOMATION ###).


### AUTOMATION ###

- id: "automation-module"
  title: "Automation Hub"
  short: "The component in the Synerise platform where you can create workflows (automated scenarios)"
  long: "In Automation Hub, you can build scenarios triggered by profile actions, schedules, or business-oriented triggers. These scenarios can import, export, and transform data; send messages; and more."
  link: "/docs/automation"
  components: 
    - "Automation Hub"
  seealso:
    - "workflow"
    - "synerise-platform"
    - "profile"
    - "business-workflow"
- id: "business-workflow"
  title: "Business workflow"
  short: "Triggered by a business event, for example an external data request"
  long: |
    A type of workflow which is used for automating non-profile processes such as importing and exporting data, integrating with external services.
    - Such a workflow can be triggered by receiving data requests from external tools (for example, an ecommerce platform) or by the [Scheduled Run node](/docs/automation/triggers/scheduled-run/). The data from Synerise can be sent to external tools in response to circumstances specified in the workflow. 
    - To build such a workflow, you can use only business-oriented nodes. When you start building a workflow and use a **Business trigger**, the library of nodes will only contain the nodes that can be used in a business-oriented workflow.
    - In business workflows, you can't use profile-related Synerise Jinjava such as profile attributes, aggregates and expressions.
  link: "/docs/automation/creating-automation"
  components:
    - "Automation Hub"
  seealso: 
    - "profile-oriented-workflow"
    - "workflow"
    - "node"
    - "connection"
- id: "profile-oriented-workflow"
  title: "Profile-oriented workflow"
  short: "A workflow which runs in context of a customer's profile"
  long: |
    A type of workflow which is usually oriented towards performing an action towards a profile, for example updating their data or sending a message.
    - Such a workflow can be triggered:
        - by a defined activity of a profile or the infrastructure's activity towards the profile. 
        - by a change in a profile's data.
        - manually or periodically for a selected group or groups of profiles.
    - In such a workflow, you can use only profile-oriented nodes. When you start building a workflow and use **Profile trigger**, the library of nodes will only contain the nodes that can be used in this type of workflows.  
    - In profile-oriented workflows, you can use the Synerise Jinjava related to profile attributes.
  link: "/docs/automation/creating-automation"
  components:
    - "Automation Hub"
  seealso: 
    - "business-workflow"
    - "workflow"
    - "node"
    - "profile"
- id: "aes"
  title: "AES"
  short: "A type of encryption key that secures data"
  long: |
    AES (Advanced Encryption Standard) is a type of encryption key that secures data. AES is a symmetric encryption algorithm where the same key is used for both encryption and decryption, making it efficient for fast and bulk data encryption.  

    **Synerise supports only AES-256 keys**.
  link: "/docs/settings/data-exchange-encryption/#aes-keys"
  components:
    - "Automation Hub"
    - "Settings"
  seealso: 
    - "data-exchange-encryption"
    - "kek"
    - "dek"
- id: "workflow"
  title: "Workflow"
  short: "A sequence of nodes that describe a scenario"
  long: |
    A sequence of nodes that together describe a scenario and define the course of actions to be performed in defined circumstances. This term refers to the concept of an automated process whose subject is a profile (profile-oriented workflow) or a process involving retrieving or sending out data (business workflow). The structure of the workflow is referred to in the documentation as a **diagram**. 

    Each workflow can last 60 days. After those 60 days, if a user is stuck in the workflow (for example, they didn't meet the conditions in an **Event Filter**), the workflow is automatically finished.
  link: "/docs/automation/creating-automation/#basic-information"
  components:
    - "Automation Hub"
  seealso:
    - "canvas"
    - "diagram"
    - "business-workflow"
    - "profile-oriented-workflow"
    - "profile"
- id: "canvas"
  title: "Canvas"
  short: "The area on the interface where you create a diagram."
  long: "The area on the interface where you create a diagram."
  link: "/docs/automation/creating-automation/#basic-information"
  components:
    - "Automation Hub"
  seealso:
    - "workflow"
    - "business-workflow"
- id: "connection"
  components:
    - "Automation Hub"
  title: "Connection"
  short: "A connection refers to the authorization or authentication linkage established between Synerise and an external source. It serves as a preliminary step within a workflow, enabling secure requests to be sent to the external service."
  long: "A connection refers to the authorization or authentication linkage established between Synerise and an external source. It serves as a preliminary step within a workflow, enabling secure requests to be sent to the external service."
  link: "/docs/settings/tool/connections/"
  seealso:
    - "canvas"
    - "node"
- id: "dek"
  components:
    - "Automation Hub"
    - "Settings"
  title: "Data Encryption Key (DEK)"
  short: "Key used to encrypt and decrypt data"
  long: "This key is used to encrypt and decrypt data. If you want to add an encryption key in Synerise, you must protect your DEK with a key encryption key (KEK). This key encryption key can be obtained while [adding the encryption key in Synerise](/docs/settings/data-exchange-encryption/). The secured DEK can then be used as a key to decrypt or encrypt data coming into or going out of Synerise."
  link: "/docs/settings/data-exchange-encryption/#aes-keys"
  seealso:
    - "data-exchange-encryption"
    - "kek"
    - "aes"
- id: "data-exchange-encryption"
  components:
    - "Automation Hub"
    - "Settings"
  title: "Data exchange encryption"
  short: "Enhances the protection of data within transfers"
  long: "Data exchange encryption in Synerise enhances data security during transfers by allowing businesses to encrypt outgoing data and decrypt incoming data using RSA or AES keys added to the workspace. Using these keys with the [Encrypt Data](/docs/automation/data-transformation-and-imports/transformations-and-data-operators/encrypt-data/) and [Decrypt Data](/docs/automation/data-transformation-and-imports/transformations-and-data-operators/decrypt-data/) nodes in [data transformation rules](/docs/automation/data-transformation-and-imports/creating-data-transformation/), enables secure file exchanges with external sources."
  link: "/docs/settings/data-exchange-encryption/#aes-keys"
  seealso:
    - "rsa"
    - "aes"
    - "dek"
    - "kek"
- id: "data-transformation"
  components:
    - "Automation Hub"
  title: "Data transformation"
  short: "Allows you to modify data in progress of a workflow."
  long: "A sequence of transformation nodes (different than automation nodes) which are put together to make modifications to an input (for example, a CSV file) and then return an output that can be used, for example, to import data. Such a transformation is inserted into a workflow by using the [Data Transformation node](/docs/automation/operation/data-transformation-node/)."
  link: "/docs/automation/data-transformation-and-imports/"
  seealso:
    - "workflow"
- id: "diagram"
  components:
    - "Automation Hub"
  title: "Diagram"
  short: "The structure of a workflow."
  long: "The definition of a workflow — a sequence of connected nodes, which must have at least one trigger (start) and at least one end. On the user interface, the view where you edit the diagram is called a canvas."
  link: "/docs/automation/creating-automation"
  seealso:
    - "workflow"
    - "canvas"
    - "node"
- id: "executed"
  components:
    - "Automation Hub"
  title: "Executed"
  short: "The statistic of how many times a node was completed."
  long: "One of the counters in a node's statistics. Shows how many times the node was completed."
  link: "/docs/automation/automation-activity-tracking/#node-statistics"
  seealso:
    - "statistics-automation"
    - "entered"
    - "finished"
    - "node"
- id: "entered"
  components:
    - "Automation Hub"
  title: "Entered"
  short: "The statistic of how many times a node was started."
  long: "One of the counters in a node's statistics. Shows how many times the node was started (a profile arrived at it)."
  link: "/docs/automation/automation-activity-tracking/#node-statistics"
  seealso:
    - "statistics-automation"
    - "executed"
    - "finished"
- id: "event-context"
  components:
    - "Automation Hub"
  title: "Event context"
  short: "Event information from Profile Event and Event Filter nodes."
  long: |
    Event information carried through the nodes in a workflow. The event context is first defined in the Profile Event node and it changes with every Event Filter node in a workflow. Users are allowed to refer to the event context in the node settings, for example, to retrieve specific event data such as the ID of the viewed item. For detailed instructions, go to ["Event parameters" section in the Automation inserts article](/developers/inserts/automation/#event-parameters). 
  link: "/docs/automation/event-params-reuse/"
  seealso:
    - "workflow"
    - "node"
    - "user"
- id: "finished"
  components:
    - "Automation Hub"
  title: "Finished"
  short: "The number of workflow completions."
  long: "The number of workflow completions. The number is not equal to the number of unique completions of the workflow — a profile or a process can repeat within a workflow multiple times (if the node and workflow limits allow it)."
  link: "/docs/automation/automation-activity-tracking/#workflow-statistics"
  seealso: 
    - "started"
    - "in-workflow"
- id: "goal"
  components:
    - "Automation Hub"
  title: "Goal"
  short: "The purpose of a data transformation, helpful in creating the rules."
  long: It is selected at the beginning of the data transformation and is designed to help you tailor your output data to meet the import requirements for specific object types. There are standard goals for importing transactions, events, and profiles into Synerise. These goals guide you in mapping your data correctly to ensure successful import.
  link: "/docs/automation/data-transformation-and-imports/creating-data-transformation/#select-a-goal"
  seealso:
    - "data-transformation"
- id: "incoming-integration"
  components:
    - "Automation Hub"
  title: "Incoming integration"
  short: "A custom Synerise endpoint which accepts external requests."
  long: "This is a custom Synerise endpoint to which requests from external systems can be sent. The incoming integrations are used in the Business Event nodes, which trigger business workflows."
  link: "/docs/automation/integration/incoming-webhook-node/"
  seealso:
    - "outgoing-integration"
    - "node"
- id: "insights"
  components:
    - "Automation Hub"
  title: "Insights"
  short: "A tab on the canvas with information about messages created by the workflow."
  long: "This is the tab available on the workflow canvas. It contains collective information about communication (messages) that will be created by the workflow. This section also contains suggestions on actions you may want to take, such as updating message templates used in a workflow to the latest version."
  link: "/docs/automation/creating-automation/#basic-information"
  seealso:
    - "canvas"
- id: "issues"
  components:
    - "Automation Hub"
  title: "Issues"
  short: "A tab on the canvas with a list of problems"
  long: "This is the tab available on the workflow canvas. It contains all issues that need to be addressed in order to activate the workflow, for example, missing connections between nodes, missing title of the workflow, and so on."
  link: "/docs/automation/creating-automation/#basic-information"
  seealso:
    - "canvas"
- id: "in-workflow"
  components:
    - "Automation Hub"
  title: "In workflow"
  short: "The number of workflows currently in progress."
  long: "The number of workflow instances currently in progress - the count of active workflow runs that have started but not yet completed. These statistics are shown on the workflows list to inform you how many workflows are still ongoing."
  link: "/docs/automation/automation-activity-tracking/#workflow-statistics"
  seealso:
    - "started"
    - "finished"
    - "workflow"
- id: "kek"
  components:
    - "Automation Hub"
    - "Settings"
  title: "Key Encryption Key (KEK)"
  short: "A key needed to encrypt and decrypt the Data Encryption Key (DEK)"
  long: "This is an asymmetric key used to encrypt and decrypt the Data Encryption Key (DEK). It is used to protect the DEK itself, ensuring that it remains secure and accessible only to authorized users. The public part of the key can be retrieved in **Settings > Data exchange encryption** and it's used only for the process of adding the AES key to Synerise."
  link: "/docs/settings/data-exchange-encryption"
  seealso:
    - "aes"
    - "dek"
    - "rsa"
- id: "node"
  components:
    - "Automation Hub"
  title: "Node"
  short: "An element of a workflow"
  long: "A building element of the workflow. There are several types of nodes: [triggers](/docs/automation/triggers/), [flow control](/docs/automation/flow-control/), [conditions](/docs/automation/conditions/), [actions](/docs/automation/actions/), and [integrations](/docs/automation/integration/)."
  link: "/docs/automation"
  seealso:
    - "workflow"
    - "diagram"
# - 
#   id: node-context-menu
#   components: ["Automation Hub"]
#   title: "Node Context menu"
#   short: "A menu "
#   long: ""
#   link: ""
#   seealso: []
- id: "outgoing-integration"
  components:
    - "Automation Hub"
  title: "Outgoing integration"
  short: "Allows you to send data to an external source or API"
  long: "Outgoing integrations let you send data to a third-party service or an API, including the Synerise API."
  link: "/docs/automation/integration/outgoing-webhook/"
  seealso:
    - "incoming-integration"
- id: "path"
  components:
    - "Automation Hub"
  title: "Path"
  short: "The progression of a profile in a workflow"
  long: "A profile starts a path every time they meet the requirements of the trigger of a workflow and the path shows a progression of a profile in a workflow. Depending on the configuration, a profile may have several active paths in the same workflow at the same time. This term is related only to profile-oriented workflows."
  link: "/docs/automation/changes-to-workflow-logic"
  seealso:
    - "profile"
    - "workflow"
    - "profile-oriented-workflow"
- id: "pending"
  components:
    - "Automation Hub"
  title: "Pending"
  short: "The number of profiles waiting for a node's conditions to be fulfilled"
  long: "The number of profiles waiting for a node's conditions to be fulfilled; for example the time required by the [\"Delay\" node](/docs/automation/flow-control/delay-node/)."
  link: "/docs/automation/automation-activity-tracking/#node-statistics"
  seealso:
    - "profile"
    - "node"

- id: "rsa"
  components:
    - "Automation Hub"
    - "Settings"
  title: "RSA key"
  short: "A key used to secure data"
  long: "An RSA key refers to a public-key cryptosystem used for secure data transmission and digital signatures. This system employs two keys - a public key and a private key - to encrypt and decrypt data transferred over the internet, ensuring confidentiality and data integrity."
  link: "/docs/settings/data-exchange-encryption"
  seealso:
    - "aes"
    - "dek"
    - "kek"
- id: "schedule-rule"
  components:
    - "Automation Hub"
  title: "Schedule rule"
  short: "Changes the status of a workflow at the defined time"
  long: " A rule defines a change of a workflow status at the defined date and time. You can create rules in the workflow scheduler."
  link: "/docs/automation/workflow-scheduler#creating-schedule-rules"
  seealso:
    - "workflow-scheduler"
- id: "schema-automation"
  components:
    - "Automation Hub"
  title: "Schema"
  short: "The configuration form of an [Outgoing Integration node](/docs/automation/actions/webhook-node/) built with [Schema Builder](/docs/assets/schema-builder/) to enable reusable and customizable integration."
  long: "The configuration form of an [Outgoing Integration node](/docs/automation/actions/webhook-node/) built with [Schema Builder](/docs/assets/schema-builder/) to enable reusable and customizable integration."
  link: "/docs/assets/schema-builder/"
  seealso:
    - "outgoing-integration"
    - "user"
    - "schema"
- id: "statistics-automation"
  components:
    - "Automation Hub"
  title: "Statistics"
  short: "Information about the usage of a workflow and its nodes"
  long: "The statistics let you see information about the number of profiles and processes in a workflow and its nodes."
  link: "/docs/automation/automation-activity-tracking/"
  seealso:
    - "node"
    - "workflow"
- id: "workflow-capping"
  components:
    - "Automation Hub"
  title: "Workflow capping"
  short: "Quantitative limits put on a workflow"
  long: "You can define how many times a workflow or node can be activated."
  link: "/docs/automation/automation-capping/"
  seealso:
    - "workflow"
    - "node"
- id: "workflow-scheduler"
  components:
    - "Automation Hub"
  title: "Workflow scheduler"
  short: "Lets you define when a workflow's status should change"
  long: "A workflow scheduler lets you automatically schedule changes of a workflow status by setting rules that define when the workflow status changes. You can enable scheduler for new and already active workflows."
  link: "/docs/automation/workflow-scheduler"
  seealso:
    - "schedule-rule"
- id: "workflow-status"
  components:
    - "Automation Hub"
  title: "Workflow status"
  short: "The status defines how you can interact with a workflow"
  long: |
    A workflow can have one of the following statuses:
    - ***Draft*** - It is a workflow that has been saved but it hasn't been activated yet. 
    - ***Pending*** - It is a workflow which will become active at a specified date and time.
    - ***Active*** - It is an activated workflow.
    - ***Paused*** - It is a workflow that is stopped temporarily.
    - ***Stopped*** - It is a workflow that is stopped permanently.  
  link: "/docs/automation/creating-automation#workflow-status"
  seealso:
    - "workflow"
- id: "started"
  components:
    - "Automation Hub"
  title: "Started"
  short: "The number of times a workflow was triggered"
  long: "One of the statistics of a workflow. This is the number of times when a trigger node was activated."
  link: "/docs/automation/automation-activity-tracking/#workflow-statistics"
  seealso:
    - "finished"
    - "in-workflow"
    - "node"

### AI HUB ###

- id: "ai-search-module"
  components:
    - "AI Hub"
  title: "AI Search"
  short: "Search engine feature enhanced by artificial intelligence (AI) engine."
  long: | 
    AI feature designed to enhance search results by delivering personalized and relevant product or content recommendations. Using advanced AI algorithms, it analyzes customer preferences and behavior to provide more accurate and engaging search outcomes.

    Key capabilities include:

    - Flexible search methods, supporting both keyword-based and natural language processing (NLP) queries

    - Multiple display options, such as product listings

    - Autocomplete functionality for faster searches

    - Full-text search and visual search capabilities

    - Customizable settings, including levels of personalization, predictive filtering, and dynamic reranking

    - Query suggestions and query rules to refine search behavior

    - Built-in A/B testing for optimizing search strategies

    - Comprehensive search engine statistics to track performance and user engagement  

    With AI Search, you can create tailored, efficient, and insightful search experiences that drive higher user satisfaction and conversion rates.
  link: "/docs/ai-search/introduction-to-ai-search/"
  seealso:
    - "ai-engine"
    - "query-suggestions"
    - "reranking"
    - "ab-testing"

- id: "ai-recommendation"
  components:
    - "AI Hub"
  title: "AI Recommendations"
  short: "AI Recommendations are automated, personalized product suggestions generated by Synerise’s AI engine to boost user engagement and conversion across multiple channels."
  long: "AI Recommendations use Synerise’s proprietary AI engine to analyze customer behavior and product data, delivering personalized and context-aware item suggestions across websites, apps, push notifications, and business platforms. They support various recommendation types and customization options like filtering, boosting, and A/B testing, helping businesses increase conversions with minimal manual setup."
  link: "/docs/ai-hub/recommendations-v2/"
  seealso:
    - "ai-engine"
    - "attribute"
    - "boosting"
    - "filterable-attributes"
    - "facetable-attributes"
    - "elastic-filters"
    - "distinct-filters"
    - "item-feed"
    - "campaign"
    - "synerise-object"
    - "ab-testing"
    
- id: "category"
  components:
    - "AI Hub"
    - "Experience Hub"
  title: "Category"
  short: "An item attribute that defines the hierarchical classification of an item in an item feed, specifying the category path using the format Top Level > Subcategory > Sub-subcategory."
  long: |
  
    The category attribute is a special field in an item feed that specifies the hierarchical category or classification of an item. Its primary purpose is to organize items within a structured category tree, enabling better search functionality, filtering options, and more precise AI recommendation results.

    Categories are represented as strings that describe the path from the highest-level category down to more specific subcategories. The format requires each level to be separated by a greater-than symbol with spaces on both sides (>). For example:
    `Electronics > Phone and Smartphones > Smartphones`
    This format clearly indicates that `Smartphones` belongs under `Phone and Smartphones,` which in turn is a subcategory of `Electronics.`

    If an item belongs to more than one category path, the item feed can include the additionalCategories attribute, which holds an array of multiple category strings following the same hierarchical format. Both the primary category and the additionalCategories attributes are used in filtering and recommendation algorithms.

    Correct usage of the category attribute is essential for the Synerise AI models to effectively train on feed data and generate relevant recommendations and search results. The attribute name should be exactly category for the main classification, and additionalCategories if multiple categories apply. 
  link: "nolink"
  seealso: 
    - "item-feed"
    - "item"
    - "filter"
    - "ai-recommendation"
    - "ai-search-module"

- id: "facetable-attributes"
  components:
    - "AI Hub"
  title: "Facetable attributes"
  short: "Attributes that can be used as facets."
  long: "Attributes that can be used as facets. Facets allow customers to sort search results by attributes and their values. For example, you can use the `color` attribute as facetable to let the customers select which colors they're interested in."
  link: "/docs/ai-hub/ai-search/create-index/"
  seealso: 
    - "ai-search-module"
    - "ai-recommendation"
    - "attribute"
    - "search-index"

 
- id: "filterable-attributes"
  components:
    - "AI Hub"
    - "Settings"
  title: "Filterable attributes"
  short: "Attributes by means of which recommendation and AI search results can be filtered."
  long: "Filterable attributes are qualities of items that help you narrow down or widen the results in AI recommendations and AI search. You can choose to include items with certain attribute values to see only those that match, or exclude items with certain values to hide them from the results. Using these attributes makes it easier to find the most relevant items in search and recommendations. You can select filterable attributes in the settings of a search index and in the settings of an item feed."
  link: "/docs/ai-hub/ai-search/create-index/"
  seealso: 
    - "item"
    - "ai-recommendation"
    - "ai-search-module"
    - "attribute"
    - "item-feed"
    - "search-index"

- id: "handbill"
  components:
    - "AI Hub"
  title: "Handbill"
  short: "A promotion type for which the items can be selected by the AI promotion engine."
  long: "A promotion type for which the items can be selected by the AI promotion engine."
  link: "/docs/ai-hub/personalized-promotions/"
  seealso:
    - "promotions"

- id: "predictions-module"
  title: "AI Predictions"
  components: 
    - "AI Hub"
  short: "The product which lets you analyze to anticipate profile actions"
  long: |
    A codeless AI-powered analysis which lets you anticipate profile actions. 

    Key features:

      - Built on data already stored inside the Synerise platform
      - No coding required
      - No need for manual feature selection or creation
      - Fully customizable from the user’s perspective
      - Prediction analysis is saved as events which you can use further on (for example in Automation Hub, Experience Hub, Decision Hub, and so on)
      - Easy way to discover top contributing factors to the entire model but also to single predictions
      - Simplified process of creating a prediction based on predefined scenarios
  link: "/docs/predictions"
  seealso: 
    - "analysis"
    - "event"
    - "prediction"
    - "lookalikes"
    - "classification"
    - "regression"
    - "propensity"
    - "best-fit"
- id: "classification"
  title: "Classification"
  components: 
    - "AI Hub"
  short: "A prediction model which predicts true/false values"
  long: "Classification is an example of a **supervised learning** algorithm, which is used to work with the labeled data sets. Classification should be used whenever you want to predict binary values or classes like 0/1, true/false (for example, churn, purchases, whether a customer will/will not perform a specific event, and so on)."
  link: "/docs/ai-hub/predictions/custom/"
  seealso: 
    - "prediction"
    - "regression"
    - "lookalikes"
    - "propensity"
    - "best-fit"

- id: "distinct-filters"
  components:
    - "AI Hub"
  title: "Distinct filters"
  short: "A filter that increases item variety in a recommendation slot. "
  long: |
    This type of filter allows you to increase the variety of items included in a recommendation slot. You can define the allowed number of items that share the same attribute value to be shown, for example, a number of items that have the same brand, color, shape, category, and so on. There are two types of distinct filters:
      - Slot distinct filter - Configured within the slot settings when creating a recommendation.
      - Global distinct filter - Defined in the recommendation model’s item feed settings. It can be enabled in the recommendation slot but will override the slot distinct filter if active.

  link: "/docs/ai-hub/recommendations-v2/recommendation-filters/#distinct-filter"
  seealso: 
    - "ai-recommendation"
    - "item-feed"
    - "attribute"
    - "category"
    - "slot"

- id: "elastic-filters"
  components:
    - "AI Hub"
  title: "Elastic filters"
  short: "A filter that fills a recommendation slot with extra items when it’s not fully filled with matching items."
  long: "This filter lets you choose extra items to include in a recommendation slot when the slot isn’t completely filled. For example, if you want to show up to 10 items but only 5 match the elastic filter conditions, the remaining 5 slots will be filled with additional items that don’t match the filter, based on scoring. "
  link: "/docs/ai-hub/recommendations-v2/recommendation-filters/#elastic-filter"
  seealso: 
    - "ai-recommendation"
    - "item-feed"
    - "attribute"
    - "category"
    - "slot"

- id: "feature"
  title: "Feature"
  components: 
    - "AI Hub"
  short: "A measurable property of an object (for example, a customer)"
  long: "A feature is an individual, measurable property of an object (for example, of a customer) you would like to analyze. A feature is also referred to as a **variable or attribute**. Features are automatically built statistics (for example, sums, averages, trends, deltas) based on the events already stored within the Synerise platform in order to be taken ultimately as data inputs for predictions.  "
  link: "nolink"
  seealso:
    - "event"
    - "feature-importance"
    - "synerise-platform"
- id: "feature-importance"
  title: "Feature importance"
  components: 
    - "AI Hub"
  short: "The influence of a feature on the prediction result"
  long: |
    Importance is the measure of a feature's influence on the results of a prediction.

    It has two sub-types:
      - **Global** feature importance gives you an idea how strong the influence of certain features was on overall model outputs. They have positive value and sum to an entity.
      - **Local** feature importance gives you an understanding which features had the most influence on a single prediction in comparison to an average model prediction. They can have positive and negative values and they are scaled in the prediction values.
  link: "nolink"
  seealso: 
    - "prediction"
    - "feature"
- id: "lookalikes"
  title: "Lookalikes"
  components: 
    - "AI Hub"
  short: "A prediction model which finds similarities between profiles"
  long: |
    A prediction model which allows you to discover profiles sharing the same preferences or any other qualities. Lookalikes let you compare two segmentations called *source* (for example, segmentation of profiles who converted in a campaign in the past) and *target*. The prediction lets you search the target segmentation for profiles similar to the ones in the source segmentation. This, in turn, opens up opportunities to use the lookalike segments to address personalized communication, extending your reach or other actions. Lookalikes take advantage of our state-of-the-art AI/ML algorithms and frameworks such as Cleora and EMDE and are built upon behavioral profiles.
  link: "/docs/ai-hub/predictions/lookalikes/"
  seealso: 
    - "prediction"
    - "classification"
    - "regression"
    - "best-fit"
    - "propensity"
    - "segmentation"
- id: "percentiles"
  title: "Percentiles"
  components: 
    - "AI Hub"
  short: "A score below which a specified percentage of profiles from an analyzed group falls. For instance, the 50th percentile means that 50% of the profiles have lower score than this one"
  long: |
    Percentile is a score below which a specified percentage of profiles from an analyzed group falls. For instance, the 50th percentile means that 50% of the profiles have lower score than this one. Percentiles are especially useful whenever you direct communication only to a certain number of profiles. Let's assume that you want to make a prediction for a segment that is made up of 100 000 profiles, and you want to send a message only to 10 000 of them. In this case, you can pick TOP 10% of profiles with the highest score: in terms of percentiles this value is expressed as "over the 90th percentile".
  link: "/docs/predictions/predicitions-measure-performance/"
  seealso: 
    - "prediction"
- id: "prediction"
  title: "Prediction (score)"
  components: 
    - "AI Hub"
  short: "An AI-powered estimate of a future occurrence"
  long: "A **prediction (*score*)** refers to a single output of a model after it has been trained, and then scored based on a selected data set (that contains chosen features). Predictions are probable values generated by a model, created for every customer who belongs to the selected audience. Depending on the type of the problem you want to solve, predictions can be perceived as likelihood or forecasted values. The output of the prediction is a `snr.prediction.score` event generated for profiles that were selected as the target of the prediction. "
  link: "/docs/ai-hub/predictions/enabling-predictions/"
  seealso: 
    - "classification"
    - "regression"
    - "best-fit"
    - "propensity"
    - "lookalikes"
    - "event-reference"
- id: "prediction-result-scale"
  title: "Prediction result scale"
  components: 
    - "AI Hub"
  short: "Prediction results are shown as a 2-point or 5-point scale"
  long: |
    The result of a prediction can be presented on a 2-point or 5-point (default) scale, depending on the configuration.
    - 2-point: low, high
    - 5-point: very low, low, medium, high, very high
  link: "/docs/ai-hub/predictions/enabling-predictions/"
  seealso: 
    - "classification"
    - "regression"
    - "best-fit"
    - "propensity"
    - "lookalikes"
- id: "propensity"
  title: "Propensity"
  components: 
    - "AI Hub"
  short: "A prediction model which lets you analyze the probability of an item purchase"
  long: "A prediction model that lets you predict the propensity for buying particular products, brands, categories, but you can also use any other item attributes for the prediction. The generated predictions can be easily used to build segmentations for further use in actions in Automation or Decision Hub. As with the other prediction types, propensity predictions are based on our state-of-the-art AI/ML algorithms and frameworks such as Cleora and EMDE and are built upon behavioral profiles."
  link: "/docs/ai-hub/predictions/propensity/"
  seealso: 
    - "classification"
    - "regression"
    - "best-fit"
    - "lookalikes"
    - "segmentation"
- id: "regression"
  title: "Regression"
  components: 
    - "AI Hub"
  short: "A prediction model used to predict a continuous value (for example, customer lifetime value)"
  long: "A custom prediction model type. Regression is an example of **supervised learning** algorithm, which is used to work with the labeled data sets. Regression should be used whenever you want to predict the continuous value (for example, customer lifetime value, number of transactions in the next 90 days, total transaction value in the next 30 days, and so on)."
  link: "/docs/ai-hub/predictions/custom/"
  seealso: 
    - "classification"
    - "best-fit"
    - "propensity"
    - "lookalikes"
- id: "best-fit"
  title: "Best Fit"
  components: 
    - "AI Hub"
  short: "A prediction type that evaluates how well a specific item attribute value (e.g., brand) matches a selected group of profiles."
  long: |
    The Best Fit Prediction Model helps identify the most suitable item or the value of an item attribute for each customer. It allows you to specify an attribute such as brand, category, color, or any other characteristic from your item feed. The model then predicts which attribute value is most relevant to each customer. You can create the prediction either from scratch or by using predefined scenarios that guide you step-by-step through the setup. These scenarios include finding the best brand, category, or overall best item for a customer.

    To work effectively, the AI Engine must be configured for Best Fit predictions, and the attributes you want to predict must be set as filterable. Once set up, you select the audience and the item feed to analyze, define item attributes and filters, and launch the calculation.

    The prediction result includes a score and the most likely attribute value for each customer, enabling personalized recommendations and targeted marketing.
  link: "/docs/ai-hub/predictions/bestfit/"
  seealso: 
    - "item"
    - "attribute"
    - "item-feed"
    - "ai-engine"
    - "classification"
    - "regression"
    - "lookalikes"
    - "propensity"
  
- id: "promotions"
  components:
    - "AI Hub"
  title: "Promotions"
  short: "A feature that enables personalized discounts and special offers to be assigned and applied to profiles based on predefined rules and conditions."
  long: "A marketing feature that enables personalized discounts and special offers to be assigned and applied to profiles based on predefined rules and conditions. Promotions can target specific audiences and be scoped either to selected items or the entire basket in a transaction. Promotions have different statuses reflecting their lifecycle, such as Assigned (ready to be activated), Active (can be applied during a transaction), or Redeemed (used and no longer available to the customer). They can be activated, deactivated, or redeemed through API methods or platform processes."
  link: "/docs/ai-hub/promotions/"
  seealso: 
    - "handbill"
    - "audience"
    - "profile"
    - "item"

- id: "query"
  components:
    - "AI Hub"
  title: "Query"
  short: "The text entered (or autofilled) in a search box"
  long: "The text entered (or autofilled) in a search box. "
  link: "nolink"
  seealso:
    - "query-suggestions"

- id: "query-suggestions"
  components:
    - "AI Hub"
  title: "Query suggestions"
  short: "AI-generated tips for a search query"
  long: | 
    AI-generated tips for a search query.  
    
    When a customer enters a query in the search box, you can make an API request to a suggestion index, which will return other queries that the customer may be interested in. These are called suggestions. Their source and selection method depend on the configuration of the search index - you can use our AI models to build a selection index, but you can also add suggestions manually or block certain phrases.
  link: "/docs/ai-hub/ai-search/query-suggestions/"
  seealso: []

- id: "redemption"
  components:
    - "AI Hub"
  title: "Redemption"
  short: "The act of using up a voucher or promotion"
  long: "After a promotion or voucher is assigned to a profile and activated, the profile can use it up when finalizing the transaction. This is called “redeeming” the promotion or voucher. You can configure a promotion to be redeemed multiple times by the same profile. Vouchers can only be redeemed once."
  link: "nolink"
  seealso: 
    - "promotions"
    - "handbill"
    - "voucher"

- id: "slot"
  components:
    - "AI Hub"
  title: "Slot"
  short: "A fragment of the recommendation frame"
  long: "A slot is a fragment of the recommendation frame. Each frame can contain multiple slots, and each slot can have its own item number and filters."
  link: "/docs/ai-hub/recommendations-v2/creating-recommendation-campaign/#adding-slots"
  seealso: 
    - "ai-recommendation"
    - "elastic-filters"
    - "distinct-filters"

- id: "voucher"
  components:
    - "AI Hub"
  title: "Voucher"
  short: "A unique code assigned to a profile that provides a discount or benefit redeemable during a transaction."
  long: "A voucher is a unique code that can be assigned to a profile and used to apply a discount or other benefit when finalizing a transaction. Vouchers can only be redeemed once. They are managed separately from promotions, which can be configured for multiple redemptions."
  link: "/docs/assets/code-pools/"
  seealso:
    - "redemption"
    - "promotions"
    - "profile"

- id: "search-index"
  components:
    - "AI Hub"
  title: "Search index"
  short: "A configured data structure that defines how items are indexed, searched, and ranked in AI Search."
  long: "A search index is a configuration in AI Search that determines how items from an item feed are indexed and returned in search results. Its settings include filterable attributes, facetable attributes, query suggestions, personalization levels, and query rules. Each search index is tied to an item feed and must be configured before AI Search can return results."
  link: "/docs/ai-hub/ai-search/create-index/"
  seealso:
    - "ai-search-module"
    - "item-feed"
    - "filterable-attributes"
    - "facetable-attributes"
    - "query-suggestions"

- id: "boosting"
  components:
    - "AI Hub"
  title: "Boosting"
  short: "A technique that adjusts the ranking of items in recommendations based on attribute values."
  long: "Boosting lets you promote or demote items in recommendation results based on their attribute values. For example, you can boost items of a specific brand or category to make them appear higher in the results, or demote out-of-season items. Boosting is configured in the recommendation slot settings."
  link: "/docs/ai-hub/recommendations-v2/creating-recommendation-campaign/#define-the-boosting-factors"
  seealso:
    - "ai-recommendation"
    - "slot"
    - "attribute"
    - "item-feed"

- id: "reranking"
  components:
    - "AI Hub"
  title: "Reranking"
  short: "The process of reordering search or recommendation results based on personalization signals or business rules."
  long: "Reranking adjusts the default order of items returned by AI Search or AI Recommendations. Dynamic reranking applies personalization signals — such as a customer's browsing or purchase history — to reorder results in real time, making them more relevant to the individual. Reranking can be configured as part of the search index or recommendation settings."
  link: "/docs/ai-hub/ai-search/dynamic-reranker/"
  seealso:
    - "ai-search-module"
    - "ai-recommendation"
    - "ai-engine"

- id: "ab-testing"
  components:
    - "AI Hub"
    - "Experience Hub"
  title: "A/B/X testing"
  short: "A method of comparing two or more variants to determine which performs better."
  long: "A/B/X testing splits traffic between two or more variants and measures which performs better. In Experience Hub, variants are typically different message versions — such as different subject lines, content, or send times — tested against each other within a campaign. In AI Hub, variants can be different recommendation models, search configurations, or personalization settings. Performance is tracked through built-in statistics, enabling data-driven decisions."
  link: "/docs/ai-hub/recommendations-v2/"
  seealso:
    - "ai-recommendation"
    - "ai-search-module"
    - "campaign"
    - "experience-hub"

- id: "recommendation-frame"
  components:
    - "AI Hub"
  title: "Recommendation frame"
  short: "A container that holds one or more recommendation slots."
  long: "A recommendation frame is the top-level structure of an AI recommendation campaign. It acts as a container for one or more slots, each of which can be independently configured with its own number of items and filters. The frame defines where recommendations are displayed, for example on a product page or in an email."
  link: "/docs/ai-hub/recommendations-v2/creating-recommendation-campaign/"
  seealso:
    - "slot"
    - "ai-recommendation"
    - "elastic-filters"
    - "distinct-filters"

### DATA MANAGEMENT ###

- id: "action"
  title: "Action/Event name"
  components:
    - "Data Modeling Hub"
    - "Decision Hub"
    - "Behavioral Data Hub"
    - "Automation Hub"
  short: "The system name of an event, for example page.visit"
  long: | 
    In an event definition, the event name uniquely identifies the type of event and is stored in the action parameter. For example, a page.visit event has its action parameter set to page.visit. This action value serves as the unique identifier used across analytics and integrations to recognize and filter events.

    Once an event definition is created - which many exist by default in all workspaces - the event name (action value) cannot be changed.

    When editing event definitions, you can also add human-readable display names that appear in the Synerise platform for easier understanding. If no display name is provided, the system shows the action parameter value instead.
  link: "/docs/assets/events/event-definitions/#in-the-web-application"
  seealso:
    - "profile"
    - "event"
    - "custom-events"
    - "filter"
    - "synerise-platform"

- id: "attribute"
  components:
    - "Data Modeling Hub"
    - "Behavioral Data Hub"
    - "Decision Hub"
    - "Experience Hub"
    - "AI Hub"
  title: "Attribute"
  short: "Attributes in Synerise are data points describing profiles, products, events, or other entities."
  long: | 
    Attributes in Synerise are data points describing profiles, products, events, or other entities. They can include demographic information, behavior metrics, or product features, which are used for segmentation, personalization, and targeting. They are foundation of analyses and personalization. They let you:

    - build highly precise customer segmentations,

    - apply filters in recommendations (for example, only show products in stock or within a price range),

    - narrow down AI Search results (for example, only dresses in size M),

    - define conditions in automation workflows (for example, send a discount only to customers tagged as “VIP”).
  link: "/docs/assets/customer-properties/"
  seealso: 
    - "profile"
    - "item"
    - "filter"
    - "analysis"
    - "segmentation"

- id: "catalog"
  components:
    - "Data Modeling Hub"
    - "Settings"
    - "AI Hub"
    - "Experience Hub"
  title: "Catalog"
  short: "A data repository that allows you to upload CSV, JSON, and XML files, enabling you to store item feeds, supplemental feeds, and other business data to enrich events and personalize content of your marketing actions (messages and content displayed on your websites). "
  long: |
    A catalog in Synerise is a place where you can store different types of business data. This data helps you set up and use many features in the platform. You can upload files in formats like CSV, XML, JSON, or JSON Lines. You can add files to a catalog by using the Automation Hub, simple upload options, or through API methods.

    Catalogs are useful for many business tasks. You can keep product feeds in them, such as item lists, product details (used for recommendation models), and extra information like prices and availability for different stores or sales channels. This information helps you create better recommendations, search results, and predictions.

    You can also store data that adds more details to events or that you want to include in marketing messages and campaigns to make them more personal. Catalogs can also hold lists of stores, so you can run promotions that target only certain stores.

    Remember, catalogs are not for storing personal data about customers. That kind of data is kept in Behavioral Data Hub.
  link: "/docs/assets/catalogs/"
  seealso: 
    - "item-feed"
    - "event-enrichment"
    - "promotions"
    - "ai-recommendation"
    - "ai-search-module"
    - "prediction"

- id: "custom-events"
  components:
    - "Data Modeling Hub"
    - "Settings"
  title: "Custom events"
  short: "Events you created for integration purposes and that do not exist in the [default event reference](/docs/assets/events/event-reference/)."
  long: "Custom events are user-defined events not included in Synerise’s default event catalog. They enable tracking of unique and business-specific profile interactions important for analyses and personalization. You can name and define these events according to your needs to monitor particular profile behaviors or processes. "
  link: "/developers/web/event-tracking/#declarative-tracking-custom-events"
  seealso: 
    - "analysis"
    - "event"
    - "event-reference"
    - "profile"
  
- id: "data-modeling-hub"
  components:
    - "Data Modeling Hub"
  title: "Data Modeling Hub"
  short: "The name of the component in the Synerise platform. "
  long: |
    This component provides the following key functions:

    - Central data repository: Stores your workspace’s data, including catalogs (such as item feeds and business information for campaigns), events and their parameters, customer attributes, tags, profile tags, and files. These data assets can be utilized for analysis, message templates, and workflows.

    - Creation of reusable content: Enables the creation and management of schemas, brickworks, records, snippets (reusable code segments used in templates or fields across the Synerise platform that allow dynamic data usage), and voucher pools.

    - Data transfer: Supports importing and exporting data to facilitate easy integration and efficient data management.
  link: "/docs/assets/"
  seealso: 
    - "catalog"
    - "item-feed"
    - "event-enrichment"
    - "tag"
    - "schema"
    - "import"
    - "synerise-platform"
    - "workspace"

- id: "data-management"
  components:
    - "Data Modeling Hub"
  title: "Data Management"
  short: "The former name for Data Modeling Hub"
  long: "The former name for Data Modeling Hub"
  link: "nolink"
  seealso: 
    - "data-modeling-hub"

- id: "event"
  components:
    - "Data Modeling Hub"
    - "AI Hub"
    - "Decision Hub"
    - "Automation Hub"
    - "Behavioral Data Hub"
    - "AI Hub"
    - "Experience Hub"
    - "Settings"
  title: "Event"
  short: "An event is a profile or system activity tracked in Synerise, such as website visits, product interactions, or message sending. "
  long: |
    An event represents an action performed either by a profile on a website, like visiting a page or adding a product to a shopping cart—or by a user interacting with customers, such as sending messages. Events are the basic input data in Synerise, powering various components, products, and features. 
    
    There are two main types of events in Synerise: default events, which are automatically collected through tracking codes, SDKs, automations, and more (such, page visits, message sending, transactions); and custom events, which users define and add manually or programmatically. Events are collected via website tracking code implementations, SDK event tracking, API tracking, and can also be imported from historical data to power more comprehensive analyses.
  link: "/docs/assets/events/introduction-to-events/"
  seealso: 
    - "action"
    - "event-parameters"
    - "custom-events"
    - "event-enrichment"
    - "event-reference"
    - "component"
    - "user"
    - "tracking-code"
    - "mobile-sdk"
    - "import"

- id: "event-enrichment"
  components:
    - "Data Modeling Hub"
  title: "Event enrichment"
  short: "Process of automatically adding data from a catalog to recorded events in the Synerise platform."
  long: "The process of automatically adding additional data from catalogs to an event based on matching parameter values, enhancing the event with relevant information without needing to send all data each time. When an event parameter’s value matches a key in a catalog, the corresponding catalog data is appended to the event. This enables richer event detail, such as adding comprehensive product information to product-related events, without sending all the data explicitly with every event occurrence."
  link: "/docs/assets/events/adding-event-parameters/#enriching-events-with-data-from-catalogs"
  seealso: 
    - "event"
    - "catalog"
    - "event-parameters"
    - "event-reference"

- id: "event-parameters"
  components:
    - "Data Modeling Hub"
    - "Decision Hub"
  title: "Event parameters"
  short: "Additional pieces of information about an activity the event describes."
  long: "An event parameter provides extra context and details about the profile activity represented by an event. For example, in a page.visit event, parameters might include the visitor’s IP address, the UTM source that referred them, and the device they used to access the website. By capturing event parameters alongside events, you can perform detailed analyses, such as counting visits to specific subdomains or calculating the estimated value of abandoned shopping carts for individual customers. "
  link: "/docs/assets/events/adding-event-parameters/"
  seealso:
    - "event"
    - "action"
    - "custom-events"
    - "event-enrichment"
    - "event-reference"
    - "filter"

- id: "event-reference"
  components:
    - "Data Modeling Hub"
  title: "Event reference"
  short: "List of events and their parameters that are generated automatically after implementing a tracking code."
  long: "A comprehensive list of events and their parameters that are automatically generated once the tracking code is implemented. The list is organized by features, and for each event, it includes the parameters involved along with descriptions."
  link: "/docs/assets/events/event-reference/"
  seealso: 
    - "event"
    - "tracking-code"

- id: "import"
  components:
    - "Data Modeling Hub"
    - "Automation Hub"
  title: "Import"
  short: "A process of bringing data to Synerise"
  long: |
    Refers to the process of uploading and integrating external data into the Synerise platform using Data Modeling Hub. This feature enables users to transfer various types of external data such as profiles, transactions, events, promotions, vouchers, and catalog records into their Synerise workspace to enrich their marketing and business activities.  
    
    When importing data, users must select an appropriate import method depending on the source and format of their files. There are two main import methods available on the user’s interface in the Synerise platform:
      - Import local file – This method lets you upload a single .csv file directly from your device. During this process, the user maps columns from the file to the corresponding parameters within Synerise, facilitating a straightforward and quick data upload suited for one-time or ad-hoc imports. 
      - Import in Automation – This method supports importing files in multiple formats, including .csv, .json, .jsonl, and .xml, that are stored on external servers accessible via HTTP or SFTP protocols. After declaring the import source, users are redirected to a customizable workflow template featuring a [Data Transformation node](/docs/automation/operation/data-transformation-node/), where they can apply transformation rules to modify and adapt the data before integration into the system. This method is ideal for recurring or periodic imports.
  link: "/docs/assets/imports/"
  seealso: 
    - "mapping"
    - "template"
    - "event"
    - "promotions"
    - "profile"
    - "catalog"
    - "synerise-platform"
    - "user"
- id: "primary-key"
  components:
    - "Data Modeling Hub"
  title: "Primary key"
  short: "Unique ID of a catalog entry"
  long: "The primary key is a unique ID of an entry in a catalog. When you import entries to a catalog (for example, from a CSV file), you must select the property which will be used as the primary key."
  link: "nolink"
  seealso: 
    - "catalog"
    - "import"
- id: "schema"
  components:
    - "Data Modeling Hub"
  title: "Schema (brickworks)"
  short: "Governs the content of records"
  long: "A schema is the layout for records which are created from it. The schema defines the fields and their allowed and default values; and records must adhere to those settings when they are created. Updating a schema may influence content generation from existing records."
  link: "/docs/assets/brickworks/"
  seealso: []

- id: "slug"
  components:
    - "Data Modeling Hub"
  title: "Slug"
  short: "A unique, human-readable identifier of a document"
  long: "A slug is one of the identifiers of a document. You can define it when creating the document and then use it in URLs and references to the document, for example in Jinjava inserts. It’s shorter and more human-friendly than the randomly generated UUID."
  link: "/docs/assets/documents/creating-documents/"
  seealso: []


### ANALYTICS ###

- id: "aggregate"
  components:
    - "Decision Hub"
  title: "Aggregate"
  short: "An aggregate is an analysis type that summarizes data from a selected event within a specified time range. When created for a profile, it functions as a dynamic attribute of a profile, providing concise and actionable insights based on event data."
  long: | 
    An aggregate in Synerise is a summarized metric calculated from a selected event within a specified time range for a profile or an event, offering results like latest, first, average, sum, minimum, or maximum values.  
    
    There are two main types: 
      - Profile aggregates: provide customer-specific insights and allow viewing results for individual profiles (for example, return the name of last purchased item). 
      - Event aggregates: analyze event occurrences (for example, calculate recommendation revenue after the first click within 24 hours) and can be used as custom parameters in filters for complex analyses. 
    
     Aggregates are not only used for reporting but also enhance advanced features like AI recommendations and predictions. They enable a variety of use cases, from identifying customer preferences to creating sophisticated segmentations based on behavior. Aggregates help transform raw event data into actionable insights for personalized marketing and data-driven decision-making.
  link: "/docs/analytics/aggregates/"
  seealso: 
    - "analysis"
    - "ai-recommendation"
    - "synerise-object"
    - "predictions-module"

- id: "aggregator"
  components:
    - "Decision Hub"
  title: "Aggregator"
  short: "An aggregator (available in metrics and aggregates) is a calculation function that summarizes event data within a specified time range by calculating values such as sum, minimum, median, or quantile for a chosen event parameter."
  long: "An aggregator is a metric that summarizes event data within a selected time range by applying functions like Exists (checks if an event occurred), Sum (total value), Min (lowest value), Median (middle value), or Quantile (value dividing data into equal parts). It transforms raw event parameters into actionable metrics, useful for analyzing both individual profiles and aggregated datasets. For example, a median aggregator can help understand typical purchase amounts by identifying the middle spend value within a chosen period, while a quantile aggregator can reveal threshold values for statistical segments, such as the top 20% of spenders. "
  link: "/docs/analytics/metrics/creating-simple-metrics/"
  seealso: 
    - "metric"
    - "aggregate"

- id: "analysis"
  components:
    - "Decision Hub"
  title: "Analysis"
  short: "An analysis refers to the objects a Synerise user can create in Decision Hub, such as dashboards, funnels, segmentations, metrics, histograms, reports, trends, geoanalyses, Sankey diagrams, aggregates, and expressions."
  long: | 
    An analysis in Synerise refers to the various objects you can create in Decision Hub to examine and interpret data. These objects include dashboards, funnels, segmentations, metrics, histograms, reports, trends, geoanalyses, Sankey diagrams, aggregates, and expressions. Analyses are built on  events (specific actions taken by profiles or systems) and attributes (characteristics or properties related to those events or profiles).

    You can limit an analysis to a specific time range, allowing you to focus on relevant periods for your business needs. Additionally, analyses can be performed in the context of a specific profile, for example, a customer profile enabling businesses to gain insights at an individual or group level.

    By using these analysis tools, you can better understand customer behavior, track performance trends, identify bottlenecks in funnels, segment your audience for targeted marketing, and make data-driven decisions. This leads to improved personalization, optimized marketing strategies, enhanced customer experiences, and ultimately, increased efficiency and revenue growth.
  link: "/docs/analytics/"
  seealso: 
    - "synerise-object"
    - "metric"
    - "aggregate"
    - "expression"
    - "segmentation"
    - "trend"
    - "report"
    - "filter"
    - "event"
    - "attribute"

- id: "analytics"
  components:
    - "Decision Hub"
  title: "Analytics"
  short: "The former name for Decision Hub"
  long: "The former name for Decision Hub"
  link: "nolink"
  seealso: 
    - "decision-hub"

- id: "decision-hub"
  components:
    - "Decision Hub"
  title: "Decision Hub"
  short: "This is the name of the component in the Synerise platform in which you can create dashboards, funnels, segmentations, metrics, histograms, reports, trends, geoanalyses, Sankey diagrams, aggregates, and expressions."
  long: "Decision Hub is a suite of tools and reports that measure customer interactions, engagement rates, and the effectiveness of marketing messages. It provides data-driven insights that support informed decision-making and strategy refinement."
  link: "/docs/analytics/"
  seealso: 
    - "analysis"

- id: "dimension"
  components:
    - "Decision Hub"
  title: "Dimension"
  short: "An attribute or event parameter used to group and segment data in reports."
  long: "In Synerise, reports are created using data from metrics. You start by selecting a metric, then choose its dimensions—such as event parameters from the event associated with that metric. These selected parameters (for example, location, payment types, quantity) become the dimensions (columns) in the report."
  link: "/docs/analytics/reports/creating-reports/"
  seealso: 
    - "report"
    - "metric"
    - "event"
    - "event-parameters"

- id: "dynamic-key"
  components:
    - "Decision Hub"
  title: "Dynamic key"
  short: "A parameter placeholder used in analyses, filters, and workflows that retrieves its value dynamically from event parameters, profile attributes, or user input at runtime."
  long: "A dynamic key is a condition value in Synerise that can be changed at the time an analysis or filter is requested. It allows you to create flexible analyses or dashboards where the key’s value is not fixed but can be defined dynamically, for example, to analyze different items, customers, campaigns, or products without rebuilding the analysis each time. Dynamic keys enable interactive dashboards where users can input values manually, and support automation workflows by dynamically comparing event or profile data against changing criteria."
  link: "/docs/analytics/i_events-parameter-value/#dynamic-key"
  seealso: 
    - "analysis"
    - "filter"
    - "event"


- id: "expression"
  components:
    - "Decision Hub"
  title: "Expression"
  short: "A formula combining multiple attributes to create derived attributes for customers or events, used to further specify profiles or events within Synerise."
  long: "An expression is a customizable calculation that combines attributes, aggregates, and functions into a single computed value. Rather than being stored as actual attributes, expressions behave like ones — they can be used in filters and segmentation across the Synerise platform just as regular customer or event attributes can. Expressions extend your data model on the fly by computing new values from existing data. Depending on where they are applied, they behave as customer attributes (when built on customer data) or event attributes (when built on event data)."
  link: "/docs/analytics/expressions/"
  seealso:
    - "attribute"
    - "event"
    - "synerise-object"


- id: "filter"
  components:
    - "Decision Hub"
  title: "Filter"
  short: "A funnel—a sequence of one or more conditions—that selects profiles by attributes, events, or other analyses used across the Synerise platform."
  long: "A filter is effectively a funnel, a specialized feature available in Decision Hub, designed to capture profiles based on a sequence of one or more conditions related to profile attributes or performed events. These conditions can be combined with logical operators (AND, OR) and constrained by time windows. Filters can represent simple single-event conditions or complex funnels with ordered event sequences and time limits."
  link: "/docs/analytics/i_profile-filter/"
  seealso: 
    - "profile"
    - "analysis"
    - "event"
    - "attribute"

- id: "metric"
  components:
    - "Decision Hub"
  title: "Metric"
  short: "An analysis type which lets you measure such indicators like revenue, the number of visitors on a website, conversion rates."
  long: |
    A metric is a product in Decision Hub representing numbers calculated from your data for use in dashboards and reports. Metrics quantify important business indicators such as total revenue, unique visitors, buyers, conversion rates, or revenue per visitor to help track and understand business performance within a given period. Metrics can be created in two ways:

    - Simple metrics, which analyze single event types or customer attributes by aggregating event counts, sums, averages, medians, quantiles, minimums, maximums, or occurrence times.

    - Formula metrics, which use mathematical operations combining multiple event types and customer attributes to generate results.
  link: "/docs/analytics/metrics/introduction-to-metrics/"
  seealso: 
    - "report"
    - "metric"
    - "dimension"
    - "analysis"
  
- id: "operators"
  components:
    - "Decision Hub"
  title: "Operators/Logical operators"
  short: "Used to build analysis and filter conditions"
  long: "Operators are the building blocks of analyses and filters. They let you apply logical or mathematical tests to event parameters, profile attributes, and results of other analyses. For example, you can use the = operator to check if two values are identical."
  link: "/docs/analytics/i_events-parameter-operators/"
  seealso: 
    - "analysis"
    - "event"
    - "profile"
    - "filter"

- id: "report"
  components:
    - "Decision Hub"
  title: "Report"
  short: "Reports organize your data into grid tables, enabling rapid analysis of customer behavior and quick insight generation."
  long: " A report is a visual representation of data derived from metrics. Parameters analyzed in metrics—such as event parameters, customer attributes, or expressions—can be displayed as dimensions within a report. Reports can be presented as bar charts, line charts, or tables, often highlighting key values like the top or most recent items (for example, top 10 products added to cart or last 5 products purchased). "
  link: "/docs/analytics/"
  seealso: 
    - "metric"
    - "dimension"
    - "operators"
    - "event-parameters"
    - "filter"
    - "analysis"
    - "synerise-object"

- id: "segmentation"
  components:
    - "Decision Hub"
    - "Experience Hub"
  title: "Segmentation"
  short: "An analysis that lets you group profiles based on shared characteristics"
  long: "Segmentation is a method of organizing customers into distinct groups that share common characteristics. This can be done according to various criteria, including geographical factors (e.g., place of residence), demographic profiles (such as age, gender, occupation, or education), behavioral patterns (like website activity or purchase history), and psychographic traits (including interests, preferences, or opinions). By segmenting profiles, you can optimize promotions and customize content and communication channels to better align with each group’s unique preferences and needs. "
  link: "/docs/analytics/segmentations/"
  seealso:
    - "profile"
    - "analysis"
    - "synerise-object"
    - "segment"

- id: "segment"
  components:
    - "Decision Hub"
    - "Experience Hub"
  title: "Segment"
  short: "It’s a subgroup in a segmentation."
  long: "It’s a subgroup in a segmentation. Each segment can have its own set of conditions. By using multiple segments, you can divide your profiles based on factors such as their average order value, the product categories they have visited, or how frequently they make purchases."
  link: "/docs/analytics/segmentations/"
  seealso:
    - "segmentation"
    - "profile"

- id: "trend"
  components:
    - "Decision Hub"
  title: "Trend"
  short: "An analysis type that lets you present event occurrences over time on a chart"
  long: "A feature in Decision Hub. It’s an analysis type that lets you present event occurrences over time on a chart. It allows you to check the results of events you track and predict their direction. With this knowledge, you can undertake the appropriate business activities."
  link: "/docs/analytics/trends/"
  seealso:
    - "event"
    - "analysis"
    - "synerise-object"

### SETTINGS ###

- id: "api-key"
  components:
    - "Settings"
  title: "API key"
  short: "A unique code used to authenticate application access."
  long: "An API key in Synerise is a unique identifier provided to external applications or integrations, allowing secure communication with Synerise RESTful APIs. It authenticates and authorizes requests to access data or perform operations on the platform."
  link: "/docs/settings/tool/api/"
  seealso:

- id: "data-catalog"
  components:
    - "Settings"
    - "AI Hub"
    - "Experience Hub"
    - "Data Modeling Hub"
  title: "Data catalog"
  short: "The source type of product information (stored in Data Management > Catalogs) used for creating an item feed during AI engine configuration."
  long: "The source type of product information (stored in Data Management > Catalogs) used for creating an item feed during AI engine configuration. A data catalog holds full product information and serves as a standalone feed, whereas a metadata catalog includes only additional details like images and product descriptions. "
  link: "/docs/settings/configuration/ai-engine-configuration/engine-configuration-for-recommendations/#adding-item-feed"
  seealso: 
    - "item-feed"
    - "ai-engine"
    - "catalog"


- id: "item-feed"
  components:
    - "Settings"
    - "AI Hub"
    - "Experience Hub"
    - "AI Hub"
  title: "Item feed"
  short: "A repository of product information generated as a result of AI engine configuration."
  long: |
    Creating an item feed in Synerise involves uploading product information into a catalog. Alternatively, if you have a Google Merchant feed, you can configure Synerise to pull data directly from it when setting up the item feed. Besides the main item feed, there are supplementary types of item feeds that are not standalone. These include:

    - Metadata catalog: Contains metadata such as images used for recommendations based on section pages and attribute models.
    - Supplemental catalog: Contains availability and price information about items per store or sales channel.
  link: "/docs/settings/configuration/ai-engine-configuration/"
  seealso: 
    - "ai-engine"
    - "catalog"
    - "data-catalog"
    - "ai-recommendation"
    - "ai-search-module"
    - "prediction"

- id: "jwt"
  components:
    - "Settings"
  title: "JWT"
  short: "(JSON Web Token) A compact, URL-safe token format used in Synerise API as a one method for authentication"
  long: "(JSON Web Token) A compact, URL-safe token format used in Synerise API as a one method for authentication. The JWT is generated by making a request to an authorization endpoint. It is then used to authenticate requests to other endpoints. Make sure that the token you're using is generated for a consumer with access to the endpoint you're trying to use."
  link: "/developers/web/jwt-auth/"
  seealso: []

- id: "settings"
  components:
    - "Settings"
  title: "Settings"
  short: "The area where you manage your workspace"
  long: "Settings is the component where you manage most of your workspace settings, such as user permissions and roles, AI engine configuration, a Global Control Group, the timezone, integrations with third-party services, and more."
  link: "/docs/settings/"
  seealso: 
    - "component"
    - "tracking-code"

- id: "tracking-code"
  components:
    - "Settings"
  title: "Tracking code"
  short: "A JavaScript code that enables integrating your website with Synerise"
  long: "The tracking code is a JavaScript code fragment in your website which enables the Synerise Web SDK once the site is loaded. This lets you track visitor activity and collect data in Synerise."
  link: "/developers/web/installation-and-configuration/"
  seealso: 
    - "event"


### GENERAL TERMS ###

- id: "ai-engine"
  components:
    - "AI Hub"
    - "Experience Hub"
    - "AI Hub"
    - "Settings"
    - "Automation Hub"
  title: "AI engine"
  short: "AI engine comprises a set of advanced algorithms that analyze data, learn patterns, and automate complex processes. It powers features like recommendations, predictions, and AI search."
  long: "The AI engine in Synerise powers features such as predictions, recommendations, AI-driven search, Automation’s time optimizer, and dynamic content A/B/X testing by utilizing proprietary machine learning algorithms. It analyzes data from profile events and attributes to enable intelligent decision-making and personalized customer experiences. Users must provide an item feed—the essential data source for AI search, predictions, recommendations, and time optimizer models. Additionally, depending on the features being used, users need to supply further data such as historical events like transactions. Detailed requirements for each feature are outlined in the documentation to ensure proper configuration and optimal engine training."
  link: "/docs/settings/configuration/ai-engine-configuration/"
  seealso: 
    - "ai-search-module"
    - "ai-recommendation"
    - "prediction"
    - "event"
    - "attribute"
    - "item-feed"

- id: "api-reference"
  components:
    - "General terms"
  title: "API reference"
  short: "Documentation detailing API endpoints and usage."
  long: "The API reference for Synerise is comprehensive documentation describing available endpoints, request and response formats, authentication methods, and examples. It guides developers on integrating external systems with Synerise via RESTful APIs."
  link: "https://developers.synerise.com/"
  seealso: 
    - "api-key"
    - "jwt"
    - "tracking-code"

- id: "business-profile"
  components:
    - "General terms"
  title: "Business profile"
  short: "Deprecated term previously used to refer to a workspace."
  long: "This term appears in the API (e.g., businessProfileId) and some authorization endpoints, where `profile` is included in the URL as a legacy reference to what is now called a workspace."
  link: "/docs/settings/business-profile/"
  seealso: 
    - "workspace"

- id: "cookies"
  components:
    - "General terms"
  title: "Cookies"
  short: "Small pieces of data stored in a visitor’s browser by the Synerise SDK. They keep information about the customer’s visits, sessions, identifiers (like UUIDs), and campaign tracking, enabling personalized user experiences, event tracking, and session management on websites."
  long: | 
    Cookies in the Synerise platform are small text files stored in a user’s browser by the Synerise JavaScript SDK to hold important customer data. These cookies help identify visitors, track their activity, manage sessions, and support marketing actions such as personalized recommendations and campaign effectiveness.
    Cookie expiration times vary; most user identification cookies expire after about 400 days by default but can be configured differently. Session cookies expire after 30 minutes and cannot be changed.

    Cookies work alongside local storage keys and tracking methods to ensure seamless tracking of website visitors, event sending, and support for various advanced features such as dynamic content campaigns, form tracking, and web push notifications.

    Proper cookie management is vital for accurate customer identification and data consistency across Synerise features. The Synerise SDK also supports configuration options like cookieExpiration to customize cookie lifetimes and advanced tracking code for more detailed visitor data control.
  link: "/developers/web/cookies/"
  seealso: []

- id: "component"
  components:
    - "General terms"
  title: "Component"
  short: "A component is a group of related products organized together and accessible from the left-hand menu on the Synerise platform dashboard (for example, AI Hub, Experience Hub, and so on)."
  long: "A component is a group of related products organized together and accessible from the left-hand menu on the Synerise platform dashboard (for example, AI Hub, Experience Hub, and so on)."
  link: "nolink"
  seealso: 
    - "synerise-platform"
  
- id: "custom-id"
  components:
    - "General terms"
  title: "Custom ID"
  short: "A profile attribute used for recognizing a profile in API clients (applicable when a workspace uses non-unique email addresses)."
  long: "A profile attribute used for recognizing a profile in API clients (applicable when a workspace uses non-unique email addresses)."
  link: "/docs/settings/configuration/non-unique-emails/"
  seealso:
    - "custom-identify"
    - "profile-identifiers"
    - "non-unique-emails"

- id: "custom-identify"
  components:
    - "General terms"
  title: "custom_identify"
  short: "A profile attribute that used for recognizing a profile in Synerise JS SDK (applicable when a workspace uses non-unique email addresses)."
  long: "A profile attribute that used for recognizing a profile in Synerise JS SDK (applicable when a workspace uses non-unique email addresses)."
  link: "/docs/settings/configuration/non-unique-emails/"
  seealso:
    - "custom-id"
    - "profile-identifiers"
    - "non-unique-emails"

- id: "customer"
  components:
    - "General terms"
  title: "Customer"
  short: "A common type of a profile representing the end user for whom actions in a workspace are targeted or analyzed."
  long: "A profile in a workspace represents an entity whose data is recorded and stored, and towards which actions, analyses, and workflows are directed. Profiles can represent various types of entities, with the most common being customers—the end users of the system or service."
  link: "nolink"
  seealso: 
    - "profile"

- id: "id"
  components:
    - "General terms"
  title: "ID"
  short: "Unchangable identifier of a profile assigned in the moment of adding it to the database"
  long: "Unchangable identifier of a profile assigned in the moment of adding it to the database"
  link: "nolink"
  seealso: 
    - "profile-identifiers"

- id: "item"
  components:
    - "General terms"
  title: "Item"
  short: "A single product defined in an item feed"
  long: "An item is an individual product or service. Each item includes attributes such as name, price, description, SKU, and product-specific features. Items serve as fundamental elements for generating recommendations and marketing activities."
  link: "nolink"
  seealso: 
    - "item-feed"
    - "attribute"

- id: "mapping"
  components:
    - "General terms"
  title: "Mapping"
  short: "Process of linking and aligning external data attributes with Synerise’s internal data structure."
  long: "Mapping in Synerise is the process of linking and aligning external data attributes with Synerise’s internal data structure. It is primarily used while importing to ensure data consistency. This feature is available in sections where you configure data imports or synchronize external systems. Proper mapping guarantees that imported data fits seamlessly into Synerise’s environment."
  link: "nolink"
  seealso:
    - "import"

- id: "marketing-agreement"
  components:
    - "General terms"
    - "Experience Hub"
  title: "Marketing agreement"
  short: "A profile attribute which contains a status of marketing agreement. "
  long: "A boolean-type profile attribute indicating the status of a marketing agreement. There are four types of marketing agreements, each corresponding to a communication channel: email, SMS, web push, and mobile push."
  link: "/docs/crm/crm-profile/#subscriptions"
  seealso: []

- id: "mobile-sdk"
  components:
    - "General terms"
  title: "Mobile SDK"
  short: "A toolkit that helps developers add Synerise’s marketing and analytics features to mobile apps for personalized user engagement.  "
  long: "A software development kit provided by Synerise that enables developers to integrate Synerise’s AI-powered marketing, analytics features, and customer engagement features into mobile applications, supporting platforms like iOS and Android for enhanced personalized user experiences."
  link: "/developers/mobile-sdk/"
  seealso: []

- id: "non-unique-emails"
  components:
    - "General terms"
    - "Settings"
    - "Behavioral Data Hub"
  title: "Non-unique emails"
  short: "A configuration in which the custom ID replaces email as the unique identifier of a profile."
  long: "A configuration in which the custom ID replaces email as the unique identifier of a profile. When this is enabled, the email attribute of a profile is no longer considered an identifier and is only used for communication purposes."
  link: "/docs/settings/configuration/non-unique-emails/"
  seealso: 
    - "profile"
    - "attribute"
    - "profile-identifiers"


- id: "private-preview"
  components:
    - "General terms"
  title: "Private Preview"
  short: "Feature access status; the feature is available to a selected group of Synerise customers and strategic partners for early validation."
  long: "The feature is available to a select group of Synerise customers and strategic partners for early validation. Access is granted by invitation and typically involves close collaboration with the Synerise product team. The feature may have limited scope, evolving APIs, and workspace-specific constraints. It is not recommended for production traffic or mission-critical workflows. Feedback from participants directly influences the feature's roadmap and final design."
  link: "nolink"
  seealso: 
    - "public-preview"

- id: "public-preview"
  components:
    - "General terms"
  title: "Public Preview"
  short: "Feature access status; the feature is available to all Synerise customers who choose to enable it within their workspace."
  long: "The feature is available to all Synerise customers who choose to enable it within their workspace. While functional and increasingly stable, it is still being refined based on real-world usage across diverse configurations — including multi-brand setups, high-volume catalogs, and cross-market deployments. SLAs do not apply, and behavior or configuration options may change before final release. Public Preview is suitable for testing, proof-of-concept projects, and non-critical use cases. Customer feedback remains a key input during this stage."
  link: "nolink"
  seealso: 
    - "private-preview"

- id: "general-availability"
  components:
    - "General terms"
  title: "General availability"
  short: "Feature access status; the feature is fully released and production-ready across all Synerise workspaces."
  long: "The feature is fully released and production-ready across all Synerise workspaces. It is covered by standard SLAs, fully documented, and supported through regular support channels. GA features are built to operate reliably at enterprise scale — across multi-brand environments, high-throughput communication workflows, and complex automation scenarios. Any future changes follow Synerise's standard versioning and deprecation policies."
  link: "nolink"
  seealso: 
    - "public-preview"
    - "private-preview"

- id: "profile"
  components:
    - "General terms"
    - "Behavioral Data Hub"
  title: "Profile"
  short: "The data of a person or object"
  long: "A profile is the database entry of a unique entity, usually a customer. The profile stores the activity (events) and attributes (for example, email address) of the entity. It is the subject of analysis (such as funnels or segmentations) and the target of communication campaigns. 
    A profile is NOT the same as a customer account, but they are closely related."
  link: "nolink"
  seealso: 
    - "event"
    - "attribute"

- id: "profile-card"
  components:
    - "General terms"
    - "Behavioral Data Hub"
  title: "Profile card"
  short: "A collection of information about a profile available in the Behavioral Data Hub."
  long: "A collection of information about a profile available in the Behavioral Data Hub. It contains a history of a profile activity (events), assigned attributes and identifiers."
  link: "/docs/crm/crm-profile/"
  seealso: 
    - "profile"
    - "event"
    - "attribute"
    - "marketing-agreement"

- id: "profile-identifiers"
  components:
    - "General terms"
    - "Behavioral Data Hub"
  title: "Profile identifiers"
  short: "ID, UUID, custom ID, email, and phone number of a profile."
  long: | 
    A profile has the following identifiers:
    - ID: unique, generated automatically when the profile is created and cannot be changed
    - UUID: unique, commonly used to identify a profile between devices and sessions. May change; and you can check a profile’s previous UUIDs.
    - custom ID (optional): an ID from a voucher pool or assigned by a third-party system. May be unique depending on the configuration.
    - email (optional): the email address of a profile. If non-unique emails are enabled, the email is no longer an identifier.
    - phone: (optional): a phone number. In some API requests, it may be used as an identifier when no other identifier is provided.
  link: "nolink"
  seealso: 
    - "profile"
    - "uuid"
    - "id"
    - "custom-id"
    - "custom-identify"
    - "non-unique-emails"

- id: "retention"
  components:
    - "General terms"
  title: "Retention"
  short: "How long an event is stored in the database"
  long: "Retention is the number of days an event is stored in the database. After this period, it’s deleted and can’t be used for analysis. Some events are stored infinitely.The retention period is defined separately for each event type (action) and may vary between workspaces, depending on your business agreements with Synerise. The default values are listed in the Event reference. Custom events have a default retention of 30 days."
  link: "nolink"
  seealso:
    - "event"
    - "event-reference"
    - "action"
    - "custom-events"

- id: "sku"
  components:
    - "General terms"
  title: "SKU"
  short: "A unique identifier of an item in your inventory"
  long: "An SKU (Stock Keeping Unit) is a unique identifier of an item in your inventory. It can also be used as the unique ID of the item when you save it in the Synerise catalog which stores your item feed."
  link: "nolink"
  seealso: 
    - "item"
    - "item-feed"
    
- id: "synerise-jinjava"
  components:
    - "General terms"
  title: "Synerise Jinjava"
  short: "A customized Java templating engine based on Jinjava, enhanced with Synerise-specific features and modifications to suit platform needs."
  long: "A customized Java-based templating engine derived from Jinjava (the Java port of Python's Jinja). It incorporates Synerise-specific tags, filters, and feature modifications—such as security-related restrictions and fixes for inconsistencies—to better fit the Synerise platform's requirements, offering a tailored solution rather than a full Jinjava implementation."
  link: "/developers/inserts/"
  seealso: []

- id: "synerise-object"
  components:
    - "General terms"
  title: "Synerise object"
  short: "A generic term for entities such as analyses, templates, predictions, etc."
  long: "Synerise objects is a generic term for: analyses, workflows, inserts, campaigns, recommendations, catalogs, predictions, and other entities which can be referenced, re-used and embedded in a variety of ways in Synerise. Many objects can also be copied between workspaces."
  link: "nolink"
  seealso: 
  - analysis
  - metric
  - segmentation
  - report
  - ai-recommendation


- id: "tag"
  components:
    - "General terms"
    - "Behavioral Data Hub"
    - "Data Modeling Hub"
  title: "Tag"
  short: "Can be used to filter and manage profiles, promotions, campaigns, and workflows and manage communication limits. "
  long: | 
    Tags can be used to mark an asset for more precise analysis or management. Tags are divided into two sub-types:
    - Profile tags: can be used to filter profiles, for example when selecting the audience for a campaign.
    - Asset tags: can be assigned to workflows, promotions, and campaigns to filter their lists and manage [communication limits](/docs/settings/configuration/campaign-limits/).
  link: "nolink"
  seealso:
    - "profile"
    - "campaign"
    - "workflow"
    - "promotions"

- id: "template"
  components:
    - "General terms"
    - "Experience Hub"
    - "Automation Hub"
  title: "Template"
  short: "A re-usable definition of the content of a message or a workflow"
  long: |
    There are the following template variants in Synerise: 
      - A template is a re-usable layout for a message. You can modify it between campaigns to best suit your needs. To personalize the message for each customer and use variables and conditional logic, you can add Synerise Jinjava to the template. Some useful templates are automatically created in each workspace. 
      - You can use workflow templates while using simple imports and exports - when selecting import or export through Automation, you are redirected to a template workflow which let you import/export the data.
  link: "nolink"
  seealso: 
    - "synerise-jinjava"
    - "campaign"
    - "workflow"
  
- id: "synerise-platform"
  components:
    - "General terms"
  title: "The Synerise platform"
  short: "The website where you access your workspace and Synerise features."
  long: |
    The Synerise Platform is the website where you work with Synerise. It allows you to enter workspaces where you have access and use features allowed by your role. The address of the Platform depends on where your workspace is hosted:
    - `https://app.azu.synerise.com` - Microsoft Azure USA deployments
    - `https://app.geb.synerise.com` - Google Cloud deployments
    - `https://app.synerise.com` - Microsoft Azure EU deployments
  link: "nolink"
  seealso: []

- id: "uuid"
  components:
    - "General terms"
  title: "UUID"
  short: "A random identifier of a resource, used widely in Synerise and other systems"
  long: " A random identifier of a resource. In Synerise, you can encounter UUIDs in profiles, events, campaigns, and many other places; and use in a number of different ways. To learn about the details, check the documentation of the element you’re interested in."
  link: "nolink"
  seealso: 
    - "event"
    - "campaign"
    - "profile-identifiers"

- id: "user"
  components:
    - "General terms"
  title: "User"
  short: "A person who uses the Synerise platform."
  long: "A person who uses the Synerise Platform. Each user has their own account in Synerise, and may have access to multiple workspaces. Within each, the user’s access to features is managed by roles and permissions."
  link: "nolink"
  seealso: 
    - "workspace"
    - "component"

- id: "workspace"
  components:
    - "General terms"
    - "Settings"
  title: "Workspace"
  short: "Your “virtual office” in Synerise, shared with other users from your business. May be part of a larger organization."
  long: "Your “office” in Synerise. Each workspace has its own database of profiles, events, analyses, communication campaigns, and so on, which is not accessible to other workspaces unless you copy the data. 
    Users of a workspace may have different access levels, depending on their roles and permissions.
    A workspace is often the representation of one business and accessible only to employees of that business, but large companies may create multiple workspaces (for example, different brands or country branches) collected into organizations. "
  link: "/docs/settings/workspace/"
  seealso: 
    - "user"
    - "profile"
    - "event"
    - "tracking-code"

### COMMUNICATION ###

- id: "audience"
  components:
    - "Experience Hub"
    - "Automation Hub"
    - "AI Hub"
    - "Data Modeling Hub"
  title: "Audience"
  short: "A defined group of profiles targeted with your activities (for example, send message, create a workflow)."
  long: "An audience is typically a predefined segmentation or a new group of profiles defined on the spot. These profiles share specific attributes or behaviors. Audiences serve as targets for campaigns, workflows, objects, and predictions, enabling personalized marketing strategies."
  link: "nolink"
  seealso:
    - "segmentation"
    - "profile"
    - "attribute"
    - "campaign"
    - "marketing-agreement"

- id: "campaign"
  components:
    - "Experience Hub"
    - "Automation Hub"
  title: "Campaign"
  short: "An object in Experience Hub representing a marketing initiative (for example, email, SMS, push) sent to or displayed to multiple profiles."
  long: "In Experience Hub, you can create campaigns to send messages or display content: email, SMS, web push, mobile push, dynamic content, in-app messages, recommendations. It is designed to be sent to or displayed to profiles specified by the campaign’s audience. This term refers to the overall object, not to an individual message sent within that campaign. "
  link: "/docs/campaign/"
  seealso: 
    - "ai-recommendation"
    - "audience"
    - "profile"
    - "global-control-group"

- id: "communication"
  components:
    - "Experience Hub"
  title: "Communication"
  short: "The former name for Experience Hub"
  long: "The former name for Experience Hub"
  link: "nolink"
  seealso: 
    - "experience-hub"

- id: "experience-hub"
  components:
    - "Experience Hub"
  title: "Experience Hub"
  short: "The name of the component in the Synerise platform in which you can create messages, dynamic content (pop-ups and web layers), landing pages, and screen views."
  long: "The name of the module in the Synerise platform where you can create and send different types of customer messages, such as emails, pop-ups, web layers, landing pages, and screen views. This component helps you run marketing campaigns across many channels like email, SMS, and push notifications. It works together with other parts of the Synerise platform to help you target the right audience, personalize your messages, and track how well your campaigns are doing. This makes it easier to connect with customers and improve their experience. "
  link: "/docs/campaign/"
  seealso: 
    - "audience"
    - "campaign"
    - "marketing-agreement"
    - "tag"
    - "synerise-platform"


- id: "fcm-token"
  components:
    - "Experience Hub"
    - "Settings"
  title: "FCM token"
  short: "A unique identifier that enables mobile and web applications to receive messages through Firebase Cloud Messaging (FCM)."
  long: "An FCM token is a unique identifier generated by Firebase Cloud Messaging and sent to Synerise along with the UUID of a profile who has consented to receive web push notifications through the browser’s permission prompt. This token is required to send web push notifications to the user’s device. The presence and status of the FCM token are tracked in the snrs_has_web_push_devices attribute, which is set to true when a valid token is assigned to the profile."
  link: "/docs/campaign/Webpush/introduction-to-webpush/#fcm-token"
  seealso: 
    - "attribute"
    - "fcm-token-migration"
    - "uuid"
    - "profile"
    - "marketing-agreement"

- id: "fcm-token-migration"
  components:
    - "Settings"
    - "Experience Hub"
  title: "FCM token migration"
  short: "Firebase Cloud Messaging tokens may require migration if multiple customers share a device"
  long: "Token migration is a process in which the assignment of a FCM token is transferred from one profile to another, along with associated changes in web push marketing consent. This migration occurs when a profile context changes in the browser, such as when a profile logs out and a new profile logs in, causing the FCM token to be reassigned to the new profile or when [customer profiles are merged](/developers/api/clients/profiles/merging-profiles/)."
  link: "/docs/campaign/Webpush/introduction-to-webpush/#fcm-token-migration"
  seealso: 
    - "fcm-token"
    - "marketing-agreement"
    - "profile"

- id: "global-control-group"
  components:
    - "Experience Hub"
    - "Automation Hub"
    - "Settings"
  title: "Global Control Group"
  short: "A group of profiles excluded from the audience of the message by default for any campaign type sent from Synerise. "
  long: "Global Control Group is a group of profiles which can be excluded from the audience of the message. You can set the global control group to be enabled by default for any campaign type sent from Synerise. You can enable or disable global control group separately for  Experience Hub (in which you manually send campaigns) and Automation Hub."
  link: "/docs/settings/configuration/global-control-group/"
  seealso: 
    - "audience"
    - "campaign"
