Module ProcessDefinitionService

Macros to retrieve information about process definitions.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_activateprocessdefinition(lsaf_processdefid=);
Activates a process flow definition. The user must have the PRIVILEGE_MANAGE_PROCESS_FLOW_DEFINITIONS ...
external

LSAF
%lsaf_deployprocessdefinition(lsaf_path=, lsaf_version=, sas_dsname=, lsaf_comment=, lsaf_activate=1, lsaf_overwrite=0);
Deploys a process flow definition using a BPMN file from the repository. The macro variable ...
external

LSAF
%lsaf_getallprocessdefinitions(sas_dsname=work.lsafGetAllProcessDefinitions);
Gets the metadata for all of the process flow definitions that are available to the user. The ...
external

LSAF
%lsaf_getprocessdefcontexts(lsaf_processdefid=, sas_dsname=work.lsafGetProcessDefContexts);
Gets the contexts in which the specified process flow definition is deployed. The metadata is ...
external

LSAF
%lsaf_getprocessdefinitionstatus(lsaf_processdefid=);
Gets the status of a process flow definition. The Manage Process Flows privilege is required. ...
external

LSAF
%lsaf_getprocessdefsbytype(lsaf_typeid=, sas_dsname=work.lsafGetProcessDefsByType);
Gets the metadata for all of the process flow definitions that are available at the specified ...
external

LSAF
%lsaf_processdefdeployedatcontext(lsaf_processflowdef=, lsaf_typeid=);
Indicates whether a process flow definition is deployed at the specified context type.
external

LSAF
%lsaf_suspendprocessdefinition(lsaf_processdefid=);
Suspends a process flow definition. The PRIVILEGE_MANAGE_PROCESS_FLOW_DEFINITIONS global privilege ...

Macro Detail

%lsaf_activateprocessdefinition(lsaf_processdefid=);

[ Exposure: external ]
Activates a process flow definition. The user must have the PRIVILEGE_MANAGE_PROCESS_FLOW_DEFINITIONS
global privilege.

Syntax:
%LSAF_ACTIVATEPROCESSDEFINITION(LSAF_PROCESSDEFID=lsaf-processdefid);

          
History:
   2019-09-12
Initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_processdefid - - Required - The case-sensitive identifier of the process flow definition.
        This can be retrieved by calling the lsaf_getallprocessdefinitions macro.
File: lsaf_activateprocessdefinition.sas
First available in version: 2.2

%lsaf_deployprocessdefinition(lsaf_path=, lsaf_version=, sas_dsname=, lsaf_comment=, lsaf_activate=1, lsaf_overwrite=0);

[ Exposure: external ]
Deploys a process flow definition using a BPMN file from the repository. The macro variable
_lsafProcessDefinitionId_ contains the process definition identifier that is set as part of
PRIVILEGE_MANAGE_PROCESS_FLOW_DEFINITIONS.

Syntax:
%LSAF_DEPLOYPROCESSDEFINITION(LSAF_PATH=lsaf-path, LSAF_VERSION=lsaf-version,
SAS_DSNAME=SAS-data-set, LSAF_COMMENT=lsaf-comment, LSAF_ACTIVATE=lsaf-activate,
LSAF_OVERWRITE=lsaf-overwrite);

          
History:
   2019-09-12
initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafProcessDefinitionId_ - - The identifier of the deployed process definition.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The case-sensitive path to the process BPMN file.
lsaf_version - - Optional - The version of the BPMN file. If blank, the most recent version
        is used.
sas_dsname - - Required - The name of a SAS data set that contains the context type
        identifiers where the process flow definition is to be deployed, specified as
        libref.dataset. The data set must contain at least the variable listed below.
        Additional variables are ignored.
        - id: The context type id. The identifiers can be retrieved by calling the
        lsaf_getcontexttpes macro.
lsaf_comment - - Optional - The audit trail comment for the deployment.
lsaf_activate - - Optional - Indicates whether to activate the process flow definition.
        Valid values: 0: Do not activate, 1: Activate (Default).
lsaf_overwrite - - Optional - Indicates whether an existing process flow definition with
        same identifier is overwritten.
        Valid values: 0: Do not overwrite (Default), 1: Overwrite.
File: lsaf_deployprocessdefinition.sas
First available in version: 2.2

%lsaf_getallprocessdefinitions(sas_dsname=work.lsafGetAllProcessDefinitions);

[ Exposure: external ]
Gets the metadata for all of the process flow definitions that are available to the user. The
metadata is stored in a SAS data set.

Syntax:
%LSAF_GETALLPROCESSDEFINITIONS(<,SAS_DSNAME=SAS-data-set>);

          
History:
   2019-09-16
original creation.
   2019-11-01
update to handle a blank SAS output file.
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the process flow definitions, specified as libref.dataset. The default value is
        WORK.LSAFGETALLPROCESSDEFINITIONS and is sorted by the process flow definition ID.
        The data set contains a row for each process flow definition deployed and has
        columns with the following names.
        - contexts: A comma-delimited string that lists the context types for which the
        process flow definition is deployed.
        - defID: The ID of the process flow definition.
        - name: The name of the process flow definition.
        - description: The process flow definition description.
        - deployedVersion: The version of the process flow definition.
        - filePath: The path of the source file from which the process flow definition was
        deployed.
        - fileVersion: The version of the source file from which the process flow definition
        was deployed.
        - status: The status of the process flow definition.
        - comment: Comment for audit trail purposes when the process definition was deployed.
