Module ExternalDictionaryService

Macros to get and export dictionary information in SAS Life Science Analytics Framework.

Since: 2.2

Macro Summary
external

LSAF
%lsaf_exportextdicts(lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for external dictionaries. The metadata is stored in a SAS data set in the ...
external

LSAF
%lsaf_getextdictionaryid(lsaf_dictionary=, lsaf_version=, lsaf_datatype=);
Gets the dictionary identifier for an external dictionary. The SAS macro variable ...
external

LSAF
%lsaf_getexternaldictionaries(sas_dsname=work.lsafgetexternaldictionaries);
Gets the metadata for all of the external dictionaries. The metadata is stored in a SAS data set.

Macro Detail

%lsaf_exportextdicts(lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);

[ Exposure: external ]
Exports the metadata for external dictionaries. The metadata is stored in a SAS data set in the
specified location (WORKSPACE or REPOSITORY).

Syntax:
%LSAF_EXPORTEXTDICTS(
LSAF_LOCATION=lsaf-location,
LSAF_PATH=lsaf-path,
LSAF_OVERWRITE=lsaf-overwrite,
LSAF_ENABLEVERSIONING=lsaf-enableversioning,
LSAF_VERSIONTYPE=lsaf-versiontype,
LSAF_CUSTOMVERSION=lsaf-customversion,
LSAF_COMMENT=lsaf-comment);

          
History:
   2019-07-08
initial coding
Expected Macro Variables:
_lsafExtDictionaryPath_ - The full path of the external dictionary data set, which includes
        the file extension. If the dictionary data set is not created, _lsafExtDictionaryPath_ is blank.
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_location - - Required - The case-insensitive output location for the exported external
        dictionary file. Valid values: WORKPSACE and REPOSITORY.
lsaf_path - - Required - The output path for the data set that contains the exported external
        dictionaries. If the sas7bdat file extension is not specified, it is added during processing.
lsaf_overwrite - - Optional - Indicates whether to overwrite an existing unversioned data
        set. Valid values: 0 (Default): No, 1: Yes.
lsaf_enableversioning - - Optional - Indicates whether a new exported file is versioned.
        This value is iggnored, if lsaf_location=WORKSPACE. Valid values: 0 (Default): No, 1: Yes
lsaf_versiontype - - Conditional - The version type (MAJOR, MINOR, CUSTOM) to use to create
        a file, if enableversioning is True. The default is MAJOR. This option is ignored, if
        lsaf_location=WORKSPACE.
lsaf_customversion - - Conditional - The version number to use to create a customized
        versioned file. This option is ignored, if lsaf_location=WORKSPACE or if lsaf_versiontype is
        not CUSTOM.
lsaf_comment - - Optional - The check-in comment to associate with the action of adding the
        data set to the repository. This option is ignored, if lsaf_location=WORKSPACE.
File: lsaf_exportextdicts.sas
First available in version: 2.2

%lsaf_getextdictionaryid(lsaf_dictionary=, lsaf_version=, lsaf_datatype=);

[ Exposure: external ]
Gets the dictionary identifier for an external dictionary. The SAS macro variable
_lsafExtDictionaryId_ is set to the identifier. The dictionary name, status, and data type can be
retrieved by calling the lsaf_getexternaldictionaries macro.

Syntax:
%LSAF_GETEXTDICTIONARYID(LSAF_DICTIONARY=lsaf-dictionary, LSAF_VERSION=lsaf-status,
LSAF_DATATYPE=lsaf-datatype);

          
History:
   2019-07-23
Initial coding
Expected Macro Variables:
_lsafExtDictionaryId_ - The external dictionary identifier.
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_dictionary - - Required - The case-sensitive name of the dictionary. This is the
        dictionary variable in the lsafgetexternaldictionaries data set that is generated by the
        lsaf_getexternaldictionaries macro.
lsaf_version - - Required - The referenced version of the external dictionary.
lsaf_datatype - - Required - The data type of the external dictionary.
        Valid values: TEXT, FLOAT, INTEGER.
File: lsaf_getextdictionaryid.sas
First available in version: 2.2

%lsaf_getexternaldictionaries(sas_dsname=work.lsafgetexternaldictionaries);

[ Exposure: external ]
Gets the metadata for all of the external dictionaries. The metadata is stored in a SAS data set.

Syntax:
%LSAF_GETEXTERNALDICTIONARIES(<SAS_DSNAME=WORK.LSAFGETEXTERNALDICTIOANRIES>);

          
History:
   2019-07-08
initial coding
   2019-11-01
update to handle a blank SAS output file.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the external dictionaries, specified as libref.dataset. The default value is
        WORK.LSAFGETEXTERNALDICTIONARIES. The data set contains a row for each external
        dictionary, sorted by the external dictionary name, and columns with the following
        names:
        - id: The unique external dictionary identifier.
        - name: The external dictionary name.
        - description: The external dictionary description.
        - dataType: The external dictionary data type. Valid values: text, float, integer.
        - shortName: The short name of the external dictionary.
        - dictionary: The external dictionary.
        - version: The current published version of the external dictionary.
        - href: The HTTP reference for the external dictionary.
        - createdDate: The date on which the external dictionary was created.
        - createdDateSASFormat: The date on which the external dictionary was created (in SAS
        Format).
        - createdBy: The identifier of the user who created the external dictionary.
        - associatedStudiesCount: The number of studies that are associated with the
        external dictionary.
        - lastModifiedDate: The date on which the external dictionary was last modified.
        - lastModifiedDateSASFormat: The date on which the external dictionary was last
        modified (in SAS Format).
        - lastModifiedBy: The identifier of the user of who last modified the external
        dictionary.
File: lsaf_getexternaldictionaries.sas
First available in version: 2.2