CreateCaseDeadline

TIBCO iProcess Workspace (Browser)

TIBCO iProcess Workspace (Windows)

Create a case deadline on a case to trigger an event after a specified time period.

Syntax

CreateCaseDeadline (procname, casenum, deadname, eventname, deadline)

where:

• procname(text) is the procedure name. A null value indicates the current procedure name.
• casenum(numeric) is the case number. A value of 0 indicates the current case.
• deadname(text) is the deadline name.
• eventname(text) is the name of the event step.
• deadline(text) is the time period and can be in one of the following formats:

Type

Format

Period

minutes^hours^days^weeks^months^years

Expression

date expression^time expression

Note:
• For the Period type deadline, each field cannot be omitted. If the values of some fields are null, set them to 0. For example, "2^0^0^0^0^0".

For the Expression type deadline, a field can be omitted if the value of the field is null, but the caret (^) is necessary. For example, "SW_DATE^" or "^SW_TIME".

• After a case is closed, all the deadlines of the case are removed. If the case is reopened , you can recreated the deadlines by using the CreateCaseDeadline function.

For more information on creating case deadline, see “Case Deadline Setting" in TIBCO iProcess Modeler Procedure Management.

Returns

One of the following numeric values:

Value

Description

1

Success.

-100

Invalid or unknown procedure.

-101

Invalid or unknown event step.

-102

Invalid or unknown case number.

-104

The type of event is not valid.

-107

The specified case has terminated.

-108

Unknown error from server.

-109

Invalid or unknown parameters.

-112

The deadline already exists.

-113

Invalid deadline value.

Examples

TIBCO iProcess Modeler:

  1. This example creates a period deadline:

    CreateCaseDeadline("TEST", 111, "WARNDEAD", "WARNEV", "2^1^1^1^1^2");

    Or

    CreateCaseDeadline("", 0, "WARNDEAD", "WARNEV", "2^1^1^1^1^2");

  2. This example creates an expression deadline:

    CreateCaseDeadline("TEST", 111, "WARNDEAD", "WARNEV", "SW_DATE^SW_TIME+5");

    Or

    CreateCaseDeadline("", 0, "WARNDEAD", "WARNEV", "SW_DATE^SW_TIME+5");

    Or

    CreateCaseDeadline("", 0, "WARNDEAD", "WARNEV", "Date^Time");

Where, Date is the name of a Date type field, Time is the name of a Time type field.

TIBCO Business Studio

  1. Equivalent of iProcess Example 1:

    IPEProcessUtil.CreateCaseDeadline("TEST", 111, "WARNDEAD", "WARNEV", "2^1^1^1^1^2");

    Or

    IPEProcessUtil.CreateCaseDeadline("", 0, "WARNDEAD", "WARNEV", "2^1^1^1^1^2");

  2. Equivalent of iProcess Example 2:

    IPEProcessUtil.CreateCaseDeadline("TEST", 111, "WARNDEAD", "WARNEV", "SW_DATE^SW_TIME+5");

    Or

    IPEProcessUtil.CreateCaseDeadline("", 0, "WARNDEAD", "WARNEV", "SW_DATE^SW_TIME+5");