Mandatory fields and dependencies
Some fields are mandatory and some fields have dependencies to each other. Below you will find an overview of standard entities, mandatory fields, and dependencies between fields. If a field is mandatory, it must have a value. You can either specify a default hard-coded value in Interact Designer or you can make the field mandatory in the Interact form for end users to fill in.
Action: CREATE
Entity ID: Files
The Files entity defines meta data on cases.
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Files |
Sager |
Cases |
Title |
Titel |
Title |
- |
|
|
FileClass_Value |
Sagsgrp. |
Class |
- |
Guidelines:
- Cases can be created separately without any other entities (such as documents or contacts). In this case, do not map fields of other entities in the form.
Entity ID: Records
The Records entity defines meta data on documents.
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Records |
Dokumenter |
Documents |
Title |
Titel |
Title |
Attachment file name |
|
|
State_Value |
Tilstand |
State |
|||
|
|
RecordType_Value |
Dokumenttype |
Document type |
Guidelines:
- Documents can be created only in relation with a specific case. If the form lacks mapping for mandatory Files fields, the document creation will fail.
- The form must not contain mandatory mapped Contacts or AddressMains fields that are not filled in either with a hard-coded value or by the user when filling in the form. Mandatory fields cannot be empty.
Entity ID: Contacts
The Contacts entity contains meta data on contacts.
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Contacts |
Adressater |
Contacts |
NameType_value |
Adressattype |
Contact type |
- |
|
|
|
|
NameCode |
Adressatkode |
Contact code |
- |
Guidelines:
- Contacts can be created only in relation to a specific case. If the form lacks mapping for mandatory Files fields, the contact creation will fail.
- The form must not contain mapped AddressMains fields that are not filled in either with a hard-coded value or by the user when filling in the form. Mandatory fields cannot be empty.
- Filling only mandatory fields will create a contact without a name and with an empty main address field.
NameCode is mandatory for some contact types, for example:
- C (Person with CPR)
- J (Company with CVR)
And not mandatory for some other types, for example P (Person without CPR) and F (Companies without CVR).
Entity ID: AddressMains
The AddressMains entity contains contacts' main addresses.
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
AddressMains |
Address_main |
Address_main |
AddressType_Value |
Adressetype |
Address type |
- |
Guidelines:
- Main address can be created only in relation to a specific contact. If the form lacks mapping of mandatory Contact fields, the main address creation will fail.
- Filling only the mandatory field will create a main address without an actual address.
- AddressType_Value should always be HA - main address.
Mapping of additional addresses is supported (entity ID: Addresses) but for the mapping to work you must make sure to map the main address first with the value HA. Additional addresses must not be of the type HA.
Action: UPDATE existing case
Entity ID: Files
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Files |
Cases |
FileKey or FileNo |
Surrogatnøgle i SAG. |
Key in file |
- |
Guidelines:
- All case fields sent in such a form will update values on the case that already exists in the database with the mentioned FileKey or FileNo.
Entity ID: Records
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Records |
Dokumenter |
Documents |
Title |
Titel |
Title |
Attachment file name |
|
State_Value |
Tilstand |
State |
ARK |
|||
|
RecordType_Value |
Dokumenttype |
Document type |
DOK |
Guidelines
- No mandatory Records fields are required to be mapped. Mandatory values fall back to default values.
- Documents will be created on the case that already exists in the database with the mentioned FileKey or FileNo.
Entity ID: Contacts
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
Contacts |
Adressater |
Contacts |
NameType_value |
Adressattype |
Contact type |
- |
|
NameCode |
Adressatkode |
Contact code |
- |
Guidelines:
- If a contact with the combination of NameType_value + NameCode is found in the database, its main address will be linked to the case that already exists in the databases with the mentioned FileKey or FileNo. No values Contact/adressMains will be changed (only linked to case).
- If a contact with the combination of NameType_value + NameCode is NOT found in the database, an attempt of creation of a new contact will be performed (with all values filled in for Contact/addressMains).
Entity ID: AddressMains
| Entity ID | Entity label (Da) | Entity label (En) | Mandatory field IDs | Field labels (Da) | Field labels (En) | Fallback value |
|---|---|---|---|---|---|---|
|
AddressMains |
Address_main |
Address_main |
AddressType_Value |
Adressetype |
Address type |
- |
Guidelines:
- Do not add AddressMains mappings if you are not expecting it to be filled in (otherwise it will fail the dialogue submission).
- AddressType_Value should always be HA - main address.
