Kernel APIs: $$ACTIVE^XUSER

$$ACTIVE^XUSER(): Status Indicator

Reference Type: Supported, Category: User, Integration Agreement: 2343

Description

This extrinsic function returns the active status indicator and latest signon information of a user in the NEW PERSON file (#200).

Format

  $$ACTIVE^XUSER(ien)

Input Parameters

ien:

(Required) Internal Entry Number (IEN) of the user to be checked in the NEW PERSON file (#200).

Output

returns:

Returns any of the following codes:

""—Null, no user record found.
0—User can't sign on.
0^DISUSER—User can't sign on because of DISUSER flag.
0^TERMINATED^FMDATE—User terminated on date indicated.
1^NEW—A new user, can sign on.
1^ACTIVE^FMDATE—An active user, last signon date.

Example 1

This is an example of an Active User in the NEW PERSON file (#200):

>S X=$$ACTIVE^XUSER(1529)

>WRITE X
1^ACTIVE^3030321.093756

Example 2

This is an example of a Terminated User in the NEW PERSON file (#200):

>S X=$$ACTIVE^XUSER(957)

>W X
0^TERMINATED^2980504

Example 3

This is an example of a User with no record in the NEW PERSON file (#200), returns a null string:

>S X=$$ACTIVE^XUSER(999999999)
  
>W X

>

Example 4

This is an example of a User in the NEW PERSON file (#200) with the DISUSER flag set:

>S X=$$ACTIVE^XUSER(111)
  
>W X
0^DISUSER

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: December 14, 2005

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.