Create an expiration rule

Build 1501 on 14/Nov/2017  This topic last edited on: 17/Mar/2016, at 17:25

Use EdAdmin4 to create an expiration rule

1.Run EdAdmin4 and then under Security, click Expiration rules.

2.On the Action menu, click New.

3.In Name, enter an unique name of the expiration rule.

4.In Computed by, select how the expiration date is calculated for the objects referencing it. Possible values are: Creation date (the expiration date will be calculated from the object creation date), Modified date (the expiration date will be calculated from the object modified date), or Attribute (the expiration date will be calculated from an object attribute of date type).

5.In Attribute name, enter the name of the attribute to use to calculate the expiration date - only if in Computed by you selected Attribute.

6.In Time span, enter the number of days to be added to the date, selected in step 5 or 6 to calculate the expiration date. For example, if you specify 10d, that means that all objects older than 10 days will be auto deleted. Do not use decimal numbers of days: they will be rounded down, e.g. 0.5d becomes 0d.

7.In Object types, enter a list of object types (space-separated). Determine which object types will be affected by the rule. An empty value means "all object types".

8.In Spike Code, select the code to assign to the auto-deleted object after it expired. There are: Normal, Carbon copy and Auto.

9.In Spike Unref, enter the name of the unref parameter used when deleting objects. An example: if you enter story.images, and the story with id 872 references the image id 815 via its attribute story.images, so srv4 spike 815 -unref story.images spikes the image 815 and removes the reference to it from the story 872.

10.In Spike Extend, enter the name of the extend parameter used when deleting objects. For example, if you enter story.images, and the story with id 872 references the image id 815 via its attribute story.images, so srv4 spike 815 -extend story.images spikes both the image 815 and the story 872.
For articles, enter txtGeometry.txtRef, webComments.objectRef

11.In Spike Extend or unref, enter the name of the extendunref parameter used when deleting objects. For example, if you enter story.images, and the story with id 872 references the image id 815 via its attribute story.images, so srv4 spike 815 -extendunref story.images spikes the image 815 and spikes the story 872 if it has no partition, or it is in a partition with 'extendSpike' set to true AND it is not referenced by any other object. If the story 872 is in a partition with extendSpike set to false OR story 872 is referenced by any other object then it is not deleted and the reference to the image 815 is removed.

12.In Purge Time Span, enter the time span for the purge. For example, if you specify 1d, that means that all objects deleted for more than 1 day will be auto purged. Do not use decimal numbers of days: they will be rounded down, e.g. 0.5d becomes 0d.

13.In Workflow Name, enter the the name of the workflow to launch when the objects expire. Note: You cannot specify both Spike  Code and Workflow Name: in that case only the workflow would be executed.

14.In Workflow Parameters, enter the parameters to pass to the workflow (name-value)

15.In Description, enter an optional description.