Module JobService
Macros to create, update, and retrieve information for jobs.
Since: 2.1
Macro Summary |
external
| %lsaf_createworkspacejob(lsaf_path=, sas_dsname_info=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_programs=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_parameters=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_inputs=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_outputs=%str(_lsaf_createworkspacejob_ds_notprovided_));
Creates a job in the workspace of the current user. The SAS macro variable _lsafWorkspaceJobPath_ ...
|
external
LSAF | %lsaf_getjobinfo(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobInfo);
Gets the information for a job in the repository. The information is stored in a SAS data set.
|
external
LSAF | %lsaf_getjobinputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobInputs);
Gets the metadata for the inputs for the specified job in the repository. The metadata is ...
|
external
LSAF | %lsaf_getjoboutputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobOutputs);
Gets the metadata for the outputs for the specified job in the repository. The metadata is ...
|
external
LSAF | %lsaf_getjobparameters(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobParameters);
Gets the job parameter metadata for the specified job. The metadata is stored in a SAS data ...
|
external
LSAF | %lsaf_getjobprograms(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobPrograms);
Gets the metadata for the programs for the specified job in the SAS Life Science Analytics ...
|
external
LSAF | %lsaf_getjobrunasowner(lsaf_path=);
Gets the value of the property Run as owner for a repository job. The information is stored ...
|
external
LSAF | %lsaf_getworkspacejobinfo(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobInfo);
Gets the information for a job in the workspace of the current user. The information is stored ...
|
external
LSAF | %lsaf_getworkspacejobinputs(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobInputs);
Gets the metadata for the inputs for the specified job in the workspace of the current user. ...
|
external
LSAF | %lsaf_getworkspacejoboutputs(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobOutputs);
Gets the metadata for the outputs for the specified job in the workspace of the current user. ...
|
external
LSAF | %lsaf_getworkspacejobparameters(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobParameters);
Gets the job parameter metadata for the specified job in the workspace of the current user. ...
|
external
LSAF | %lsaf_getworkspacejobprograms(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobPrograms);
Gets the metadata for the programs for the specified job in the workspace of the current user. ...
|
external
LSAF | %lsaf_setjobrunasowner(lsaf_path=, lsaf_runasowner=);
Sets the job property Run as owner. Only the owner can change the property. Get the ...
|
external
| %lsaf_updateworkspacejob(lsaf_path=, sas_dsname_info=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_programs=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_parameters=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_inputs=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_outputs=%str(_lsaf_updateworkspacejob_ds_notprovided_));
Updates a job in workspace of the current user.
|
%lsaf_createworkspacejob(lsaf_path=, sas_dsname_info=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_programs=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_parameters=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_inputs=%str(_lsaf_createworkspacejob_ds_notprovided_), sas_dsname_outputs=%str(_lsaf_createworkspacejob_ds_notprovided_));
[ Exposure:
external
]
- Creates a job in the workspace of the current user. The SAS macro variable _lsafWorkspaceJobPath_
is set to the full path of the created job, which includes the file extension. If the job is not
created, _lsafWorkspaceJobPath_ is set to blank.
Data sets that represent the job data to be set at creation time can be specified in the call to
lsaf_createworkspacejob. If data sets are not specified, the default values for all job data are
used.
The output data sets from the following macros contain all of the data that is relevant to the
job properties that can be specified when the job is created. See the macro documentation for
more details.
- lsaf_getjobinfo or lsaf_getworkspacejobinfo
- lsaf_getjobprograms or lsaf_getworkspacejobprograms
- lsaf_getjobparameters or lsaf_getworkspacejobparameters
- lsaf_getjobinputs or lsaf_getworkspacejobinputs
- lsaf_getjoboutputs or lsaf_getworkspacejoboutputs
The output data sets from the following job manifest macros contain all of the data that is
relevant to the job properties that can be specified when the job is created. See the macro
documentation for more details.
- lsaf_getjobmanifestinfo
- lsaf_getjobmanifestprograms
- lsaf_getjobmanifestparameters
- lsaf_getjobmanifestinputs
- lsaf_getjobmanifestoutputs
Syntax:
%LSAF_CREATEWORKSPACEJOB(LSAF_PATH=lsaf-path <SAS_DSNAME_INFO=SAS-data-set-info,
SAS_DSNAME_PROGRAMS=SAS-data-set-jobprograms, SAS_DSNAME_PARAMETERS=SAS-data-set-parameters,
SAS_DSNAME_INPUTS=SAS-data-set-inputs, SAS_DSNAME_OUTPUTS=SAS-data-set-outputs>);
-
History:
- 2016-09-23
- initial coding
- 2019-02-11
- update to 2.1
- 2019-08-28
- update file path length to $2048
- 2019-12-03
- update header documentation to include job manifest macros.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafWorkspaceJobPath_
-
The full path of the new job.
-
Parameters:
-
lsaf_path
-
- Required - The path for the job to create in the workspace of the current user.
-
sas_dsname_info
-
- Optional - The name of the SAS data set that contains the job
information, specified as libref.dataset. If the parameter is not included in the call,
the default job information is set. The data set must contain at least the
character variables that are listed below. Additional variables are ignored.
- name: The name of the job property.
- value: The value of the property.
The information that can be specified is DESCRIPTION, LOGPATH, LSTPATH, MANIFESTPATH,
NEWOUTPUTS_CUSTOMVERSION, NEWOUTPUTS_ENABLEVERSION, and NEWOUTPUTS_VERSIONTYPE.
All other values listed in the data set are ignored. All data are case-insensitive.
If a name is listed more than once, the last value processed is used. If a name is
omitted, the default value is used.
-
sas_dsname_programs
-
- Optional - The name of the SAS data set that contains the list of
paths to the SAS programs to be run, specified as libref.dataset. If the parameter is
not included in the call, no programs are set. The data set must contain at least
the variables that are listed below. Additional variables are ignored.
- programPath: The path of the SAS program file.
- programVersion: The version of the SAS program file. Blank values specify the
latest file version.
-
sas_dsname_parameters
-
- Optional - The name of the SAS data set that contains the job
parameter information, specified as libref.dataset. If the parameter is not included in
the call, no parameters are set. The data set must contain at least the character
variables listed below. Additional variables are ignored.
- name: The name of the parameter.
- label: The label for the parameter.
- type: The parameter type. Valid values are CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- defaultValue: The value to set as the default value for the parameter. DATE job
parameter values must be one of the following formats. Date values in formats other
than the two described below result in an execution error.
- SAS datetime18. format (such as 02NOV2013:09:33:22) - an offset of zero hours from
GMT is used.
- SAS E8601DZ25. format (such as 2013-11-02T09:33:22-04:00).
- fileVersion: The file version to use, if the parameter is of type FILE. Blank values
specifiy the latest file version.
- includeSubFolders (numeric): Indicates whether the folder includes subfolders.
Valid values: 0 and 1.
Data set rows with duplicate values for parameter name result in a data set
validation error.
-
sas_dsname_inputs
-
- Optional - The name of the SAS data set that contains the list of the
job inputs, specified as libref.dataset. If the parameter is not included in the call,
no inputs are set. The data set must contain at least the variables that are listed
below as the type specified. Additional variables are ignored.
- inputPath (character): The path of the file or container to use as input.
- inputType (character): The type of input item. Valid values: FILE and CONTAINER.
- inputVersion (character): The version of the FILE item. Blank values specify the
latest file version. The value is ignored for inputs of type CONTAINER.
- inputIncludeSubFolders (numeric): Indicates whether the input folder includes
subfolders. Valid values: 0 and 1. The value is ignored for inputs of type FILE.
Data set rows with duplicate values for inputPath result in a data set validation
error.
-
sas_dsname_outputs
-
- Optional - The name of the SAS data set that contains the list of the
job outputs, specified as libref.dataset. If the parameter is not included in the call,
no outputs are set. The data set must contain at least the variables listed that are
below as the type specified. Additional variables are ignored.
- outputPath (character): The path of the container to use as output.
- outputIncludeSubFolders (numeric): Indicates whether the output container includes
subfolders. Valid values: 0 and 1.
Data set rows with duplicate values for outputPath result in a data set validation
error.
-
File: lsaf_createworkspacejob.sas
-
First available in version: 1.5
%lsaf_getjobinfo(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobInfo);
[ Exposure:
external
]
- Gets the information for a job in the repository. The information is stored in a SAS data set.
This is the information that is displayed on the Details tab of the job editor and the
information that concerns the versioning of new outputs.
Syntax:
%LSAF_GETJOBINFO(LSAF_PATH=lsaf-path <, LSAF_VERSION=lsaf-version, SAS_DSNAME=SAS-data-set>);
-
History:
- 2014-04-08
- initial coding.
- 2016-08-26
- rebrand as LSAF
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
lsaf_version
-
- Optional - The specific version number of the job. If not specified,
the information for the latest version is returned. Specifying a version for a
non-versioned job causes an error.
-
sas_dsname
-
- Optional - The name of the output SAS data set that contains the metadata
for the job, specified as libref.dataset. The default value is
WORK.LSAFGETJOBINFO. The data set contains variables that represent each
element of the metadata for the job. The data set is sorted by the NAME
variable. The following metadata is represented in the data set.
- path: The path of the job.
- version: The version number that is associated with the job.
- name: The name of the property or attribute.
- value: The value of the property or attribute.
-
File: lsaf_getjobinfo.sas
-
First available in version: 1.4
%lsaf_getjobinputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobInputs);
[ Exposure:
external
]
- Gets the metadata for the inputs for the specified job in the repository. The metadata is
stored in a SAS data set. The list does not include the input programs.
Syntax:
%LSAF_GETJOBINPUTS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);
-
History:
- 2014-04-22
- initial coding.
- 2016-08-26
- rebrand as LSAF
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
lsaf_version
-
- Optional - The version of the job. If not specified, the latest version
is used.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the inputs, specified as libref.dataset. The default value is
WORK.LSAFGETJOBINPUTS. The data set contains a row for each job input and columns
with the following names. The data set retains the order of the inputs.
- jobPath: The path of the job.
- jobVersion: The job version.
- inputPath: The path of the input file.
- inputType: The item type for the input. Valid values: CONTAINER and FILE.
- inputVersion: The version of the input file. A blank value specifies the latest
version of the input file is used by the job.
- inputIncludeSubFolders: Indicates whether the subfolders of a container input
are included during job execution.
-
File: lsaf_getjobinputs.sas
-
First available in version: 1.4
%lsaf_getjoboutputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobOutputs);
[ Exposure:
external
]
- Gets the metadata for the outputs for the specified job in the repository. The metadata is
stored in a SAS data set.
Syntax:
%LSAF_GETJOBOUTPUTS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);
-
History:
- 2014-04-22
- initial coding.
- 2016-08-26
- rebrand as LSAF
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
lsaf_version
-
- Optional - The version of the job. If not specified, the latest version
is used.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the outputs, specified as libref.dataset. The default value is
WORK.LSAFGETJOBOUTPUTS. The data set contains a row for each job output and columns
with the following names. The data set retains the order of the outputs.
- jobPath: The path of the job.
- jobVersion: The job version.
- outputPath: The path of the output location.
- outputIncludeSubFolders: Indicates whether the subfolders of an output container
are included during job execution.
-
File: lsaf_getjoboutputs.sas
-
First available in version: 1.4
%lsaf_getjobparameters(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobParameters);
[ Exposure:
external
]
- Gets the job parameter metadata for the specified job. The metadata is stored in a SAS data
set.
Syntax:
%LSAF_GETJOBPARAMETERS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);
-
History:
- 2014-04-11
- initial coding.
- 2016-08-26
- rebrand as LSAF
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
lsaf_version
-
- Optional - The version of the job. If not specified, the latest version
is used.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the parameters, specified as libref.dataset. The default value is
WORK.LSAFGETJOBPARAMETERS. The data set contains a row for each job parameter
and columns with the following names. The data set retains the job parameter order.
- jobPath: The path of the job.
- jobVersion: The job version.
- name: The name of the parameter.
- label: The parameter label.
- type: The parameter type. Valid values: CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- defaultValue: The default value for the parameter. Dates are returned in SAS
datetime format and are in GMT format.
- fileVersion: The file version to use, if the parameter is of type FILE.
A blank value specifies that either the file is not versioned or the file is
versioned but no version was specified.
- includeSubFolders: Indicates whether the subfolders of a container are included
during job execution.
-
File: lsaf_getjobparameters.sas
-
First available in version: 1.4
%lsaf_getjobprograms(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobPrograms);
[ Exposure:
external
]
- Gets the metadata for the programs for the specified job in the SAS Life Science Analytics
Framework repository. The metadata is stored in a SAS data set.
Syntax:
%LSAF_GETJOBPROGRAMS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);
-
History:
- 2014-04-22
- initial coding.
- 2016-08-26
- rebrand as LSAF
- 2019-02-11
- update to 2.1
- 2019-02-26
- rename from lsaf_getjobtasks to lsaf_getjobprograms
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
lsaf_version
-
- Optional - The version of the job. If not specified, the latest version
is used.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the programs, specified as libref.dataset. The default value is
WORK.LSAFGETJOBPROGRAMS. The data set contains a row for each job program and
columns with the following names. The data set retains the order of the programs.
- jobPath: The path of the job.
- jobVersion: The job version.
- programPath: The path of the program file.
- programVersion: The version of the program file. A blank value specifies the
latest version of the program file is used by the job.
-
File: lsaf_getjobprograms.sas
-
First available in version: 1.4
%lsaf_getjobrunasowner(lsaf_path=);
[ Exposure:
external
]
- Gets the value of the property Run as owner for a repository job. The information is stored
in the SAS macro variable _lsafJobRunAsOwner_.
Syntax:
%LSAF_GETJOBRUNASOWNER(LSAF_PATH=lsaf-path);
-
History:
- 2020-03-18
- initial coding.
-
-
Expected Macro Variables:
-
_lsafJobRunAsOwner_
-
The value of the property.
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The case-sensitive path of the job.
-
File: lsaf_getjobrunasowner.sas
-
First available in version: 2.3
%lsaf_getworkspacejobinfo(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobInfo);
[ Exposure:
external
]
- Gets the information for a job in the workspace of the current user. The information is stored
in a SAS data set.
This is the information that is displayed on the Details tab of the job editor and the
information that concerns the versioning of new outputs.
Syntax:
%LSAF_GETWORKSPACEJOBINFO(LSAF_PATH=lsaf-path <, SAS_DSNAME=SAS-data-set>);
-
History:
- 2016-10-04
- initial coding.
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job in the workspace of the current user.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata,
specified as libref.dataset. The default value is WORK.LSAFGETWORKSPACEJOBINFO.
The data set contains variables that represent each element of the metadata for the
job. The data set is sorted by the NAME variable. The following metadata is
represented in the data set.
- path: The path of the job.
- version: Versions are not relevant in the workspace. This variable is included
for consistency with the data set that is returned by the macro lsaf_getjobinfo.
The value from this macro call is WORKSPACE.
- name: The name of the property or attribute.
- value: The value of the property or attribute.
-
File: lsaf_getworkspacejobinfo.sas
-
First available in version: 1.5
%lsaf_getworkspacejobinputs(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobInputs);
[ Exposure:
external
]
- Gets the metadata for the inputs for the specified job in the workspace of the current user.
The metadata is stored in a SAS data set. The list does not include the input programs.
Syntax:
%LSAF_GETWORKSPACEJOBINPUTS(LSAF_PATH=lsaf-path <,SAS_DSNAME=SAS-data-set>);
-
History:
- 2016-10-04
- initial coding.
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the inputs, specified as libref.dataset. The default value is
WORK.LSAFGETWORKSPACEJOBINPUTS. The data set contains a row for each job input and
columns with the following names. The data set retains the order of the inputs.
- jobPath: The path of the job.
- jobVersion: Versions are not relevant in the workspace. This variable is
included for consistency with the data set that is returned by the macro
lsaf_getjobinputs. The value from this macro call is WORKSPACE.
- inputPath: The path of the input file or container.
- inputType: The item type for the input. Valid values: CONTAINER and FILE.
- inputVersion: The version of the input file. A blank value specifies the latest
version of the input file is used by the job.
- inputIncludeSubFolders: Indicates whether the subfolders of a container input
are included during job execution.
-
File: lsaf_getworkspacejobinputs.sas
-
First available in version: 1.5
%lsaf_getworkspacejoboutputs(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobOutputs);
[ Exposure:
external
]
- Gets the metadata for the outputs for the specified job in the workspace of the current user.
The metadata is stored in a SAS data set.
Syntax:
%LSAF_GETJOBOUTPUTS(LSAF_PATH=lsaf-path <, SAS_DSNAME=SAS-data-set>);
-
History:
- 2016-10-04
- initial coding.
- 2019-02-11
- update to 2.1
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
the outputs, specified as libref.dataset. The default value is
WORK.LSAFGETWORKSPACEJOBOUTPUTS. The data set contains a row for each job output and
columns with the following names. The data set retains the order of the outputs.
- jobPath: The path of the job.
- jobVersion: Versions are not relevant in the workspace. This variable is included
for consistency with the data set that is returned by the repository
macro lsaf_getjoboutputs. The value from this macro call is WORKSPACE.
- outputPath: The path of the output location.
- outputIncludeSubFolders: indicates whether the subfolders of an output container
are included during job execution.
-
File: lsaf_getworkspacejoboutputs.sas
-
First available in version: 1.5
%lsaf_getworkspacejobparameters(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobParameters);
[ Exposure:
external
]
- Gets the job parameter metadata for the specified job in the workspace of the current user.
The metadata is stored in a SAS data set.
Syntax:
%LSAF_GETWORKSPACEJOBPARAMETERS(LSAF_PATH=lsaf-path <,SAS_DSNAME=SAS-data-set>);
-
History:
- 2016-10-04
- initial coding.
- 2019-02-11
- update to 2.1.
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for
the parameters, specified as libref.dataset. The default value is
WORK.LSAFGETWORKSPACEJOBPARAMETERS. The data set contains a row for each job
parameter and columns with the following names. The data set retains the job
parameter order.
- jobPath: The path of the job.
- jobVersion: Versions are not relevant in the workspace. This variable is
included for consistency with the data set returned by the macro
lsaf_getjobparameters. The value from this macro call is WORKSPACE.
- name: The name of the parameter.
- label: The parameter label.
- type: The parameter type. Valid values: CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- defaultValue: The default value for the parameter. Dates are returned in SAS
datetime format and are in GMT format.
- fileVersion: The file version to use, if the parameter is of type FILE.
A blank value specifies that either the file is not versioned or the file is
versioned but no version was specified.
- includeSubFolders: Indicates whether the subfolders of a container are included
during job execution.
-
File: lsaf_getworkspacejobparameters.sas
-
First available in version: 1.5
%lsaf_getworkspacejobprograms(lsaf_path=, sas_dsname=work.lsafGetWorkspaceJobPrograms);
[ Exposure:
external
]
- Gets the metadata for the programs for the specified job in the workspace of the current user.
The metadata is stored in a SAS data set.
Syntax:
%LSAF_GETWORKSPACEJOBPROGRAMS(LSAF_PATH=lsaf-path <, SAS_DSNAME=SAS-data-set>);
-
History:
- 2016-10-04
- initial coding.
- 2019-02-11
- update to 2.1.
- 2019-02-27
- rename from lsaf_getworkspacejobtasks to lsaf_getworkspacejobprograms
- 2019-11-01
- update to handle a blank SAS output file.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path of the job.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
for the programs, specified as libref.dataset. The default value is
WORK.LSAFGETWORKSPACEJOBPROGRAMS. The data set contains a row for each job program
and columns with the following names. The data set retains the order of the programs.
- jobPath: The path of the job.
- jobVersion: Versions are not relevant in the workspace. This variable is included
for consistency with the data set that is returned by the macro
lsaf_getjobprograms. The value from this macro call is WORKSPACE.
- programPath: The path of the program file.
- programVersion: The version of the program file. A blank value specifies the
latest version of the program file is used by the job.
-
File: lsaf_getworkspacejobprograms.sas
-
First available in version: 1.5
%lsaf_setjobrunasowner(lsaf_path=, lsaf_runasowner=);
[ Exposure:
external
]
- Sets the job property Run as owner. Only the owner can change the property. Get the
current value of the property by calling the %lsaf_getjobrunasowner macro.
Syntax:
%LSAF_SETJOBRUNASOWNER(LSAF_PATH=lsaf-path, LSAF_runasowner=lsaf-runasowner);
-
History:
- 2020-03-18
- Initial coding
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The case-sensitive path of the job.
-
lsaf_runasowner
-
- Required - The property value for property.
Valid values: - 0: No, - 1: Yes.
-
File: lsaf_setjobrunasowner.sas
-
First available in version: 2.3
%lsaf_updateworkspacejob(lsaf_path=, sas_dsname_info=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_programs=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_parameters=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_inputs=%str(_lsaf_updateworkspacejob_ds_notprovided_), sas_dsname_outputs=%str(_lsaf_updateworkspacejob_ds_notprovided_));
[ Exposure:
external
]
- Updates a job in workspace of the current user.
Data sets that represent the job data to update must be specified in the call to
lsaf_updateworkspacejob. The information in the data sets replaces the data of the existing
job. The output data sets from the following macros contain all of the data that is relevant to
the job properties that can be updated. See the macro documentation for more details.
- lsaf_getjobinfo or lsaf_getworkspacejobinfo
- lsaf_getjobprograms or lsaf_getworkspacejobprograms
- lsaf_getjobparameters or lsaf_getworkspacejobparameters
- lsaf_getjobinputs or lsaf_getworkspacejobinputs
- lsaf_getjoboutputs or lsaf_getworkspacejoboutputs
Syntax:
%LSAF_UPDATEWORKSPACEJOB(LSAF_PATH=lsaf-path <SAS_DSNAME_INFO=SAS-data-set-info,
SAS_DSNAME_PROGRAMS=SAS-data-set-jobprograms, SAS_DSNAME_PARAMETERS=SAS-data-set-parameters,
SAS_DSNAME_INPUTS=SAS-data-set-inputs, SAS_DSNAME_OUTPUTS=SAS-data-set-outputs>);
-
History:
- 2016-09-23
- initial coding
- 2019-02-11
- update to 2.1
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_path
-
- Required - The path for the job to update in the workspace of the current user.
-
sas_dsname_info
-
- Optional - The name of the SAS data set that contains the job
information, specified as libref.dataset. The data set must contain at least the
character variables listed below. Additional variables are ignored.
- name: The name of the job property.
- value: The value of the property.
The information that can be specified is DESCRIPTION, LOGPATH, LSTPATH, MANIFESTPATH,
NEWOUTPUTS_CUSTOMVERSION, NEWOUTPUTS_ENABLEVERSION, and NEWOUTPUTS_VERSIONTYPE.
All other values listed in the data set are ignored. All data are case-insensitive.
If a name is listed more than once, the last value processed is used. If a name is
omitted, the value in the job is not updated.
-
sas_dsname_programs
-
- Optional - The name of the SAS data set that contains the list of the
paths to the SAS programs to run, specified as libref.dataset. If the data set is
empty, all programs are removed from the job. The data set must contain at least the
character variables listed below. Additional variables are ignored.
- programPath: The path of the SAS program file.
- programVersion: The version of the SAS program file. Blank values specify the
latest file version.
-
sas_dsname_parameters
-
- Optional - The name of the SAS data set that contains the job
parameter information, specified as libref.dataset. If the data set is empty, all job
parameters are removed from the job. The data set must contain at least the
character variables listed below. Additional variables are ignored.
- name: The name of the parameter.
- label: The label for the parameter.
- type: The parameter type. Valid values are CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- defaultValue: The value to set as the default value for the parameter.
DATE job parameter values must be one of the following formats. Date values in
formats other than the two described below result in an execution error.
- SAS datetime18. format (such as 02NOV2013:09:33:22) - an offset of zero hours
from GMT is used.
- SAS E8601DZ25. format (such as 2013-11-02T09:33:22-04:00).
- fileVersion: The file version to use, if the parameter is of type FILE. Blank
values specify the latest file version.
- includeSubFolders (numeric): Indicates whether the container includes subfolders.
Valid values: 0 and 1.
Data set rows with duplicate values for parameter name result in a data set
validation error.
-
sas_dsname_inputs
-
- Optional - The name of the SAS data set that contains the list of the
job inputs, specified as libref.dataset. If the data set is empty, all job inputs are
removed from the job. The data set must contain at least the variables listed below
as the type specified. Additional variables are ignored.
- inputPath (character): The path of the file or container to use as input.
- inputType (character): The type of the input item. Valid values: FILE and CONTAINER.
- inputVersion (character): The version of the FILE item. Blank values specify
the latest file version. The value is ignored for inputs of type CONTAINER.
- inputIncludeSubFolders (numeric): Indicates whether the input folder includes
subfolders. Valid values: 0 and 1. The value is ignored for inputs of type FILE.
Data set rows with duplicate values for inputPath result in a data set validation
error.
-
sas_dsname_outputs
-
- Optional - The name of the SAS data set that contains the list of the
job outputs, specified as libref.dataset. If the data set is empty, all job outputs are
removed from the job. The data set must contain at least the variables listed below
as the type specified. Additional variables are ignored.
- outputPath (character): The path of the container to use as output.
- outputIncludeSubFolders (numeric): Indicates whether the output container includes
subfolders. Valid values: 0 and 1.
Data set rows with duplicate values for outputPath result in a data set validation
error.
-
File: lsaf_updateworkspacejob.sas
-
First available in version: 1.5