@peter.prib/renderengine 0.2.7 → 0.2.10

package/examples/data-model.html

@@ -115,6 +115,7 @@
 
     const logical = {
         entities: [
+            { id: 'party', name: 'Party', ...at(0.5, -0.8), description: 'A person or an organisation: what Person and Organisation are kinds of.', attributes: [attr('party id', 'PK'), attr('kind')] },
             { id: 'person', name: 'Person', ...at(0, 0), attributes: [attr('party id', 'PK'), attr('given name'), attr('family name'), attr('born on')] },
             { id: 'organisation', name: 'Organisation', ...at(1, 0), attributes: [attr('party id', 'PK'), attr('legal name'), attr('registration number')] },
             { id: 'party-role', name: 'Party Role', ...at(0, 1), attributes: [attr('party id', 'PK FK'), attr('role code', 'PK FK'), attr('valid from'), attr('valid to')] },
@@ -137,6 +138,8 @@
             { id: 'code', name: 'Classification Code', ...at(4, 2), attributes: [attr('scheme', 'PK FK'), attr('code', 'PK'), attr('label'), attr('parent code', 'FK')] },
         ],
         relationships: [
+            { id: 'person-is-party', kind: 'generalization', source: 'person', target: 'party', complete: true, disjoint: true },
+            { id: 'organisation-is-party', kind: 'generalization', source: 'organisation', target: 'party', complete: true, disjoint: true },
             { source: 'person', target: 'party-role', name: 'plays', sourceCardinality: '1', targetCardinality: '0..*' },
             { source: 'organisation', target: 'party-role', name: 'plays', sourceCardinality: '1', targetCardinality: '0..*' },
             { source: 'arrangement', target: 'participation', name: 'has', sourceCardinality: '1', targetCardinality: '1..*' },
@@ -181,7 +184,7 @@
             ] },
             { id: 'place', name: 'place', ...at(3, 0), attributes: [
                 // GEOGRAPHY is no type group the drawing knows: it shows as unknown (grey).
-                attr('place_id', 'PK', 'BIGINT'), attr('name', '', 'TEXT'), attr('location', '', 'GEOGRAPHY'), attr('tz', '', 'VARCHAR(40)'),
+                attr('place_id', 'PK', 'BIGINT'), attr('name', '', 'VARCHAR(120)'), attr('location', '', 'GEOGRAPHY'), attr('tz', '', 'VARCHAR(40)'),
             ] },
             { id: 'business_event', name: 'business_event', ...at(2, 1), attributes: [
                 attr('event_id', 'PK', 'BIGINT'), attr('type_code', 'FK', 'VARCHAR(20)'), attr('occurred_at', '', 'TIMESTAMP'),
@@ -197,7 +200,7 @@
                 attr('launched_on', '', 'DATE'), attr('retired_on', '', 'DATE'), attr('components', '', 'JSONB'),
             ] },
             { id: 'product_price', name: 'product_price', ...at(4, 1), attributes: [
-                attr('product_id', 'PK FK', 'BIGINT'), attr('valid_from', 'PK', 'DATE'), attr('amount', '', 'DECIMAL(12,2)'), attr('currency', '', 'CHAR(3)'),
+                attr('product_id', 'PK FK', 'BIGINT'), attr('valid_from', 'PK', 'DATE'), attr('amount', '', 'DECIMAL(18,2)'), attr('currency', '', 'CHAR(3)'),
             ] },
             { id: 'agreement', name: 'agreement', ...at(0, 3), attributes: [
                 attr('agreement_id', 'PK', 'BIGINT'), attr('party_id', 'FK', 'BIGINT'), attr('signed_on', '', 'DATE'), attr('terms', '', 'JSONB'),
@@ -206,7 +209,7 @@
                 attr('product_id', 'PK FK', 'BIGINT'), attr('feature', 'PK', 'VARCHAR(40)'), attr('value', '', 'TEXT'),
             ] },
             { id: 'condition', name: 'condition', ...at(2, 3), attributes: [
-                attr('condition_code', 'PK', 'VARCHAR(20)'), attr('kind', '', 'VARCHAR(12)'), attr('rate', '', 'DECIMAL(9,4)'), attr('product_id', 'FK', 'BIGINT'),
+                attr('condition_code', 'PK', 'VARCHAR(20)'), attr('kind', '', 'VARCHAR(20)'), attr('rate', '', 'DECIMAL(9,4)'), attr('product_id', 'FK', 'BIGINT'),
             ] },
             { id: 'business_direction', name: 'business_direction', ...at(0, 2), attributes: [
                 attr('direction_id', 'PK', 'BIGINT'), attr('kind', '', 'VARCHAR(20)'), attr('statement', '', 'TEXT'),
@@ -214,9 +217,9 @@
             ] },
             { id: 'direction_target', name: 'direction_target', ...at(4, 2), attributes: [
                 attr('direction_id', 'PK FK', 'BIGINT'), attr('measure', 'PK', 'VARCHAR(40)'), attr('product_id', 'FK', 'BIGINT'),
-                attr('value', '', 'NUMERIC(14,2)'), attr('unit', '', 'VARCHAR(10)'), attr('due_on', '', 'DATE'),
+                attr('target_value', '', 'NUMERIC(14,2)'), attr('unit', '', 'VARCHAR(10)'), attr('due_on', '', 'DATE'),
             ] },
