Kernel APIs: $$LOOKUP^XUSER

$$LOOKUP^XUSER(): New Person File Lookup

Reference Type: Supported, Category: User, ICR#: 2343

Description

The $$LOOKUP^XUSER extrinsic function does a user lookup on the NEW PERSON (#200) file screening out users that are terminated. You are first asked to enter a name of a user in the NEW PERSON (#200) file. By default, the function then asks if the correct user name was selected. For example:

  Select NEW PERSON NAME: XUUSER,THREE
  Is XUUSER,THREE the one you want? YES//

If the optional input parameter is set to Q then the second, confirmation prompt is suppressed. The return is in the same format as a call to DIC (i.e., IEN^NAME). Adding new entries is not allowed.

Format

  $$LOOKUP^XUSER([""])

Input Parameters

"":

(optional) This optional input parameter does the following:

NULL (default)—Do not suppress the NEW PERSON (#200) file name confirmation prompt for each entry selected.
A—Screen out terminated users.
Q—Suppress the NEW PERSON (#200) file name confirmation prompt for each entry selected.
AQ—Screen out terminated users and suppress the NEW PERSON (#200) file name confirmation prompt for each entry selected.

Output

returns:

Returns the Internal Entry Number (IEN) and name of the user in the NEW PERSON (#200) file entered after the "Select NEW PERSON NAME:" prompt (IEN^NAME).

Examples

Example 1

This is an example of a lookup of an active user when not passing in the optional Q parameter (showing confirmation prompt):

  >S LRDOC=$$LOOKUP^XUSER("")

  Select NEW PERSON NAME: ?
   Answer with NEW PERSON NAME, or INITIAL, or SSN, or VERIFY CODE, or
       NICK NAME, or SERVICE/SECTION, or DEA#, or ALIAS
   Do you want the entire 1601-Entry NEW PERSON List? N <Enter> (No)
  Select NEW PERSON NAME: XUUSER,TWO E <Enter>      TX          COMPUTER SPECIALIST
  Is XUUSER,TWO E the one you want? YES// <Enter>
  >W LRDOC
  1529^XUUSER,TWO E

Example 2

This is an example of a lookup of an active user when passing in the optional Q parameter (suppressing confirmation prompt):

  >S LRDOC=$$LOOKUP^XUSER("Q")

  Select NEW PERSON NAME: XUUSER,TWO E <Enter>       TX          COMPUTER SPECIALIST
  >W LRDOC
  1529^XUUSER,TWO E

Example 3

This is an example of a lookup of a terminated user when passing in the optional A parameter:

  >S LRDOC=$$LOOKUP^XUSER("A")

  Select NEW PERSON NAME: XUUSER,EIGHT <Enter>       EX
                 This user was terminated on May 04, 1998
  Select NEW PERSON NAME: