dataprotection

This configuration is optional when using the plugin Data_Protection.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<dataProtectionConfiguration
<dataProtectionLabels
<label
<id
>
required
string

The id of this data protection label. The id will not be shown but used to identify the label and has to be unique and must never change.

</id>
<shortName
>
required
string

The short name of this data protection label. The short name is used to identify the label and should be unique.

</shortName>
<longName
>
required
string

The long name of this data protection label used for display.

</longName>
<maximumStorageTime
xsd:duration
>
required

The maximum number of days data is allowed to be stored.

</maximumStorageTime>
<fontColor
>
required
string

The font color to show the label in. The color is defined in a hex representation like #FF0000.

</fontColor>
<backgroundColor
>
required
string

The background color of the label. The color is defined in a hex representation like #FF0000.

</backgroundColor>
<display
xsd:string
none

Level not shown in web, report and printing.

header

Level shown in header of web, report and printing.

>
required
</display>
>
requiredmax. unbounded

Defines one data protection label.

</label>
>
optional

List of data protection labels in ascending order of there severeness.

</dataProtectionLabels>
<dataConfidentialityLevels
<level
<id
>
required
string

The id this data confidentiality level. The id will not be shown but used to identify the level and has to be unique and must never change.

</id>
<shortName
>
required
string

The short name of this data confidentiality level. The short name is used to identify the level and should be unique.

</shortName>
<longName
>
required
string

The long name of this data confidentiality level used for display.

</longName>
<fontColor
>
required
string

The font color to show the confidentiality level. The color is defined in a hex representation like #FF0000.

</fontColor>
<backgroundColor
>
required
string

The background color to show the confidentiality level. The color is defined in a hex representation like #FF0000.

</backgroundColor>
<display
xsd:string
none

Level not shown in web, report and printing.

header

Level shown in header of web, report and printing.

headerAndFooter

Level shown in header of web, report and printing. Level shown in footer of report and printing.

>
required
</display>
>
requiredmax. unbounded

Defines one data protection label.

</level>
>
optional

List of data confidentiality levels in ascending order of there severeness.

</dataConfidentialityLevels>
<defaultDataConfidentialityLevelId
>
required
string

ID of the default confidentiality level.

</defaultDataConfidentialityLevelId>
<defaultMaximumStorageTime
xsd:duration
>
required

The default maximum number of days data is allowed to be stored. This will be used when data protection context has no objecttype assigned to it.

Default: P730D

</defaultMaximumStorageTime>
<emailNotifications
<adminRecipient
>
required
string

Admin email-address: will be notified if a data protection context couldn't be archived or deleted.

</adminRecipient>
<exampleRecipient
>
optional
string

Example recipient email address used as a UI hint.

</exampleRecipient>
<exampleDataProtectionContextPrintName
>
optional
string

Example data protection context print name used as a UI hint.

</exampleDataProtectionContextPrintName>
<exampleDataProtectionContextDescription
>
optional
string

Example data protection context description used as a UI hint.

</exampleDataProtectionContextDescription>
<sender
>
optional
string

Sender (From:) address for notification emails.

</sender>
<createNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about creation of a data protection context.

</createNotificationTemplate>
<confirmNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about confirmation of a data protection context deletion date.

</confirmNotificationTemplate>
<prolongNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about prolonging of a data protection context deletion date.

</prolongNotificationTemplate>
<activeToDeletedNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about a state change from active state to deleted state for a data protection context.

</activeToDeletedNotificationTemplate>
<reactivateNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about reactivation of a data protection context from deleted state to active state.

</reactivateNotificationTemplate>
<deleteNotificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional

Email template for notifications about deletion of a data protection context.

</deleteNotificationTemplate>
<beforeDeleteNotificationConfiguration
<notificationTemplate
<subject
>
required
string

The notification subject line, may contain placeholders.

</subject>
<body
>
required
string

The email body (plain) text, may contain placeholders. To ensure that white space is preserved, consider wrapping the text in a CDATA section.

</body>
>
optional
</notificationTemplate>
<timeToDeletion
xsd:duration
>
requiredmax. unbounded

