Module StudyService
Macros to get and update study information in SAS Life Science Analytics Framework.
Since: 2.1
Macro Summary |
external
LSAF | %lsaf_addstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
Adds an external dictionary to a study.
|
external
LSAF | %lsaf_addstudystandard(lsaf_studyid=, lsaf_standardid=);
Adds a standard to a study.
|
external
LSAF | %lsaf_createemptystudytables(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=);
Creates a zero-observation data set in the repository for each table in a study.
|
external
LSAF | %lsaf_createemptystudytablesinws(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_overwrite=);
Creates a zero-observation data set in the workspace for each table in a study.
|
external
LSAF | %lsaf_exportstudycodelists(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study code lists. The metadata is stored in a SAS data set in the ...
|
external
LSAF | %lsaf_exportstudydetails(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study details. The metadata is stored in a SAS data set that is ...
|
external
LSAF | %lsaf_exportstudydicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study controlled terminology dictionaries. The metadata is stored in ...
|
external
LSAF | %lsaf_exportstudydocs(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study supporting documents. The metadata is stored in a SAS data set ...
|
external
LSAF | %lsaf_exportstudyextdicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study external dictionaries. The metadata is stored in a SAS data set ...
|
external
LSAF | %lsaf_exportstudystandards(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study standards. The metadata is stored in a SAS data set in the ...
|
external
LSAF | %lsaf_exportstudytables(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=, sas_result_dsname=LSAFEXPORTSTUDYTABLES);
Exports the metadata for the study tables to the specified area in the repository. The metadata ...
|
external
LSAF | %lsaf_exportstudytablestows(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTABLESTOWS);
Exports the metadata for the study tables to a location in the workspace. The metadata are ...
|
external
LSAF | %lsaf_exportstudytlfs(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, lsaf_includeresultsanddatasets=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=, sas_result_dsname=LSAFEXPORTSTUDYTLFS);
Exports the metadata for the study tables, listings, and figures to the specified area in the ...
|
external
LSAF | %lsaf_exportstudytlfstoworkspace(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_includeresultsanddatasets=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTLFSTOWORKSPACE);
Exports the metadata for the study tables, listings, and figures to the specified area in the ...
|
external
LSAF | %lsaf_exportstudyvlm(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
Exports the metadata for the study value level metadata (VLM). The metadata is stored in a SAS ...
|
external
LSAF | %lsaf_getdictionarystudies(lsaf_dictionaryid=, sas_dsname=work.lsafgetdictionarystudies);
Gets the metadata for all of the studies that are associated with a dictionary. The metadata is ...
|
external
LSAF | %lsaf_getextdictionarystudies(lsaf_extdictionaryid=, sas_dsname=work.lsafgetextdictionarystudies);
Gets the metadata for all of the studies that are associated with an external dictionary. The ...
|
external
LSAF | %lsaf_getstandardstudies(lsaf_standardid=, sas_dsname=work.lsafgetstandardstudies);
Gets the metadata for all of the studies that are associated with a data standard. The ...
|
external
LSAF | %lsaf_getstdycomponenteditedby(lsaf_studyid=, lsaf_studycomponent=);
Gets the name of the user who is the current editor for a study component. The SAS macro ...
|
external
LSAF | %lsaf_getstudydictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudydictionaries);
Gets the metadata for all of the controlled terminology dictionaries that are associated with a ...
|
external
LSAF | %lsaf_getstudyextdictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudyextdictionaries);
Gets the metadata for all of the external dictionaries that are associated with a study. The ...
|
external
LSAF | %lsaf_getstudyid(lsaf_path=);
Gets the identifier for a study that is in the repository. You must have Read access ...
|
external
LSAF | %lsaf_getstudystandards(lsaf_studyid=, sas_dsname=work.lsafgetstudystandards);
Gets the metadata for all of the standards that are associated with a study. The metadata is ...
|
external
LSAF | %lsaf_importstudycodelists(lsaf_studyId=, lsaf_importAction=, lsaf_location=, lsaf_codelistsPath=, lsaf_codelistsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudycodelists);
Imports study codelists from the specified data set, and optionally creates a validation ...
|
external
LSAF | %lsaf_importstudydetails(lsaf_studyId=, lsaf_location=, lsaf_detailspath=, lsaf_detailsversion=);
Imports study details from the specified SAS data set. The imported data replaces the ...
|
external
LSAF | %lsaf_importstudydocs(lsaf_studyId=, lsaf_basestandardname=, lsaf_modelId=, lsaf_importAction=, lsaf_location=, lsaf_docsPath=, lsaf_docsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudydocs);
Imports study supporting documents from the specified data set and optionally creates a ...
|
external
LSAF | %lsaf_importstudyfromdefinexml(lsaf_studyId=, lsaf_standardId=, lsaf_codeListUpdateAction=, lsaf_location=, lsaf_definePath=, lsaf_defineVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudyfromdefinexml);
Imports metadata from a Define-XML file and updates study components based on the contents ...
|
external
LSAF | %lsaf_importstudytables(lsaf_studyId=, lsaf_standardId=, lsaf_importAction=, lsaf_location=, lsaf_tablesPath=, lsaf_tablesVersion=, lsaf_columnsPath=, lsaf_columnsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudytables);
Imports study tables from the specified data sets and optionally creates a validation ...
|
external
LSAF | %lsaf_importstudytlfs(lsaf_studyId=, lsaf_basestandardname=, lsaf_modelId=, lsaf_importAction=, lsaf_location=, lsaf_sectionsPath=, lsaf_sectionsVersion=, lsaf_tlfsPath=, lsaf_tlfsVersion=, lsaf_resultsPath=, lsaf_resultsVersion=, lsaf_datasetsPath=, lsaf_datasetsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudytlfs);
Imports study tables, figures, and listings from the specified data sets and optionally ...
|
external
LSAF | %lsaf_importstudyvlm(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_importaction=, lsaf_location=, lsaf_vlmpath=, lsaf_vlmversion=, lsaf_reportlocation=, lsaf_reportpath=, lsaf_reportoverwrite=, lsaf_reportenableversioning=, lsaf_reportversiontype=, lsaf_reportcustomversion=, lsaf_reportcomment=, sas_result_dsname=work.lsafimportstudyvlm);
Imports study value level metadata from the specified data set and optionally creates a ...
|
external
LSAF | %lsaf_isstudydictionary(lsaf_studyid=, lsaf_dictionaryid=);
Indicates whether a controlled terminology dictionary is associated with a study.
|
external
LSAF | %lsaf_isstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
Indicates whether an external dictionary is associated with a study.
|
external
LSAF | %lsaf_isstudystandard(lsaf_studyid=, lsaf_standardid=);
Indicates whether a standard is associated with a study.
|
external
LSAF | %lsaf_removeallstudydictionaries(lsaf_studyid=);
Removes all controlled terminology dictionaries from a study.
|
external
LSAF | %lsaf_removestudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
Removes an external dictionary from a study.
|
external
LSAF | %lsaf_removestudystandard(lsaf_studyid=, lsaf_standardid=);
Removes a standard from a study.
|
external
LSAF | %lsaf_setstdycomponenteditstatus(lsaf_studyid=, lsaf_studycomponent=, lsaf_editcomponent=0, lsaf_forceclaim=0);
Sets the component edit status for a study.
|
external
LSAF | %lsaf_updatestudydictionaries(lsaf_studyid=, sas_dsname=);
Updates the controlled terminology dictionaries for a study using a SAS data set as input. ...
|
%lsaf_addstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
- Adds an external dictionary to a study.
Syntax:
%LSAF_ADDSTUDYEXTDICTIONARY(LSAF_STUDYID=lsaf-studyid,
LSAF_EXTDICTIONARYID=lsaf-extdictionaryid);
-
History:
- 2019-08-14
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The
identifier can be retrieved by calling the lsaf_getextdictionaryid macro.
-
File: lsaf_addstudyextdictionary.sas
-
First available in version: 2.2
%lsaf_addstudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
- Adds a standard to a study.
Syntax:
%LSAF_ADDSTUDYSTANDARD(LSAF_STUDYID=lsaf-studyid, LSAF_STANDARDID=lsaf-standardid);
-
History:
- 2019-08-02
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_standardid
-
- Required - The identifier of the standard. The identifier can be
retrieved by calling the lsaf_getstandardid macro.
-
File: lsaf_addstudystandard.sas
-
First available in version: 2.2
%lsaf_createemptystudytables(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=);
[ Exposure:
external
]
- Creates a zero-observation data set in the repository for each table in a study.
The base standard name and model identifier can be retrieved by calling the lsaf_getstudystandards
macro.
Syntax:
%LSAF_CREATEEMPTYSTUDYTABLES(LSAF_STUDY=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_OVERWRITE=lsaf-overwrite,
LSAF_ENABLEVERSIONING=lsaf-enableversioning,
LSAF_VERSIONTYPEFORNEWFILES=lsaf-versiontypefornewfiles,
LSAF_CUSTOMVERSFORNEWFILES=lsaf-customversfornewfiles,
LSAF_VERSIONTYPEFOREXISTINGFILES=lsaf-versiontypeforexistingfiles,
LSAF_CUSTOMVERSFOREXISTINGFILES=lsaf-customversforexistingfiles,
LSAF_COMMENT=lsaf-comment)
-
History:
- 2019-08-16
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, if
enableversioning is True. Valid values: MAJOR (Default), MINOR, and CUSTOM.
-
lsaf_customversfornewfiles
-
- Conditional - The version number to use to create a
customized versioned file. If versiontypefornewfiles is not CUSTOM, this option is ignored.
-
lsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.
Valid values: MAJOR, MINOR (Default), and CUSTOM.
-
lsaf_customversforexistingfiles
-
- Conditional - The version number to use for an
existing customized versioned file. If versiontypeforexistingfiles is not CUSTOM, this option
is ignored.
-
lsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets to
the repository.
-
File: lsaf_createemptystudytables.sas
-
First available in version: 2.2
%lsaf_createemptystudytablesinws(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_overwrite=);
[ Exposure:
external
]
- Creates a zero-observation data set in the workspace for each table in a study.
The base standard name and model identifier can be retrieved by calling the lsaf_getstudystandards
macro.
Syntax:
%LSAF_CREATEEMPTYSTUDYTABLESINWS(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_OVERWRITE=lsaf-overwrite)
-
History:
- 2019-08-20
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.
Valid values: 0 (Default): No, 1: Yes.
-
File: lsaf_createemptystudytablesinws.sas
-
First available in version: 2.2
%lsaf_exportstudycodelists(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study code lists. The metadata is stored in a SAS data set in the
workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYCODELISTS(LSAF_STUDYID=lsaf-studyid,
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-08-23
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudycodelistspath_
-
The full path of the code lists data set, which includes
the file extension. If the data set is not created, _lsafexportstudycodelistspath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudycodelists.sas
-
First available in version: 2.2
%lsaf_exportstudydetails(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study details. The metadata is stored in a SAS data set that is
located in the workspace or the repository.
Syntax:
%LSAF_EXPORTSTUDYDETAILS(LSAF_STUDYID=lsaf-studyid,
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-08-23
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudydetailspath_
-
The full path of the details data set, which includes
the file extension. If the data set is not created, _lsafexportstudydetailspath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudydetails.sas
-
First available in version: 2.2
%lsaf_exportstudydicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study controlled terminology dictionaries. The metadata is stored in
a SAS data set in the workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYDICTS(LSAF_STUDYID=lsaf-studyid,
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-08-23
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudydictspath_
-
The full path of the dictionaries data set, which includes
the file extension. If the data set is not created, _lsafexportstudydictspath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKPSACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudydicts.sas
-
First available in version: 2.2
%lsaf_exportstudydocs(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study supporting documents. The metadata is stored in a SAS data set
in the workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYDOCS(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
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-08-21
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudydocspath_
-
The full path of the documents data set, which includes the file
extension. If the data set is not created, _lsafexportstudydocspath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudydocs.sas
-
First available in version: 2.2
%lsaf_exportstudyextdicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study external dictionaries. The metadata is stored in a SAS data set
in the workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYEXTDICTS(LSAF_STUDYID=lsaf-studyid,
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-08-26
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudyextdictspath_
-
The full path of the external dictionaries data set, which
includes the file extension. If the data set is not created, _lsafexportstudyextdictspath_ is
blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudyextdicts.sas
-
First available in version: 2.2
%lsaf_exportstudystandards(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study standards. The metadata is stored in a SAS data set in the
workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYSTANDARDS(LSAF_STUDYID=lsaf-studyid,
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-08-26
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudystandardspath_
-
The full path of the standards data set, which includes the
file extension. If the data set is not created, _lsafexportstudystandardspath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudystandards.sas
-
First available in version: 2.2
%lsaf_exportstudytables(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=, sas_result_dsname=LSAFEXPORTSTUDYTABLES);
[ Exposure:
external
]
- Exports the metadata for the study tables to the specified area in the repository. The metadata
is stored in SAS data sets. The paths of the exported files are stored in a SAS data set.
Syntax:
%LSAF_EXPORTSTUDYTABLES(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_PREFIX=lsaf-prefix,
LSAF_OVERWRITE=lsaf-overwrite,
LSAF_ENABLEVERSIONING=lsaf-enableversioning,
LSAF_VERSIONTYPEFORNEWFILES=lsaf-versiontypefornewfiles,
LSAF_CUSTOMVERSFORNEWFILES=lsaf-customversfornewfiles,
LSAF_VERSIONTYPEFOREXISTINGFILES=lsaf-versiontypeforexistingfiles,
LSAF_CUSTOMVERSFOREXISTINGFILES=lsaf-customversforexistingfiles,
LSAF_COMMENT=lsaf-comment,
SAS_RESULT_DSNAME=WORK.LSAFEXPORTSTUDYTABLES);
-
History:
- 2019-08-20
- initial coding
- 2019-11-01
- update to handle a blank SAS output file.
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_prefix
-
- Required - The lower case prefix of the SAS data sets that are created for
the exported tables.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, if
enableversioning is true. If not specified, the system defaults will be applied.
Valid values: MAJOR, MINOR, and CUSTOM).
-
lsaf_customversfornewfiles
-
- Conditional - The version number to use to create a
customized versioned file. If versiontypefornewfiles is not CUSTOM, this option is ignored.
-
lsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.
Valid values: MAJOR, MINOR (Default), and CUSTOM.
-
lsaf_customversforexistingfiles
-
- Conditional - The version number to use for an
existing customized versioned file. If versiontypeforexistingfiles is not CUSTOM, this option
is ignored.
-
lsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets to
the repository.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
name, and location of the exported table SAS data sets, specified as libref.dataset.
The default is WORK.LSAFEXPORTSTUDYTABLES. The data set contains a row for each export data
set and columns with the following names. The data set is sorted by path.
- location: The location of the exported file (REPOSITORY).
- name: The name of the exported file.
- path: The path of the exported file.
-
File: lsaf_exportstudytables.sas
-
First available in version: 2.2
%lsaf_exportstudytablestows(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTABLESTOWS);
[ Exposure:
external
]
- Exports the metadata for the study tables to a location in the workspace. The metadata are
stored in SAS data sets. The paths of the exported files are stored in a SAS data set.
Syntax:
%LSAF_EXPORTSTUDYTABLESTOWS(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_PREFIX=lsaf-prefix,
LSAF_OVERWRITE=lsaf-overwrite,
SAS_RESULT_DSNAME=WORK.LSAFEXPORTSTUDYTABLESTOWS);
-
History:
- 2019-08-21
- 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:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_prefix
-
- Required - The lower case prefix of the SAS data sets that are created for
the exported tables.
-
lsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.
Valid values: 0 (Default): No, 1: Yes.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
name, and location of the exported table SAS data sets, specified as libref.dataset.
The default is WORK.LSAFEXPORTSTUDYTABLESTOWS. The data set contains a row for each exported
data set and columns with the following names. The data set is sorted by path.
- location: The location of the exported file (WORKSPACE).
- name: The name of the exported file.
- path: The path of the exported file.
-
File: lsaf_exportstudytablestows.sas
-
First available in version: 2.2
%lsaf_exportstudytlfs(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, lsaf_includeresultsanddatasets=, lsaf_enableversioning=, lsaf_versiontypefornewfiles=, lsaf_customversfornewfiles=, lsaf_versiontypeforexistingfiles=, lsaf_customversforexistingfiles=, lsaf_comment=, sas_result_dsname=LSAFEXPORTSTUDYTLFS);
[ Exposure:
external
]
- Exports the metadata for the study tables, listings, and figures to the specified area in the
repository. The metadata is stored in SAS data sets. The paths of the exported files are stored in
a SAS data set.
Syntax:
%LSAF_EXPORTSTUDYTLFS(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_PREFIX=lsaf-prefix,
LSAF_OVERWRITE=lsaf-overwrite,
LSAF_INCLUDERESULTSANDDATASETS=lsaf-includeresultsanddatasets
LSAF_ENABLEVERSIONING=lsaf-enableversioning,
LSAF_VERSIONTYPEFORNEWFILES=lsaf-versiontypefornewfiles,
LSAF_CUSTOMVERSFORNEWFILES=lsaf-customversfornewfiles,
LSAF_VERSIONTYPEFOREXISTINGFILES=lsaf-versiontypeforexistingfiles,
LSAF_CUSTOMVERSFOREXISTINGFILES=lsaf-customversforexistingfiles,
LSAF_COMMENT=lsaf-comment,
SAS_RESULT_DSNAME=WORK.LSAFEXPORTSTUDYTLFS);
-
History:
- 2019-10-17
- 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:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_prefix
-
- Required - The lower case prefix of the SAS data sets that are created for
the exported tables.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_includeresultsanddatasets
-
- Optional - Indicates whether to include the results data
sets. This setting is only relevant when model=Analysis, otherwise, the flag is ignored. Valid
values: 0 : No, 1 (Default) : Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, if
enableversioning is true. If not specified, the system defaults will be applied.
Valid values: MAJOR, MINOR, and CUSTOM).
-
lsaf_customversfornewfiles
-
- Conditional - The version number to use to create a
customized versioned file. If versiontypefornewfiles is not CUSTOM, this option is ignored.
-
lsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.
If not specified, the system defaults will be applied. Valid values: MAJOR, MINOR, and CUSTOM. *;
-
lsaf_customversforexistingfiles
-
- Conditional - The version number to use for an
existing customized versioned file. If versiontypeforexistingfiles is not CUSTOM, this option
is ignored.
-
lsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets to
the repository.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
name, and location of the exported tables, listings, and figures SAS data sets, specified as
libref.dataset. The default is WORK.LSAFEXPORTSTUDYTLFS. The data set contains a row for each
exported data set and columns with the following names. The data set is sorted by path.
- location: The location of the exported file (REPOSITORY).
- name: The name of the exported file.
- path: The path of the exported file.
-
File: lsaf_exportstudytlfs.sas
-
First available in version: 2.2.1
%lsaf_exportstudytlfstoworkspace(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_includeresultsanddatasets=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTLFSTOWORKSPACE);
[ Exposure:
external
]
- Exports the metadata for the study tables, listings, and figures to the specified area in the
wokspace. The metadata is stored in SAS data sets. The paths of the exported files are stored in
a SAS data set.
Syntax:
%LSAF_EXPORTSTUDYTLFSTOWORKSPACE(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_PATH=lsaf-path,
LSAF_PREFIX=lsaf-prefix,
LSAF_OVERWRITE=lsaf-overwrite,
LSAF_INCLUDERESULTSANDDATASETS=lsaf-includeresultsanddatasets
SAS_RESULT_DSNAME=WORK.LSAFEXPORTSTUDYTLFSTOWORKSPACE);
-
History:
- 2019-10-17
- 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:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_prefix
-
- Required - The lower case prefix of the SAS data sets that are created for
the exported tables.
-
lsaf_includeresultsanddatasets
-
- Optional - Indicates whether to include the results data
sets. This setting is only relevant when model=Analysis, otherwise, the flag is ignored. Valid
values: 0 : No, 1 (Default) : Yes.
-
lsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.
Valid values: 0 (Default): No, 1: Yes.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
name, and location of the exported tables, listings, and figures SAS data sets, specified as
libref.dataset. The default is WORK.LSAFEXPORTSTUDYTLFSTOWORKSPACE. The data set contains a
row for each exported data set and columns with the following names. The data set is sorted by
path.
- location: The location of the exported file (WORKSPACE).
- name: The name of the exported file.
- path: The path of the exported file.
-
File: lsaf_exportstudytlfstoworkspace.sas
-
First available in version: 2.2.1
%lsaf_exportstudyvlm(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
- Exports the metadata for the study value level metadata (VLM). The metadata is stored in a SAS
data set in the workspace or repository.
Syntax:
%LSAF_EXPORTSTUDYVLM(LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
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-08-26
- initial coding
- 2020-11-23
- update for versioning strategy.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafexportstudyvlmpath_
-
The full path of the VLM data set, which includes the file
extension. If the data set is not created, _lsafexportstudyvlmpath_ is blank.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such as
SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using the
lsaf_getstudystandards macro.
-
lsaf_location
-
- Required - The case-insensitive output location for the exported file.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The case-sensitive output path for the exported files.
-
lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets are
overwritten. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for new
exported files. Valid values: 0 (Default): No, 1: Yes.
-
lsaf_versiontype
-
- Optional - The case insensitive type for a versioned file
in the repository. This parameter is ignored when writing to the workspace and will
not apply if the file exists as a non-versioned repository file. If not provided, the
system defaults will be applied.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_customversion
-
- Conditional - Sets the specified version value if lsaf_versiontype is
CUSTOM. This parameter is ignored when writing to the workspace and will not apply if the
file exists as a non-versioned repository file.
-
lsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
data set to the repository. If lsaf_location=WORKSPACE, this option is ignored.
-
File: lsaf_exportstudyvlm.sas
-
First available in version: 2.2
%lsaf_getdictionarystudies(lsaf_dictionaryid=, sas_dsname=work.lsafgetdictionarystudies);
[ Exposure:
external
]
- Gets the metadata for all of the studies that are associated with a dictionary. The metadata is
stored in a SAS data set.
Syntax:
%LSAF_GETDICTIONARYSTUDIES(LSAF_DICTIONARYID=lsaf-dictionaryid,
<SAS_DSNAME=WORK.LSAFGETDICTIONARYSTUDIES>);
-
History:
- 2019-06-25
- 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:
-
lsaf_dictionaryid
-
- Required - The identifier of the dictionary. The dictionary identifier
can be retrieved by calling the lsaf_getdictionaryid macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the studies, specified as libref.dataset. The default value is
WORK.LSAFGETDICTIONARYSTUDIES. The data set contains a row for each study, sorted
by the study ID, and columns with the following names:
- id: The unique study identifier.
- name: The study name.
- path: The path of the study.
- typeid: The type identifier of the study.
-
File: lsaf_getdictionarystudies.sas
-
First available in version: 2.2
%lsaf_getextdictionarystudies(lsaf_extdictionaryid=, sas_dsname=work.lsafgetextdictionarystudies);
[ Exposure:
external
]
- Gets the metadata for all of the studies that are associated with an external dictionary. The
metadata is stored in a SAS data set.
Syntax:
%LSAF_GETEXTDICTIONARYSTUDIES(LSAF_EXTDICTIONARYID=lsaf-extdictionaryid,
<SAS_DSNAME=WORK.LSAFGETEXTDICTIONARYSTUDIES>);
-
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:
-
lsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The external
dictionary identifier can be retrieved by calling the lsaf_getexternaldictionaries macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the studies, specified as libref.dataset. The default value is
WORK.LSAFGETEXTDICTIONARYSTUDIES. The data set contains a row for each study, sorted
by the study name, and columns with the following names:
- id: The unique study identifier.
- name: The study name.
- path: The path of the study.
- typeid: The type identifier of the study.
-
File: lsaf_getextdictionarystudies.sas
-
First available in version: 2.2
%lsaf_getstandardstudies(lsaf_standardid=, sas_dsname=work.lsafgetstandardstudies);
[ Exposure:
external
]
- Gets the metadata for all of the studies that are associated with a data standard. The
metadata is stored in a SAS data set.
Syntax:
%LSAF_GETSTANDARDSTUDIES(LSAF_STANDARDID=lsaf-standardid,
<SAS_DSNAME=WORK.LSAFGETSTANDARDSTUDIES>);
-
History:
- 2019-06-12
- 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:
-
lsaf_standardid
-
- Required - The identifier of the standard. The standard identifier can
be retrieved by calling the lsaf_getstandardid macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the studies, specified as libref.dataset. The default value is
WORK.LSAFGETSTANDARDSTUDIES. The data set contains a row for each study, sorted
by the study ID, and columns with the following names:
- id: The unique study identifier.
- name: The study name.
- path: The path of the study.
- typeid: The type identifier of the study.
-
File: lsaf_getstandardstudies.sas
-
First available in version: 2.2
%lsaf_getstdycomponenteditedby(lsaf_studyid=, lsaf_studycomponent=);
[ Exposure:
external
]
- Gets the name of the user who is the current editor for a study component. The SAS macro
variable _lsafstudycomponenteditedby_ is set to the user. If no user is assigned as the
editor, the macro variable returns a blank value.
Syntax:
%lsaf_GETSTDYCOMPONENTEDITEDBY(LSAF_STUDYID=lsaf-studyid,
LSAF_STUDYCOMPONENT=lsaf-studycomponent);
-
History:
- 2019-07-31
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafStudyComponentEditedBy_
-
The user identifier of the editor for the study component.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
lsaf_studycomponent
-
- Required - The study component. Valid values:
TABLES, DICTIONARIES, SUPPORTING_DOCUMENTS, VALUE_LEVEL_METADATA, and TLFS.
-
File: lsaf_getstdycomponenteditedby.sas
-
First available in version: 2.2
%lsaf_getstudydictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudydictionaries);
[ Exposure:
external
]
- Gets the metadata for all of the controlled terminology dictionaries that are associated with a
study. The metadata is stored in a SAS data set.
Syntax:
%LSAF_GETSTUDYDICTIONARIESS(LSAF_STUDYID=lsaf-studyid,
<SAS_DSNAME=WORK.LSAFGETSTUDYDICTIONARIES>);
-
History:
- 2019-08-14
- 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:
-
lsaf_studyid
-
- Required - The study item identifier. The study item identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
the controlled terminology dictionaries, specified as libref.dataset. The default
value is WORK.LSAFGETSTUDYDICTIONARIES. The data set contains a row for each
dictionary in the order that they are associated with the study, and columns with
the following names:
- name: The dictionary name.
- id: The unique dictionary identifier.
- standard: The associated data standard.
- description: The dictionary description.
- isCheckedOut: Indicates whether the dictionary is checked out. Valid values:
0: no, 1: yes.
- checkedOutBy: The identifier of the user who has the dictionary checked out, if it
is checked out. This should always be the identifier of the current user.
- checkedOutDate: The date on which the dictionary was checked out, if it is checked
out.
- checkedOutDateSASFormat: The date on which the dictionary was checked out (in SAS
format), if it is checked out.
- createdDate: The date on which the dictionary was created.
- createdDateSASFormat: The date on which the dictionary was created (in SAS format).
- createdBy: The identifier of the user who created the dictionary.
- state: The state of the dictionary.
- publishedState: The published state of the dictionary.
- currentVersion: The current published version of the dictionary.
- associatedStudiesCount: The number of studies that are associated with the
dictionary.
- lastModifiedDate: The date on which the dictionary was last modified.
- lastModifiedDateSASFormat: The date on which the dictionary was last modified (in
SAS Format).
- lastModifiedBy: The identifier of the user of who last modified the dictionary.
- releaseDate: The date on which the dictionary was released.
- dictionaryStatus: The status of the dictionary.
-
File: lsaf_getstudydictionaries.sas
-
First available in version: 2.2
%lsaf_getstudyextdictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudyextdictionaries);
[ Exposure:
external
]
- Gets the metadata for all of the external dictionaries that are associated with a study. The
metadata is stored in a SAS data set.
Syntax:
%LSAF_GETSTUDYEXTDICTIONARIES(LSAF_STUDYID=lsaf-studyid,
<SAS_DSNAME=WORK.LSAFGETSTUDYEXTDICTIONARIES>);
-
History:
- 2019-08-14
- 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:
-
lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
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.LSAFGETSTUDYEXTDICTIONARIES. The data set contains a row for each dictionary,
sorted by the 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, and 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_getstudyextdictionaries.sas
-
First available in version: 2.2
%lsaf_getstudyid(lsaf_path=);
[ Exposure:
external
]
- Gets the identifier for a study that is in the repository. You must have Read access
permission to the study. The SAS macro variable _lsafStudyId_ is set to the study identifier.
Syntax:
%LSAF_GETSTUDYID(LSAF_PATH=lsaf_path);
-
History:
- 2019-08-27
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafStudyId_
-
The study identifier.
-
Parameters:
-
lsaf_path
-
- Required - The case-sensitive path of the study.
-
File: lsaf_getstudyid.sas
-
First available in version: 2.2
%lsaf_getstudystandards(lsaf_studyid=, sas_dsname=work.lsafgetstudystandards);
[ Exposure:
external
]
- Gets the metadata for all of the standards that are associated with a study. The metadata is
stored in a SAS data set.
Syntax:
%LSAF_GETSTUDYSTANDARDS(LSAF_STUDYID=lsaf-studyid, <SAS_DSNAME=WORK.LSAFGETSTUDYSTANDARDS>);
-
History:
- 2019-08-02
- 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:
-
lsaf_studyid
-
- Required - The study item identifier. The study item identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
the standards, specified as libref.dataset. The default value is
WORK.LSAFGETSTUDYSTANDARDS. The data set contains a row for each standard, sorted by
the standard name, and columns with the following names:
- id: The unique standard identifier.
- name: The data standard name.
- baseStandardType: The base data standard type.
- baseStandardName: The base data standard name.
- baseStandardVersion: The base data standard version.
- modelId: The model identifier.
- description: The data standard description.
- isCheckedOut: Indicates whether the data standard is checked out. Valid values:
0: no, 1: yes.
- checkedOutBy: The identifier of the user who has the data standard checked out, if
it is checked out. This should always be the identifier of the current user.
- checkedOutDate: The date on which the data standard was checked out, if it is
checked out.
- checkedOutDateSASFormat: The date on which the data standard was checked out
(in SAS format), if it is checked out.
- createdDate: The date on which the data standard was created.
- createdDateSASFormat: The date on which the data standard was created (in SAS
format).
- createdBy: The identifier of the user who created the data standard.
- state: The state of the data standard.
- publishedState: The published state of the data standard.
- currentVersion: The current published version of the data standard.
- associatedStudiesCount: The number of studies that are associated with the data
standard.
- lastModifiedDate: The date on which the data standard was last modified.
- lastModifiedDateSASFormat: The date on which the data standard was last modified
(in SAS format).
- lastModifiedBy: The identifier of the user who last modified the data standard.
- standardStatus: The status of the data standard.
-
File: lsaf_getstudystandards.sas
-
First available in version: 2.2
%lsaf_importstudycodelists(lsaf_studyId=, lsaf_importAction=, lsaf_location=, lsaf_codelistsPath=, lsaf_codelistsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudycodelists);
[ Exposure:
external
]
- Imports study codelists from the specified data set, and optionally creates a validation
report as a .csv file in the specified location.
Failure and Message Handling
The macro performs a series of preliminary validation procedures to determine whether the
specified parameters are valid and required parameters are specified. If none of these
procedures fail, the import is attempted. The success or failure, as well as any issues that
are encountered during the import, are reported as follows.
Return Code / Description
0: The import was successful. Import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: The preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note is printed to the SAS log and is designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes, if any,
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each warning or note is printed to the SAS log file and is
designated as a WARNING or NOTE, respectively.
-302: The import failed due to input data errors. The errors, warnings, and notes are
included in the sas_result_dsname data set and the validation report, if specified.
Additionally, each error, warning, or note is printed to the SAS log and is
designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYCODELISTS(
LSAF_STUDYID=lsaf-studyid,
LSAF_IMPORTACTION=lsaf-importaction,
LSAF_LOCATION=lsaf-location,
LSAF_CODELISTSPATH=lsaf-codelistspath,
<LSAF_CODELISTSVERSION=lsaf-codelistsversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-dsname>
);
-
History:
- 2020-09-25
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_importAction
-
- Required - The case-insensitive value to indicate the action to
take by the import. Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_codelistsPath
-
- Required - The case-sensitive path of the data set to import code
lists.
-
lsaf_codelistsVersion
-
- Optional - The version of the data set to import code
lists. If not specified, the most recent version is used.
-
lsaf_reportLocation
-
- Optional - The case-insensitive location in which to create
the report. If the report location and report path are not provided, the import runs
but no validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportPath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not provided, the
import runs but no validation report is created.
-
lsaf_reportOverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by a new report with a same path.
When a versioned repository file exists, this parameter is ignored and the
parameters versionType and customVersion, or their defaults, if not specified, are
applied to the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportEnableVersioning
-
- Optional - Indicates whether to enable versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and does not apply when the repository file exists. This parameter does not enable or
disable versioning of an existing repository file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportVersionType
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportCustomVersion
-
- Optional - Specifies the custom version value, if
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportComment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information, specified as libref.dataset. The defaultvalue is
WORK.LSAFIMPORTSTUDYCODELISTS. The data set contains information that pertains to
the import operation using the following columns:
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudycodelists.sas
-
First available in version: 2.4
%lsaf_importstudydetails(lsaf_studyId=, lsaf_location=, lsaf_detailspath=, lsaf_detailsversion=);
[ Exposure:
external
]
- Imports study details from the specified SAS data set. The imported data replaces the
existing details.
Syntax:
%LSAF_IMPORTSTUDYDETAILS(
LSAF_STUDYID=lsaf-studyid,
LSAF_LOCATION=lsaf-location,
LSAF_DETAILSPATH=lsaf-detailspath,
<LSAF_DETAILSVERSION=lsaf-detailsversion>
);
-
History:
- 2020-09-25
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_detailspath
-
- Required - The case-sensitive path of the data set to import the
study details.
-
lsaf_detailsversion
-
- Optional - The version of the data set to import the details
metadata. If not provided, the most recent version is used.
-
File: lsaf_importstudydetails.sas
-
First available in version: 2.4
%lsaf_importstudydocs(lsaf_studyId=, lsaf_basestandardname=, lsaf_modelId=, lsaf_importAction=, lsaf_location=, lsaf_docsPath=, lsaf_docsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudydocs);
[ Exposure:
external
]
- Imports study supporting documents from the specified data set and optionally creates a
validation report as a .csv file in the designated location.
Failure and Message Handling
The macro performs a series of preliminary validation procedures to determine whether the
provided parameters are valid and required parameters are specified. If none of these
procedures fail, the import is attempted. The success or failure, and issues that are
encountered during the import, are reported as follows.
Return Code / Description
0: The import was successful. Import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: The preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note is printed to the SAS log file and designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes, if any,
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each warning or note is printed to the SAS log file and
designated as a WARNING or NOTE, respectively.
-302: The import failed because of input data errors. The errors, warnings, and notes
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each error, warning, or note is printed to the SAS log file
and designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYDOCS(
LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_IMPORTACTION=lsaf-importaction,
LSAF_LOCATION=lsaf-location,
LSAF_DOCSPATH=lsaf-suppdocspath,
<LSAF_DOCSVERSION=lsaf-docsversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-dsname>
);
-
History:
- 2020-09-24
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case-sensitive name of the base standard, such
as SDTM and ADaM.
-
lsaf_modelId
-
- Required - The identifier of the model. This can be retrieved by
calling the lsaf_getstudystandards macro.
-
lsaf_importAction
-
- Required - The case-insensitive value to indicate the action to
take by the import. Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_docsPath
-
- Required - Case-sensitive path of the data set to import the
supporting documents.
-
lsaf_docsVersion
-
- Optional - The version of the data set to import the supporting
documents. If not specified, the most recent version is used.
-
lsaf_reportLocation
-
- Optional - The case-insensitive location in which to create
the report. If the report location and report path are not specified, the import runs
but no validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportPath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not provided, the
import runs but no validation report is created.
-
lsaf_reportOverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by a new report with a same path.
When a versioned repository file exists, this parameter is ignored and the
parameters versionType and customVersion, or their defaults, if not specified, are
applied to the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportEnableVersioning
-
- Optional - Indicates whether to turn on versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and will not apply if the repository file already exists. This parameter will not
turn on/off versioning of an existing repository file.
Valid values: 0 = No (Default), 1 = Yes
-
lsaf_reportVersionType
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportCustomVersion
-
- Optional - Sets the specified version value, if
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportComment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information about the import, specified as libref.dataset. The
default value is WORK.LSAFIMPORTSTUDYDOCS. The data set contains information
pertaining to the import operation using the following columns.
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudydocs.sas
-
First available in version: 2.4
%lsaf_importstudyfromdefinexml(lsaf_studyId=, lsaf_standardId=, lsaf_codeListUpdateAction=, lsaf_location=, lsaf_definePath=, lsaf_defineVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudyfromdefinexml);
[ Exposure:
external
]
- Imports metadata from a Define-XML file and updates study components based on the contents
of the file. It optionally creates a validation report as a .csv file in the designated
location. Codelists for the study are updated based on the UpdateAction that is specified.
All other study metadata is replaced.
Return Code / Description
0: Import was successful. The import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: Preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note is printed to the SAS log file and designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes are
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each warning or note is printed to the SAS log file and
designated as a WARNING or NOTE, respectively.
-302: The import failed because of input data errors. The errors, warnings, and notes
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each error, warning, or note is printed to the SAS log file
and designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYFROMDEFINEXML(
LSAF_STUDYID=lsaf-studyid,
LSAF_STANDARDID=lsaf-standardid,
LSAF_CODELISTUPDATEACTION=lsaf-codeListUpdateAction,
LSAF_LOCATION=lsaf-location,
LSAF_DEFINEPATH=lsaf-definepath,
<LSAF_DEFINEVERSION=lsaf-defineversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-result-dsname>
);
-
History:
- 2020-09-24
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_standardId
-
- Required - The identifier of the data standard. The identifier can
be retrieved by calling the lsaf_getstandardid macro.
-
lsaf_codeListUpdateAction
-
- Required - The case-insensitive value to indicate the
action to take for updating the code lists in the study.
Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_definePath
-
- Required - Case-sensitive path of the Define-XML file to import
the study metadata.
-
lsaf_defineVersion
-
- Optional - The version of the Define-XML to import the study
metadata. If not specified, the most recent version is used.
-
lsaf_reportLocation
-
- Optional - The location in which to create the report
If the report location and report path are not provided, the import runs but no
validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportPath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not provided, the
import runs but no validation report is created.
-
lsaf_reportOverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by a new report with a same path.
When a versioned repository file exists, this parameter is ignored and the
parameters versionType and customVersion, or their defaults, if not specified, are
applied to the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportEnableVersioning
-
- Optional - Indicates whether to enable versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and does not apply when the repository file exists. This parameter does not enable or
disable versioning of an existing repository file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportVersionType
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportCustomVersion
-
- Optional - Sets the specified version value, if
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportComment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information about the import, specified as libref.dataset. The
default value is WORK.LSAFIMPORTSTUDYFROMDEFINEXML. The data set contains information
pertaining to the import operation using the following columns.
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudyfromdefinexml.sas
-
First available in version: 2.4
%lsaf_importstudytables(lsaf_studyId=, lsaf_standardId=, lsaf_importAction=, lsaf_location=, lsaf_tablesPath=, lsaf_tablesVersion=, lsaf_columnsPath=, lsaf_columnsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudytables);
[ Exposure:
external
]
- Imports study tables from the specified data sets and optionally creates a validation
report as a .csv file in the designated location.
Failure and Message Handling
The macro performs a series of preliminary validation procedures to whether the specified
parameters are valid and required parameters are specified. If none of these procedures
fail, the import is attempted. The success or failure, and any issues that are encountered
during the import, are reported as follows.
Return Code / Description
0: The import was successful. Import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: Preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note will be printed to the SAS log designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes are
included in the sas_result_dsname data set and the validation report, if specified.
Additionally, each warning or note is printed to the SAS log file and is designated
as a WARNING or NOTE, respectively.
-302: The import failed because of input data errors. The errors, warnings, and notes
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each error, warning, or note is printed to the SAS log file
and is designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYTABLES(
LSAF_STUDYID=lsaf-studyid,
LSAF_STANDARDID=lsaf-standardid,
LSAF_IMPORTACTION=lsaf-importaction,
LSAF_LOCATION=lsaf-location,
LSAF_TABLESPATH=lsaf-tablespath,
<LSAF_TABLESVERSION=lsaf-tablesversion,>
LSAF_COLUMNSPATH=lsaf-columnspath,
<LSAF_COLUMNSVERSION=lsaf-columnsversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-result-dsname>
);
-
History:
- 2020-09-24
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_standardId
-
- Required - The standard identifier. This can be retrieved by calling
the lsaf_getStudyStandards macro.
-
lsaf_importAction
-
- Required - The case-insensitive value to indicate the action to
take by the import. Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_tablesPath
-
- Required - The case-sensitive path of the data set to import the
study tables.
-
lsaf_tablesVersion
-
- Optional - The version of the data set to import the study
tables. If not specified, the most recent version is used.
-
lsaf_columnsPath
-
- Required - The case-sensitive path of the data set to import the
study columns.
-
lsaf_columnsVersion
-
- Optional - The version of the data set to import the study
columns. If not specified, the most recent version is used.
-
lsaf_reportLocation
-
- Optional - The case-insensitive location in which to create
the report. If the report location and report path are not specified, the import runs
but no validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportPath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not specified, the
import runs but no validation report is created.
-
lsaf_reportOverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by the new report with the same path.
When a versioned repository file exists, this parameter is ignored and the
parameters versionType and customVersion, or their defaults, if not specified, are
applied to the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportEnableVersioning
-
- Optional - Indicates whether to enable versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and does not apply when the repository file exists. This parameter does not enable
or disable versioning of an existing repository file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportVersionType
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportCustomVersion
-
- Optional - The version value when
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportComment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information about the import, specified as libref.dataset. The
default value is WORK.LSAFIMPORTSTUDYTABLES. The data set contains information
pertaining to the import operation using the following columns.
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudytables.sas
-
First available in version: 2.4
%lsaf_importstudytlfs(lsaf_studyId=, lsaf_basestandardname=, lsaf_modelId=, lsaf_importAction=, lsaf_location=, lsaf_sectionsPath=, lsaf_sectionsVersion=, lsaf_tlfsPath=, lsaf_tlfsVersion=, lsaf_resultsPath=, lsaf_resultsVersion=, lsaf_datasetsPath=, lsaf_datasetsVersion=, lsaf_reportLocation=, lsaf_reportPath=, lsaf_reportOverwrite=, lsaf_reportEnableVersioning=, lsaf_reportVersionType=, lsaf_reportCustomVersion=, lsaf_reportComment=, sas_result_dsname=work.lsafimportstudytlfs);
[ Exposure:
external
]
- Imports study tables, figures, and listings from the specified data sets and optionally
creates a validation report as a .csv file in the specified location.
Failure and Message Handling
The macro performs a series of preliminary validation procedures to whether the specified
parameters are valid and required parameters are specified. If none of these procedures
fail, the import is attempted. The success or failure, and any issues that are encountered
during the import are reported as follows.
Return Code / Description
0: The import was successful. Import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: Preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note is printed to the SAS log file and is designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes are
included in the sas_result_dsname data set and the validation report, if specified.
Additionally, each warning or note is printed to the SAS log file and is designated
as a WARNING or NOTE, respectively.
-302: The import failed due to input data errors. The errors, warnings, and notes are
included in the sas_result_dsname data set and the validation report, if specified.
Additionally, each error, warning, or note is printed to the SAS log file and is
designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYTLFS(
LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_IMPORTACTION=lsaf-importaction,
LSAF_LOCATION=lsaf-location,
LSAF_SECTIONSPATH=lsaf-sectionspath,
<LSAF_SECTIONSVERSION=lsaf-sectionsversion,>
LSAF_TLFSPATH=lsaf-tlfspath,
<LSAF_TLFSVERSION=lsaf-tlfsversion,>
LSAF_RESULTSPATH=lsaf-resultspath,
<LSAF_RESULTSVERSION=lsaf-resultsversion,>
LSAF_DATASETSPATH=lsaf-datasetspath,
<LSAF_DATASETSVERSION=lsaf-datasetsversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-dsname>
);
-
History:
- 2020-09-22
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyId
-
- Required - The study identifier. This can be retrieved by calling the
lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case-sensitive name of the base standard, such
as SDTM and ADaM.
-
lsaf_modelId
-
- Required -The identifier of the model. This can be retrieved by
calling the lsaf_getstudystandards macro.
-
lsaf_importAction
-
- Required - The case-insensitive value to indicate the action to
take by the import. Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_sectionsPath
-
- Required - The case-sensitive path of the data set to import the
TLF sections.
-
lsaf_sectionsVersion
-
- Optional - The version of the data set to import the TLF
sections. If not specified, the most recent version is used.
-
lsaf_tlfsPath
-
- Required - The case-sensitive path of the data set to import the TLF
TLFs.
-
lsaf_tlfsVersion
-
- Optional - The version of the data set to import the TLF TLFs. If
not specified, the most recent version is used.
-
lsaf_resultsPath
-
- Required - The case-sensitive path of the data set to import the
TLF results.
-
lsaf_resultsVersion
-
- Optional - The version of the data set to import the TLF results.
If not specified, the most recent version is used.
-
lsaf_datasetsPath
-
- Required - The case-sensitive path of the data set to import the
TLF data sets.
-
lsaf_datasetsVersion
-
- Optional - The version of the data set to import the TLF data
sets. If not specified, the most recent version is used.
-
lsaf_reportLocation
-
- Optional - The case-insensitive location in which to create
the report. If the report location and report path are not spcified, the import runs
but no validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportPath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not specified, the
import runs but no validation report is created.
-
lsaf_reportOverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by the new report with the same path.
When a versioned repository file exists, this parameter is ignored and the parameters
versionType and customVersion, or their defaults, if not specified, are applied to
the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportEnableVersioning
-
- Optional - Indicates whether to enable versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and does not apply when the repository file exists. This parameter does not enable or
disable versioning of an existing repository file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportVersionType
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportCustomVersion
-
- Optional - The version value when
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportComment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information about the import, specified as libref.dataset. The
default value is WORK.LSAFIMPORTSTUDYTLFS. The data set contains information
pertaining to the import operation using the following columns.
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudytlfs.sas
-
First available in version: 2.4
%lsaf_importstudyvlm(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_importaction=, lsaf_location=, lsaf_vlmpath=, lsaf_vlmversion=, lsaf_reportlocation=, lsaf_reportpath=, lsaf_reportoverwrite=, lsaf_reportenableversioning=, lsaf_reportversiontype=, lsaf_reportcustomversion=, lsaf_reportcomment=, sas_result_dsname=work.lsafimportstudyvlm);
[ Exposure:
external
]
- Imports study value level metadata from the specified data set and optionally creates a
validation report as a .csv file in the designated location.
Failure and Message Handling
The macro performs a series of preliminary validation procedures to whether the
specified parameters are valid and required parameters are specified. If none of these
procedures fail, the import is attempted. The success or failure, and any issues that are
encountered during the import are reported as follows.
Return Code / Description
0: The import was successful. Import details are reported in the sas_result_dsname data
set and in the validation report, if specified.
-1: Preliminary validation procedures failed. The sas_result_dsname data set is empty.
No validation report is created.
-300: The import was successful but issues were noted. The notes are included in the
sas_result_dsname data set and the validation report, if specified.
Additionally, each note is printed to the SAS log file and is designated as a NOTE.
-301: The import was successful but warnings were reported. The warnings and notes, if any,
are included in the sas_result_dsname data set and the validation report, if
specified. Additionally, each warning or note is printed to the SAS log file and is
designated as a WARNING or NOTE, respectively.
-302: The import failed because of input data errors. The errors, warnings, and notes are
included in the sas_result_dsname data set and the validation report, if specified.
Additionally, each error, warning, or note is printed to the SAS log file and is
designated as an ERROR, WARNING, or NOTE, respectively.
Syntax:
%LSAF_IMPORTSTUDYVLM(
LSAF_STUDYID=lsaf-studyid,
LSAF_BASESTANDARDNAME=lsaf-basestandardname,
LSAF_MODELID=lsaf-modelid,
LSAF_IMPORTACTION=lsaf-importaction,
LSAF_LOCATION=lsaf-location,
LSAF_VLMPATH=lsaf-vlmpath,
<LSAF_VLMVERSION=lsaf-vlmversion,
LSAF_REPORTLOCATION=lsaf-reportlocation,
LSAF_REPORTPATH=lsaf-reportpath,
LSAF_REPORTOVERWRITE=lsaf-reportoverwrite,
LSAF_REPORTENABLEVERSIONING=lsaf-reportenableversioning,
LSAF_REPORTVERSIONTYPE=lsaf-reportversiontype,
LSAF_REPORTCUSTOMVERSION=lsaf-reportcustomversion,
LSAF_REPORTCOMMENT=lsaf-reportcomment,
SAS_RESULT_DSNAME=sas-dsname>
);
-
History:
- 2020-09-25
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_basestandardname
-
- Required - The case-sensitive name of the base standard, such
as SDTM and ADaM.
-
lsaf_modelid
-
- Required - The identifier of the model. This can be retrieved calling
the lsaf_getstudystandards macro.
-
lsaf_importaction
-
- Required - The case-insensitive value to indicate the action to
take by the import. Valid values: REPLACE or ADD_NEW.
-
lsaf_location
-
- Required - The location of the import source file.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_vlmpath
-
- Required - The case-sensitive path of the data set to import the value
level metadata.
-
lsaf_vlmversion
-
- Optional - The version of the data set to import the value level
metadata. If not specified, the most recent version is used.
-
lsaf_reportlocation
-
- Optional - The case-insensitive location in which to create
the report. If the report location and report path are not specified, the import runs
but no validation report is created.
Valid values: REPOSITORY or WORKSPACE.
-
lsaf_reportpath
-
- Optional - The case-sensitive path of the report, which includes
the report file name. If the report location and report path are not specified, the
import runs but no validation report is created.
-
lsaf_reportoverwrite
-
- Optional - Indicates whether an existing unversioned repository
or existing workspace report file is overwritten by the new report with the same path.
When a versioned repository file exists, this parameter is ignored and the parameters
versionType and customVersion, or their defaults, if not specified, are applied
to the new version of the file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportenableversioning
-
- Optional - Indicates whether to enable versioning for a
new file in the repository. The parameter is ignored when writing to the workspace
and does not apply when the repository file exists. This parameter does not enable or
disable versioning of an existing repository file.
Valid values: 0 (Default): No, 1: Yes.
-
lsaf_reportversiontype
-
- Optional - The case-insensitive type for a versioned report
in the repository. This parameter is ignored when writing to the workspace and does
not apply when the file exists as a non-versioned repository file.
Valid values: MAJOR, MINOR, or CUSTOM.
-
lsaf_reportcustomversion
-
- Optional - The version value when
lsaf_reportversiontype is CUSTOM. This parameter is ignored when writing to the
workspace and does not apply when the file exists as a non-versioned repository file.
-
lsaf_reportcomment
-
- Optional - The comment to associate with the new repository
file.
-
sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the
completion status information about the import, specified as libref.dataset. The
default value is WORK.LSAFIMPORTSTUDYVLM. The data set contains information
pertaining to the import operation using the following columns.
- studyId: The study identifier.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_importstudyvlm.sas
-
First available in version: 2.4
%lsaf_isstudydictionary(lsaf_studyid=, lsaf_dictionaryid=);
[ Exposure:
external
]
- Indicates whether a controlled terminology dictionary is associated with a study.
The SAS macro variable _lsafIsStudyDictionary_ is set to a value of 1, if the specified dictionary
is associated with the specified study, 0 if it is not. In the event of an incorrect call to the
macro that results in an error, the return value of _lsafIsStudyDictionary_ is set to -1.
Syntax:
%LSAF_ISSTUDYDICTIONARY(LSAF_STUDYID=lsaf-studyid, LSAF_DICTIONARYID=lsaf-dictionaryid);
-
History:
- 2019-08-23
- initial coding
-
-
Expected Macro Variables:
-
_lsafIsStudyDictionary_
-
Indicates whether the controlled terminology dictionary is
associated with the study.
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved
by calling the lsaf_getstudyid macro.
-
lsaf_dictionaryid
-
- Required - The controlled terminology dictionary identifier. The
identifier can be retrieved by calling the lsaf_getdictionaryid macro.
-
File: lsaf_isstudydictionary.sas
-
First available in version: 2.2
%lsaf_isstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
- Indicates whether an external dictionary is associated with a study.
The SAS macro variable _lsafIsStudyExtDictionary_ is set to a value of 1, if the specified
dictionary is associated with the specified study, 0 if it is not. In the event of an incorrect
call to the macro that results in an error, the return value of _lsafIsStudyExtDictionary_ is set
to -1.
Syntax:
%LSAF_ISSTUDYEXTDICTIONARY(LSAF_STUDYID=lsaf-studyid, LSAF_EXTDICTIONARYID=lsaf-extdictionaryid);
-
History:
- 2019-08-26
- initial coding
-
-
Expected Macro Variables:
-
_lsafIsStudyExtDictionary_
-
Indicates whether the external dictionary is associated with the
study.
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved by
calling the lsaf_getstudyid macro.
-
lsaf_extdictionaryid
-
- Required - The external dictionary identifier. The identifier can be
retrieved by calling the lsaf_getextdictionaryid macro.
-
File: lsaf_isstudyextdictionary.sas
-
First available in version: 2.2
%lsaf_isstudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
- Indicates whether a standard is associated with a study.
The SAS macro variable _lsafIsStudyStandard_ is set to a value of 1, if the specified standard is
associated with the specified study, 0 if it is not. In the event of an incorrect call to the
macro that results in an error, the return value of _lsafIsStudyStandard_ is set to -1.
Syntax:
%LSAF_ISSTUDYSTANDARD(LSAF_STUDYID=lsaf-studyid, LSAF_STANDARDID=lsaf-standardid);
-
History:
- 2019-08-26
- initial coding
-
-
Expected Macro Variables:
-
_lsafIsStudyStandard_
-
Indicates whether the standard is associated with the study.
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved by
calling the lsaf_getstudyid macro.
-
lsaf_standardid
-
- Required - The standard identifier. The identifier can be retrieved by
calling the lsaf_getstandardid macro.
-
File: lsaf_isstudystandard.sas
-
First available in version: 2.2
%lsaf_removeallstudydictionaries(lsaf_studyid=);
[ Exposure:
external
]
- Removes all controlled terminology dictionaries from a study.
Syntax:
%LSAF_REMOVEALLSTUDYDICTIONARIES(LSAF_STUDYID=lsaf-studyid);
-
History:
- 2019-08-23
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
File: lsaf_removeallstudydictionaries.sas
-
First available in version: 2.2
%lsaf_removestudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
- Removes an external dictionary from a study.
Syntax:
%LSAF_REMOVESTUDYEXTDICTIONARY(LSAF_STUDYID=lsaf-studyid,
LSAF_EXTDICTIONARYID=lsaf-extdictionaryid);
-
History:
- 2019-08-14
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The
identifier can be retrieved by calling the lsaf_getextdictionaryid macro.
-
File: lsaf_removestudyextdictionary.sas
-
First available in version: 2.2
%lsaf_removestudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
- Removes a standard from a study.
Syntax:
%LSAF_REMOVESTUDYSTANDARD(LSAF_STUDYID=lsaf-studyid, LSAF_STANDARDID=lsaf-standardid);
-
History:
- 2019-08-09
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The identifier of the study item. The identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
lsaf_standardid
-
- Required - The identifier of the standard. The identifier can be
retrieved by calling the lsaf_getstandardid macro.
-
File: lsaf_removestudystandard.sas
-
First available in version: 2.2
%lsaf_setstdycomponenteditstatus(lsaf_studyid=, lsaf_studycomponent=, lsaf_editcomponent=0, lsaf_forceclaim=0);
[ Exposure:
external
]
- Sets the component edit status for a study.
Syntax:
%LSAF_SETSTDYCOMPONENTEDITSTATUS(LSAF_STUDYID=lsaf-studyid,
LSAF_STUDYCOMPONENT=lsaf-studycomponent,
LSAF_EDITCOMPONENT=lsaf-editcomponent,
LSAF_FORCECLAIM=lsaf-forceclaim);
-
History:
- 2019-07-16
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved by
calling the lsaf_getstudyid macro.
-
lsaf_studycomponent
-
- Required - The study component to set. Valid values: TABLES,
DICTIONARIES, SUPPORTING_DOCUMENTS, VALUE_LEVEL_METADATA, and TLFS.
-
lsaf_editcomponent
-
- Optional - Indicates whether the component can be edited.
Valid values: 0 (Default)- Disallow, 1 - Allow.
-
lsaf_forceclaim
-
- Optional - Forces the operation even if the user does not own the
editability of the study component. Valid only if the user has the manage study
privilege.
Valid values: 0 (Default)- Do not force, 1 - Force.
-
File: lsaf_setstdycomponenteditstatus.sas
-
First available in version: 2.2
%lsaf_updatestudydictionaries(lsaf_studyid=, sas_dsname=);
[ Exposure:
external
]
- Updates the controlled terminology dictionaries for a study using a SAS data set as input.
The order of the dictionary identifiers in the input data set dictates the order in which the
dictionaries are associated to the study. This order is important and determines the precedence
of duplicate code lists in the study. For example, if multiple dictionaries have the same
named code list, only the code list from the first dictionary is associated with the study.
All other duplicates are ignored.
Each dictionary identifier is represented as a single row in the input data set.
Use the output data set from the lsaf_getstudydictionaries macro to determine the
controlled terminology dictionaries that are currently associated with a study. Consider running
this macro first to have a record of the current associated controlled terminology dictionaries.
If there are any issues with the updates, this data set can be used to reinstate the dictionary
associations prior to running the updates.
The output data set from the lsaf_getdictionariesbystatus (published) can be used to determine
dictionary identifiers that are available to be associated with the study.
The dictionary identifiers that are represented in the input data set replace the list of
dictionaries that are currently associated with the study.
Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.
If an invalid value is specified for a dictionary identifier, the updates are aborted and the
appropriate error message is written to the SAS log file.
If duplicate valid dictionary identifiers are provided for the study, only the first value is
is maintained.
Syntax:
%LSAF_UPDATESTUDYDICTIONARIES(LSAF_STUDYID=lsaf-studyid, SAS_DSNAME=SAS-data-set);
-
History:
- 2019-08-14
- initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_studyid
-
- Required - The study item identifier. The study item identifier can be
retrieved by calling the lsaf_getstudyid macro.
-
sas_dsname
-
- Required - The name of a SAS data set that contains the dictionary
identifiers for the study to update, specified as libref.dataset. The data set must
contain at least the variable that is listed below. Additional variables are ignored.
- id: The identifier for the controlled terminology dictionary. The identifier
can be retrieved by calling the lsaf_getdictionariesbystatus macro with the
PUBLISHED option.
-
File: lsaf_updatestudydictionaries.sas
-
First available in version: 2.2