-            { id: 'account', name: 'account', ...at(3, 2), attributes: [attr('account_code', 'PK', 'VARCHAR(20)'), attr('name', '', 'TEXT'), attr('kind', '', 'CHAR(1)')] },
+            { id: 'account', name: 'account', ...at(3, 2), attributes: [attr('account_code', 'PK', 'VARCHAR(20)'), attr('name', '', 'VARCHAR(120)'), attr('kind', '', 'VARCHAR(20)')] },
             { id: 'classification', name: 'classification', ...at(3, 1), attributes: [
                 attr('scheme', 'PK', 'VARCHAR(40)'), attr('code', 'PK', 'VARCHAR(20)'), attr('label', '', 'TEXT'),
                 attr('parent_code', 'FK', 'VARCHAR(20)'), attr('notes'),   // no type at all: unknown too
@@ -246,7 +249,7 @@
     // How the levels map: [concept, logical entity], then [logical entity, table]; any number either way.
     const mappings = [
         { from: 'conceptual', to: 'logical', pairs: [
-            ['party', 'person'], ['party', 'organisation'], ['role', 'party-role'],
+            ['party', 'party'], ['party', 'person'], ['party', 'organisation'], ['role', 'party-role'],
             ['party', 'participation'], ['arrangement', 'participation'], ['role', 'participation'],
             ['arrangement', 'arrangement'], ['resource', 'resource'], ['place', 'place'], ['event', 'event'],
             ['ledger', 'account'], ['ledger', 'ledger-entry'], ['classification', 'scheme'], ['classification', 'code'],
@@ -255,7 +258,7 @@
             ['agreement', 'agreement'], ['feature', 'product-feature'], ['condition', 'condition'],
         ] },
         { from: 'logical', to: 'physical', pairs: [
-            ['person', 'party'], ['organisation', 'party'], ['party-role', 'party_role'], ['participation', 'arrangement_party'],
+            ['party', 'party'], ['person', 'party'], ['organisation', 'party'], ['party-role', 'party_role'], ['participation', 'arrangement_party'],
             ['arrangement', 'arrangement'], ['resource', 'resource'], ['place', 'place'],
             ['event', 'business_event'], ['event', 'event_payload'], ['account', 'account'], ['ledger-entry', 'ledger_entry'],
             ['scheme', 'classification'], ['code', 'classification'],
@@ -307,6 +310,7 @@
                 { id: 'gst', text: 'Prices include GST (10%)', applies: ['ledger', 'product'], x: 1030, y: 600 },
                 { id: 'one-price', text: 'A product has one current price', applies: ['product'], x: 730, y: 790 },
                 { id: 'one-payer', text: 'A subscription has exactly one paying customer', applies: ['arrangement', 'party'], x: 280, y: 225 },
+                { id: 'legal-name', text: 'always given for an organisation', applies: ['party'], dimension: 'Completeness', attribute: 'legal name', x: 1330, y: 225 },
             ],
         },
         {
@@ -360,7 +364,8 @@
         levels: {
             conceptual: {
                 entities: [
-                    { id: 'party', name: 'Party', details: { bian: 'Party' }, ...grid(0, 0), shape: 'person', labelPosition: 'below', color: '#ede9fe', description: 'A person or organisation the bank deals with.' },
+                    { id: 'party', name: 'Party', details: { bian: 'Party' }, ...grid(0, 0), shape: 'person', labelPosition: 'below', color: '#ede9fe', description: 'A person or organisation the bank deals with.',
+                        sensitivity: 'Confidential', categories: ['PII'], stewardship: { owner: 'Head of Customer', steward: 'Customer data steward' } },
                     { id: 'agreement', name: 'Agreement', details: { bian: 'Agreement' }, ...grid(1, 0), shape: 'contract-box', color: '#fef9c3', description: 'The contract a customer signs with the bank: the promises both parties agree on.' },
                     { id: 'arrangement', name: 'Arrangement', details: { bian: 'Arrangement' }, ...grid(2, 0), color: '#fef3c7', description: 'The terms a product is provided on, under an agreement: an account, a loan.' },
                     { id: 'product', name: 'Product', details: { bian: 'Product' }, ...grid(3, 0), shape: 'product-box', color: '#dcfce7', description: 'What the bank offers: a current account, a consumer loan.' },
@@ -377,9 +382,11 @@
             },
             logical: {
                 entities: [
-                    { id: 'party-entry', name: 'Party Reference Data Directory Entry', ...grid(0, 0), attributes: [attr('party id', 'PK'), attr('legal name'), attr('kind')] },
-                    { id: 'party-reference', name: 'Reference', ...grid(0, 1), attributes: [attr('party id', 'PK FK'), attr('tax number'), attr('passport')] },
-                    { id: 'demographics', name: 'Demographics', ...grid(0, 2), attributes: [attr('party id', 'PK FK'), attr('born on'), attr('occupation')] },
+                    { id: 'party-entry', name: 'Party Reference Data Directory Entry', ...grid(0, 0), stewardship: { steward: 'Customer data steward' },
+                        attributes: [attr('party id', 'PK'), { ...attr('legal name'), sensitivity: 'Confidential', categories: ['PII'] }, attr('kind')] },
+                    { id: 'party-reference', name: 'Reference', ...grid(0, 1), attributes: [attr('party id', 'PK FK'),
+                        { ...attr('tax number'), sensitivity: 'Restricted', categories: ['PII'] }, { ...attr('passport'), sensitivity: 'Restricted', categories: ['PII'] }] },
+                    { id: 'demographics', name: 'Demographics', ...grid(0, 2), attributes: [attr('party id', 'PK FK'), { ...attr('born on'), sensitivity: 'Confidential', categories: ['PII'] }, attr('occupation')] },
                     { id: 'customer-agreement', name: 'Customer Agreement', ...grid(1, 0), attributes: [attr('agreement id', 'PK'), attr('party id', 'FK'), attr('signed on'), attr('status')] },
                     { id: 'agreement-term', name: 'Agreement Term', ...grid(1, 1), attributes: [attr('agreement id', 'PK FK'), attr('term', 'PK'), attr('value')] },
                     { id: 'current-account', name: 'Current Account Facility', ...grid(2, 0), attributes: [attr('arrangement id', 'PK'), attr('agreement id', 'FK'), attr('product id', 'FK'), attr('account number', '', 'Account Identification'), attr('account type', '', 'Current Account Type'), attr('currency', '', 'Currency Code'), attr('balance', '', 'Amount'), attr('opened on')] },
@@ -419,17 +426,31 @@
             },
             physical: {
                 entities: [
-                    { id: 'party', name: 'party', ...grid(0, 0), attributes: [attr('party_id', 'PK', 'BIGINT'), attr('legal_name', '', 'VARCHAR(200)'), attr('party_kind', '', 'CHAR(1)'), attr('tax_number', '', 'VARCHAR(20)'), attr('born_on', '', 'DATE'), attr('details', '', 'JSONB')] },
-                    { id: 'customer_agreement', name: 'customer_agreement', ...grid(1, 0), attributes: [attr('agreement_id', 'PK', 'BIGINT'), attr('party_id', 'FK', 'BIGINT'), attr('signed_on', '', 'DATE'), attr('status', '', 'VARCHAR(12)'), attr('terms', '', 'JSONB')] },
-                    { id: 'account', name: 'account', ...grid(2, 0), attributes: [attr('arrangement_id', 'PK', 'BIGINT'), attr('agreement_id', 'FK', 'BIGINT'), attr('product_id', 'FK', 'BIGINT'), attr('kind', '', 'CHAR(1)'), attr('balance', '', 'DECIMAL(18,2)'), attr('opened_on', '', 'DATE')] },
-                    { id: 'account_interest', name: 'account_interest', ...grid(2, 1), attributes: [attr('arrangement_id', 'PK FK', 'BIGINT'), attr('rate', '', 'DECIMAL(7,4)'), attr('basis', '', 'VARCHAR(10)')] },
-                    { id: 'account_mandate', name: 'account_mandate', ...grid(2, 2), attributes: [attr('arrangement_id', 'PK FK', 'BIGINT'), attr('mandate', 'PK', 'VARCHAR(30)'), attr('kind', '', 'VARCHAR(12)'), attr('amount', '', 'DECIMAL(18,2)')] },
-                    { id: 'account_fee', name: 'account_fee', ...grid(2, 3), attributes: [attr('arrangement_id', 'PK FK', 'BIGINT'), attr('fee_code', 'PK', 'VARCHAR(12)'), attr('amount', '', 'DECIMAL(12,2)')] },
-                    { id: 'loan_schedule', name: 'loan_schedule', ...grid(3, 1), attributes: [attr('arrangement_id', 'PK FK', 'BIGINT'), attr('due_on', 'PK', 'DATE'), attr('kind', '', 'CHAR(1)'), attr('amount', '', 'DECIMAL(18,2)'), attr('paid', '', 'BOOLEAN')] },
+                    { id: 'party', name: 'party', ...grid(0, 0), sensitivity: 'Restricted', categories: ['PII'], stewardship: { custodian: 'Core banking platform team' }, attributes: [attr('party_id', 'PK', 'BIGINT'), attr('legal_name', '', 'VARCHAR(200)'), attr('party_kind', '', 'CHAR(1)'), attr('tax_number', '', 'VARCHAR(20)'), attr('born_on', '', 'DATE'), attr('details', '', 'JSONB')] },
+                    { id: 'customer_agreement', name: 'customer_agreement', ...grid(1, 0), attributes: [attr('agreement_id', 'PK', 'BIGINT'), { ...attr('party_id', 'FK', 'BIGINT'), references: 'party' }, attr('signed_on', '', 'DATE'), attr('status', '', 'VARCHAR(12)'), attr('terms', '', 'JSONB')] },
+                    { id: 'account', name: 'account', ...grid(2, 0), attributes: [attr('arrangement_id', 'PK', 'BIGINT'), { ...attr('agreement_id', 'FK', 'BIGINT'), references: 'customer_agreement' }, { ...attr('product_id', 'FK', 'BIGINT'), references: 'product' }, attr('kind', '', 'VARCHAR(20)'), attr('balance', '', 'DECIMAL(18,2)'), attr('opened_on', '', 'DATE')] },
+                    { id: 'account_interest', name: 'account_interest', ...grid(2, 1), attributes: [{ ...attr('arrangement_id', 'PK FK', 'BIGINT'), references: 'account' }, attr('rate', '', 'DECIMAL(7,4)'), attr('basis', '', 'VARCHAR(10)')] },
+                    { id: 'account_mandate', name: 'account_mandate', ...grid(2, 2), attributes: [{ ...attr('arrangement_id', 'PK FK', 'BIGINT'), references: 'account' }, attr('mandate', 'PK', 'VARCHAR(30)'), attr('kind', '', 'VARCHAR(20)'), attr('amount', '', 'DECIMAL(18,2)')] },
+                    { id: 'account_fee', name: 'account_fee', ...grid(2, 3), attributes: [{ ...attr('arrangement_id', 'PK FK', 'BIGINT'), references: 'account' }, attr('fee_code', 'PK', 'VARCHAR(12)'), attr('amount', '', 'DECIMAL(18,2)')] },
+                    { id: 'loan_schedule', name: 'loan_schedule', ...grid(3, 1), attributes: [attr('arrangement_id', 'PK FK', 'BIGINT'), attr('due_on', 'PK', 'DATE'), attr('kind', '', 'VARCHAR(20)'), attr('amount', '', 'DECIMAL(18,2)'), attr('paid', '', 'BOOLEAN')] },
                     { id: 'payment_order', name: 'payment_order', ...grid(4, 0), attributes: [attr('payment_id', 'PK', 'BIGINT'), attr('from_arrangement', 'FK', 'BIGINT'), attr('to_account', '', 'VARCHAR(34)'), attr('amount', '', 'DECIMAL(18,2)'), attr('status', '', 'VARCHAR(12)'), attr('steps', '', 'JSONB')] },
                     { id: 'product', name: 'product', ...grid(5, 0), attributes: [attr('product_id', 'PK', 'BIGINT'), attr('name', '', 'VARCHAR(120)'), attr('line', '', 'VARCHAR(20)'), attr('features', '', 'JSONB'), attr('conditions', '', 'JSONB')] },
+                    // A star for reporting balances (a dimensional scheme): a fact at a stated grain, its dimensions around it.
+                    { id: 'dim_account', name: 'dim_account', ...grid(6, 0), role: 'dimension', scdType: '2', description: 'An account as it was over time: a row per version.', attributes: [
+                        attr('account_key', 'PK', 'BIGINT'), { ...attr('arrangement_id', 'FK', 'BIGINT'), references: 'account' }, attr('valid_from', '', 'DATE'), attr('valid_to', '', 'DATE'),
+                    ] },
+                    { id: 'dim_date', name: 'dim_date', ...grid(7, 0), role: 'dimension', scdType: '0', conformed: true, description: 'A calendar day, shared by every fact.', attributes: [
+                        attr('date_key', 'PK', 'INT'), attr('calendar_date', '', 'DATE'), attr('month', '', 'INT'), attr('year', '', 'INT'),
+                    ] },
+                    { id: 'fact_daily_balance', name: 'fact_daily_balance', ...grid(6.5, 1.5), role: 'fact', grain: 'One row per account per day', attributes: [
+                        { ...attr('date_key', 'PK FK', 'INT'), references: 'dim_date' }, { ...attr('account_key', 'PK FK', 'BIGINT'), references: 'dim_account' },
+                        { ...attr('balance', '', 'DECIMAL(18,2)'), measure: 'semi-additive' }, { ...attr('interest_accrued', '', 'DECIMAL(18,2)'), measure: 'additive' },
+                    ] },
                 ],
                 relationships: [
+                    { source: 'account', target: 'dim_account', name: 'versioned as', sourceCardinality: '1', targetCardinality: '1..*', identifying: false },
+                    { source: 'dim_account', target: 'fact_daily_balance', name: 'balance of', sourceCardinality: '1', targetCardinality: '0..*' },
+                    { source: 'dim_date', target: 'fact_daily_balance', name: 'balance on', sourceCardinality: '1', targetCardinality: '0..*' },
                     { source: 'party', target: 'customer_agreement', name: 'signs', sourceCardinality: '1', targetCardinality: '0..*', identifying: false },
                     { source: 'customer_agreement', target: 'account', name: 'governs', sourceCardinality: '1', targetCardinality: '0..*', identifying: false },
                     { source: 'account', target: 'account_interest', name: 'has', sourceCardinality: '1', targetCardinality: '0..1' },
@@ -482,6 +503,7 @@
             { id: 'account-identification', name: 'Account Identification', basedOn: 'Text', description: 'An account number in any suitable form (an IBAN).', iso20022: 'AccountIdentification' },
         ],
         perspectives: [
+            { kind: 'classification', id: 'sensitive', name: 'Sensitive data', description: 'Every entity coloured by how sensitive it is: green public, blue internal, amber confidential, red restricted.' },
             { kind: 'service-domain', id: 'sd-current-account', name: 'Current Account', businessArea: 'Operations and Execution', businessDomain: 'Loans and Deposits',
                 asset: 'Current Account', pattern: 'Fulfill', entities: ['arrangement', 'product', 'condition'], controlRecord: 'current-account',
                 qualifiers: [{ name: 'Interest', entity: 'interest' }, { name: 'Payments', entity: 'account-payments' }, { name: 'Service Fees', entity: 'service-fees' }] },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.prib/renderengine",
-  "version": "0.2.7",
+  "version": "0.2.10",
   "description": "ArchiMate modeller, diagram editor and chart library for the browser, with no runtime dependencies.",
   "type": "module",
   "main": "src/index.js",