Skip to content
Last updated

Key Concepts

This page introduces the main One Platform concepts used across customer management, service activation, monitoring, and billing flows.

Core concepts

ConceptDescription
OrganizationOperational scope used to manage users, services, and customers.
UserMyNamirial identity with access to One Platform functions.
ConsumerEntity that can represent a customer, legal entity, partner, or internal unit.
ContractAgreement used to activate one or more services for a customer.
Business RelationLink between product, legal entity, customer path, and integrator.
ConsumptionUsage value recorded for a business relation and product metric.
Product MetricDefinition of what is measured for a product, such as transactions, documents, or volume.

Technical terms such as attributes, counters, and price models are introduced only where they are needed.

Customers

A customer is an individual or company involved in the buying or selling flow of a Namirial product.

Customer entity modularity

The term includes:

  • direct customers
  • indirect customers
  • end users
  • resellers

Customer data is organized into these main groups:

Data groupPurpose
Basic dataMinimum data required for every consumer, such as identifier, name, country, and customer type.
Fiscal dataTax information used to define the fiscal status of the customer.
Billing dataData required when the customer is billable.
Birth dataBirth information for individual customers.
Residence dataResidence information for individual customers.
Contact detailsEmails, PEC addresses, and phone numbers.
Custom dataProduct-line-specific metadata and custom attributes.

Customer records can represent different commercial roles depending on the relationship with the product or service.

Contracts

A contract is the service activation model for a customer.

Contract structure

A contract contains the customer context and the services to activate. Each service line can include provisioning data, pricing data, lifecycle state, and the business relation used for metering and billing.

Contracts are used to support:

  • service activation
  • digital signing flows
  • product provisioning
  • reporting and billing support

Consumptions

A consumption is a set of metric values that represents product usage for a specific business relation.

Consumption schema

Metrics

Metrics define what is measured for a product line.

Examples include:

  • number of documents
  • document size
  • number of transactions

A metric can include a unit of measurement.

Metric types

TypeBehavior
IncrementalValues are added to previous consumptions.
TotalThe latest value replaces the previous total for the same period. Missing totals count as zero.
Total persistentSimilar to total, but keeps using the latest sent consumption until a newer value is available.

Attributes

Attributes describe qualitative dimensions of a consumption.

Business relations answer who made the consumption. Attributes describe what the consumption refers to.

For example, an Archive product can use attributes to group metrics by document type.

Timestamp and datestamp

  • Timestamp identifies when the consumption was made.
  • Datestamp identifies the publication date used to group usage by day.