XUS MVI NEW PERSON RMTE AUDIT (4546)    REMOTE PROCEDURE (8994)

Name Value
NAME XUS MVI NEW PERSON RMTE AUDIT
TAG AUDIT
ROUTINE XURNPAUD
RETURN VALUE TYPE GLOBAL ARRAY
AVAILABILITY AGREEMENT
WORD WRAP ON TRUE
VERSION 1
APP PROXY ALLOWED Yes
DESCRIPTION
This restricted RPC is used exclusively by the Master Veteran Index (MVI)
to return audit data from the AUDIT (#1.1) file at a facility for a 
specific user's record in the NEW PERSON (#200) file.
INPUT PARAMETER
  • PARAM
    PARAMETER TYPE:   LIST
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
     Required input:
       PARAM("BegDate") = The earliest recorded date of the audit records to
                          return. Must contain a year, month, and day. 
                          (Defaults to the date of the first audit record.)
      
       PARAM("EndDate") = The latest recorded date of the audit records to 
                          return. Must contain a year, month, and day. 
                          (Defaults to the date of the last audit record.)
     --------------                     
       PARAM("SourceSystemID") = Facility Station Number
       PARAM("SourceID")       = Source ID (DUZ)
      
     Optional input:
     --------------
       PARAM("IDTYPE")         = Source ID Type (e.g., "PN")
       PARAM("ASSIGNAUTH")     = Assigning Authority (e.g., "USDVA") 
    
RETURN PARAMETER DESCRIPTION
 First Line
 where,
  
   <SourceSystemID>     = The Facility Station Number passed in 
                          PARAM("SourceSystemID").
   <SourceID>           = The Source ID passed in PARAM("SourceID").
   <IDType>             = The Source ID Type if passed in PARAM("IDTYPE").
   <AssigningAuthority> = The Assigning Authority if passed in 
                          PARAM("ASSIGNAUTH").
   <AuditBegDate>       = The earliest recorded date passed in
                          PARAM("BegDate") in yyyymmdd format.
 ----------
   <AuditEndDate>       = The latest recorded date passed in
                          PARAM("EndDate") in yyyymmdd format.
                          
 Subsequent lines      
 ----------------
 Each subsequent line contains data from one of the Audit records that 
 fall within the specified date range:
  
   @Return@(n) = <DateTimeRecorded>^<FieldName>
                  ^<UserName>^<UserDUZ>
 The first line returned contains basic information, including the data 
                  ^<OldValue>^<NewValue>
                  ^<MenuOptionUsed>^<ProtocolOrOptionUsed>
  
 where,                     
                              
   <DateTimeRecorded>     = The Date and Time the Audit was recorded, in
                            FileMan external format MMM DD, YYYY@hh:mm:ss
                            e.g., MAR 03, 2021@14:25:30
   <FieldName>            = The name of the field that was changed.
   <UserName>             = The name of the user that made the change.
 that was passed to the remote procedure:
   <UserDUZ>              = The DUZ of the user that made the change.
   <OldValue>             = The old value of the field before the change.
                            If there was no old value, "<no previous
                            value>" is returned.
   <NewValue>             = The new value of the field after the change. 
                            If there was no new value, "<deleted>" is 
                            returned.
   <MenuOptionUsed>       = The name of the Option in the Kernel menu
                            system that was used to change the data (if 
                            any).
  
   <ProtocolOrOptionUsed> = The name of the Protocol or the protocol-type 
                            Option that was used (if any).
  
 Error
 -----
 If there was some problem with the input parameters or in obtaining the 
 audit data, a single line is returned in the following format:
 
   @Return@(0) = -1^<errorMessage>
  
   @Return@(0) =  1^<SourceSystemID>^<SourceID>^<IDType>
 where,
  
   <errorMessage> = An error message, such as:
  
     SourceSystemID: Facility Station Number is required
     SourceID: Source ID is required
     BegDate: Beginning Date is not a valid date
     EndDate: Ending Date is not a valid date
                  ^<AssigningAuthority>^<AuditBegDate>^<AuditEndDate>
                  ^<TotalAuditRecordsReturned>