DigEraseSoftDelete Workflow

This workflow soft-deletes all the entries from a table/tables which are matching the configured conditions.

The workflow is usually configured via a Workflow Scheduler which takes care of instantiating a workflow based on a schedule. Please see Configuring Workflow Scheduler for more information.

Workflow arguments

Name Type	Description
ProtocolEnabled System.Boolean	Write verbose messages to Logs. Default: True
TestOnly System.Boolean	Simulates deletion. Default: True
TableIds System.String	TableIds for which the workflow has been created.
IncludeProtected System.Boolean	If True, allow to soft-delete entries that are marked delete protected. Default: False
EntryOlderThanDaysIfProtected System.Int32	Soft-delete entries that are delete protected, without deletion date and older than the specified amount of days. Disabled when set to -1. Default: -1
EntryOlderThanDaysIfUnprotected System.Int32	Soft-delete entries that are not delete protected, without deletion date and older than the specified amount of days. Disabled when set to -1. Default: -1
EntryDeleteDateOlderThanDays System.Int32	Soft-delete entries that have a delete date that lies in the past for more than the value specified Disabled when set to -1. Default: 14
BatchSize System.Int32	Maximum number of entries the search query returns per table. Also limit soft-deleted entries per table. Default: 1000
AdditionalXmlFilter System.String	Optional XML filter that adds extra deletion criteria to the configured parameter values. Use it to restrict deletion by entry metadata, such as class, author, or other fields, in addition to age-based rules. Default: Empty

Name

Type

Description

ProtocolEnabled

System.Boolean

Write verbose messages to Logs. Default: True

TestOnly

System.Boolean

Simulates deletion. Default: True

TableIds

System.String

TableIds for which the workflow has been created.

IncludeProtected

System.Boolean

If True, allow to soft-delete entries that are marked delete protected.

Default: False

EntryOlderThanDaysIfProtected

System.Int32

Soft-delete entries that are delete protected, without deletion date and older than the specified amount of days.

Disabled when set to -1.

Default: -1

EntryOlderThanDaysIfUnprotected

System.Int32

Soft-delete entries that are not delete protected, without deletion date and older than the specified amount of days.

Disabled when set to -1.

Default: -1

EntryDeleteDateOlderThanDays

System.Int32

Soft-delete entries that have a delete date that lies in the past for more than the value specified

Disabled when set to -1.

Default: 14

BatchSize

System.Int32

Maximum number of entries the search query returns per table. Also limit soft-deleted entries per table.

Default: 1000

AdditionalXmlFilter

System.String

Optional XML filter that adds extra deletion criteria to the configured parameter values. Use it to restrict deletion by entry metadata, such as class, author, or other fields, in addition to age-based rules.

Default: Empty

Examples

Soft-delete entries that are delete protected, without deletion date and older than 30 days and entries that are not delete protected, without deletion date and older than 90 days

IncludeProtected = True
EntryOlderThanDaysIfUnprotected = 30
EntryOlderThanDaysIfProtected = 90
EntryDeleteDateOlderThanDays = -1

Soft-delete entries when the deletion date is reached

IncludeProtected = True or False (as you like)
EntryOlderThanDaysIfUnprotected = -1
EntryOlderThanDaysIfProtected = -1
EntryDeleteDateOlderThanDays= 0

Soft-delete entries when the deletion date is reached or entry is older than 45 days

IncludeProtected = True or False (as you like)
EntryOlderThanDaysIfUnprotected = 45
EntryOlderThanDaysIfProtected = 45
EntryDeleteDateOlderThanDays= 0

Soft-delete entries when the deletion date is reached and the class is “Text”

IncludeProtected = True or False (as you like)
EntryOlderThanDaysIfUnprotected = -1
EntryOlderThanDaysIfProtected = -1
EntryDeleteDateOlderThanDays= 0
AdditionalXmlFilter= “<XmlFilter><And><Field Name=”Class”>Text</Field></And></XmlFilter>“

Use Case	IncludeProtected	EntryOlderThanDays IfUnprotected	EntryOlderThanDays IfProtected	EntryDeleteDate OlderThanDays	AdditionalXmlFilter
DAVID default	False	-1	-1	14
Older than n days	True	30	90	-1
Delete date reached	True	-1	-1	0
Delete date reached or older than n days	True	45	45	0
Class “Text” and delete date reached	True	-1	-1	0	<XmlFilter> <And> <Field Name=”Class”>Text</Field> </And> </XmlFilter>

Logic: IncludeProtected AND (EntryOlderThanDaysIfUnprotected OR EntryOlderThanDaysIfProtected OR EntryDeleteDateOlderThanDays)