Skip to main content

CaseStatus

The CaseStatus function is supported both in Studio and Search and returns a true if the case is in the selected status. It returns False if the case status is different or Undefined, or if the case is not available; for example, if the case is not selected or the previous case is not associated.

  • Locked - the case is locked
  • Free - the case is available
  • CheckedOut - the case is checked out by the current user
  • CheckedOutByOthers - the case is checked out by another user

Prototype

    CaseStatus(PreviousCase ; Status)

Arguments

    PraviousCase        String        By value  (Nullable)

Null (not defined) or emty string or equal to:

'N' -- work on current case
'Y' -- work on previous case

Status String By value

A valid string containing the status if the case (Locked, Free, CheckedOut, CheckedOutByOthers)

Returns

    Boolean

The function returns True if the Status is matched, otherwise it returns False

Exception

    Undefined

Undefined is returned if:

- PreviousCase is not empty and not a valid one, or
- the previous case does not exist

Examples

    CaseStatus(; 'free')

This will return True if the case is free.

    CaseStatus('Y' ; 'free')

This will return True if the previous case is free.