Partner
A person (common.persons in Nexus) in their capacity as partner of one or more franchise units - the identity and contacts behind every FranchisePartner link. Aggregate root of the Partner Kafka topic, keyed by the person id. Exists on the wire only while the person holds at least one link.
Overview
A Partner is not a table of its own: it is a row of common.persons seen through the Franchise PartnerFranchise PartnerEntityv1.0.0The link between a franchise unit and a person behind it, with one or more roles - FRANCHISEE (leads the unit) or OPERAT...Ownercna-platformView docs links that point at it. The links are replaced as a set whenever a franchise is created from a contract, its legal information is edited or a contract is applied onto it, and each change publishes one of the partner events on Franchise (Kafka topic)Franchise (Kafka topic)Channelv1.0.0Kafka topic for the Franchise aggregate. Carries the nine NEXUS events about franchise units, their addresses, economic ...Ownercna-platformView docs, keyed by the unit. The person’s own data (name, legal name, e-mail, phone, birth date) changes through the updatePerson mutation, independently of any unit, and until now no message carried that change.
Partner UpdatedPartner UpdatedEventv1.0.0The personal data of a franchise partner changed in CNA Nexus - name, legal name, e-mail, phone or birth date. Snapshot ...Ownercna-platformSchemaMapView docs on Partner (Kafka topic)Partner (Kafka topic)Channelv1.0.0Kafka topic for the Partner aggregate - a person in their capacity as partner of one or more franchise units. Carries Pa...Ownercna-platformView docs closes that gap: it is the snapshot of the person, keyed by the person id, published when the person is edited and holds at least one link. A person with no link is not a Partner and publishes nothing. The situation of the person (situation, situationChangedAt) is not part of the aggregate.
CNA OneCNA OneServicev1.0.0Franchise operating system (franchises and employees, pricing, products and learning books, school operations). Publishe...PublishesGrantApplicationAccess, EmployeeCreated +6SubscribesInviteUser, FranchiseCreated +9Ownercna-platformMapRepoView docs mirrors partners as employees with the FRANCHISEE job role and correlates them by document, the only key both systems share.
| Name | Type | Required | Description | Reference |
|---|---|---|---|---|
id | string | Required | Person id (UUID) in common.persons. Kafka message key of PartnerUpdated and the value the FranchisePartner events carry in person.id. | |
document | string | Required | Person document, formatted as stored; the key cna-one correlates the person by. Not editable in Nexus. | |
documentType | stringEnum:
| Required | Document type (PersonsDocumentType). | |
name | string | Required | Person name. | |
legalName | string | Optional | Legal name, for companies. | |
email | string | Optional | E-mail, when any. | |
phone | string | Optional | Phone, when any. | |
birthDate | string | Optional | Birth date as a calendar day, YYYY-MM-DD, no time zone (a date column). |
Custom properties
| Property | Value |
|---|---|
| Kafka Topicx-kafka-topic | Partner |
| Routing Keyx-routing-key | id |