deletiondeadline

This configuration is required when using the plugin Deletion_Deadline.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<deletionDeadlineConfiguration
<deletionTimeOptions
mandatory
optional
=
boolean

If mandatory, the deletion time has to be given on content creation.

Default: false

<period
longName
required
=
string
relativeTime
required
=
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds
>
optionalmax. unbounded
</period>
<freeInput
maxPeriod
optional
=
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

Defines the maximum period a user can select in the free input. If not given the period is unlimited.

>
optional
</freeInput>
>
required
</deletionTimeOptions>
<emailNotifications
<sender
>
optional
string

Sender (From:) address for notification emails.

</sender>
<deletedSoonNotificationTemplate
<notificationTemplate
<subject
>
required
string

Defines the template that is used for the mail subject. The following placeholders are resolved before sending: {{itemType}}, {{itemName}}, {{deletionDeadline}} and {{itemDetailLink}}

</subject>
<body
>
required
string

Defines the template that is used for the mail body. The following placeholders are resolved before sending: {{itemType}}, {{itemName}}, {{deletionDeadline}} and {{itemDetailLink}}

</body>
>
required
</notificationTemplate>
<timeToDeletion
>
required
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

Defines the period in which a mail is sent before an item is deleted.

</timeToDeletion>
>
requiredmax. unbounded

Defines the template that is used for the mail that is sent a defined time before an item is deleted.

</deletedSoonNotificationTemplate>
<deletedNotificationTemplate
<notificationTemplate
<subject
>
required
string

Defines the template that is used for the mail subject. The following placeholders are resolved before sending: {{itemType}}, {{itemName}}, {{deletionDeadline}} and {{itemDetailLink}}

</subject>
<body
>
required
string

Defines the template that is used for the mail body. The following placeholders are resolved before sending: {{itemType}}, {{itemName}}, {{deletionDeadline}} and {{itemDetailLink}}

</body>
>
required
</notificationTemplate>
>
required

Defines the template that is used for the mail that is sent when an object is deleted.

</deletedNotificationTemplate>
>
optional

Optionally define notifications to be sent before deletion of the Projects and/or Workbooks as well as the period of time before the deletion that the email is sent. If not present, no emails will be sent.

</emailNotifications>
>
required
</deletionDeadlineConfiguration>
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:
    deletiondeadline:
      deletionTimeOptions:
        mandatory: true
        period:
        - longName: "text"
          relativeTime: "P2DT3M"
        - longName: "text"
          relativeTime: "P2DT3M"
        freeInput:
          maxPeriod: "P2DT3M"
      emailNotifications:
        sender: "text"
        deletedSoonNotificationTemplate:
        - notificationTemplate:
            subject: "text"
            body: "text"
          timeToDeletion: "P2DT3M"
        - notificationTemplate:
            subject: "text"
            body: "text"
          timeToDeletion: "P2DT3M"
        deletedNotificationTemplate:
          notificationTemplate:
            subject: "text"
            body: "text"

Filename: deletiondeadline-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"?>
<deletionDeadlineConfiguration>
  <deletionTimeOptions mandatory="true">
    <period longName="text" relativeTime="P2DT3M"/>
    <period longName="text" relativeTime="P2DT3M"/>
    <freeInput maxPeriod="P2DT3M"/>
  </deletionTimeOptions>
  <emailNotifications>
    <sender>text</sender>
    <deletedSoonNotificationTemplate>
      <notificationTemplate>
        <subject>text</subject>
        <body>text</body>
      </notificationTemplate>
      <timeToDeletion>P2DT3M</timeToDeletion>
    </deletedSoonNotificationTemplate>
    <deletedSoonNotificationTemplate>
      <notificationTemplate>
        <subject>text</subject>
        <body>text</body>
      </notificationTemplate>
      <timeToDeletion>P2DT3M</timeToDeletion>
    </deletedSoonNotificationTemplate>
    <deletedNotificationTemplate>
      <notificationTemplate>
        <subject>text</subject>
        <body>text</body>
      </notificationTemplate>
    </deletedNotificationTemplate>
  </emailNotifications>
</deletionDeadlineConfiguration>