wfm.GetHistTimersByProcess

This job determines all reminder/lock periods for a historical process.

1. Input Parameters

Name Type Required Description

ProcessId

STRING

Yes

Historical ID of the process

2. Output Parameters

Name Type Dependency Description

Timers

BASE64

—

The requested reminder/lock periods in XML format

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Example

Structure of Timers:

<Timers>
  <Timer TimerId=".." ProcessId=".." FromActivityId=".." FromActivityName=".."
         ToActivityId=".." ToActivityName=".." TimerType=".." DestinationType=".."
         DestinationTime=".." LoopType=".."/>
</Timers>
Table 1. Fields of <Timer>
Attribute Type Description

TimerId

STRING

ID of the reminder/lock period

ProcessId

STRING

ID of the process

FromActivityId

STRING

ID of the activity from which the period is valid

FromActivityName

STRING

Name of the activity from which the period is valid

ToActivityId

STRING

ID of the activity until which the period is valid

ToActivityName

STRING

Name of the activity until which the period is valid

TimerType

INT

Type of the period:

* 0 = lock period * 1 = reminder period

DestinationType

INT

Reference point of the period:

* 0 = TIMER_REFERENCES_START_OF_ACTIVITY * 1 = TIMER_REFERENCES_END_OF_ACTIVITY

DestinationTime

INT

Indicates when the target should be reached

LoopType

INT

Is always returned as 0

5. See Also

wfm.GetHistProcessList, wfm.GetHistTimerEntries