IBM FileNet P8, Version 5.2.1            

F_calculateTimertype

These functions calculate the expiration time for two types of timers: deadline timers and reminder timers. If you set the deadline by using the F_calculateDeadline function, set the reminder by passing the same parameter values to the F_calculateReminder function.

The following example shows a call to the F_calculateDeadline function:
F_calculateDeadline(adddays(systemtime(), 5), F_getRegionField(SLAName1, string),
          priority, “workscheduleA")
The syntax is as follows:
  • F_calculateDeadline(time_value, sla_name, sla_index, [work_schedule_name])
  • F_calculateReminder(time_value, sla_name, sla_index, [work_schedule_name])
time_value

The start time for the deadline calculation.

If a work schedule is specified for the function, the function might adjust the start time. For more information, see Work schedules.

sla_name

The name of the service-level agreement to use for the deadline calculation. An empty string indicates that no service-level agreement is specified.

The function generates a runtime exception if the specified service-level agreement cannot be found in the region.

sla_index

An index for the service-level agreement entries array that determines the entry to use. The array is one-based (as with all other workflow field arrays). An empty string indicates that no service-level agreement entry is to be used.

The function generates a runtime exception if the index is out of bounds.

work_schedule_name

Optional. The name of a work schedule within the region. An empty string indicates that no work schedule is specified.

The specified service-level agreement for the function determines whether the specified work schedule is used. If the service-level agreement is not configured to use a work schedule, this parameter is ignored. Otherwise, if the service-level agreement is configured to use a work schedule, the function generates a runtime exception if no schedule is specified.

If the service-level agreement is configured to use a work schedule, the function uses the work schedule to calculate the deadline expiration time (instead of the default 24x7 schedule). The returned expiration time is always within the work schedule.



Last updated: October 2015
bpfe029.htm

© Copyright IBM Corporation 2015.