Co-authored-by: Michael Hoennig <michael@hoennig.de> Co-authored-by: Marc Sandlus <marc.sandlus@hostsharing.net> Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/170 Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>
7.7 KiB
hsadminNg fachliches Glossar
Dieses ist eine Sammlung von Fachbegriffen, die in diesem Projekt benutzt werden. Ebenfalls aufgenommen sind technische Begriffe, die für Benutzer für das Verständnis der Schnittstellen nötig sind.
Falls etwas fehlt, bitte Bescheid geben.
Partner
In diesem System ist ein Partner grundsätzlich jeglicher Geschäftspartner der Hostsharing eG. Dies können grundsätzlich Kunden, siehe Debitor, wie Lieferanten sein. Derzeit sind aber nur Debitoren implementiert.
Des Weiteren gibt es für jeden Partner eine fünfstellige Partnernummer mit dem Prefix 'P-' (z.B. P-12345
)
sowie Zusatzinformationen (z.B. Registergerichtnummer oder Geburtsdatum), die zur genauen Identifikation benötigt werden.
Für einen Partner kann es gleichzeitig mehrere Debitoren und zeitlich nacheinander mehrere Mitgliedschaften geben.
Partner sind grundsätzlich als ist Relation der Vertragsperson mit der Person Hostsharing eG implementiert.
Debitor
Ein Debitor ist quasi ein Rechnungsempfänger für einen Partner.
Für einen Partner kann es gleichzeitig mehrere Debitoren geben, z.B. für spezielle Projekte des Kunden oder verbundene Organisationen.
Die Debitoren-Nummer besteht aus dem Prefix D-
, dem nummerischen Teil der Partnernummer und einem zweistelligen, fortlaufenden Debitoren-Suffix (also z.B. D-1234500
).
Debitoren sind grundsätzlich als Relation der Vertragsperson mit der Person des Vertragspartners implementiert.
Mitgliedschaft
Mitgliedschaften enthalten Zusatzdaten für Partner, die Mitglieder sind.
Für einen Partner kann es nacheinander mehrere Mitgliedschaften geben, falls dieser ausgetreten und später wieder eingetreten ist. Gleichzeitig ist nur eine Mitgliedschaft möglich.
Die Mitgliedschafts-Nummer besteht aus dem Prefix M-
, dem nummerischen Teil der Partnernummer und einem zweistelligen, fortlaufenden Mitgliedschafts-Suffix (also z.B. M-1234500
).
Mitgliedschaften haben einen der folgenden Status:
INVALID
: ungültige Mitgliedschaft - sollte nur durch den Import entstanden sein, falls es Fehlbuchungen von Geschäftsanteilen und/oder Geschäftsguthaben gab, aber gar keine gültige MitgliedschaftACTIVE
: aktive MitgliedschaftCANCELLED
: Mitgliedschaft wurde vom Mitglied ausgehend gekündigtTRANSFERRED
: Mitgliedschaft wurde übertragenDECEASED
: Mitglied ist verstorben und es fand keine Erbfolge stattLIQUIDATED
: Mitglied (Firma, Verein) wurde aufgelöstEXPULSED
: Mitglied wurde aus der Genossenschaft ausgeschlossenUNKNOWN
: unbekannter Mitgliedschaftsstatus - sollte nur durch den Import entstanden sein, falls die Daten unvollständig waren
Relation
Eine Relation ist eine typisierte und mit Kontaktdaten versehene Beziehung einer (Holder)-Person zu einer Anchor-Person.
Eine Relation ist eine Art Geschäftsrolle, wir haben hier aber keinen Begriff mit 'Rolle' verwendet, weil 'Role' (engl.) zu leicht mit der RBAC-Rolle verwechselt werden könnte.
Die Relation ist auch ein technisches Konzept und gehört nicht zur Domänensprache. Dieses Konzept ist jedoch für das Verständnis der (API) notwendig.
Ex-Partner
Ex-Partner bilden Personen ab, die vormals Partner waren. Diese bleiben dadurch informationshalber im System verfügbar.
Implementiert ist der Ex-Partner als eine besondere Form der Relation der Person des Ex-Partner (Holder) zum neuen Partner (Anchor) dargestellt. Dieses kann zu einer Kettenbildung führen.
Representative-Contact (ehemals contractual)
Ein Representative ist eine natürliche Person, die für eine nicht-natürliche Person vertretungsberechtigt ist.
Implementiert ist der Representative als eine besondere Form der Relation der Person des Repräsentanten (Holder) zur repräsentierten Person (Anchor) dargestellt.
VIP-Contact
Ein VIP-Contact ist eine natürliche Person, die für einen Geschäftspartner eine wichtige Funktion übernimmt, nicht aber deren offizieller Repräsentant ist.
Implementiert ist der VIP-Contact als eine besondere Form der Relation der Person des VIP-Contact (Holder) zur repräsentierten Person (Anchor) dargestellt.
Operations-Contact
Ein Operations-Contact ist eine natürliche Person, die für einen Geschäftspartner technischer Ansprechpartner ist.
Ein Seiteneffekt ist, dass diese Person im Ticketsystem Znuny direkt dem Geschäftspartner zugeordnet werden kann.
Im Legacy System waren das die Kontakte mit der Rolle operation
und silent
.
Implementiert ist der Operations-Contact als eine besondere Form der Relation der Person des Operations-Contact (Holder) zur repräsentierten Person (Anchor) dargestellt.
OperationsAlert-Contact
Ein OperationsAlert-Contact ist eine natürliche Person, die für einen Geschäftspartner bei technischen Probleme kontaktiert werden soll.
Im Legacy System waren das die Kontakte mit der Rolle operation
.
Implementiert ist der OperationsAlert-Contact als eine besondere Form der Relation der Person des OperationsAlert-Contact (Holder) zur repräsentierten Person (Anchor) dargestellt.
Subscriber-Contact
Ein Subscriber-Contact ist eine natürliche Person, die für einen Geschäftspartner eine bestimmte Mailingliste abonniert.
Implementiert ist der Subscriber-Contact als eine besondere Form der Relation der Person des Subscriber-Contact (Holder) zur repräsentierten Person (Anchor) dargestellt. Zusätzlich wird diese Relation mit dem Kurznamen der abonnierten Mailingliste markiert.
Coop-Asset-Transactions (Geschäftsguthabens-Transaktionen)
- positiver Wert => Geschäftsguthaben nehmen zu
- negativer Wert => Geschäftsguthaben nehmen ab
REVERSAL: Korrekturbuchung einer fehlerhaften Buchung, positiver oder negativer Wert ist möglich
DEPOSIT: Zahlungseingang vom Mitglied nach Beteiligung mit Geschäftsanteilen, immer positiver Wert
DISBURSAL: Zahlungsausgang an Mitglied nach Kündigung von Geschäftsanteilen, immer negativer Wert
TRANSFER: Übertragung von Geschäftsguthaben an ein anderes Mitglied, immer negativer Wert
ADOPTION: Übernahme von Geschäftsguthaben von einem anderen Mitglied, immer positiver Wert
CLEARING: Verrechnung von Geschäftsguthaben mit Schulden des Mitglieds, immer negativer Wert
LOSS: Verlust von Geschäftsguthaben bei Zuweisung Eigenkapitalverlust nach Kündigung von Geschäftsanteilen, immer negativer Wert
LIMITATION: Verjährung von Geschäftsguthaben, wenn Auszahlung innerhalb der Frist nicht möglich war.
Coop-Share-Transactions (Geschäftsanteil-Transaktionen)
- positiver Wert => Geschäftsanteile nehmen zu
- negativer Wert => Geschäftsanteile nehmen ab
REVERSAL: Korrekturbuchung einer fehlerhaften Buchung, positiver oder negativer Wert ist möglich
SUBSCRIPTION: Beteiligung mit Geschäftsanteilen, z.B. durch Beitrittserklärung, immer positiver Wert
CANCELLATION: Kündigung von Geschäftsanteilen, z.B. durch Austritt, immer negativer Wert
Anchor / Relation-Anchor
siehe Relation
Holder / Relation-Holder
siehe Relation
API
Und API (Application-Programming-Interface) verstehen wir eine über HTTPS angesprochene programmatisch bedienbare Schnittstelle zur Funktionalität des hsAdmin-NG-Systems.