Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$HANDLE^XUSRB4(): Return Unique Session ID String

Reference Type: Supported, Category: Signon/Security, ICR#: 4770

Description

The $$HANDLE^XUSRB4 extrinsic function returns a unique Caché cluster string for a VistA system for use by HealtheVet Desktop applications.

NOTE: This API was released with Kernel Patch XU*8.0*395.

Format

  $$HANDLE^XUSRB4("namespace"[,timetolive])

Input Parameters

"namespace":

(required) This input parameter should start with the VistA software namespace. In addition, users can add any additional application/software identifiers.
timetolive:

(optional) This input parameter indicates the number of days that this handle is available for use. Possible values range from 1 to 7. The default is 1. XTMP requires that the zero node hold the save through date. This value is cleaned up via the XQ82 routine (i.e., Clean old Job Nodes in XUTL [XQ XUTL $J NODES] option).

Output

returns:

Returns the unique Vista system Caché cluster string. The value generated includes the data entered in the namespace input parameter and $J and $H. If this value is already defined, a new value is generated.

Example

In this example, we are creating a unique session ID for the RPC Broker namespace (i.e., "XWB"):

>S HDL=$$HANDLE^XUSRB4("XWB-CCOW")

>W HDL
XWB-CCOW928-57785_0

When checking the ^XTMP temporary global you would see:

^XTMP("XWB-CCOW928-57785_0",0) = 3050805^3050804