VISTALINK SUPPORTED CALLS    ICR (4090)

Name Value
NUMBER 4090
IA # 4090
DATE CREATED 2003/06/16
CUSTODIAL PACKAGE VISTALINK
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XOBVLIB
NAME VISTALINK SUPPORTED CALLS
GENERAL DESCRIPTION
Supported reference to allow other packages to access
VistALink application developer calls.  These calls address XML processing and
RPC timeout handling.

XML processing call tags
========================
$$XMLHDR()
$$CHARCHK(STR)

RPC timeout handling call tags
==============================
$$STOP()
$$GETTO()
$$SETTO(TO)
STATUS Active
KEYWORDS
  • VISTALINK
  • XML
  • RPC
DURATION Till Otherwise Agreed
ID XOBVLIB
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$XMLHDR()
Provides the current XML standard header.

Example:

DEV> W $$XMLHDR^XOBVLIB                                        <?xml
version="1.0" encoding="utf-8" ?>
VARIABLES TYPE VARIABLES DESCRIPTION
$$XMLHDR() Output
Output is the current XML header.
$$CHARCHK(STR)
Performs character resolution to replace XML
character limits with XML entities.

Example:

DEV>W $$CHARCHK^XOBVLIB("This is an example of what call <charchk> does.")

This is an example of what call &lt;charchk&gt; does.
VARIABLES TYPE VARIABLES DESCRIPTION
STR Input

Input:
STR  - string of characters to input
$$CHARCHK(STR) Output
Output string of characters with XML entities
replacing character limits.
$$STOP()
Used by the application to determine if processing
should stop. Below are the development steps an application would use:

RPC Time Out Process
====================

Step    Where         Description
====    =====         ===========
1       Client        Set time out property at
RpcRequest.setRpcClientTimeOut(int)

[int :: number of seconds]

2       Server        Periodically check if timed out or
system needs for process to stop by
calling $$STOP^XOBVLIB()

[returns ;: 1 - stop processing
0 - continue processing]

3       Client        Catch RpcTimeOutFaultException
[Related DIALOG Entry :: 182007]
VARIABLES TYPE VARIABLES DESCRIPTION
$$STOP() Output
Indicator to stop processing (value = 1) or continue
processing (value = 0).
$$GETTO()
Get the current timeout value (default = 300
seconds).
VARIABLES TYPE VARIABLES DESCRIPTION
$$GETTO() Output
Timeout value if it exists (in seconds) or default of
300 seconds.
$$SETTO(TO)
Used to reset the RPC timeout value.  Will override
the current timeout setting received from the client via
RpcRequest.setRpcClientTimeout(int) or the default.

Note:  In processing, the new timeout value will take effect the next time
$$STOP^XOBVLIB() is called.
VARIABLES TYPE VARIABLES DESCRIPTION
TO Input
TO is the RPC timeout value in seconds.
$$SETTO(TO) Output
Function sets the RPC timeout value (in seconds) and
returns a 1 to indicate value successfully reset or 0 if not successful.

MAIL MESSAGE 36394410
Generated from SEP 05, 2018@ IA Listing Descriptions