Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

EN^XUSHSHP: Encrypt Data String

Reference Type: Supported, Category: Electronic Signatures, ICR#: 10045

Description

The EN^XUSHSHP API encrypts a string, and associates the encrypted string with an identification number and a document number. To decrypt the string, a call must be made to the DE^XUSHSHP: Decrypt Data String API, with the encrypted string, identification number, and document number as input variables. Typically, this API would be used to encrypt strings within a document.

Format

  EN^XUSHSHP

Make sure to perform the following steps before calling this API:

  1. NEW all non-namespaced variables.

  2. Set all input variables.

  3. Call the API.

Input Variables

X:

(required) The string to be encrypted (e.g., the contents of the SIGNATURE BLOCK PRINTED NAME field in the NEW PERSON [#200] file).
X1:

(required) An identification number (e.g., DUZ).
X2:

(required) A document number (or the number one).

Output Variables

X:

Encrypted string.