Duration until deletion is automatically performed. Currently, it is only possible to set the time in days, e.g. P1D.

</timeToDeletion>
>
optional

Configuration of notifications in the period before deletion of Data Protection Context.

</beforeDeleteNotificationConfiguration>
>
required

Configuration of data protection email functionality.

</emailNotifications>
<grace
<gracePeriod
xsd:duration
>
required

Duration until which the Data Protection Context is put into deleted state instead of permanently deleting it. Data protection context and projects, workbooks, objecttypes assigned to it will be unusable. Only the user with special privilege can revive the dpc. Currently, it is only possible to set the time in days, e.g. P7D.

Default: P7D

</gracePeriod>
<revivePeriod
xsd:duration
>
required

Duration until which the Data Protection Context is prolonged after reviving it from deleted state. Currently, it is only possible to set the time in days, e.g. P7D.

Default: P7D

</revivePeriod>
>
optional

Configuration of data protection context's grace period functionality. Default behavior is to permanently delete the data protection context after deletion deadline is reached.

</grace>
<deletionMoratoriums
<deletionMoratorium
<id
>
required
string

The id of this deletion moratorium. The id will not be shown but used to identify the deletion moratorium and has to be unique and must never change.

</id>
<name
>
required
string

The print name of this deletion moratorium. The name is shown to the user to identify the deletion moratorium and should be unique.

</name>
<database
<type
>
required
string

The type of the data source (see docs).

</type>
<driverName
>
required
string

Fully qualified name of the JDBC driver class

</driverName>
<jdbcURL
>
required
string

JDBC URL of the database

</jdbcURL>
<user
>
required
string

The database user on whose behalf the connection is being made

</user>
<password
>
required
string

The password for the database user

</password>
<properties
<property
xsd:string
name
required
=
string
description
optional
=
string
>
optionalmax. unbounded
</property>
>
optional
</properties>
>
required
</database>
>
requiredmax. unbounded

Defines one deletion moratorium.

</deletionMoratorium>
>
optional

List of deletion moratoriums that if assigned to the data protection context is used for archiving the data when data protection context reaches end of life.

</deletionMoratoriums>
>
required

Configuration regarding the data protection of imported data.

</dataProtectionConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    dataprotection:
      dataProtectionLabels:
      - id: "text"
        shortName: "text"
        longName: "text"
        maximumStorageTime: "P2DT3M"
        fontColor: "text"
        backgroundColor: "text"
        display: "none"
      - id: "text"
        shortName: "text"
        longName: "text"
        maximumStorageTime: "P2DT3M"
        fontColor: "text"
        backgroundColor: "text"
        display: "none"
      dataConfidentialityLevels:
      - id: "text"
        shortName: "text"
        longName: "text"
        fontColor: "text"
        backgroundColor: "text"
        display: "none"
      - id: "text"
        shortName: "text"
        longName: "text"
        fontColor: "text"
        backgroundColor: "text"
        display: "none"
      defaultDataConfidentialityLevelId: "text"
      defaultMaximumStorageTime: "P2DT3M"
      emailNotifications:
        adminRecipient: "text"
        exampleRecipient: "text"
        exampleDataProtectionContextPrintName: "text"
        exampleDataProtectionContextDescription: "text"
        sender: "text"
        createNotificationTemplate:
          subject: "text"
          body: "text"
        confirmNotificationTemplate:
          subject: "text"
          body: "text"
        prolongNotificationTemplate:
          subject: "text"
          body: "text"
        activeToDeletedNotificationTemplate:
          subject: "text"
          body: "text"
        reactivateNotificationTemplate:
          subject: "text"
          body: "text"
        deleteNotificationTemplate:
          subject: "text"
          body: "text"
        beforeDeleteNotificationConfiguration:
          notificationTemplate:
            subject: "text"
            body: "text"
          timeToDeletion:
          - "P2DT3M"
          - "P2DT3M"
      grace:
        gracePeriod: "P2DT3M"
        revivePeriod: "P2DT3M"
      deletionMoratoriums:
      - id: "text"
        name: "text"
        database:
          type: "text"
          driverName: "text"
          jdbcURL: "text"
          user: "text"
          password: "text"
          properties:
          - name: "text"
            description: "text"
            value: "text"
          - name: "text"
            description: "text"
            value: "text"
      - id: "text"
        name: "text"
        database:
          type: "text"
          driverName: "text"
          jdbcURL: "text"
          user: "text"
          password: "text"
          properties:
          - name: "text"
            description: "text"
            value: "text"
          - name: "text"
            description: "text"
            value: "text"

