Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  ICR |  Found Entries |  External References |  Global Variables Directly Accessed |  Local Variables |  Marked Items  | All
Print Page as PDF
Global: ^XWB(8994.5

Package: Kernel

Global: ^XWB(8994.5


Information

FileMan FileNo FileMan Filename Package
8994.5 REMOTE APPLICATION Kernel

Description

Directly Accessed By Routines, Total: 21

Package Total Routines
Kernel 17 CALLBACKTYPE    FILE    XU8P702    XU8P779    XU8P780    XU8P810    XU8PS629    XU8PS630
XU8PS659    XUESSO1    XUESSO2    XUESSO3    XUESSO4    XUSAML    XUSBSE1    XUSP557
^XWB(8994.5    
Toolkit 2 XUREMAP    XUREMAP1    
Automated Medical Information Exchange 1 DVBAP219    
National Health Information Network 1 NHINP025    

Accessed By FileMan Db Calls, Total: 14

Package Total Routines
Scheduling 3 SDEC826P    SDECI2    SDPST746    
Imaging 2 MAGIP105    MAGIP111    
VistA Web 2 WEBVY15    WEBVY22    
Advanced Medication Platform 1 PREAPO2    
Mental Health 1 YS236PST    
National Health Information Network 1 NHINP025    
Order Entry Results Reporting 1 ORY274    
Toolkit 1 XUREMAP    
Veterans Data Integration and Federation 1 VDI1P2    
WEBVRAM 1 WEBGY00    

Pointed To By FileMan Files, Total: 2

Package Total FileMan Files
Kernel 2 NEW PERSON(#200)[202.06]    SIGN-ON LOG(#3.081)[18]    

Pointer To FileMan Files, Total: 1

Package Total FileMan Files
Kernel 1 OPTION(#19)[.02]    

Fields, Total: 6

Field # Name Loc Type Details
.01 NAME 0;1 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E) X
  • HELP-PROMPT:  NAME MUST BE 3-30 CHARACTERS, NOT NUMERIC OR STARTING WITH PUNCTUATION
  • DESCRIPTION:  
    This is the NAME of the REMOTE GUI APPLICATION for which the data in this entry pertains.
  • CROSS-REFERENCE:  8994.5^B
    1)= S ^XWB(8994.5,"B",$E(X,1,30),DA)=""
    2)= K ^XWB(8994.5,"B",$E(X,1,30),DA)
  • RECORD INDEXES:  ARIAM (#1790)
.02 CONTEXTOPTION 0;2 POINTER TO OPTION FILE (#19)
************************REQUIRED FIELD************************
OPTION(#19)

  • LAST EDITED:  APR 03, 2006
  • HELP-PROMPT:  This is the option which should be given to the signed in visitor as the Context Option for this application.
  • DESCRIPTION:  The name of the context (Client/Server or B-type) option that the application users will need that will be added as a secondary menu item.
    The user is signed on as a visitor and given the Context Option specified in this field as a secondary menu option. The application still needs to set the Context Option using the CreateContext method, but the visitor has
    it as a valid option so that it can be used.
  • RECORD INDEXES:  ARIAM (#1790)
.03 APPLICATIONCODE 0;3 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>60!($L(X)<3) X
  • LAST EDITED:  AUG 17, 2023
  • HELP-PROMPT:  Enter the HASHED value of the application's security phrase. Answer must be 3 to 60 characters in length.
  • DESCRIPTION:  This is the application's hashed value for a security phrase and is described below.
    Security Phrase
    The security phrase is an application's entry into the REMOTE APPLICATION file (#8994.5) for accessing the information necessary to permit the application to enroll a remote user. Create a security phrase, case sensitive,
    in programmer mode using the following command (assuming the security phrase is "My Special Phrase"):
    W $$SHAHASH^XUSHSH(256,"My Special Phrase","B")
    The resulting value is:
    xfXJqDgiByKcNdnGj8f6v64B98Ecs8wlmKFfMzusjaM=
    This is the one-way hash value for the security phrase. It is this hashed value that will be entered into the ApplicationCode field (#.03) in the REMOTE APPLICATION file (#8994.5) for the application.
    To make a remote connection, the application will have the user sign onto the application's authenticating server (the one entered as CallbackServer) and then obtain a Token for the user (similar to "XWBHDL977-124367_0")
    using the "XUS SET VISITOR" RPC. The application will then disconnect from the authenticating server and set the new SecurityPhrase property for the TRPCBroker component to the unhashed security phrase concatenated with a
    caret ("^") and the token for the user (e.g., "My Special Phrase^XWBHDL977-124367_0")
    This property will be encoded and passed to the remote server for authentication; it will hash the security phrase and use the resulting value to identify the application's entry in the REMOTE APPLICATION file (#8994.5).
    The mechanism(s) for contacting the authenticating server will be identified and the authentication server will be requested to provide the demographic information necessary to identify the user and create or match an
    entry in the NEW PERSON file (#200) based on the token provided. With this information, the user will be set up as a visitor entry and be provided the context option specified. The application will then be notified that
    the user is connected. If there is no entry for the application, no match for the token, or the authenticating server can not be connected, the user will be prompted with a regular sign on screen (i.e., required to enter
    their Access and Verify codes).
    Since the security phrase is the application's identifier, we recommend that the security phrase in RPCBroker Delphi-based programs be identified as a const value in an include file. And that a substitute include file
    containing a phrase similar to that used above, be included with release of the source code. It must be realized that the security phrase identifies any application that uses it as your application, and it would, of
    course, be desirable that rogue applications not appear to be your application.
  • FIELD INDEX:  ACODE (#1702) REGULAR IR SORTING ONLY
    Short Descr: Hashed value for an application's security phrase.
    Description: This is the hashed value for an application's security phrase, which is the application's entry into the REMOTE APPLICATION file (#8994.5) for accessing the information necessary to permit the application to enroll a
    remote user.
    Set Logic: S ^XWB(8994.5,"ACODE",X,DA)=""
    Kill Logic: K ^XWB(8994.5,"ACODE",X,DA)
    Whole Kill: K ^XWB(8994.5,"ACODE")
    X(1): APPLICATIONCODE (8994.5,.03) (Subscr 1) (forwards)
  • RECORD INDEXES:  ARIAM (#1790)
.04 CAN ADD USERS 2;1 SET (BOOLEAN Data Type)
  • VistA system that is not the user's authenticating VistA instance. If this field is set to NO, then a user of the remote application will be denied access to a VistA instance they are attempting to visit. However, if the
  • user is authorized and active in the NEW PERSON (#200) file of the VistA instance being visited, then a NO in this field will not deny the visitor access to the site being visited.

  • LAST EDITED:  APR 18, 2025
  • HELP-PROMPT:  Enter Yes if this remote application is authorized to add visiting users to the NEW PERSON (#200) file to support remote access.
  • DESCRIPTION:  This field defines the remote application's behavior when a user of the remote application visits another VistA instance. If this field is set to YES, then the remote application is authorized to add a visiting user to a
    VistA system that is not the user's authenticating VistA instance. If this field is set to NO, then a user of the remote application will be denied access to a VistA instance they are attempting to visit. However, if the
    user is authorized and active in the NEW PERSON (#200) file of the VistA instance being visited, then a NO in this field will not deny the visitor access to the site being visited.
  • TECHNICAL DESCR:  
    This field is set to yes or no based on formal approval of the Remote Application authorization to visit remote sites.
  • AUDIT:  YES, ALWAYS
  • RECORD INDEXES:  ARIAM (#1790)
.05 DISABLED 2;2 SET (BOOLEAN Data Type)
  • VistA instance. If this field is not set (null) or set to NO, then the remote application is authorized to connect to this VistA instance.

  • LAST EDITED:  FEB 05, 2025
  • HELP-PROMPT:  Enter Yes to deny VistA access for connections using this remote application.
  • DESCRIPTION:  This field defines the remote application's behavior when a user of the remote application attempts to access a VistA instance. If this field is set to YES, then the remote application is not authorized to operate at the
    VistA instance. If this field is not set (null) or set to NO, then the remote application is authorized to connect to this VistA instance.
  • TECHNICAL DESCR:  
    This field is set to yes or no based on formal approval of the Remote Application authorization to operate at a particular VistA instance.
  • AUDIT:  YES, ALWAYS
  • RECORD INDEXES:  ARIAM (#1790)
1 CALLBACKTYPE 1;0 SET Multiple #8994.51 8994.51

  • LAST EDITED:  APR 03, 2006
  • DESCRIPTION:  This is a multiple field. It may contain multiple values describing mechanisms by which the remote site can contact the application's authenticating site to obtain the demographic information.
    It consists of the following subfields:
    .01 CALLBACKTYPE
    .02 CALLBACKPORT
    .03 CALLBACKSERVER
    .04 URLSTRING

Found Entries, Total: 44

NAME: VISTAWEB    NAME: VISTAWEB-FW    NAME: CAPRIFHIE    NAME: VISTA IMAGING DISPLAY    NAME: VISTA IMAGING TELEREADER    NAME: VISTA IMAGING VIX    NAME: VISTA IMAGING VISTARAD    NAME: VISTA IMAGING AWIV    
NAME: VISTAWEB-PROD    NAME: VISTAWEB-PROD2    NAME: VISTAWEB-UAT    NAME: VISTAWEB-UAT2    NAME: MYHEALTHEVET    NAME: NATIONAL SUICIDE HOTLINE    NAME: NATIONAL HOMELESS HOTLINE    NAME: MOVE    
NAME: TBI SCREENING    NAME: MEDICAL DOMAIN WEB SERVICES    NAME: PCS ANALYTICS    NAME: VRAM    NAME: CCR-CAPRI    NAME: VLER DAS-CAPRI    NAME: VISTA IMAGING TELEPATHOLOGY    NAME: CAPRI    
NAME: VS SCHEDULING CALL CENTER    NAME: IAM PROVISIONING    NAME: IAM BINDING    NAME: NUMI    NAME: BMS    NAME: JLV BSE    NAME: JLV NHIN    NAME: CAPRI GUI    
NAME: WEBVRAM    NAME: TERMINAL EMULATOR    NAME: MICRO FOCUS REFLECTION    NAME: TELE HEALTH MANAGEMENT    NAME: ADVANCED MEDICATION PLATFORM    NAME: ENTERPRISE APPOINTMENT SERVICE    NAME: CRMS VAHC DAS    NAME: CRMS VCL MDFC    
NAME: NHIN DAS CC    NAME: XU PKI ORR    NAME: MENTAL HEALTH ASSISTANT    NAME: VDI DENTAL ELIGIBILITY    

ICR, Total: 1

ICR LINK Subscribing Package(s) Fields Referenced Description
ICR #5502
  • Imaging
    		•  NAME (.01).
    Access: Write w/Fileman

    APPLICATIONCODE (.03).
    Access: Write w/Fileman

    CALLBACKTYPE (.01).
    Access: Write w/Fileman

    CALLBACKPORT (.02).
    Access: Write w/Fileman

    External References

    Name Field # of Occurrence
    ARIAM^XUIAMRAC IXARIAMSL+1

    Global Variables Directly Accessed

    Name Line Occurrences  (* Changed,  ! Killed)
    ^XWB(8994.5 - [#8994.5] IXACODESL+1*, IXACODEKL+1!, IXACODEKEIC+1!, .01(XREF 1S), .01(XREF 1K)

    Local Variables

    Legend:

    >> Not killed explicitly
    * Changed
    ! Killed
    ~ Newed

    Name Field # of Occurrence
    >> DA IXACODESL+1, IXACODEKL+1, IXARIAMSL+1, .01(XREF 1S), .01(XREF 1K)
    DUZ IXARIAMSL+1
    X IXACODESL+1, IXACODEKL+1, .01+1!, .01(XREF 1S), .01(XREF 1K), .03+1!
    >> X1 IXARIAMSL+1
    >> X2 IXARIAMSL+1

    Marked Items

    Name Field # of Occurrence
    $T(ARIAM^XUIAMRAC IXARIAMSL+1
    Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  ICR |  Found Entries |  External References |  Global Variables Directly Accessed |  Local Variables |  Marked Items  | All