Module JobManifestService

Macros to retrieve the information from a job manifest file.

Since: 2.4

Macro Summary
external

LSAF
%lsaf_getjobmanifestexternalrefs(lsaf_path=, lsaf_version=, lsaf_type=, sas_dsname=work.lsafGetJobManifestExternalRefs);
Gets the metadata for the external references for the specified job manifest in the ...
external

LSAF
%lsaf_getjobmanifestinfo(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestInfo);
Gets the information for a job manifest in the repository. The information is stored in a SAS ...
external

LSAF
%lsaf_getjobmanifestinputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestInputs);
Gets the metadata for the input files for the specified job manifest in the repository. The ...
external

LSAF
%lsaf_getjobmanifestloglocs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestLogLocs);
Gets the log location information for a job manifest in the repository. The information is ...
external

LSAF
%lsaf_getjobmanifestmetrics(lsaf_path=, lsaf_version=, sas_dsname=work.lsafgetjobmanifestmetrics);
Gets the metrics for the specified job manifest in the repository. The data is stored in a ...
external

LSAF
%lsaf_getjobmanifestoutputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestOutputs);
Gets the metadata for the output files for the specified job manifest in the repository. The ...
external

LSAF
%lsaf_getjobmanifestparameters(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestParameters);
Gets the metadata for the parameters for the specified job manifest in the repository. The ...
external

LSAF
%lsaf_getjobmanifestprograms(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestPrograms);
Gets the metadata for the programs for the specified job manifest in the repository. The ...
external

LSAF
%lsaf_getjobmanifestresultlocs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestResultLocs);
Gets the result location information for a job manifest that is in the repository. The ...

Macro Detail

%lsaf_getjobmanifestexternalrefs(lsaf_path=, lsaf_version=, lsaf_type=, sas_dsname=work.lsafGetJobManifestExternalRefs);

[ Exposure: external ]
Gets the metadata for the external references for the specified job manifest in the
repository. The metadata is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTEXTERNALREFS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
LSAF_TYPE=lsaf-type, SAS_DSNAME=SAS-data-set>);

          
History:
   2020-09-04
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. If not specified, the latest
        version is used.
lsaf_type - - Optional - The type of the external references to retrieve. Valid values are
        INPUTS and OUTPUTS. A blank or missing parameter value retrieves both types.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata for the
        external references, specified as libref.dataset. The default value is
        WORK.LSAFGETJOBMANIFESTEXTERNALREFS. The data set contains a row for each job manifest,
        external reference, and columns with the following names. The data set retains the
        order of the external references.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - path: The path of the external reference.
        - referenceProgram: The referenced SAS program file.
        - type: The type of the external reference.
        - referenceType: The type of the external reference: input or output.
File: lsaf_getjobmanifestexternalrefs.sas
First available in version: 2.4

%lsaf_getjobmanifestinfo(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestInfo);

[ Exposure: external ]
Gets the information for a job manifest in the repository. The information is stored in a SAS
data set. The output data set can be used as an input data set for the lsaf_createworkspacejob
macro.

This is the information that is displayed on the Details tab of the job manifest and the
information that concerns the versioning of new output files.

Syntax:
%LSAF_GETJOBMANIFESTINFO(LSAF_PATH=lsaf-path <, LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-12-03
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The specific version number of the job manifest. If not
        specified, the information for the latest version is returned. Specifying a version
        for a non-versioned job manifest causes an error.
sas_dsname - - Optional - The name of the output SAS data set that contains the metadata
        for the manifest, specified as libref.dataset. The default value is
        WORK.LSAFGETJOBMANIFESTINFO. The data set contains variables that represent each
        element of the metadata for the job manifest. The data set is sorted by the NAME
        variable. The following metadata is represented in the data set.
        - path: The path of the job manifest.
        - version: The version number that is associated with the job manifest.
        - name: The name of the property or attribute.
        - value: The value of the property or attribute.
File: lsaf_getjobmanifestinfo.sas
First available in version: 2.3

%lsaf_getjobmanifestinputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestInputs);

[ Exposure: external ]
Gets the metadata for the input files for the specified job manifest in the repository. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTINPUTS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-11-01
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. 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.LSAFGETJOBMANIFESTINPUTS. The data set contains a row for each job manifest
        input and columns with the following names. The data set retains the order of the
        inputs.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - jobLocation: The job source location.
        - path: The path of the input file.
        - version: The version of the input file that is used in the job submission, or
        blank, if the file is not versioned.
        - size: The size (in bytes) of the input file.
        - sizeFormatted: The formatted size (in bytes, KB, MB, or TB) of the input file.
        - referenceProgram: The referenced SAS program file.
File: lsaf_getjobmanifestinputs.sas
First available in version: 2.3

%lsaf_getjobmanifestloglocs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestLogLocs);

