DSICXPDU    ICR (5323)

Name Value
NUMBER 5323
IA # 5323
DATE CREATED 2008/12/23
CUSTODIAL PACKAGE VA CERTIFIED COMPONENTS - DSSI
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DSICXPDU
NAME DSICXPDU
ORIGINAL NUMBER 5317
GENERAL DESCRIPTION
This ICR records API's in the DSICXPDU routine.  This
routine is used by DSS applications for retrieving data from the INSTALL
(#9.7) file. The routine is a wrapper around Standard FILEMAN and KERNEL calls
to get dates and other information concerning KIDS installs.
STATUS Active
DURATION Till Otherwise Agreed
ID DSICXPDU
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
INSLIST
This API will return a list of INSTALL (#9.70 file
entries sorted by BUILD Package name (#1) and Installed Completed Date #17) in
reverse chronological order.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
DSIC(n)=<INSTALL file ifn>^<Build name>^ <date
installed completed>
for n=1,2,3,4,...
Note: date installed completed should only have a value for those
entries whose status is 3 [Install Completed].

If no matches found, or problems, return -1^message.
DSIKID Input

(Required) Lookup will be done on the name portion of the Build name.  For
new version Build names, always use name portion only.

For patch Build names, use the entire Build name with "*" unless DSIALL=1,
then only use the first "*"-piece of the Build name.
DSIALL Input
(Optional) Boolean flag - default=0, see DSIKID.
DSISTAT Input
(Optional) Numbers indicating which statuses to
return:
Defaults to '23'.
0:loaded  1:Queued  2:Started  3:Completed 4:De-installed
LAST
This API will return the latest installed version of
a DSS package.  Since there is no PACKAGE file entry, this API gets
information from the INSTALL file.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIKID Both
(Required)
INPUT:  Name of kids package to get last install.

OUTPUT:

On error, return -1^error message.

If successful, return version ^ date.time installed.
where version is taken from .01 field value of INSTALL
(#9.7) file entry of the most recent INSTALL DATE.TIME
(field 17).

If no matches found to DSIKID, return 0^message.
MES
API to send message to KIDS install to display.  This
one call combines both MES^XPDUTL and BMES^XPDUTL.
VARIABLES TYPE VARIABLES DESCRIPTION
XMES Input
required - string (or array) to pass to KIDS.
XMES array must be in form XMES(#)=text
and # = 1,2,3,4,....
BLANK Input
(Optional) Boolean (0/1) to indicate if text is to be
preceeded by a blank line.
PATCH
This calls the KIDS API which will check the patch
application history multiple in the version multiple in the Package (#9.4)
file.

This API is used by the "DSIC XPD PATCH" RPC.
VARIABLES TYPE VARIABLES DESCRIPTION
XRET Output
(Required) 1 if patch installed, otherwise 0.
PKG Input
(Required) Patch designation to check (e.g.,
LR*5.2*200).
FUN Input
(Optional) I FUN>0 then extrinsic API, else RPC.
PKG
This API will return the pointer to the PACKAGE
(#9.4) file.
VARIABLES TYPE VARIABLES DESCRIPTION
X Both
(Required) INPUT:  Name of kids package to get last
install.

OUTPUT:

On error, return -1^error message

If successful, return version ^ date.time installed.
where version is taken from .01 field value of INSTALL
(#9.7) file entry of the most recent INSTALL DATE.TIME
(field 17).
RLAST
API to return the latest installed version of a DSS
package.  Since there is no PACKAGE file entry, get from INSTALL file.
VARIABLES TYPE VARIABLES DESCRIPTION
PKG Both
(Required)  INPUT:  Name of kids package to get last
install.

OUTPUT:

On error, return -1^error message

If successful, return version ^ date.time installed.
where version is taken from .01 field value of INSTALL
(#9.7) file entry of the most recent INSTALL DATE.TIME
(field 17).

If no matches found to DSIKID, return 0^message
FUN Input
(Optional) I FUN>0 then extrinsic API, else RPC.
UPDSTAT
This API is used to update the percentages on the
KIDS installation status bar.
VARIABLES TYPE VARIABLES DESCRIPTION
TOT Input
(Required) Total number of items.
NUM Input
(Required) Current item number.
INIT Input
(Optional) if INIT=1 then initialize status bar.

OT,NUM not needed to initialize.
VERSION
This API is used to get the current version number of
package. This API is used by the "DSIC XPD VERSION" RPC.
VARIABLES TYPE VARIABLES DESCRIPTION
XRET Output
(Required) Package version number or -1 if not found.

PKG Input
(Required) Namespace or full package name.
FUN Input
(Optional) I FUN>0 then extrinsic API, else RPC.
SUBSCRIBING PACKAGE INSURANCE CAPTURE BUFFER
CREATOR CAREY,BILL
EDITOR CLARK,KAREN Y
DATE ACTIVATED 2009/06/11
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2009/06/11 11:53 APPROVED CLARK,KAREN CAREY,WILLIAM
Generated from SEP 05, 2018@ IA Listing Descriptions