Mappings¶
The overlap is small: column fields and one contract price (ODCS), pricing plans (ODPS 4.1) and relationships (Apache Ossie). Do not expect a full ODCS or Ossie mapping. For every standard the spec builds on, including UCUM and ISO 4217, see Related standards.
The spec carries knowledge that other formats have no place for, so it is not a replacement for them. Where fields overlap they follow the other format's names or are mapped, as below. Mappings are defined here from the first implementation's models and pricing code; a generator that writes whole ODCS or Ossie files is not part of this version.
ODCS: columns¶
Each column maps to an ODCS schema property. ODCS has no unit field, so the unit fields go to customProperties.
| Declarations | ODCS |
|---|---|
type |
logicalType |
physical_type (declared value, else the build's) |
physicalType |
description |
description |
unit, currency, per |
customProperties entries {property: unit, currency or per, value: ...} |
ODCS: price¶
An ODCS (Open Data Contract Standard) contract has one price. It is filled from the first plan, in order, that has
a price, is not Revenue-sharing and is not a free unit (Freemium, Open-data, Trial). If none qualifies there
is no ODCS price.
| Declarations | ODCS |
|---|---|
pricing[].price |
price.priceAmount (as a number) |
pricing[].price_currency |
price.priceCurrency |
pricing[].price_unit, else GB when unit is Data-volume, else billing_duration |
price.priceUnit |
Absent values are left out.
ODPS 4.1: pricing plans¶
Every plan maps to one entry under pricingPlans.declarative.<language> (language en by default).
| Declarations | ODPS 4.1 | Note |
|---|---|---|
name |
name |
|
unit |
unit |
Same enumeration. |
price |
price |
Written as a string. |
price_currency |
priceCurrency |
|
billing_duration |
billingDuration |
|
max_transaction_quantity |
maxTransactionQuantity |
|
additional_price |
additionalPrice |
Written as a string. |
max_data_quantity |
maxDataQuantity |
|
min_price |
minPrice |
Written as a string. |
max_price |
maxPrice |
Written as a string. |
offering |
offering |
Omitted when empty. |
valid_from |
validFrom |
Date becomes a date-time at midnight UTC. |
valid_to |
validTo |
As above. |
notes |
notes |
|
price_unit |
- | Not an ODPS field; left out (it goes to ODCS). |
x- keys |
- | Left out. |
Apache Ossie: relationships¶
relationships[] follows the shape of an Ossie relationship.
| Declarations | Ossie | Note |
|---|---|---|
name |
name |
|
from |
from |
Many side. |
to |
to |
One side. |
from_columns |
from_columns |
Matched to to_columns by position. |
to_columns |
to_columns |
|
ai_context |
ai_context |
String or map. |
Not in these formats¶
The following have no counterpart in the formats above: dates_asof (an as-of date per source), facts (status,
severity, expiry, citation id), use_cases and do_not, removed_columns, not_exported and the aliases. They are
the reason the spec exists.