Filename: dataprotection-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dataProtectionConfiguration>
  <dataProtectionLabels>
    <label>
      <id>text</id>
      <shortName>text</shortName>
      <longName>text</longName>
      <maximumStorageTime>P2DT3M</maximumStorageTime>
      <fontColor>text</fontColor>
      <backgroundColor>text</backgroundColor>
      <display>none</display>
    </label>
    <label>
      <id>text</id>
      <shortName>text</shortName>
      <longName>text</longName>
      <maximumStorageTime>P2DT3M</maximumStorageTime>
      <fontColor>text</fontColor>
      <backgroundColor>text</backgroundColor>
      <display>none</display>
    </label>
  </dataProtectionLabels>
  <dataConfidentialityLevels>
    <level>
      <id>text</id>
      <shortName>text</shortName>
      <longName>text</longName>
      <fontColor>text</fontColor>
      <backgroundColor>text</backgroundColor>
      <display>none</display>
    </level>
    <level>
      <id>text</id>
      <shortName>text</shortName>
      <longName>text</longName>
      <fontColor>text</fontColor>
      <backgroundColor>text</backgroundColor>
      <display>none</display>
    </level>
  </dataConfidentialityLevels>
  <defaultDataConfidentialityLevelId>text</defaultDataConfidentialityLevelId>
  <defaultMaximumStorageTime>P2DT3M</defaultMaximumStorageTime>
  <emailNotifications>
    <adminRecipient>text</adminRecipient>
    <exampleRecipient>text</exampleRecipient>
    <exampleDataProtectionContextPrintName>text</exampleDataProtectionContextPrintName>
    <exampleDataProtectionContextDescription>text</exampleDataProtectionContextDescription>
    <sender>text</sender>
    <createNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </createNotificationTemplate>
    <confirmNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </confirmNotificationTemplate>
    <prolongNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </prolongNotificationTemplate>
    <activeToDeletedNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </activeToDeletedNotificationTemplate>
    <reactivateNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </reactivateNotificationTemplate>
    <deleteNotificationTemplate>
      <subject>text</subject>
      <body>text</body>
    </deleteNotificationTemplate>
    <beforeDeleteNotificationConfiguration>
      <notificationTemplate>
        <subject>text</subject>
        <body>text</body>
      </notificationTemplate>
      <timeToDeletion>P2DT3M</timeToDeletion>
      <timeToDeletion>P2DT3M</timeToDeletion>
    </beforeDeleteNotificationConfiguration>
  </emailNotifications>
  <grace>
    <gracePeriod>P2DT3M</gracePeriod>
    <revivePeriod>P2DT3M</revivePeriod>
  </grace>
  <deletionMoratoriums>
    <deletionMoratorium>
      <id>text</id>
      <name>text</name>
      <database>
        <type>text</type>
        <driverName>text</driverName>
        <jdbcURL>text</jdbcURL>
        <user>text</user>
        <password>text</password>
        <properties>
          <property name="text" description="text">text</property>
          <property name="text" description="text">text</property>
        </properties>
      </database>
    </deletionMoratorium>
    <deletionMoratorium>
      <id>text</id>
      <name>text</name>
      <database>
        <type>text</type>
        <driverName>text</driverName>
        <jdbcURL>text</jdbcURL>
        <user>text</user>
        <password>text</password>
        <properties>
          <property name="text" description="text">text</property>
          <property name="text" description="text">text</property>
        </properties>
      </database>
    </deletionMoratorium>
  </deletionMoratoriums>
</dataProtectionConfiguration>