You can set the timer.date attribute of a Waiting Timer element to a relative time and date by binding it to a Date object. You define the Date object in a scripted function.

Before you begin

  • Create a workflow.

  • Open the workflow for editing in the workflow editor.

  • Add some elements to the workflow schema.

About this task

When the time on the given date arrives, the long-running workflow that is based on a timer reactivates and continues its run. For example, you can set the workflow to reactivate at midday on February 12. Alternatively, you can create a workflow element that calculates and generates a relative Date object according to a function that you define. For example, you can create a relative Date object that adds 24 hours to the current time.

Procedure

  1. Drag a Scriptable task element from the Generic menu to the schema of a workflow, before the element that requires the relative Date object for its timeout.date attribute.
  2. Click the Edit icon (Edit icon) of the Scriptable task element in the workflow schema.
  3. Provide a name and description for the scripted workflow element in the Info properties tab.
  4. Click the OUT properties tab, and click the Bind to workflow parameter/attribute icon (Bind to a workflow parameter or attribute).
  5. Click Create parameter/attribute in workflow to create a workflow attribute.
    1. Name the attribute timerDate.
    2. Select Date from the list of attribute types.
    3. Select Create workflow ATTRIBUTE with the same name.
    4. Leave the attribute value set to Not set, because a scripted function will provide this value.
    5. Click OK.
  6. Click the Scripting tab for the scripted workflow element.
  7. Define a function to calculate and generate a Date object named timerDate in the scripting pad in the Scripting tab.

    For example, you can create a Date object by implementing the following JavaScript function, in which the timeout period is a relative delay in milliseconds.

    timerDate = new Date();
    System.log( "Current date : '" + timerDate + "'" );
    timerDate.setTime( timerDate.getTime() + (86400 * 1000) );
    System.log( "Timer will expire at '" + timerDate + "'" );

    The preceding example JavaScript function defines a Date object that obtains the current date and time by using the getTime method and adds 86,400,000 milliseconds, or 24 hours. The Scriptable Task element generates this value as its output parameter.

  8. Click Close.
  9. Click Save.

Results

You created a function that calculates and generates a Date object. A Waiting Timer element can receive this Date object as an input parameter, to suspend a long-running workflow until the date encapsulated in this object. When the workflow arrives at the Waiting Timer element, it suspends its run and waits for 24 hours before continuing.

What to do next

You must add a Waiting Timer element to a workflow to implement a long-running workflow that is based on a timer.