Module SignatureService

Macros to retrievw electronic signature information for files that are in the repository.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_getsignatures(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetSignatures);
Gets the metadata for all of the signatures of a file or a specific version of the file. ...
external

LSAF
%lsaf_getsigningstatus(lsaf_path=);
Gets the status of a signature for the current file. ...
external

LSAF
%lsaf_isversionsigned(lsaf_path=, lsaf_version=);
Indicates whether the specified version of a file in the repository is signed.

Macro Detail

%lsaf_getsignatures(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetSignatures);

[ Exposure: external ]
Gets the metadata for all of the signatures of a file or a specific version of the file.
The metadata is stored in a SAS data set.

Syntax:
%LSAF_GETSIGNATURES(LSAF_PATH=lsaf-path <, LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2014-02-25
initial coding.
   2016-08-26
rebrand as LSAF
   2019-01-31
update to 2.1
   2019-11-01
update to handle a blank SAS output file.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The path of the file in the repository.
lsaf_version - - Optional - The specific version number of the file. If not specified,
        the signatures of all versions of the file are returned. Specifying a version for
        a non-versioned job causes an error.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the signatures, specified as libref.dataset. The default value is
        WORK.LSAFGETSIGNATURES. The data set contains a row for each signature for file
        and/or version specified and columns with the following names. The data set is
        sorted by descending date of signature.
        - name: The name of the file.
        - path: The path of the file.
        - itemType: The type of file (such as data set or program).
        - version: The version that is associated with this specific item.
        - userId: The unique login identifier for the signer of the file.
        - dateTimeStamp: The date and time of the signature, represented as a string.
        - dateSigned: The date and time of the signature, represented as a SAS Datetime
        format.
        - reason: The reason specified when the file was signed.
        - role: The role specified when the file was signed.
        - comment: The comment that was entered when the file was signed.
File: lsaf_getsignatures.sas
First available in version: 1.4

%lsaf_getsigningstatus(lsaf_path=);

[ Exposure: external ]
Gets the status of a signature for the current file.
The macro variable _lsafSigningStatus_ is set to the status value. Valid values:
- NONE: The current version is not signed.
- CURRENT: The current version is signed.
- PREVIOUS: At least one previous version is signed.
- CURRENT_AND_PREVIOUS: The current version and at least one previous version are
signed.

Syntax:
%LSAF_GETSIGNINGSTATUS(LSAF_PATH=lsaf-path);

          
History:
   2020-01-30
initial code
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
_lsafSigningStatus_ - The signature status.
Parameters:
lsaf_path - - Required - The full path, which includes the name of the file.
File: lsaf_getsigningstatus.sas
First available in version: 2.3

%lsaf_isversionsigned(lsaf_path=, lsaf_version=);

[ Exposure: external ]
Indicates whether the specified version of a file in the repository is signed.

The SAS macro variable _lsafIsVersionSigned_ is set to a value of 1, if the specified version of a
file is signed, 0 if it is not. In the event of an incorrect call to the macro that results in an
error, the return value of _lsafIsVersionSigned_ is set to -1.

Syntax:
%LSAF_ISVERSIONSIGNED(LSAF_PATH=lsaf-path, LSAF_VERSION=lsaf-version);

          
History:
   2019-02-04
initial coding
Expected Macro Variables:
_lsafIsVersionSigned_ - Indicates whether the version of the file is signed.
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The full path, which includes the name of the file.
lsaf_version - - Required - The version of the file.
File: lsaf_isversionsigned.sas
First available in version: 2.1