E-SIG API'S ICR (1557)

Name

Value

NUMBER

1557

IA #

1557

DATE CREATED

1996/07/03

CUSTODIAL PACKAGE

KERNEL

CUSTODIAL ISC

Salt Lake City

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUSESIG1

NAME

E-SIG API'S

GENERAL DESCRIPTION

This is the list of supported references to the E-SIG
facility.

STATUS

Active

DURATION

Till Otherwise Agreed

XUSESIG1

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

CHKSUM

$$CHKSUM^XUSESIG1($name_value,flag) This would take a
root ($name_value) and build a checksum for all data in the root. (Not used
now, flag would be used when there is more that one checksum algorithm.)

VARIABLES	TYPE	VARIABLES DESCRIPTION
name_value	Input	This is a global root as would be returned from $NAME.
flag	Input	Not used at this time.

ESBLOCK

$$ESBLOCK^XUSESIG1(ien) This extrinsic function would
return the set of fields from the new person file that are need as part of the
hash for a acceptable E-Sig. If IEN is not passed in then DUZ is used.  (E-Sig
block, E-Sig title, Degree, Current Date/Time)

VARIABLES	TYPE	VARIABLES DESCRIPTION
ien	Input	Optional. The default is to use the DUZ of the current user. This is the IEN of the new person file entry to return data for.

$$EN^XUSESIG1(checksum,esblock) If the ESBLOCK is not
passed then the function would get the ESBLOCK. In either case it would encode
the ESBLOCK using the checksum as the KEY.  Return a encoded string.

VARIABLES	TYPE	VARIABLES DESCRIPTION
checksum	Input	A number that will reveil if the data in the root has been changed.
esblock	Input	Optional. This should be the data returned from the $$ESBLOCK^XUSESIG1 call.

CMP

$$CMP^XUSESIG1(checksum,$name_value) The extrinsic
function would compare the checksum passed in to the calculated value from the
$NAME_VALUE.  Return 1 for match, 0 for no match.

VARIABLES	TYPE	VARIABLES DESCRIPTION
checksum	Input	The output from the $$CHKSUM^XUSESIG1 call.
name_value	Input	This is a global root as would be returned from $NAME.

$$DE^XUSESIG1(checksum,encoded_string) This extrinsic
function would decode the string using the checksum as the key.  Return a
decoded string.

VARIABLES	TYPE	VARIABLES DESCRIPTION
checksum	Input	The output from the $$CHKSUM^XUSESIG1 call.
encoded_string	Input	The output from the $$EN^XUSESIG1 call.

DATE ACTIVATED

2008/03/24