XUS IAM RA QUERY (5187)    REMOTE PROCEDURE (8994)

Name Value
NAME XUS IAM RA QUERY
TAG RAQ2
ROUTINE XUREMAP
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
APP PROXY ALLOWED No
DESCRIPTION
This remote procedure provides IAM Service with a method to query VistA 
instances for the Remote Application file entry configuration.  IAM 
Service is the authoritative source for approved Remote Applications and 
it is incumbent upon IAM Service to monitor the status of this file at
all VistA sites.
INPUT PARAMETER
  • NAME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    Full name of the remote application entry to search for OR leading 
    characters to return partial matches
    
  • FLAGS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   2
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    FLAGS must be:
    X = NAME input must match an entry exactly;  
      AND/OR
    M = return context option (#19) data that is pointed to by .02 field 
    (CONTEXT OPTION).
    
RETURN PARAMETER DESCRIPTION
If Failure:
     n is the number of matching entries)
   XURET(#) = file;field no.^ field name^data
   XURET(#) = file;field no.^ field name^data
   
   REPEATED AS:
   {
      XURET(#) = 8994.5;.01^NAME ^ ra name
      XURET(#) = 8994.5;.02^CONTEXTOPTION ^ ra context option
      XURET(#) = 8994.5;.03^APPLICATION CODE ^ ra app code (encrypted)
      XURET(#) = 8994.5;.04^CAN ADD USERS ^ ra can add users (boolean 
  XURET(0) = 0 ^ matching entries^station #
YES/NO)
      XURET(#) = 8994.5;.05^DISABLED ^ ra disabled (boolean YES/NO)
      XURET(#) = 8994.51;.01^CALLBACKTYPE^ ra callback type
      XURET(#) = 8994.51;.02^CALLBACKPORT^ ra callback port
      XURET(#) = 8994.51;.03^CALLBACKSERVER^ ra callback server
      XURET(#) = 8994.51;.04^URLSTRING^ ra url string
   } for each matching entry
  
   AND, if the M flag is set for the context multiple, with each entry 
 above...
 
   {
      XURET(#) = 19;.01^NAME^context option name
      XURET(#) = 19;1^MENU TEXT^context option menu text
      XURET(#) = 19;1.1^UPPERCASE MENU TEXT^context option UC  menu text
         { XURET(#) = 19;3.5^DESCRIPTION^context option wp ln }
      XURET(#) = 19;3.6^CREATOR^context option creator
      XURET(#) = 19;4^TYPE^ context option type
      XURET(#) = 19;99.1^TIMESTAMP OF PRIMARY MENU^$h timestamp
         { XURET(#) = 19.05;.01^RPC^context option attached RPC  }
   }
If Error:
  XURET(0) = -1 ^ <error>
  
If Success:
   XURET(#) = "C ^ n matching (entry or entries)^station #
     (where C is a response code of -1, 0, or 1 and