Über dbs | case manager contract
Voraussetzungen
Menü der Dokumentation
Standardlieferumfang
Folgende Funktionen sind im Standardlieferumfang enthalten.
Repositorykonfiguration und Aktenplan
Erweiterte Eigenschaften
Bei der Installation von dbs | case manager contract werden folgende erweiterte Eigenschaften ausgeliefert:
InternalID | InternalName | Name | Position | Datentyp |
|---|---|---|---|---|
1 | internal_contract_number | Vertragsnummer (intern) | 1 | Alphanumerisch |
2 | external_contract_number | Vertragsnummer (extern) | 2 | Alphanumerisch |
3 | contract_description | Vertragsbezeichnung | 3 | Alphanumerisch |
4 | contract_status | Vertragsstatus | 4 | Alphanumerisch |
5 | contract_type | Vertragstyp | 5 | Alphanumerisch |
6 | place_of_filling | Ablageort | 6 | Alphanumerisch |
7 | person_responsible | Verantwortlich | 64 | Alphanumerisch |
8 | automatic_renewal | Automatische Verlängerung | 9 | Alphanumerisch |
9 | noticed_by | Gekündigt durch | 10 | Alphanumerisch |
10 | partner_noticed_by | Gekündigt durch Partner | 11 | Alphanumerisch |
11 | frame_contract_number | Rahmenvertragsnummer | 13 | Alphanumerisch |
12 | unit_of_organisation | Organisationseinheit | 15 | Alphanumerisch |
13 | date_of_underwriting | Unterzeichnung | 51 | Datum |
14 | contract_start_date | Vertragsbeginn | 52 | Datum |
15 | contract_end_date | Vertragsende | 53 | Datum |
16 | renewal_to | Verlängerung bis | 54 | Datum |
17 | date_of_notice | Gekündigt am | 55 | Datum |
18 | business_partner_id | Geschäftspartner ID | 60 | Alphanumerisch |
19 | role | Rolle | 61 | Alphanumerisch |
20 | external_contact | Externer Ansprechpartner | 62 | Alphanumerisch |
21 | name_of_business_partner | Geschäftspartnername | 63 | Alphanumerisch |
22 | person_responsible | Verantwortlich | 64 | Alphanumerisch |
22 | contract_value | Vertragswert | 70 | Geld |
23 | last_change | Letzte Aktivität | 47 | Alphanumerisch |
24 | type_of_contract_paper | Typ Vertragsunterlage | 16 | Alphanumerisch |
33 | partner_id | Partner ID | 1 | Alphanumerisch |
34 | partner_name | Partnername | 2 | Alphanumerisch |
35 | list_of_contact_persons | Ansprechpartnerliste | 60 | Alphanumerisch |
36 | list_of_case_types | Vorgangstyp des Partners | 64 | Alphanumerisch |
37 | list_of_email_addresses | E-Mail Adressliste | 65 | Alphanumerisch |
38 | post_address | Postanschrift | 66 | Alphanumerisch |
39 | list_of_phone_numbers | Telefonnummerliste | 67 | Alphanumerisch |
InternalID: Interne ID innerhalb dbs | case manager contract
InternalName: Interner Name innerhalb dbs | case manager contract
Name: Name bzw. Titel der erweiterten Eigenschaft
Position: Position der erweiterten Eigenschaft in der d.3-Datenbank
Datentyp: Datentyp der erweiterten Eigenschaft
Kategorien (Akten- und Dokumentarten)
Im folgenden werden die Kategorien (Akten- und Dokumentarten) sowie die Zuordnung der erweiterten Eigenschaft gemäß Standardinstallation tabellarisch dargestellt:
Name | Position | Datentyp | Einzel- vertrag (XEVER) | Rahmen- vertrag (XRVER) | Vertrags-dokument (XEVDO) | Vertrags- unterlage (XEVUN) | Partner (XPRTN) | Organisations- einheit (XORG) |
|---|---|---|---|---|---|---|---|---|
Vertragsnummer (intern) | 1 | Alphanumerisch | x | x | x | x | ||
Vertragsnummer (extern) | 2 | Alphanumerisch | x | x | ||||
Vertragsbezeichnung | 3 | Alphanumerisch | x | x | ||||
Vertragsstatus | 4 | Alphanumerisch | x | x | ||||
Vertragstyp | 5 | Alphanumerisch | x | x | ||||
Ablageort | 6 | Alphanumerisch | x | x | ||||
Verantwortlich | 64 | Alphanumerisch | x | |||||
Automatische Verlängerung | 9 | Alphanumerisch | x | x | ||||
Gekündigt durch | 10 | Alphanumerisch | x | x | ||||
Gekündigt durch Partner | 11 | Alphanumerisch | x | x | ||||
Rahmenvertragsnummer | 13 | Alphanumerisch | x | |||||
Organisationseinheit | 15 | Alphanumerisch | x | x | x | |||
Unterzeichnung | 51 | Date | x | x | ||||
Vertragsbeginn | 52 | Date | x | x | ||||
Vertragsende | 53 | Date | x | x | ||||
Verlängerung bis | 54 | Date | x | x | ||||
Gekündigt am | 55 | Date | x | x | ||||
Geschäftspartner ID | 60 | Alphanumerisch | x | x | ||||
Rolle | 61 | Alphanumerisch | x | x | ||||
Externer Ansprechpartner | 62 | Alphanumerisch | x | x | ||||
Geschäftspartnername | 63 | Alphanumerisch | x | x | ||||
Vertragswert | 70 | Geld | x | x | ||||
Letzte Änderung | 47 | Alphanumerisch | x | x | ||||
Typ Vertragsunterlage | 16 | Alphanumerisch | x | |||||
Partner ID | 1 | Alphanumerisch | x | |||||
Partnername | 2 | Alphanumerisch | x | |||||
Ansprechpartnerliste | 60 | Alphanumerisch | x | |||||
Vorgangstyp des Partners | 64 | Alphanumerisch | x | |||||
E-Mail Adressliste | 65 | Alphanumerisch | x | |||||
Postanschrift | 66 | Alphanumerisch | x | |||||
Telefonnummerliste | 67 | Alphanumerisch | x |
Aktenplan
Mit der Installation von dbs | case manager contract kann ein standardisierter Aktenplan implementiert werden. Dieser sieht wie folgt aus:
Hook
Diese Hooks dürfen lediglich im Kontext folgender Funktionen kundenspezifisch angepasst werden:
Generierung der Vertragsnummer
Generierung der Partner-ID
Im Kontext dieser Funktionsbereiche fungieren die im Standard ausgelieferten Hooks als Templates, für die kein Wartungsanspruch gegenüber der d.velop AG besteht.
Insgesamt werden folgende Hook-Dateien ausgeliefert:
Datei | Beschreibung | Anpassung |
|---|---|---|
dbsCaseContractHooks.groovy | In dieser Datei finden sich die vier Funktionen für folgende Einsprungspunkte:
Darüber hinaus finden sich hier diverse Hilfsfunktionen. | In dieser Datei dürfen keine kundenspezifischen Anpassungen vorgenommen werden, da diese bei einem Update zu überschreiben ist. |
dbsCaseContractHooks_prefixGen.groovy | Diese Datei separiert die Funktion generateContractNumberPrefix zur Generierung der Vertragsnummer. | Diese Datei bzw. diese Funktion darf kundenspezifisch angepasst werden, um individuelle Nummernkreise bzw. Systematiken abbilden zu können. Diese Funktion ist daher als Template zu verstehen und sollte bei einem Update nicht überschrieben werden. |
dbsCaseContractHooks.classpath | Diese Datei enthält den Pfad zur JAR-Datei, die für die gleichnamige Groovy-Hook-Datei verwendet wird. | Sie müssen hier nichts anpassen, wenn Sie alle Groovy-, CLASSPATH und die JAR-Dateien in das gleiche Verzeichnis kopieren. |
dbsCasePartnerHooks.groovy | In dieser Datei befindet sich eine Funktion für den Einsprungspunkt 78 hook_validate_import_entry_10. Die Funktion generiert die Partner-ID, falls keine Partner-ID bei Anlage einer Partnerakte angegeben wurde. | Diese Datei bzw. diese Funktion darf kundenspezifisch angepasst werden, um die Partner-ID anders zu generieren. Diese Funktion ist daher als Template zu verstehen und braucht bei einem Update nicht überschrieben werden. |
dbsCasePartnerHooks.classpath | Diese Datei enthält den Pfad zur JAR-Datei, die für die gleichnamige Groovy-Hook-Datei verwendet wird. | Sie müssen hier nichts anpassen, wenn Sie alle Groovy-, CLASSPATH und die JAR-Dateien in das gleiche Verzeichnis kopieren. |
dbs_contract_functions.ini | In dieser Datei werden die für die Hooks notwendigen Mappings im Hinblick auf die konkrete Repositorykonfiguration hinterlegt. | In dieser Datei dürfen keine manuellen kundenspezifischen Anpassungen vorgenommen werden. Diese Datei wird während der Installation beim Speichern auf der Seite Repositorykonfiguration generiert und muss bei jeder Änderung an der Konfiguration ausgetauscht werden. |
dbsCase_ip_valueset.groovy | In dieser Datei befindet sich ein Wertemengen-Hook für d.ecs identity-Benutzer und -Gruppen. Wenn Sie diesen Wertemengen-Hook "cm_user_translation" in d.3 bei den erweiterten Eigenschaften "Verantwortlich" und "Gekündigt durch" hinterlegen, werden alle d.ecs identity provider IDs in d.3one und d.3 smart explorer mit ihren Anzeigenamen angezeigt. Dieser Hook schlägt allerdings z.B. bei Neuanlage oder Bearbeitung über d.3one oder d.3 smart explorer keine Werte vor. | Wenn Sie mit dem Verhalten dieses Hooks nicht einverstanden sind, müssen Sie diesen Wertemengen-Hook nicht verwenden und können stattdessen weiterhin keinen Übersetzungs-Hook verwenden oder einen eigenen Hook schreiben. |
dbsCase_ip_valueset.classpath | Diese Datei enthält den Pfad zur JAR-Datei, die für die gleichnamige Groovy-Hook-Datei verwendet wird. | Sie müssen hier nichts anpassen, wenn Sie alle Groovy-, CLASSPATH und die JAR-Dateien in das gleiche Verzeichnis kopieren. |
MovePersonResponsible.groovy | Diesen Hook benötigen Sie nur dann, wenn die erweiterte Eigenschaft "Verantwortlich" in d.3 keine Mehrfacheigenschaft ist. Mithilfe dieses Hooks können Sie die Verantwortichen von einer Einfacheigenschaft auf eine Mehrfacheigenschaft verschieben. | Sie müssen diese Datei vor Ausführung bearbeiten und z.B. Dokumentartkürzel und Datenbankpositionen der erweiterten Eigenschaften angeben. Beachten Sie dafür die Hinweise in der Datei. |
Generierung des Präfix der Vertragsnummer
Die Generierung des Präfix der Vertragsnummer erfolgt im Standardlieferumfang nach dem Schema <Präfix>-<jjjj>-.
Im Anschluss wird eine fortlaufende 5-stellige Nummer angehängt.
Beispiel:
Präfix für den Rahmenvertrag = RV
Präfix für den Einzelvertrag = EV
Einzelvertrag Nr. 110 in 2016 - Vertragsnummer (intern) = EV-2016-00110
Rahmenvertrag Nr. 12 in 2016 - Vertragsnummer (intern) = RV-2016-00012
Die Präfixe für den Einzel- und Rahmenvertrag können bereits über die Administrationsseite während der Installation vom Kunden spezifisch definiert werden.
Die hier definierten Präfixe werden als globale Variable in die Datei dbs_contract_functions.ini aufgenommen.
dbsCase_prefix_id = "EV" dbsCase_prefix_rahmen = "RV"
Im Standardlieferumfang wird als Template die Funktion generateContractNumberPrefix in der Datei dbs_contractMngr_prefixGen.jpl für JPL Hooks bzw. in dbsCaseContractHooks_prefixGen.groovy für Groovy Hooks aufgeliefert.
Diese Funktion wird innerhalb des Einsprungspunkts vali_import_entry_10 aufgerufen. Als Parameter wird die Dokumentart (p_DokuArt) übergeben. Dabei handelt es sich entweder um die Dokument- bzw. in diesem Fall Aktenart Rahmenvertrag oder Einzelvertrag. Zunächst wird das aktuelle Jahr über das aktuelle Tagesdatum ermittelt und dann im Anschluss das jeweilige Präfix in Abhängigkeit der Aktenart vorangestellt. Die anzuhängende fortlaufende Nummer wird automatisch vom dbs | case manager contract erzeugt und angehängt. Änderungen an der Generierung des Präfix sind im Rahmen der Hook-Programmierung innerhalb der Funktion generateContractNumberPrefix erlaubt. Es empfiehlt sich, hierfür eine Hook-Schulung zu besuchen bzw. die d.velop AG oder Partner mit der Hook-Programmierung zu beauftragen.
Warnung
Bei der Hook-Funktion generateContractNumberPrefix handelt es sich um ein Template. Für Änderungen im Rahmen der Hook-Programmierung übernimmt die d.velop AG keinerlei Wartungsverpflichtung.
Anmerkung
Durch die Vergabe einer 5-stelligen Nummer ist die Anzahl der erstellbaren Verträge auf 99.999 pro Jahr beschränkt. Sollten mehr als 99.999 Verträge pro Jahr erwartet werden empfielt es sich im Hook dbsCaseContractHooks_prefixGen .groovy zusätzlich die Monatszahl vor das Jahr zu setzen.
Wertemenge für Partner
Die Liste der Geschäftspartnernamen finden Sie im Vertragsmanagement im Vertragsformular im Bereich Stammdaten in der Suchhilfe zur Spalte Partner.
Die Inhalte der Suchhilfe, d.h. die Liste der möglichen Vertragspartner, kann dabei generell aus der Partnerpflege im Vertragsmanagement oder aber aus einem für diese Stammdaten führenden System kommen, z.B. dem ERP- oder CRM-System. Dabei wird in der Suchhilfe zum Geschäftspartnernamen immer der Geschäftspartnername zusammen mit der Geschäftspartner-ID (in Klammer) angezeigt. Beim Speichern erfolgt eine Extrahierung der Geschäftspartner-ID in die erweiterte Eigenschaft des Rahmen- bzw. Einzelvertrags. Die Formatierung "<Geschäftspartnername> (<Geschäftspartner-ID>)" ist dabei ausschlaggebend für die korrekte Trennung, d.h. die runden Klammern sowie das Leerzeichen vor der öffnenden runden Klammer dienen dem Vertragsmanagement als Trenner.
Sofern Sie die Inhalte der Suchhilfe aus einem Fremdsystem oder einer Fremddatenbank ermitteln wollen, können Sie dies per sogenanntem Wertemengenhook durchführen. Meistens sind solche Hooks bei Bestandskunden bereits vorhanden. Hinterlegen Sie den Wertemengenhook für die erweiterte Eigenschaft Geschäftspartnername.
Da sich der Name des Partners durchaus mal verändern kann, empfehlen wir einen Groovy-Wertemengenhook inkl. Übersetzungs- und Validierungshook zu verwenden. Der Wertemengenhook sollte eine Liste der Geschäftspartner-IDs liefern. Der Übersetzungshook sollte zu jeder ID den Geschäftspartnernamen inkl. ID in Klammern zurückgeben. Sie benötigen außerdem einen Validierungshook, welcher sowohl die IDs als auch die Anzeigenamen akzeptiert. Durch Verwendung eines Übersetzungshooks wird sowohl in den Oberflächen von dbs | case manager contract als auch d.3one der aktuelle Name des Geschäftspartners angezeigt. Es besteht jedoch weiterhin die Möglichkeit keinen Übersetzungshook zu verwenden. Bei einer Namensänderung wäre das Speichern dann jedoch u.U. nicht möglich und der Geschäftspartner müsste neu ausgewählt werden. Um dies zu umgehen können Sie aber auch die Wertemenge als Vorschlagswertemenge definieren.
Warnung
Bei der Realisierung eigener Funktionen zur Ermittlung achten Sie bitte genau auf die Einhaltung der hier beschriebenen Formatierung "<Geschäftspartnername> (<Geschäftspartner ID>)". Das Leerzeichen nach dem Geschäftspartnernamen muss unbedingt vorhanden sein.
Anmerkung
Wird ein Wertemengenhook für Partner verwendet, so ist dieser Hook die ausschließliche Quelle für die Partnerstammdaten. Wir weisen darauf hin, dass in diesem Fall die Pflege von Partnerstammdaten über dbs | case manager contract im Normalfall nicht mehr möglich ist. Somit können innerhalb von dbs | case manager contract auch ergänzende Stammdaten wie z.B. Ansprechpartner und dessen Kontaktdaten nicht mehr gepflegt werden, sofern sie nicht die unten aufgeführte erweiterte Konfiguration vornehmen, Das Visitenkartenicon in jeder Zeile der Partnertabelle im Bereich Stammdaten ist in diesem Fall nicht aktiv.
Für die Verwendung eines Wertemengenhooks muss außerdem die Konfiguration auf der Administrationsseite angepasst werden.
Erweiterte Konfiguration
Sofern Sie einen Wertemengenhook verwenden und gleichzeitig die Stammdatenpflege von Partnern von dbs | case manager aktivieren möchten, müssen Sie folgende Schritte durchführen bzw. Punkte beachten.
Der Wertemengenhook muss so geschrieben sein, dass dieser auch die Ergebnisse aus der Partnerkategorie ausliest und im richtigen Format zurück gibt. Die Ergebnisse werden also nicht durch dbs | case manager um die Partner aus den Kategorien angereichert.
Es muss eine application.properties Datei im <Installationsordner>\working\config angelegt werden, in der folgender Parameter definiert ist: casemanagement.partner.hook.enablecategoryedit=true
Das Editieren der Partner durch einen Klick auf das Visitenkartenicon bei der Vertragsanlage ist nicht mehr möglich.
Erstellung des Aktenplans
Es wird ein Aktenplan konfiguriert, um Vertragsdokumente und Vertragsunterlagen in die Rahmen- bzw. Einzelvertragsakten zu verknüpfen. Der Aktenplan dient lediglich als Vorlage und darf kundenspezifisch angepasst werden.
Konfigurieren von Detailreitern
Sie haben die Möglichkeit, eigene Detailreiter in das Vertrags-/Vorgangsformular einzublenden, um dem Benutzer weitere Informationen anzuzeigen oder zusätzliche Daten zu pflegen.
Angenommen Sie möchten Mobilfunkverträge verwalten, dann benötigen diese durchaus weitere Daten als die in dbs | case manager contract vorhandenen Stammdaten. Sie könnten diese einfach als zusätzliche erweiterte Eigenschaften zur Vertragsakte hinzufügen, dann würden diese Eigenschaften im Bereich Erweiterte Stammdaten im Vertragsformular erscheinen. Oder Sie können einen Detailreiter erstellen, der Daten in eine eigene Datenbank oder auch in die erweiterten Eigenschaften der Vertragsakte speichert.
Damit ein Detailreiter im Vertragsformular erscheint, müssen Sie den Detailreiter in der Konfiguration entsprechend eintragen. Die Logik, wann ein Detailreiter angezeigt werden soll, z.B. nur im Vertragskontext oder nur bei Auswahl eines bestimmten Vertragstyps etc., wird nicht hier konfiguriert. Die Logik müssen Sie im Detailreiter selbst programmieren.
Sind in der Detailreiterkonfiguration noch keine Detailreiter aufgeführt, so können Sie dies direkt vornehmen.
So geht's
Klicken Sie auf die Schaltfläche +.
Geben Sie folgende Daten an.
Name: Dieser Name wird im Vertragsformular als Bereichsüberschrift angezeigt.
URL: Geben Sie die URL an, über die der Detailreiter erreichbar ist. Beachten Sie, dass der Detailreiter über d.ecs http gateway erreichbar sein muss. Deshalb muss die URL mit einem / beginnen.
Höhe: Geben Sie an, wie viel Platz in der Höhe der Detailreiter einnehmen soll. Verwenden Sie nur Werte, die für die CSS-Eigenschaft height gültig sind, um die Höhe eines HTML-Elements einzustellen.
Icon: Geben Sie ein Icon an, indem Sie den Namen eines Icons von Material Design angeben. Mögliche Werte finden Sie unter https://material.io/tools/icons/ .
Initial sichtbar: Wenn Sie diese Option aktivieren, ist der Detailreiter initial sichtbar. Die Sichtbarkeit kann über eine API-Funktion vom Detailreiter selbst verändert werden. Wenn der Detailreiter diese Funktion nicht verwendet, wird der Detailreiter immer angezeigt, wenn Initial sichtbar eingeschaltet ist. Ansonsten wird der Detailreiter nie angezeigt.
Klicken Sie auf Erstellen.
Zudem haben Sie die Möglichkeit, vor dem Klick auf Erstellen, die Erstellung zusätzlicher Reiter über das Aktivieren der Option Weiteren Detailreiter hinzufügen vorzunehmen.
Hinzufügen von erweiterten Stammdaten
Sie können zusätzlich zu den, im Standardlieferumfang enthaltenen, Eigenschaften weitere erweiterte Eigenschaften zu der Einzel- oder Rahmenvertragsakte in d.3 admin hinzufügen, die dann auch im Vertragsformular dargestellt werden und editierbar sind. Im Bereich Erweiterte Stammdaten werden die erweiterten Stammdaten dann entsprechend der Wahl der Vertragsart angezeigt.
Sie können sowohl Einfach- als auch Mehrfacheigenschaftsfelder zu den Akten hinzufügen. Es werden numerischen, geldwertige, datumswertige und textwertige Eigenschaften mit und ohne Wertemenge unterstützt.