About dbs | case manager
Prerequisites
Open Documentation Menu
Default functionality provided
The following functions are included in the standard scope of delivery.
Repository configuration and dossier scheme
Advanced properties
When installing dbs | case manager, the following advanced properties are provided:
InternalID | InternalName | Name | Position | Data type |
|---|---|---|---|---|
7 | person_responsible | Person in charge | 64 | Alphanumeric |
12 | unit_of_organisation | Organizational unit | 15 | Alphanumeric |
18 | business_partner_id | Business partner ID | 60 | Alphanumeric |
19 | role | Role | 61 | Alphanumeric |
20 | external_contact | External contact person | 62 | Alphanumeric |
21 | name_of_business_partner | Business partner name | 63 | Alphanumeric |
23 | last_change | Last change | 47 | Alphanumeric |
25 | internal_case_number | Case number (internal) | 1 | Alphanumeric |
26 | external_case_number | Case number (external) | 2 | Alphanumeric |
27 | case_description | Case name | 3 | Alphanumeric |
28 | case_status | Case status | 4 | Alphanumeric |
29 | case_type | Case type | 5 | Alphanumeric |
30 | reminder | Reminder | 52 | Date |
31 | term | Term | 53 | Date |
32 | type_of_case_paper | Type of case paper | 16 | Alphanumeric |
33 | partner_id | Partner ID | 1 | Alphanumeric |
34 | partner_name | Partner name | 2 | Alphanumeric |
35 | list_of_contact_persons | List of contacts | 60 | Alphanumeric |
36 | list_of_case_types | Case type of the partner | 64 | Alphanumeric |
37 | list_of_email_addresses | E-mail address list | 65 | Alphanumeric |
38 | post_address | Mail address | 66 | Alphanumeric |
39 | list_of_phone_numbers | List of phone numbers | 67 | Alphanumeric |
InternalID: Internal ID within dbs | case manager
InternalName: Internal name within dbs | case manager
Name: Name and label of the advanced property
Position Position of the advanced property in the d.3 database
Data type: Data type of the advanced property
Categories (dossier and document types)
The categories (dossier and document types) and the assignment of the advanced property according to the default installation are shown in tabular form below:
Name | Position | Data type | Case (XCASE) | Case paper (XDCAS) | Partner (XPRTN) | Organizational unit (XORG) |
|---|---|---|---|---|---|---|
Person in charge | 7 | Alphanumeric | x | |||
Organizational unit | 15 | Alphanumeric | x | x | ||
Business partner ID | 60 | Alphanumeric | x | |||
Role | 61 | Alphanumeric | x | |||
External contact person | 62 | Alphanumeric | x | |||
Business partner name | 63 | Alphanumeric | x | |||
Last change | 47 | Alphanumeric | x | |||
Case number (internal) | 1 | Alphanumeric | x | x | ||
Case number (external) | 2 | Alphanumeric | x | |||
Case name | 3 | Alphanumeric | x | |||
Case status | 4 | Alphanumeric | x | |||
Case type | 5 | Alphanumeric | x | |||
Reminder | 52 | Date | x | |||
Term | 53 | Date | x | |||
Type of case paper | 16 | Alphanumeric | x | |||
Partner ID | 1 | Alphanumeric | x | |||
Partner name | 2 | Alphanumeric | x | |||
List of contacts | 60 | Alphanumeric | x | |||
Case type of the partner | 64 | Alphanumeric | x | |||
E-mail address list | 65 | Alphanumeric | x | |||
Mail address | 66 | Alphanumeric | x | |||
List of phone numbers | 67 | Alphanumeric | x |
Folder scheme
With the installation of dbs | case manager contract a standardized dossier scheme can be implemented. This looks like this:
 |
