![]() | SUMMARY | DETAIL |
Macros to get and update study information in SAS Life Science Analytics Framework.
Macro Detail |
%lsaf_addstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The
%lsaf_addstudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_standardid
-
- Required - The identifier of the standard. The identifier can be
%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
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, iflsaf_customversfornewfiles
-
- Conditional - The version number to use to create alsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.lsaf_customversforexistingfiles
-
- Conditional - The version number to use for anlsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets to
%lsaf_createemptystudytablesinws(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_overwrite=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.
%lsaf_exportstudycodelists(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudycodelistspath_
-
The full path of the code lists data set, which includeslsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_exportstudydetails(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudydetailspath_
-
The full path of the details data set, which includeslsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_exportstudydicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudydictspath_
-
The full path of the dictionaries data set, which includeslsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_exportstudydocs(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudydocspath_
-
The full path of the documents data set, which includes the filelsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_exportstudyextdicts(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudyextdictspath_
-
The full path of the external dictionaries data set, whichlsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_exportstudystandards(lsaf_studyid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudystandardspath_
-
The full path of the standards data set, which includes thelsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%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
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrievedlsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_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 forlsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, iflsaf_customversfornewfiles
-
- Conditional - The version number to use to create alsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.lsaf_customversforexistingfiles
-
- Conditional - The version number to use for anlsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets tosas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
%lsaf_exportstudytablestows(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTABLESTOWS);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_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 forlsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
%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
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrievedlsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_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 forlsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_includeresultsanddatasets
-
- Optional - Indicates whether to include the results datalsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontypefornewfiles
-
- Conditional - The version type to use to create a file, iflsaf_customversfornewfiles
-
- Conditional - The version number to use to create alsaf_versiontypeforexistingfiles
-
- Conditional - The version type for an existing file.lsaf_customversforexistingfiles
-
- Conditional - The version number to use for anlsaf_comment
-
- Optional - The check-in comment to associate with adding the data sets tosas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
%lsaf_exportstudytlfstoworkspace(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_path=, lsaf_prefix=, lsaf_includeresultsanddatasets=, lsaf_overwrite=, sas_result_dsname=LSAFEXPORTSTUDYTLFSTOWORKSPACE);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrievedlsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_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 forlsaf_includeresultsanddatasets
-
- Optional - Indicates whether to include the results datalsaf_overwrite
-
- Optional - Indicates whether existing data sets are overwritten.sas_result_dsname
-
- Optional - The name of the output SAS data set to contain the path,
%lsaf_exportstudyvlm(lsaf_studyid=, lsaf_basestandardname=, lsaf_modelid=, lsaf_location=, lsaf_path=, lsaf_overwrite=, lsaf_enableversioning=, lsaf_versiontype=, lsaf_customversion=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafexportstudyvlmpath_
-
The full path of the VLM data set, which includes the filelsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_basestandardname
-
- Required - The case sensitive name of the base standard, such aslsaf_modelid
-
- Required - The identifier of the model. This can be retrieved using thelsaf_location
-
- Required - The case-insensitive output location for the exported file.lsaf_path
-
- Required - The case-sensitive output path for the exported files.lsaf_overwrite
-
- Optional - Indicates whether existing nonversioned data sets arelsaf_enableversioning
-
- Optional - Indicates whether versioning is enabled for newlsaf_versiontype
-
- Conditional - The version type to use to create a file, iflsaf_customversion
-
- Conditional - The version number to use to create a customizedlsaf_comment
-
- Optional - The check-in comment to associate with the action of adding the
%lsaf_getdictionarystudies(lsaf_dictionaryid=, sas_dsname=work.lsafgetdictionarystudies);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_dictionaryid
-
- Required - The identifier of the dictionary. The dictionary identifiersas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_getextdictionarystudies(lsaf_extdictionaryid=, sas_dsname=work.lsafgetextdictionarystudies);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The externalsas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_getstandardstudies(lsaf_standardid=, sas_dsname=work.lsafgetstandardstudies);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_standardid
-
- Required - The identifier of the standard. The standard identifier cansas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_getstdycomponenteditedby(lsaf_studyid=, lsaf_studycomponent=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafStudyComponentEditedBy_
-
The user identifier of the editor for the study component.lsaf_studyid
-
- Required - The identifier of the study. The identifier can be retrievedlsaf_studycomponent
-
- Required - The study component. Valid values:
%lsaf_getstudydictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudydictionaries);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The study item identifier can besas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
%lsaf_getstudyextdictionaries(lsaf_studyid=, sas_dsname=work.lsafgetstudyextdictionaries);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrievedsas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
%lsaf_getstudyid(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafStudyId_
-
The study identifier.lsaf_path
-
- Required - The case-sensitive path of the study.
%lsaf_getstudystandards(lsaf_studyid=, sas_dsname=work.lsafgetstudystandards);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The study item identifier can besas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
%lsaf_isstudydictionary(lsaf_studyid=, lsaf_dictionaryid=);
[ Exposure:
external
]
_lsafIsStudyDictionary_
-
Indicates whether the controlled terminology dictionary is_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrievedlsaf_dictionaryid
-
- Required - The controlled terminology dictionary identifier. The
%lsaf_isstudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
_lsafIsStudyExtDictionary_
-
Indicates whether the external dictionary is associated with the_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved bylsaf_extdictionaryid
-
- Required - The external dictionary identifier. The identifier can be
%lsaf_isstudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
_lsafIsStudyStandard_
-
Indicates whether the standard is associated with the study._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved bylsaf_standardid
-
- Required - The standard identifier. The identifier can be retrieved by
%lsaf_removeallstudydictionaries(lsaf_studyid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can be
%lsaf_removestudyextdictionary(lsaf_studyid=, lsaf_extdictionaryid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study. The identifier can belsaf_extdictionaryid
-
- Required - The identifier of the external dictionary. The
%lsaf_removestudystandard(lsaf_studyid=, lsaf_standardid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The identifier of the study item. The identifier can belsaf_standardid
-
- Required - The identifier of the standard. The identifier can be
%lsaf_setstdycomponenteditstatus(lsaf_studyid=, lsaf_studycomponent=, lsaf_editcomponent=0, lsaf_forceclaim=0);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The identifier can be retrieved bylsaf_studycomponent
-
- Required - The study component to set. Valid values: TABLES,lsaf_editcomponent
-
- Optional - Indicates whether the component can be edited.lsaf_forceclaim
-
- Optional - Forces the operation even if the user does not own the
%lsaf_updatestudydictionaries(lsaf_studyid=, sas_dsname=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_studyid
-
- Required - The study item identifier. The study item identifier can besas_dsname
-
- Required - The name of a SAS data set that contains the dictionary