Glossary
Look through the glossary of Emporix terms.
access control
A combination of user's roles and resources determining what a user can do on a particular entity.
add-on
An add-on, or plugin, is a software component that adds a specific feature or functionality to the Emporix platform. An add-on is usually more focused and contained within the external host application to extend the capabilities without alerting its fundamental structure. Usually, it's pre-built and ready to use with minimal setup but can allow some customization or configuration. For example, there are a few Emporix add-ons dedicated to external CMSs or support systems.
API
An API, or Application Programming Interface is a set of rules, protocols and tools that allow different software applications and systems to communicate and interact with each other. Emporix services expose public REST API that enable communication with external systems and allow you to easily manage your business resources.
authentication
A process of verifying the identity of a user, system, or entity to ensure that they are who or what they claim to be. It's a first line defense mechanism before granting access to a system, or application.
authorization
A process of determining and granting permissions and access controls for a user to perform specific actions or access particular resources. Authorization enhances security of the application by restricting access and ensuring that actions are performed by users with the appropriate level of permission.
calculationType
An attribute of the totalDiscount parameter. It indicates whether discounts were applied to net or gross values.
The discount is applied to either price.grossValue, when includesTax=true, or price.netValue, when includesTax=false. Based on this, the corresponding net or gross value is recalculated using the tax rate.
The calculation method used is indicated in totalDiscount.calculationType, which can be either ApplyDiscountAfterTax or ApplyDiscountBeforeTax.
CE
Commerce Engine is a MACH digital commerce platform combining B2B and B2C features that provides end-to-end commerce solution. Previously, it was known as Digital Commerce Platform.
Commerce Orchestration Platform
Emporix solution that enables you to digitalize your sales end-to-end. It embraces Commerce Engine and Orchestration Engine that together can help you revolutionize the ways you sell your goods and operate more efficiently within your company.
data retention policy
Standard practice of storing and maintaining data for a specified period to meet legal, regulatory, business, or other requirements. The policy takes into account factors such as purpose, compliance, and security. The data retention in Emporix refers to data collected by digital processes.
digital process
A process you can configure and trigger in the Orchestration Engine to automate typical workflows and connect different systems. A digital process starts upon a defined trigger in the system and can consist of multiple steps.
discountedPrice
The attribute used to calculate a relevant price on an item level or on a cart level.
On an item level, it's the price of the line item calculated as unit price multiplied by quantity, with any applied discounts.
The attribute is included in the cart response if a discount is applied to at least one line item.
Depending on the tax configuration for a site, it get be either net or gross.
The calculation method that was used is indicated in totalDiscount.calculationType, which can be either ApplyDiscountAfterTax or ApplyDiscountBeforeTax.
On a cart level, it's the sum of all line item prices after discounts. This attribute is included in the cart response if at least one line item has a discounted price. It represents the total of discounted prices for line items with discounts applied, or the regular prices for line items without discounts. Ultimately, it reflects the total cost of all line items after discounts.
domain
A unique name that identifies your website or online store.
effectiveValue
employee group
An aggregation of a tenant employees that share the same access control within a particular service and resource. By assigning an employee to a particular group, you grant them access to a specific access control level.
event log
A record of an important action or incident in a system or network, for example, an error or a user activity, in relation to a digital process. You can check the event logs in the Management Dashboard under OE -> Events -> Event Log.
event registry
A list of all events configured in a tenant as triggers for the digital processes. The Event Registry is available in the Management Dashboard under OE -> Events -> Event Registry.
extension
A custom module that contains custom logic and functionality that you can build separately and embed to the Management Dashboard. An extension has to contain the appropriate dependency to the Management Dashboard to be able to read contextual information.
finalPrice
The final price calculation on an item level or on a cart level.
On an item level, it's the sum of the discountedPrice or the original price, depending on whether any discounts were applied to the line item, and the totalFee, which includes all fees applied to the line item.
On a cart level, it means the sum of the all the items final prices, total shipping cost and fees included in the cart.
IAM
Identity and Access Management (IAM) Service is responsible for granting access rights and permissions for different groups and users in the Emporix system.
includesTax
The setting defined at the site or price model level. It is used in the price matching algorithm by the Price Service to calculate product prices. The setting determines if the algorithm returns net or gross prices.
integration
Integration involves connecting two or more systems, applications, or services so that they can work together and exchange data between each other. For example, you can integrate a payment gateway system, or a CRM software. Implementation can involve APIs, middleware, or webhooks to enable communication.
mixin
Mixins are custom attributes that you can add to the Emporix system to extend the data model of different entities, such as, for example, products, catalogs, or customers. Mixins functionality supports creating a custom fields schema that validates if the associated data is correct.
OAuth
OAuth (Open Authorization) is an open-standard framework for granting user's or third-party application access to the application without exposing their credentials. OAuth uses authorization tokens to grand relevant limited access based on user's permissions. OAuth Service in the Emporix system allows you to generate the following token types: anonymous, SaaS (customer), and service access tokens. Anonymous token is used on a storefront to access public resources with a read scope to allow customers browse products with prices, and add products to cart. SaaS token works similarly,but it's associated with a specific customer when they log in. The Service access token is required to access the Emporix services to manage and manipulate data, such as products, categories, prices, and others.
OE
Orchestration Engine is the application that allows you to digitalize and optimize the company's processes and workflows. OE introduces real-time, end-to-end process intelligence to enable creation of digital processes that orchestrate people and systems across your business, and even outside of it. Previously, it was known as Commerce Execution Platform.
originalValue
permission
A mechanism for controlling and limiting what actions a user can perform on specified resources.
Pick-Pack
The Pick-Pack service facilitates management of picking and packing process in-store and in a warehouse.
price
A unit price assigned to a product at price matching operation. It's multiplied by the item quantity.
At cart level, the term means a sum of all line item prices without discounts.
rulestore
A place where you can define, configure, and store business rules that you can use in a digital process as a filter logic for a step or a scenario. For example, a rule that allows approving product return requests only for damaged products, based on the return reasons. The rulestore keeps the rules so that you can easily reuse them in multiple digital processes. The rules remain inactive until they are referenced by a specific process.
schema
Schema Service allows you to manage and validate mixin fields for different entities.
scope
A constraint or filter applied to API endpoints to determine what a user can do with a service.
SEPA
Single Euro Payments Area (SEPA) allows cashless transactions in Euro within the European Union and some non-EU countries. In the Management Dashboard, you can generate SEPA-XML file for all orders with INVOICE status and payment set to DIRECT DEBIT.
service
An independent, self-contained unit that is responsible for a specific function and communicates with other services through APIs. Emporix uses microservices architecture.
site
A site represents a specific shop, warehouse or another independent facility. You can have multiple sites depending on the specific business needs. For example, if you have multiple locations and have to handle different delivery areas for each location, the taxes vary between locations, or there are different delivery options available.
site-aware
The ability of the system, application or a process to recognize and adapt to the specific site-related configurations or characteristics. In Emporix, there are the following site-aware resources: carts, delivery methods, delivery times, delivery zones, fees, orders, payment methods, picklists, packlists, pickup points, product availabilities, product locations, promotions, stock levels, prices, tax rates, and shipping.
site code
A unique identifier of a site for your online store. For example, it can be associated with a country where you operate. You define the site code in the Settings -> Sites in the Management Dashboard.
Svix
Svix is the third-party webhook service provider supported in Emporix platform. You can use shared limited account or connect your own Svix licence to manage webhooks on the events taking place in the system, or use an alternative solution.
targetCurrency
The parameter used by the Price Service in price matching operation. The targetCurrency means the code of the currency in which the prices should be matched, as defined in the Currency Service. If the matched price is defined in another currency, the service uses the currency exchange algorithm, but only if exchange rates between the two currencies have been defined beforehand.
taxAggregate
A list of tax values grouped by taxCode and taxRate.
It includes the sum of the following calculations:
item[].calculatedPrice.discountedPriceoritem[].calculatedPrice.price,item[].calculatedPrice.fees[].discountedPriceoritem[].calculatedPrice.fees[].price,calculatedPrice.totalShippingcalculatedPrice.paymentFees
tenant
An instance of Emporix Commerce Orchestration Platform that is made available for a particular company or organization as Emporix is a multi-tenant SaaS solution. Each tenant has a separate and isolated access to the data, configuration and other resources, and can be managed individually, as if it was running on it own. Even though, all the Emporix tenants share the same hardware and software infrastructure.
totalValue
A total value of all the units of a product or SKU item included in an order, based on the item's effectiveValue price, that is, including a discount if applicable.
totalDiscount
The cart attribute indicating the calculated discounts on an item level and on a cart level.
On an item level, it means a summary of all discounts applied to the line, including discounts on both the line item's price and its fees.
On a cart level, it means a sum of all applied lines discounts and shipping discounts.
totalFee
Sum of all fees applied to the line item. It's calculated by summarizing all the fees and any discounts applied to the fees.
totalShipping
The calculated shipping cost of the cart items.
upliftValue
An additional amount authorized for payment to cover potential price adjustments during packing of weight-based products. There are two conditions to have this value for an item line in a cart:
The item is added to the cart with the
weightDependent":trueattribute. It means that the quantity may vary during packaging, as some items, for example a case of bananas, cannot be divided to precisely match a given weight.The site has the percentage uplift defined -
authorizedAmountUplift, for example 0,1=10%. If the itemprice.netValue=12, theupliftValue.netValue=1,2with the 10% uplift configured.
user group
A group of users who share some common characteristics, like performing a similar job. A user group defines access controls for the users assigned to it.
webhook
A webhook is a user-defined callback mechanism that allows an application to send real-time data to another application when a specific event occurs. Applications or services can communicate with each other automatically when a certain action or event takes place in a system and send data to a specified URL endpoint. You can use webhooks for smooth API communication, automation of workflows, and notifications.
weight-dependency
A product is designated as weight-dependent when its final sale price is calculated based on its actual weight after packaging. This designation is crucial for accurate payment authorization, as the initially estimated price may differ from the final price.
Last updated
Was this helpful?