[ Exposure: external ]
Gets the log location information for a job manifest in the repository. The information is
stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTLOGLOCS(LSAF_PATH=lsaf-path <, LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2020-07-28
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The specific version number of the job manifest. If not
        specified, the information for the latest version is returned. Specifying a version
        for a non-versioned job manifest causes an error.
sas_dsname - - Optional - The name of the output SAS data set that contains the metadata
        for the manifest log locations, specified as libref.dataset. The default value is
        WORK.LSAFGETJOBMANIFESTLOGLOCS. The data set contains variables that represent each
        element of the metadata for the log locations. The data set is sorted by the LOGNAME
        variable. The following metadata is represented in the data set.
        - manifestPath: The path of the job manifest.
        - listType: The type of the property or attribute (LOGS).
        - manifestVersion: The version number that is associated with the job manifest.
        - logPath: The path of the log file.
        - logName: The name of the log file.
        - logVersion: The version of the log file.
        - engineType: The type of system that generated the file.
        - dateModified: The date the log file was last modified.
        - srcLocation: The source location (REPOSITORY or WORKSPACE).
        - fileSize: The size of the file in bytes.
        - fileSizeFmt: The formatted size of the file (ie 32 KB).
File: lsaf_getjobmanifestloglocs.sas
First available in version: 2.4

%lsaf_getjobmanifestmetrics(lsaf_path=, lsaf_version=, sas_dsname=work.lsafgetjobmanifestmetrics);

[ Exposure: external ]
Gets the metrics for the specified job manifest in the repository. The data is stored in a
SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTMETRICS(LSAF_PATH=lsaf-path <,LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-11-08
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. If not specified, the latest
        version is used.
sas_dsname - - Optional - The name of the output SAS data set to contain the manifest
        metrics, specified as libref.dataset. The default value is
        WORK.LSAFGETJOBMANIFESTMETRICS. The data set contains a row for each job manifest
        type and columns with the following names. The data set retains the order of the
        manifest types.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - type: The type of metric.
        - total: The total for the metric.
        - size: The size of the metric.
        - formattedsize: The formatted size (in bytes, KB, MB, or TB).
        - time: The time or interval of the metric.
        - formattedtime: The formatted time or interval of the metric, which is displayed
        as h:m:s:ms.
File: lsaf_getjobmanifestmetrics.sas
First available in version: 2.3

%lsaf_getjobmanifestoutputs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestOutputs);

[ Exposure: external ]
Gets the metadata for the output files for the specified job manifest in the repository. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTOUTPUTS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-11-01
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. 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.LSAFGETJOBMANIFESTOUTPUTS. The data set contains a row for each job manifest
        output and columns with the following names. The data set retains the order of the
        inputs.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - jobLocation: The job source location.
        - path: The path of the output file.
        - version: The version of the output file that is used in the job submission, or
        blank, if the output file is not versioned.
        - size: The size (in bytes) of the output file.
        - sizeFormatted: The formatted size (in bytes, KB, MB, or TB) of the output file.
        - referenceProgram: The referenced SAS program file.
File: lsaf_getjobmanifestoutputs.sas
First available in version: 2.3

%lsaf_getjobmanifestparameters(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestParameters);

[ Exposure: external ]
Gets the metadata for the parameters for the specified job manifest in the repository. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTPARAMETERS(LSAF_PATH=lsaf-path <,LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-11-13
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. 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.LSAFGETJOBMANIFESTPARAMETERS. The data set contains a row for each job manifest
        parameter and columns with the following names.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - jobLocation: The job source location.
        - name: The label of the parameter.
        - type: The type of the parameter.
        - label: The label of the parameter.
        - value: The value of the parameter.
        - version: The version of the file that is used in the job submission, or blank, if
        file is not versioned.
        - includeSubfolders: Indicates whether to include subfolders. Valid values: 0: No,
        1: Yes.
File: lsaf_getjobmanifestparameters.sas
First available in version: 2.3

%lsaf_getjobmanifestprograms(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestPrograms);

[ Exposure: external ]
Gets the metadata for the programs for the specified job manifest in the repository. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTPROGRAMS(LSAF_PATH=lsaf-path <LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2019-11-01
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The version of the job manifest. 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.LSAFGETJOBMANIFESTPROGRAMS. The data set contains a row for each job manifest
        program and columns with the following names. The data set retains the order of the
        programs.
        - jobManifestPath: The path of the job manifest.
        - jobManifestVersion: The job manifest version.
        - jobLocation: The job source location.
        - path: The path of the program file.
        - version: The version of the program file that is used in the job submission, or
        blank if, program file is not versioned.
        - size: The size (in bytes) of the program.
        - sizeFormatted: The formatted size (in bytes, KB, MB, or TB) of the input file.
File: lsaf_getjobmanifestprograms.sas
First available in version: 2.3

%lsaf_getjobmanifestresultlocs(lsaf_path=, lsaf_version=, sas_dsname=work.lsafGetJobManifestResultLocs);

[ Exposure: external ]
Gets the result location information for a job manifest that is in the repository. The
information is stored in a SAS data set.

Syntax:
%LSAF_GETJOBMANIFESTRESULTLOCS(LSAF_PATH=lsaf-path <, LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set>);

          
History:
   2020-07-29
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path of the job manifest.
lsaf_version - - Optional - The specific version number of the job manifest. If not
        specified, the information for the latest version is returned. Specifying a version
        for a non-versioned job manifest causes an error.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the manifest result locations, specified as libref.dataset. The default value
        is WORK.LSAFGETJOBMANIFESTRESULTLOCS. The data set contains variables that represent
        each element of the metadata for the result locations. The data set is sorted by the
        RESULTNAME variable. The following metadata is represented in the data set:
        - manifestPath: The path of the job manifest.
        - listType: The type of the property or attribute (RESULTS).
        - manifestVersion: The version number that is associated with the job manifest.
        - resultPath: The path of the result file.
        - resultName: The name of the result file.
        - resultVersion: The version of the result file.
        - engineType: The type of system that generated the file.
        - dateModified: The date on which the result file was last modified.
        - srcLocation: The source location (REPOSITORY or WORKSPACE).
        - fileSize: The size of the file (in bytes).
        - fileSizeFmt: The formatted size of the file (such as 32 KB).
File: lsaf_getjobmanifestresultlocs.sas
First available in version: 2.4