IF Commons GitHub

models/arca/party

Written to: 9 requirements: 9 proved, 0 partly, 0 failing, 0 with no test recorded. 0004-arca FR-001, 0004-arca FR-002, 0004-arca FR-003, 0004-arca FR-004, 0004-arca FR-005, 0004-arca FR-006 and 3 more

Arca's party model as governance (commons data 0004-arca): the people and organizations a business deals with, how they relate, what roles they play, how they are identified and how they are reached. Most business software needs this structure whoever its customers are, which is why it is the first of Arca's typical data models. It says what the business means and what must be true of its data, and names no database: the logical and the physical schema are made from it. It is Arca's own work, written from the documentation of the model it replaces and not copied.

Source: commons/data/models/arca/party.ts

8 of 15 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

partyKindconst
const partyKind: CodeList<"partyKind", "organization" | "person">

The kinds of party: a person or an organization.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

partyRoleKindconstno test imports it
const partyRoleKind: CodeList<"partyRoleKind", "contact" | "customer" | "employee" | "supplier">

The roles a party may play: customer, supplier, employee, and whatever else a business names.

partyRelationKindconstno test imports it
const partyRelationKind: CodeList<"partyRelationKind", "employedBy" | "memberOf" | "subsidiaryOf">

The ways one party may be related to another: employed by, parent company of, married to.

partyIdentifierKindconstno test imports it
const partyIdentifierKind: CodeList<"partyIdentifierKind", "companyRegistration" | "passportNumber" | "taxNumber">

The kinds of identifier a party may hold: a tax number, a passport number, a company registration.

contactMediumconstno test imports it
const contactMedium: CodeList<"contactMedium", "email" | "telephone" | "web">

The media by which a party may be reached over a network.

addressPurposeconstno test imports it
const addressPurpose: CodeList<"addressPurpose", "billing" | "delivery" | "home" | "work">

What a postal address is used for.

partyconst
const party: Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">

A party: anyone or anything a business deals with as one, whether a person or an organization. What is true of both is here; what is true of one only is in person or organization, which are identified by their party.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

personconst
const person: Concept<"person", { readonly givenName: Attribute<TextType, "required">; readonly familyName: Attribute<Te… (541 characters)
const person: Concept<"person", { readonly givenName: Attribute<TextType, "required">; readonly familyName: Attribute<TextType, "required">; readonly birthDate: Attribute<DateType, "optional">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "party">

A person: a party who is a human being. Their identity is their party's.

Imported by 19 tests of the run (19 passed, 0 failed): the library's results

organizationconstno test imports it
const organization: Concept<"organization", { readonly legalName: Attribute<TextType, "required">; readonly foundedOn: A… (499 characters)
const organization: Concept<"organization", { readonly legalName: Attribute<TextType, "required">; readonly foundedOn: Attribute<DateType, "optional">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "party">

An organization: a party that is a company, an agency, a club or any other body. Its identity is its party's.

partyRoleconst
const partyRole: Concept<"partyRole", { readonly partyRoleId: Attribute<IdentifierType, "required">; readonly kind: Attr… (683 characters)
const partyRole: Concept<"partyRole", { readonly partyRoleId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyRoleKind", "contact" | "customer" | "employee" | "supplier">>, "required">; readonly validFrom: Attribute<DateType, "required">; readonly validTo: Attribute<DateType, "optional">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "partyRoleId">

A role a party plays for a time: the same party may be a customer and a supplier at once.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

partyRelationconst
const partyRelation: Concept<"partyRelation", { readonly partyRelationId: Attribute<IdentifierType, "required">; readonl… (1024 characters)
const partyRelation: Concept<"partyRelation", { readonly partyRelationId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyRelationKind", "employedBy" | "memberOf" | "subsidiaryOf">>, "required">; readonly validFrom: Attribute<DateType, "required">; readonly validTo: Attribute<DateType, "optional">; }, { readonly from: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; readonly to: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "partyRelationId">

A relation between two parties for a time, read from the first to the second: Ada is employed by Analytical Engines.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

partyIdentifierconstno test imports it
const partyIdentifier: Concept<"partyIdentifier", { readonly partyIdentifierId: Attribute<IdentifierType, "required">; r… (721 characters)
const partyIdentifier: Concept<"partyIdentifier", { readonly partyIdentifierId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyIdentifierKind", "companyRegistration" | "passportNumber" | "taxNumber">>, "required">; readonly identifier: Attribute<TextType, "required">; readonly issuedBy: Attribute<TextType, "optional">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "partyIdentifierId">

An identifier a party holds, as someone else issued it: a tax number, a passport number. A party holds one of a kind once.

electronicContactconst
const electronicContact: Concept<"electronicContact", { readonly electronicContactId: Attribute<IdentifierType, "require… (701 characters)
const electronicContact: Concept<"electronicContact", { readonly electronicContactId: Attribute<IdentifierType, "required">; readonly medium: Attribute<CodeType<CodeList<"contactMedium", "email" | "telephone" | "web">>, "required">; readonly address: Attribute<TextType, "required">; readonly isPrimary: Attribute<BooleanType, "required">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "electronicContactId">

A way to reach a party over a network: an email address, a telephone number, a web address.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

postalAddressconst
const postalAddress: Concept<"postalAddress", { readonly postalAddressId: Attribute<IdentifierType, "required">; readonl… (965 characters)
const postalAddress: Concept<"postalAddress", { readonly postalAddressId: Attribute<IdentifierType, "required">; readonly purpose: Attribute<CodeType<CodeList<"addressPurpose", "billing" | "delivery" | "home" | "work">>, "required">; readonly line1: Attribute<TextType, "optional" | "required">; readonly line2: Attribute<TextType, "optional" | "required">; readonly locality: Attribute<TextType, "optional" | "required">; readonly region: Attribute<TextType, "optional" | "required">; readonly postalCode: Attribute<TextType, "optional" | "required">; readonly countryCode: Attribute<TextType, "required">; }, { readonly party: Relationship<"one", Concept<"party", { readonly partyId: Attribute<IdentifierType, "required">; readonly kind: Attribute<CodeType<CodeList<"partyKind", "organization" | "person">>, "required">; readonly displayName: Attribute<TextType, "required">; }, Record<never, Relationship<Cardinality, Target>>, "partyId">>; }, "postalAddressId">

A place a party receives post or may be visited.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

partyDomainconst
const partyDomain: Result<Domain, readonly DomainError[]>

The party model as a governance domain, or what is wrong with it: it is a Result, never a throw, so that a project holds it to the rules it holds its own to.

Imported by 47 tests of the run (47 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.