Module ProcessFlowTaskService

Macros to manage process flow active tasks and elements.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_getpfcompleteddetails(lsaf_path=, lsaf_processflow=, lsaf_elementid=, sas_dsname=work.lsafgetpfcompleteddetails);
Gets the details for the completed elements of the process flow that is in the specified ...
external

LSAF
%lsaf_getpfcompletedelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPFCompletedElements);
Gets the metadata for the completed elements for the specified process flow within the ...
external

LSAF
%lsaf_getpfcurrentelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPFCurrentElements);
Gets the metadata for the current elements for the specified process flow within the specified ...

Macro Detail

%lsaf_getpfcompleteddetails(lsaf_path=, lsaf_processflow=, lsaf_elementid=, sas_dsname=work.lsafgetpfcompleteddetails);

[ Exposure: external ]
Gets the details for the completed elements of the process flow that is in the specified
context. The data is stored in a SAS data set.

Syntax:
%LSAF_GETPFCOMPLETEDDETAILS(LSAF_PATH=lsaf-path, LSAF_PROCESSFLOW=process-flow-name
LSAF_ELEMENTID=process-flow-element-id <, SAS_DSNAME=SAS-data-set>);

          
History:
   2020-10-22
original creation.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The path of the context in which the process flow is located.
lsaf_processflow - - Required - The name of the process flow.
lsaf_elementid - - Optional - The identifier of the completed element for which to report
        the details. Retrieve the element identifier by calling the lsaf_getpfcompletedelements macro.
        If this parameter is not specified, the details for all of the completed elements for the
        process flow are returned.
sas_dsname - - Optional - The name of the output SAS data set to contain the details for
        the process flow completed task data, specified as libref.dataset. The default value is
        WORK.LSAFGETPFCOMPLETEDDETAILS. The data set contains a row for each detail and columns with
        the following names. The data set is not sorted. The following metadata is represented in the
        data set.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The identifier of the element.
        - elementName: The name of the element.
        - elementType: The type for the element.
        - instanceID: The identifier of the element.
        - elementCreated: The date on which the element was created, in SAS format.
        - elementCompleted: The date on which the element was completed.
        - elementCompletedBy: The user who completed the element.
        - elementCompletedState: The completion status of the element.
        - recordType: The type of element detail for the row. Examples: PROPERTY, PARAMETER.
        - id: The identifier of the element detail, when applicable. This value is repeated for
        details that span across rows, such as user task history.
        - name: The name of the element detail.
        - value: The value of the element detail.
File: lsaf_getpfcompleteddetails.sas
First available in version: 2.4

%lsaf_getpfcompletedelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPFCompletedElements);

[ Exposure: external ]
Gets the metadata for the completed elements for the specified process flow within the
specified context. The metadata is stored in a SAS data set.

Syntax:
%LSAF_GETPFCOMPLETEDELEMENTS(LSAF_PATH=lsaf-path, LSAF_processflow=process-flow-name
<,SAS_DSNAME=SAS-data-set>);

          
History:
   2020-02-19
initial coding.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The path of the context in which the process flow is located.
lsaf_processflow - - Required - The name of the process flow.
sas_dsname - - Optional - The name of the output SAS data set to contain the completed
        elements for the process flow, specified as libref.dataset.
        The default value is WORK.LSAFGETPFCOMPLETEDELEMENTS. The data set contains a row
        for each element and columns with the following names. The data set is not sorted.
        The following metadata is represented in the data set.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementType: The type of the element.
        - elementID: The unique identifier of the element.
        - elementName: The name of the element.
        - elementDescription: The description of the element.
        - elementCreated: The date on which the element was created, in SAS format.
        - elementCompleted: The date on which the element was completed.
        - elementCompletedBy: The user who completed the element.
File: lsaf_getpfcompletedelements.sas
First available in version: 2.3

%lsaf_getpfcurrentelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPFCurrentElements);

[ Exposure: external ]
Gets the metadata for the current elements for the specified process flow within the specified
context. The metadata is stored in a SAS data set. *;

Syntax:
%LSAF_GETPFCURRENTELEMENTS(LSAF_PATH=lsaf-path, LSAF_processflow=process-flow-name
<,SAS_DSNAME=SAS-data-set>);

          
History:
   2019-03-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_path - - Required - The path of the context in which the process flow is located.
lsaf_processflow - - Required - The name of the process flow.
sas_dsname - - Optional - The name of the output SAS data set to contain the current
        elements for the process flow, specified as libref.dataset.
        The default value is WORK.LSAFGETPFCURRENTELEMENTS. The data set contains a row
        for each element and columns with the following names. The data set is not sorted.
        The following metadata is represented in the data set.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementCreated: The date on which the element was created, in SAS format.
        - elementStatus: The status of the element.
        - elementType: The type of the element.
        - elementID: The unique ID of the element.
        - elementName: The name of the element.
        - elementDescription: The description of the element.
File: lsaf_getpfcurrentelements.sas
First available in version: 2.1