Define custom action properties

Define the custom action properties by selecting a custom workflow plug-in and defining related properties.

1. Select the action to be run by this workflow action.

2. Select the Date Type to use to trigger the custom action.

   Selected date

   This action is run once the date and time we have specified in step 3 is reached.

   Live date

   This action is run once the publish date specified in an item, plus any offset, is reached.

   Expiry Date

   This action is run once the expiry date specified in an item, plus any offset, is reached.

   General dates

   This action is run once either the general date one or two specified in an item, plus any offset, is reached.

   Date entered stage

   This action is run on the date the item entered the current stage, plus any offset, is reached.

   Custom Action Date

   This action is run once the date generated by the custom workflow class itself, plus any offset, is reached.

   If we select a date type that requires a date to be set by a user, and no date has been set by a user, then the action is not run regardless of whether an offset has been selected or not.

3. If Selected date is selected as the date type:

   1. Click to select a date.

   2. Click to enter a time. Only the integers "0123456789" can be used when entering times.

4. If we select one of the other options, we can choose to use a date offset which will run the custom action based on a period of time after the selected date type. For example, if we select the date type of "Live date" and define an offset of one month, the custom action is run exactly one month after the item reached the live date and time.

   1. Click Enable Offset.

   2. Enter the number of months, days, hours, or minutes to offset by.

   3. Select either "after specified date" or "before specified date".

   4. If we select either "Months" or "Days" we can also specify the time of day to run the action by selecting Time to run action after offset has been reached. For example, if we select one month plus 9 am, then the action will run at 9 am, one month after the selected date type is reached.

5. In some circumstances, the date specified in the scheduled action may have already been reached when an item enters a stage. In this case, by default the action is automatically run as soon the item reaches the current stage. We can choose to not run the action if the date has already been reached by selecting Do not run the action if date has already been reached.

Parent Create a custom action

Previous topic: Set a location for the custom action

Next topic: Define additional custom action properties