Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Source |  Entry Points
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>

Entry Points

Name Comments DBIA/ICR reference
XMLHDR() ; -- provides current XML standard header
  • ICR #4090
    • Status: Active
    • Usage: Supported
    CHARCHK(STR) ; -- replace xml character limits with entities
  • ICR #4090
    • Status: Active
    • Usage: Supported
    STOP() ; -- called by application to determine if processing should stop gracefully
  • ICR #4090
    • Status: Active
    • Usage: Supported
    GETTO() ; -- get time out value
  • ICR #4090
    • Status: Active
    • Usage: Supported
    SETTO(TO) ; -- set time out value on the fly
  • ICR #4090
    • Status: Active
    • Usage: Supported
    VLHDR(NUM) ; -- provides current VistaLink standard header
    TYPE ; -- return message types [ number ^ message type ^ schema file ]
    ERROR(XOBDAT) ; -- send error type message
    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]
    ;
    ADD(TXT) ; -- add line
    GETRATE() ; -- get J2SE heartbeat rate in seconds
    GETDELTA() ; -- get J2SE latency delta in seconds
    GETASTO() ; -- get J2EE application server time out in seconds (one day = 86400)
    GETRASTO() ; -- get J2EE application server reauthenticated session time out in seconds (ten minutes = 600)
    TOFLAG ; -- set timed out flag
    ; -- if run in non-VistALink environment never time out ; set both now & start = $h
    TOCHK() ; -- did RPC timeout?
    ENVHDR(TYPE,SCHEMA) ; -- vistalink beg tag (header)
    ENVFTR() ; -- vistalink end tag (footer)
    SYSOS(XOBOS) ; -- get system operating system
    ; -- DBIA #3522
    Info |  Source |  Entry Points