Hook
These hooks may only be customized in the context of the following functions:
Generating the case number
Generation of the partner ID
In the context of these functional areas, the hooks delivered as standard function as templates for which there is no maintenance claim against d.velop AG.
Overall, the following hook-files are provided:
File | Description | Adjustment |
|---|---|---|
dbsCaseHooks.groovy | This file contains the four functions for the following entry points:
You will also find various help functions here. | This file must not be customized as it is overwritten in case of an update. |
dbsCaseHooks_prefixGen.groovy | This file separates the generateContractNumberPrefix function for generating the contract number. | This file or this function can be customized to map individual number ranges or systems. This function should therefore be seen as a template and should not be overwritten during an update. |
dbsCaseHooks.classpath | This file contains the path to the JAR file that is used for the Groovy hook file of the same name. | You do not need to adjust anything here if you copy all groovy, CLASSPATH and JAR files to the same directory. |
dbsCasePartnerHooks.groovy | This file contains a function for the entry point 78 hook_validate_import_entry_10. The function generates the partner ID if no partner ID was specified when a partner file was created. | This file or this function may be customized to generate the partner ID differently. This function is therefore to be understood as a template and does not need to be overwritten during an update. |
dbsCasePartnerHooks.classpath | This file contains the path to the JAR file that is used for the Groovy hook file of the same name. | You do not need to adjust anything here if you copy all groovy, CLASSPATH and JAR files to the same directory. |
dbs_contract_functions.ini | The mappings required for the hooks with regard to the specific repository configuration are stored in this file. | No manual customer-specific adjustments may be made in this file. This file is generated during the installation when saving on the Repository configuration page and must be replaced each time the configuration is changed. |
dbsCase_ip_valueset.groovy | This file contains a value set hook for d.ecs identity users and groups. If you store this value set hook "cm_user_translation" in d.3 in the extended property "Responsible", all d.ecs identity provider IDs are displayed in d.3one and d.3 smart explorer with their display names. However, this hook suggests all users in the system, e.g. when creating or editing via d.3one or d.3 smart explorer. If an unauthorized user is selected, this is reported accordingly when the case form is saved. Saving within d.3one or d.3 smart explorer is permitted. | If you do not agree with the behavior of this hook, you do not have to use this value set hook and can continue to use no translation hook or write your own hook instead. |
dbsCase_ip_valueset.classpath | This file contains the path to the JAR file that is used for the Groovy hook file of the same name. | You do not need to adjust anything here if you copy all groovy, CLASSPATH and JAR files to the same directory. |
MovePersonResponsible.groovy | You only need this hook if the extended property "Responsible" in d.3 is not a multiple property. You can use this hook to move those responsible from a single property to a multiple property. | You must edit this file before execution and specify, for example, document type abbreviations and database positions of the extended properties. Follow the instructions in the file. |
Generating the prefix for the case number
By default, the prefix for the case number is generated according to the schema <Prefix>-<yyyy>-.
Then a five-digit consecutive number is appended.
Prefix for the case = CASE
Case Nr. 110 in 2016 = CASE-2016-00110
The prefix for the case dossier can already be specifically defined by the customer via the administration page during the installation.
The prefixes defined here are adopted as global variables in the file dbs_contract_functions.ini.
dbsCase_prefix_vorgang = "CASE"
In the standard scope of delivery, the generateCaseNumberPrefix function in the dbsCaseHooks_prefixGen.groovy file is supplied as a template for Groovy Hooks, the functionality of which is briefly described here.
This function is called in the entry point vali_import_entry_10. Firstly, the current year is determined via the current date and then the prefix is added. The consecutive number to be appended is automatically generated by the dbs | case manager and is appended. Updates to the generation of the prefix are allowed as part of the hook development in the function generateCaseNumberPrefix. It is recommended to attend a hook training for this effect or to have the d.velop AG or partners do the hook development for you.
Warning
The hook-function generateCaseNumberPrefix is a template. Changes as part of hook development are not liable to support and maintenance by the d.velop AG.
Note
By assigning a 5-digit number, the number of cases that can be created is limited to 99,999 per year. If more than 99,999 cases per year are expected, it is recommended to add the month number before the year in the dbsCaseHooks_prefixGen.groovy hook.
Dataset for partners
You can find the list of business partner names in the case management in the case form in the Master data area in the search help for the Partner column.
The content of the auto-complete function, i.e. the list of all allowed case partners can generally be provided by the partner management of the case management or from the master data of leading systems such as the ERP or CRM system. Here, the auto-complete function always lists the partner name in combination with the business partner ID (in brackets). When saving, the business partner ID is extracted into the extended property of the case. The formatting "<business partner name> (<business partner ID>)" controls the correct separation, i.e. the round brackets are used as delimiters for the case management.
If you want to determine the contents of the search help from an external system or database, you can do this using a so-called value set hook. In most cases, such hooks are already available for existing customers. Define the value set hook for the extended property Business partner name.
As the name of the partner can change, we recommend using a Groovy value set hook including translation and validation hooks. The value set hook should provide a list of business partner IDs. The translation hook should return the business partner name incl. ID in brackets for each ID. You also need a validation hook that accepts both the IDs and the display names. By using a translation hook, the current name of the business partner is displayed in both the dbs | case manager and d.3one interfaces. However, there is still the option of not using a translation hook. However, if the name is changed, it may not be possible to save and the business partner would have to be selected again. To avoid this, you can also define the value set as a default value set.
Warning
When implementing your own functions for determination, please pay close attention to the formatting described here "<Business partner name> (<Business partner ID>)". The space after the business partner name must be present.
Note
If a value set hook is used for partners, this is the exclusive source for the partner master data. Please note that it is normally no longer possible to maintain partner master data via dbs | case manager. This means that additional master data, such as contact persons and their contact details, can no longer be maintained within dbs | case manager unless you carry out the extended configuration listed below. The business card icon in each row of the partner table in the master data area is not active in this case.
To use a value set hook, the configuration on the administration page must also be adjusted.
Advanced configuration
If you use a value set hook and want to activate master data maintenance for partners of dbs | case manager at the same time, you must carry out the following steps or observe the following points:
The value set hook must be written in such a way that it also reads the results from the partner category and returns them in the correct format. The results are therefore not enriched by dbs | case manager with the partners from the categories.
An application.properties file must be created in the <installation folder>\working\config, in which the following parameter is defined: casemanagement.partner.hook.enablecategoryedit=true
It is no longer possible to edit partners by clicking on the business card icon when creating a case.
Creating the dossier scheme
A dossier scheme is configured to link case documents to the case dossiers. The dossier scheme only serves as a template and may be adapted to customer-specific requirements.
Configuring the detail tabs
You have the option of displaying your own detail tabs in the contract/case form in order to display further information to the user or to maintain additional data.
For example, if you want to manage mobile phone contracts, you may need more data than the master data available in dbs | case manager. You could simply add these as additional extended properties to the master agreement, then these properties would appear in the Extended master data section of the contract form. Or you can create a detail tab that saves data in a separate database or in the extended properties of the master agreement.
In order for a detail tab to appear in the contract form, you must enter the detail tab accordingly in the configuration. The logic of when a detail tab should be displayed, e.g. only in the case context or only when a specific case type is selected, etc., is not configured here. You must program the logic yourself in the detail tab.
If no detail tabs are listed in the detail tab configuration, you can do this directly.
This is how it works
Click on the button +.
Enter the following data:
Name: This name is displayed in the contract form as the area heading.
URL: Enter the URL via which the detail tab can be accessed. Please note that the detail tab must be accessible via d.ecs http gateway. Therefore, the URL must begin with a /.
Height Specify how much space in height the detail tab should take up. Only use values that are valid for the CSS property height to set the height of an HTML element.
Icon: Specify an icon by entering the name of an icon from Material Design. Possible values can be found at https://material.io/tools/icons/.
Initially visible: If you activate this option, the detail tab is initially visible. The visibility can be changed by the detail tab itself via an API function. If the detail tab does not use this function, the detail tab is always displayed when Initial visible is switched on. Otherwise the detail tab is never displayed.
Click Create.
You also have the option of creating additional tabs by enabling the option Create another detail tab before clicking Create.
Adding advanced master data
Additionally to the advanced properties included in the default scope of delivery, you can add further advanced properties to the case dossier in d.3 admin, which are then also displayed and editable in the case form. hese are being displayed in the section "Advanced master data" accordingly to the selected case type.
You can add single as well as multi-value property fields to the dossiers. Numeric, money-, date- and text-related properties with and without dataset are supported.