File: lsaf_getallprocessdefinitions.sas
First available in version: 2.2

%lsaf_getprocessdefcontexts(lsaf_processdefid=, sas_dsname=work.lsafGetProcessDefContexts);

[ Exposure: external ]
Gets the contexts in which the specified process flow definition is deployed. The metadata is
stored in a SAS data set.

Syntax:
%LSAF_GETPROCESSDEFCONTEXTS(lsaf_processdefid=lsaf-processdefid <, sas_dsname=SAS-data-set>);

          
History:
   2020-02-18
Initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_processdefid - - Required - The case-sensitive identifier of the process flow
        definition. This can be retrieved by calling the lsaf_getallprocessdefinitions macro.
sas_dsname - - Optional - The name of the output SAS data set to contain the current
        contexts for the process definition, specified as libref.dataset.
        The default value is WORK.LSAFGETPROCESSDEFCONTEXTS. The data set contains a row
        for each context and columns with the following names. The data set is sorted by
        processDefContextType.
        The following metadata is represented in the data set.
        - processDefID: The unique identifier of the process flow definition.
        - processDefName: The name of the process flow definition.
        - processDefDeployedVersion: The deployed version of the process flow definition.
        - processDefContextType: The context type of the process flow definition.
File: lsaf_getprocessdefcontexts.sas
First available in version: 2.3

%lsaf_getprocessdefinitionstatus(lsaf_processdefid=);

[ Exposure: external ]
Gets the status of a process flow definition. The Manage Process Flows privilege is required.
The SAS macro variable _lsafProcessDefinitionStatus_ is set to the status value (SUSPENDED or
ACTIVE).

Syntax:
%LSAF_GETPROCESSDEFINITIONSTATUS(lsaf_processdefid=lsaf-processdefid);

          
History:
   2019-09-19
Initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafProcessDefinitionStatus_ - The process definition status.
_lsafRC_ - The return code.
Parameters:
lsaf_processdefid - - Required - The case-sensitive identifier of the process flow
        definition. This can be retrieved by calling the lsaf_getallprocessdefinitions macro.
File: lsaf_getprocessdefinitionstatus.sas
First available in version: 2.2

%lsaf_getprocessdefsbytype(lsaf_typeid=, sas_dsname=work.lsafGetProcessDefsByType);

[ Exposure: external ]
Gets the metadata for all of the process flow definitions that are available at the specified
context type. The metadata is stored in a SAS data set.

Syntax:
%LSAF_GETPROCESSDEFSBYTYPE(LSAF_TYPEID=lsaf-typeid <,SAS_DSNAME=SAS-data-set>);

          
History:
   2016-08-23
original creation.
   2019-02-12
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_typeid - - Required - The context type. The macro lsaf_gettype can be used to
        determine the type id for the context.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the process flow definitions, specified as libref.dataset. The default value
        is WORK.LSAFGETPROCESSDEFSBYTYPE. The data set contains a row for each process
        flow definition deployed at the context level and as columns with the following
        names.
        The data set is sorted by the process flow definition ID.
        - contexts: A comma-delimited string that lists the context types for which the
        process flow definition is deployed.
        - defID: The ID of the process flow definition.
        - name: The name of the process flow definition.
        - description: The process flow definition description.
        - deployedVersion: The version of the process flow definition.
        - filePath: The path of the source file from which the process flow definition was
        deployed.
        - fileVersion: The version of the source file from which the process flow definition
        was deployed.
        - status: The status of the process flow definition.
        - comment: Comment
File: lsaf_getprocessdefsbytype.sas
First available in version: 1.5

%lsaf_processdefdeployedatcontext(lsaf_processflowdef=, lsaf_typeid=);

[ Exposure: external ]
Indicates whether a process flow definition is deployed at the specified context type.

The macro variable _lsafPFDefDeployedAtContext_ is set to a value of 1 when the process flow is
deployed for the context type, 0 if it is not. In the event of an incorrect call to the macro that
results in an error, the return value of _lsafPFDefDeployedAtContext_ is set to -1.

Syntax:
%LSAF_PROCESSDEFDEPLOYEDATCONTEXT(LSAF_processflowdef=process-flow-definition-name,
LSAF_TYPEID=lsaf-typeid);

          
History:
   2019-03-12
Initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafPFDefDeployedAtContext_ - Indicates whether the process flow definition is deployed at the
        specified context.
_lsafRC_ - The return code.
Parameters:
lsaf_processflowdef - - Required - The ID of the process flow definition.
lsaf_typeid - - Required - The context type. The macro lsaf_gettype can be used to determine
        the type ID for the context.
File: lsaf_processdefdeployedatcontext.sas
First available in version: 2.1

%lsaf_suspendprocessdefinition(lsaf_processdefid=);

[ Exposure: external ]
Suspends a process flow definition. The PRIVILEGE_MANAGE_PROCESS_FLOW_DEFINITIONS global privilege
is required. *;

Syntax:
%LSAF_SUSPENDPROCESSDEFINITION(LSAF_PROCESSDEFID=lsaf-processdefid);

          
History:
   2019-09-12
Initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_processdefid - - Required - The identifier of the process flow definition. This can be
        retrieved by calling the lsaf_getallprocessdefinitions macro.
File: lsaf_suspendprocessdefinition.sas
First available in version: 2.2