![]() | SUMMARY | DETAIL |
Macros to manage content in the repository.
Macro Summary | |
external | %lsaf_checkin(lsaf_path=, lsaf_comment=, lsaf_versiontype=MINOR, lsaf_customversion=);
Checks in a repository file.
|
external | %lsaf_checkout(lsaf_path=);
Checks out a repository file.
|
external | %lsaf_copy(lsaf_source=, lsaf_target=);
Copies a file or folder to the specified location.
|
external | %lsaf_createcontext(lsaf_path=, lsaf_typeid=);
Creates a context in the repository.
|
external | %lsaf_createfile(local_path=, lsaf_path=, lsaf_enableversioning=, lsaf_version=, lsaf_comment=);
Uploads a file from the local machine to the repository.
|
external | %lsaf_createfolder(lsaf_path=);
Creates a folder in the repository.
|
external | %lsaf_delete(lsaf_path=);
Logically deletes an item. Deleted items are moved to the recycle bin.
|
external | %lsaf_disableversioning(lsaf_path=, lsaf_comment=);
Disables versioning for a repository file.
|
external | %lsaf_downloadfile(lsaf_path=, lsaf_version=, local_path=);
Downloads a file to a local computer from the repository.
|
external | %lsaf_enableversioning(lsaf_path=, lsaf_version=, lsaf_comment=);
Enables versioning for a repository file.
|
external | %lsaf_exists(lsaf_path=);
Indicates whether a repository item exists.
|
external | %lsaf_getcheckedoutfiles(lsaf_checkedoutby=%str(_LSAF_VALUE_NOT_PROVIDED_), lsaf_name=%str(_LSAF_VALUE_NOT_PROVIDED_), lsaf_location=%str(_LSAF_VALUE_NOT_PROVIDED_), sas_dsname=work.lsafGetCheckedOutFiles, lsaf_printLimitReachedWarning=1);
Gets the checked out file information for the specified user,file, or location within the ...
|
external | %lsaf_getchildren(lsaf_path=, sas_dsname=work.lsafGetChildren, lsaf_recursive=0);
Gets the metadata for the items that are within a container in the repository. The metadata ...
|
external | %lsaf_getcontextstate(lsaf_path=);
Gets the state value for the specified context in the repository. The SAS macro variable ...
|
external | %lsaf_getcopytoworkspacestatus(lsaf_path=);
Gets the value for the Copy to Workspace status of a file or folder in the repository. The ...
|
external | %lsaf_getitemid(lsaf_path=);
Gets the identification value for a Repository item. The user can only retrieve the value for ...
|
external | %lsaf_getparentmembershipcontext(lsaf_path=);
Gets the nearest parent context with the membership capability for the specified path.
|
external | %lsaf_getproperties(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetProperties);
Gets the properties of an item in the repository. The properties are stored in a SAS data set.
|
external | %lsaf_gettoplevelcontexts(sas_dsname=work.lsafGetTopLevelContexts);
Gets the metadata for the contexts at the top hierarchical structure in the repository to ...
|
external | %lsaf_gettype(lsaf_path=);
Gets the item type for the item at the specified repository path.
|
external | %lsaf_getversions(lsaf_path=, sas_dsname=work.lsafGetVersions);
Gets the metadata for all of the versions of a file. The metadata is stored in a SAS data set.
|
external | %lsaf_ischeckedout(lsaf_path=);
Indicates whether a repository file is checked out.
|
external | %lsaf_iscontainer(lsaf_path=);
Indicates whether a repository item is a container. Containers include folders and contexts.
|
external | %lsaf_isfilelocked(lsaf_path=);
Indicates whether a file that is in the repository is locked.
|
external | %lsaf_isversioned(lsaf_path=);
Indicates whether a repository file is versioned.
|
external | %lsaf_lockfile(lsaf_path=);
Locks a file that is in the repository.
|
external | %lsaf_move(lsaf_source=, lsaf_target=);
Moves a file or folder to the specified target location. Contexts cannot be moved.
|
external | %lsaf_permanentlydelete(lsaf_path=);
Permanently deletes an item. Deleted items are not moved to the recycle bin and cannot ...
|
external | %lsaf_rename(lsaf_source=, lsaf_newname=);
Renames an item in the repository. The new name must include the file extension, otherwise ...
|
external | %lsaf_search(lsaf_location=, lsaf_name=, lsaf_typeid=, lsaf_owner=, lsaf_lastmodifiedby=, lsaf_createdby=, lsaf_fromcreated=, lsaf_tocreated=, lsaf_fromlastmodified=, lsaf_tolastmodified=, lsaf_content=, lsaf_copytoworkspacestatus=, sas_dsname=work.lsafSearch, lsaf_printLimitReachedWarning=1);
Searches for an item in the repository. Although all parameters are optional, at least one ...
|
external | %lsaf_syncfiletoworkspace(lsaf_path=, lsaf_version=);
Copies the version of the repository file to the same location in the workspace of the current ...
|
external | %lsaf_undocheckout(lsaf_path=);
Undoes the checkout of a file that is in the repository.
|
external | %lsaf_unlockfile(lsaf_path=);
Unlocks a file that is in the repository.
|
external | %lsaf_updatecontextstate(lsaf_path=, lsaf_state=, lsaf_comment=, lsaf_recursive=0);
Updates the state of a context in the repository. Attempting to set the state of a context to ...
|
external | %lsaf_updatecopytoworkspacestatus(lsaf_path=, lsaf_status=);
Updates the value for the Copy To Workspace status of a file or folder in the repository. ...
|
external | %lsaf_updatefile(local_path=, lsaf_path=, lsaf_comment=, lsaf_versiontype=MAJOR, lsaf_customversion=);
Updates the contents of a file in the repository.
|
external | %lsaf_updateproperties(lsaf_path=, sas_dsname=);
Updates the editable properties of a repository item, using a SAS data set as input.
|
Macro Detail |
%lsaf_checkin(lsaf_path=, lsaf_comment=, lsaf_versiontype=MINOR, lsaf_customversion=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file in the repository.lsaf_comment
-
- Optional - The comment to associate with the check in.lsaf_versiontype
-
- Optional - The version type (MINOR, MAJOR, or CUSTOM) to createlsaf_customversion
-
- Conditional - The specific version to create by the check-in
%lsaf_checkout(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file in the repository.
%lsaf_copy(lsaf_source=, lsaf_target=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_source
-
- Required - The path of the item.lsaf_target
-
- Required - The path (including the name) into which to copy the file or
%lsaf_createcontext(lsaf_path=, lsaf_typeid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the context.lsaf_typeid
-
- Required - The type ID of the context.
%lsaf_createfile(local_path=, lsaf_path=, lsaf_enableversioning=, lsaf_version=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.local_path
-
- Required - The absolute path and name of the file on the local computer.lsaf_path
-
- Required - The path and name of the file to create. Files can only belsaf_enableversioning
-
- Optional - Indicates whether the file to create is versioned.lsaf_version
-
- Conditional - The version number to assign to the file. The value mustlsaf_comment
-
- Conditional - The comment for the versioned file. This option is
%lsaf_createfolder(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the folder.
%lsaf_delete(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item.
%lsaf_disableversioning(lsaf_path=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.lsaf_comment
-
- Optional - The comment to associate with the action.
%lsaf_downloadfile(lsaf_path=, lsaf_version=, local_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file in the repository.lsaf_version
-
- Conditional - The version of the file to download, if the file islocal_path
-
- Required - The full path and name of the file on the local computer.
%lsaf_enableversioning(lsaf_path=, lsaf_version=, lsaf_comment=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file in the repository.lsaf_version
-
- Optional - The version number of the file. If not specified, the valuelsaf_comment
-
- Optional - The comment to associate with the action. This value appears
%lsaf_exists(lsaf_path=);
[ Exposure:
external
]
_lsafExists_
-
Indicates whether the item exists._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item.
%lsaf_getcheckedoutfiles(lsaf_checkedoutby=%str(_LSAF_VALUE_NOT_PROVIDED_), lsaf_name=%str(_LSAF_VALUE_NOT_PROVIDED_), lsaf_location=%str(_LSAF_VALUE_NOT_PROVIDED_), sas_dsname=work.lsafGetCheckedOutFiles, lsaf_printLimitReachedWarning=1);
[ Exposure:
external
]
_lsafCOFSearchLimitReached_
-
The search limit reached flag._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_checkedoutby
-
- Optional - The ID of the user who checked out the files. If set to *lsaf_name
-
- Optional - The name of the file. If set to * (such as lsaf_name=*) orlsaf_location
-
- Optional - The folder path of the files. If set to * (such assas_dsname
-
- Optional - The name of the output SAS data set to contain the checkedlsaf_printLimitReachedWarning
-
- Optional - Indicates whether to print the message
%lsaf_getchildren(lsaf_path=, sas_dsname=work.lsafGetChildren, lsaf_recursive=0);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the container.sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadatalsaf_recursive
-
- Optional - The level of recursion, if the item is a container.
%lsaf_getcontextstate(lsaf_path=);
[ Exposure:
external
]
_lsafContextState_
-
The state of the context._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path to the context.
%lsaf_getcopytoworkspacestatus(lsaf_path=);
[ Exposure:
external
]
_lsafCopyToWSStatus_
-
The Copy to Workspace status._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_getitemid(lsaf_path=);
[ Exposure:
external
]
_lsafItemId_
-
The item ID._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The case-sensitive path of the item.
%lsaf_getparentmembershipcontext(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafParentMembershipContext_
-
The parent membership context._lsafRC_
-
The return code.lsaf_path
-
- Required - The path to the repository item.
%lsaf_getproperties(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetProperties);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item in the repository.lsaf_version
-
- Optional - The specific file version. If omitted or set to blank, thesas_dsname
-
- Optional - The name of the output SAS data set to the metadata for the
%lsaf_gettoplevelcontexts(sas_dsname=work.lsafGetTopLevelContexts);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_gettype(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafType_
-
The item type.lsaf_path
-
- Required - The path of the item.
%lsaf_getversions(lsaf_path=, sas_dsname=work.lsafGetVersions);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item in the repository.sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_ischeckedout(lsaf_path=);
[ Exposure:
external
]
_lsafIsCheckedOut_
-
Indicates whether the file is checked out or not._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_iscontainer(lsaf_path=);
[ Exposure:
external
]
_lsafIsContainer_
-
Indicates whether the item is a container._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item in the repository.
%lsaf_isfilelocked(lsaf_path=);
[ Exposure:
external
]
_lsafIsFileLocked_
-
Indicates whether the file is locked or not._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_isversioned(lsaf_path=);
[ Exposure:
external
]
_lsafIsVersioned_
-
Indicates whether the file is versioned._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path to the file.
%lsaf_lockfile(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_move(lsaf_source=, lsaf_target=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_source
-
- Required - The path of the file or folder.lsaf_target
-
- Required - The full path to which to move the file or folder.
%lsaf_permanentlydelete(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item.
%lsaf_rename(lsaf_source=, lsaf_newname=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_source
-
- Required - The path, which includes the name.lsaf_newname
-
- Required - The new name.
%lsaf_search(lsaf_location=, lsaf_name=, lsaf_typeid=, lsaf_owner=, lsaf_lastmodifiedby=, lsaf_createdby=, lsaf_fromcreated=, lsaf_tocreated=, lsaf_fromlastmodified=, lsaf_tolastmodified=, lsaf_content=, lsaf_copytoworkspacestatus=, sas_dsname=work.lsafSearch, lsaf_printLimitReachedWarning=1);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafSearchLimitReached_
-
The search limit reached flag.lsaf_location
-
- Optional - The location to search.lsaf_name
-
- Optional - The name of the item.lsaf_typeid
-
- Optional - The type of the item. Type ids can be retrieved using thelsaf_owner
-
- Optional - The owner of the item.lsaf_lastmodifiedby
-
- Optional - The user account that last modified the item.lsaf_createdby
-
- Optional - The user account that created the item.lsaf_fromcreated
-
- Optional - The earliest date on which the item was created. Must belsaf_tocreated
-
- Optional - The latest date on which the item was created. Must be inlsaf_fromlastmodified
-
- Optional - The earliest date on which the item was lastlsaf_tolastmodified
-
- Optional - The latest date on which the item was last modified.lsaf_content
-
- Optional - The content value of the file.lsaf_copytoworkspacestatus
-
- Optional - The status of the Copy to Workspace property.sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadatalsaf_printLimitReachedWarning
-
- Optional - Indicates whether to write to the SAS log
%lsaf_syncfiletoworkspace(lsaf_path=, lsaf_version=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file in the repository.lsaf_version
-
- Conditional - The version of the file to synchronize, if the file is
%lsaf_undocheckout(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_unlockfile(lsaf_path=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the file.
%lsaf_updatecontextstate(lsaf_path=, lsaf_state=, lsaf_comment=, lsaf_recursive=0);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the context.lsaf_state
-
- Required - The state to set.lsaf_comment
-
- Optional - The reason for the state change.lsaf_recursive
-
- Optional - Indicates whether the state of the children of the context,
%lsaf_updatecopytoworkspacestatus(lsaf_path=, lsaf_status=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path to the file.lsaf_status
-
- Required - The Copy To Workspace status.
%lsaf_updatefile(local_path=, lsaf_path=, lsaf_comment=, lsaf_versiontype=MAJOR, lsaf_customversion=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.local_path
-
- Required - The absolute path to the file on the local computer.lsaf_path
-
- Required - The path of the file in the repository to update. The file mustlsaf_comment
-
- Conditional - The comment for a versioned file. This value is ignored for anlsaf_versiontype
-
- Conditional - The type of version to create, if the file to update islsaf_customversion
-
- Conditional - The specific version to create. If lsaf_versiontype is
%lsaf_updateproperties(lsaf_path=, sas_dsname=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_path
-
- Required - The path of the item in the repository.sas_dsname
-
- Required - The name of a SAS data set that contains the property