Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Source |  Call Graph |  Caller Graph |  Entry Points |  External References |  Global Variables Directly Accessed |  Label References |  Local Variables |  Marked Items |  All
Print Page as PDF
Routine: XOBVLIB

Package: VistALink

Routine: XOBVLIB


Information

XOBVLIB ;; mjk/alb - VistaLink Programmer Library ; 07/27/2002 13:00

Source Information

Source file <XOBVLIB.m>

Call Graph

Call Graph Total: 3

Package Total Call Graph
Kernel 2 $$OS^%ZOSV  $$HDIFF^XLFDT  
VistALink 1 (OS,POST,PRE,WRITE)^XOBVSKT  

Caller Graph

Caller Graph Total: 13

Package Total Caller Graph
VistALink 9 XOBVLJU  XOBVLL  XOBVPOST  XOBVRM  XOBVRPC  XOBVRPCI  XOBVRPCX  XOBVSKT  
XOBVSYSI  
Registration 3 DGRRLU  DGRRLU0  DGRRLU6  
VistALink Security 1 XOBSCAV1  

Entry Points

Name Comments DBIA/ICR reference
SYSOS(XOBOS) ; -- get system operating system
; -- DBIA #3522
GETRATE() ; -- get J2SE heartbeat rate in seconds
GETDELTA() ; -- get J2SE latancy delta in seconds
ENVFTR() ; -- vistalink end tag (footer)
GETASTO() ; -- get J2EE application server time out in seconds (one day = 86400)
GETRASTO() ; -- get J2EE application server reauthenticated seesion time out in seconds (ten minutes = 600)
TOCHK() ; -- did RPC timeout?
BUILD(XOBY,XOBDAT) ; -- store built xml in passed store reference (XOBY)
; -- input format
; XOBDAT("MESSAGE TYPE") = # type of message (ex. 2 = gov.va.med.foundations.vistalink.rpc.fault :: See TYPE tag)
; XOBDAT("ERRORS",<integer>,"CODE") = error code
; XOBDAT("ERRORS",<integer>,"ERROR TYPE") = type of error (system/application/security)
; XOBDAT("ERRORS",<integer>,"MESSAGE",<integer>) = error message
;
; -- SOAP related information
; XOBDAT("ERRORS",<integer>,"FAULT CODE") = high level code on where error occurred (ex. Client, Server, etc.)
; - Default: Server
; XOBDAT("ERRORS",<integer>,"FAULT STRING") = high level fault type text (ex. System Error)
; - Default: System Error
; XOBDAT("ERRORS",<integer>,"FAULT ACTOR") = RPC, routine, etc. running when error occurred
; - Default: [none]
;
SETTO(TO) ; -- set time out value on the fly
  • ICR #4090
    • Status: Active
    • Usage: Supported
    VLHDR(NUM) ; -- provides current VistaLink standard header
    ADD(TXT) ; -- add line
    ERROR(XOBDAT) ; -- send error type message
    CHARCHK(STR) ; -- replace xml character limits with entities
  • ICR #4090
    • Status: Active
    • Usage: Supported
    XMLHDR() ; -- provides current XML standard header
  • ICR #4090
    • Status: Active
    • Usage: Supported
    TOFLAG ; -- set timed out flag
    ; -- if run in non-VistALink environment never time out ; set both now & start = $h
    GETTO() ; -- get time out value
  • ICR #4090
    • Status: Active
    • Usage: Supported
    TYPE ; -- return message types [ number ^ message type ^ schema file ]
    ENVHDR(TYPE,SCHEMA) ; -- vistalink beg tag (header)
    STOP() ; -- called by application to determine if processing should stop gracefully
  • ICR #4090
    • Status: Active
    • Usage: Supported

    External References

    Name Field # of Occurrence
    $$OS^%ZOSV SYSOS+2
    $$HDIFF^XLFDT TOFLAG+2
    OS^XOBVSKT ERROR+7
    POST^XOBVSKT ERROR+12
    PRE^XOBVSKT ERROR+9
    WRITE^XOBVSKT ERROR+10

    Global Variables Directly Accessed

    Name Line Occurrences  (* Changed,  ! Killed)
    ^XOB(18.01 - [#18.01] GETRATE+2, GETDELTA+2, GETASTO+2, GETRASTO+2

    Label References

    Name Line Occurrences
    $$ENVFTR BUILD+39
    $$ENVHDR VLHDR+7
    $$GETTO TOFLAG+2
    $$TOCHK STOP+7
    $$VLHDR BUILD+18
    $$XMLHDR ENVHDR+2
    ADD BUILD+18, BUILD+19, BUILD+20, BUILD+21, BUILD+22, BUILD+23, BUILD+28, BUILD+29, BUILD+30, BUILD+33
    , BUILD+34, BUILD+35, BUILD+36, BUILD+37, BUILD+38, BUILD+39
    BUILD ERROR+4
    TOFLAG STOP+4

    Local Variables

    Legend:

    >> Not killed explicitly
    * Changed
    ! Killed
    ~ Newed

    Name Field # of Occurrence
    A CHARCHK+1~, CHARCHK+12*, CHARCHK+13
    I CHARCHK+1~, CHARCHK+10*, CHARCHK+11
    NEWSTR CHARCHK+1~, CHARCHK+3*, CHARCHK+4
    NUM VLHDR~
    SCHEMA VLHDR+1~, VLHDR+6*, VLHDR+7, ENVHDR~, ENVHDR+10
    STR CHARCHK~, CHARCHK+3*, CHARCHK+4, CHARCHK+5*, CHARCHK+6*, CHARCHK+7*, CHARCHK+8*, CHARCHK+10, CHARCHK+11, CHARCHK+13*
    , CHARCHK+14
    TO SETTO~, SETTO+1
    TXT ADD~, ADD+2
    TYPE VLHDR+1~, VLHDR+5*, VLHDR+7, ENVHDR~, ENVHDR+4
    VLVER ENVHDR+1~, ENVHDR+6*, ENVHDR+7*, ENVHDR+8
    X CHARCHK+1~, CHARCHK+4*, CHARCHK+11*, CHARCHK+12, CHARCHK+13, VLHDR+1~, VLHDR+4*, VLHDR+5, VLHDR+6, GETRATE+1~
    , GETRATE+2*, GETRATE+3, GETDELTA+1~, GETDELTA+2*, GETDELTA+3, GETASTO+1~, GETASTO+2*, GETASTO+3, GETRASTO+1~, GETRASTO+2*
    , GETRASTO+3, ENVHDR+1~, ENVHDR+2*, ENVHDR+3*, ENVHDR+4*, ENVHDR+8*, ENVHDR+9*, ENVHDR+10*, ENVHDR+12*, ENVHDR+13
    XOBCODE BUILD+15~, BUILD+26*, BUILD+28
    XOBDAT ERROR~, ERROR+4, BUILD~
    XOBDAT("ERRORS" BUILD+20, BUILD+21, BUILD+22, BUILD+25, BUILD+26, BUILD+27, BUILD+30, BUILD+32, BUILD+33, BUILD+34
    XOBDAT("MESSA GE TYPE" , BUILD+18
    >> XOBDATA("VL V ERSION" , ENVHDR+7
    >> XOBDATA("XOB RPC" , GETTO+1, SETTO+1*, TOFLAG+2*, TOCHK+1
    XOBERR BUILD+15~, BUILD+24*, BUILD+25*, BUILD+26, BUILD+27, BUILD+30, BUILD+32, BUILD+33, BUILD+34
    XOBETYPE BUILD+15~, BUILD+27*, BUILD+28
    XOBFLAG STOP+1~, STOP+7*, STOP+9
    XOBI ERROR+1~, ERROR+10*, BUILD+15~, BUILD+31*, BUILD+32*, BUILD+33
    XOBLINE BUILD+15~, BUILD+16*, ADD+1*, ADD+2
    XOBOS ERROR+1~, SYSOS~, SYSOS+2
    >> XOBPORT ERROR+6
    XOBY ERROR+1~, ERROR+2*, ERROR+4, BUILD~, ADD+2
    XOBY( ERROR+10
    Y CHARCHK+1~, CHARCHK+2*, CHARCHK+3, CHARCHK+4*
    Z CHARCHK+1~, CHARCHK+2*, CHARCHK+3, CHARCHK+4*

    Marked Items

    Name Field # of Occurrence
    $T(TYPE+NUM VLHDR+4
    Info |  Source |  Call Graph |  Caller Graph |  Entry Points |  External References |  Global Variables Directly Accessed |  Label References |  Local Variables |  Marked Items |  All