Module ProcessFlowSetupService

Macros to manage process flow setup elements.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_getpfsetupelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupelements);
Gets the metadata for the flow setup elements for the specified process flow within the ...
external

LSAF
%lsaf_getpfsetupjobinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPfSetupJobInfo);
Gets the properties for the job setup elements for the process flow within the specified ...
external

LSAF
%lsaf_getpfsetupjobparameters(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPfSetupJobParameters);
Gets the override parameters for the job setup elements for the process flow within the ...
external

LSAF
%lsaf_getpfsetupnotifinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupnotifinfo);
Gets the properties for the notification setup elements for the process flow within the ...
external

LSAF
%lsaf_getpfsetupnotifrecips(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupnotifrecips);
Gets the recipients for notification setup elements for the process flow within the specified ...
external

LSAF
%lsaf_getpfsetupsignallocs(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupsignallocs);
Gets the locations for the signal setup elements for the process flow within the specified ...
external

LSAF
%lsaf_getpfsetuptimers(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetuptimers);
Gets the data for the timer setup elements for the process flow within the specified context. ...
external

LSAF
%lsaf_getpfsetupusercandidates(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupusercandidates);
Gets the candidates for the user setup elements for the process flow within the specified ...
external

LSAF
%lsaf_getpfsetupuserinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupuserinfo);
Gets the properties for the user setup elements for the process flow within the specified ...
external

LSAF
%lsaf_updatepfsetupjobinfo(sas_dsname=);
Updates the properties for process flow job elements using a data set as input.
external

LSAF
%lsaf_updatepfsetupjobparameters(sas_dsname=);
Updates the job parameter overrides for process flow job elements using a data set as input.
external

LSAF
%lsaf_updatepfsetupnotifinfo(sas_dsname=);
Updates the properties for process flow notification elements using a data set as input.
external

LSAF
%lsaf_updatepfsetupnotifrecips(sas_dsname=);
Updates the recipients for process flow notification elements using a data set as input.
external

LSAF
%lsaf_updatepfsetupsignallocs(sas_dsname=);
Updates the locations for process flow signal elements using a data set as input.
external

LSAF
%lsaf_updatepfsetuptimers(sas_dsname=);
Updates the values of process flow timer elements using a data set as input. Each row of the ...
external

LSAF
%lsaf_updatepfsetupusercandidates(sas_dsname=);
Updates the candidates for process flow user task elements using a data set as input.
external

LSAF
%lsaf_updatepfsetupuserinfo(sas_dsname=);
Updates the properties for process flow user elements using a data set as input.

Macro Detail

%lsaf_getpfsetupelements(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupelements);

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

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

          
History:
   2016-12-07
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getprocessflowelements to lsaf_getpfsetupelements
   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 elements
        for the process flow data, specified as libref.dataset. The default value is
        WORK.LSAFGETPFSETUPELEMENTS. The data set contains a row for each element and
        columns with the following names. The data set is not sorted.
        The following metadata will be 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 ID of the element.
        - elementName: The name of the element.
        - elementDescription: The description of the element.
File: lsaf_getpfsetupelements.sas
First available in version: 1.5

%lsaf_getpfsetupjobinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPfSetupJobInfo);

[ Exposure: external ]
Gets the properties for the job setup elements for the process flow within the specified
context. The properties are stored in a SAS data set.

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

          
History:
   2016-12-10
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfjobelementinfo to lsaf_getpfsetupjobinfo
   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 properties
        attributes for the process flow data, specified as libref.dataset. The default value
        is WORK.LSAFGETPFSETUPJOBINFO. The data set contains a row for each property or
        attribute 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 ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
        - displayName: The name of the property as displayed as a label within SAS Life
        Science Analytics Framework. Derived properties (such as name) do not have a value
        for displayName.
        - type: The type of the property. Valid values:STRING, LONG, DATE, and BOOLEAN.
        - isReadonly: Indicates whether the property cannot be modified.
        - isExtended: Indicates whether the property is an extended attribute.
File: lsaf_getpfsetupjobinfo.sas
First available in version: 1.5

%lsaf_getpfsetupjobparameters(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafGetPfSetupJobParameters);

[ Exposure: external ]
Gets the override parameters for the job setup elements for the process flow within the
specified context. The parameters are stored in a SAS data set.

Job setup elements maintain a list of the parameters that are used to override the default
parameters when the job task executes. The output data set from the lsaf_getjobparameters
macro can be used to get the full list and metadata for the job parameters.

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

          
History:
   2016-12-14
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfjobparameters to lsaf_getpfsetupjobparameters
   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 override
        parameters for the process flow element, specified as libref.dataset.
        The default value is WORK.LSAFGETPFSETUPJOBPARAMETERS. The data set contains a
        row for each override parameter and columns with the following names. The data set
        is sorted by the element ID and parameter name.
        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 ID for the element applicable for the parameter.
        - jobPath: The path for the job.
        - jobVersion: The version of the job.
        - name: The name of the parameter.
        - type: The type of the parameter. Valid values:CHARACTER, CHARACTER_MASKED, NUMERIC,
        DATE, FILE, or FOLDER.
        - value: The value of the parameter.
        - fileVersion: The file version, 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_getpfsetupjobparameters.sas
First available in version: 1.5

%lsaf_getpfsetupnotifinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupnotifinfo);

[ Exposure: external ]
Gets the properties for the notification setup elements for the process flow within the
specified context. The properties are stored in a SAS data set.

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

          
History:
   2016-12-08
original creation.
   2019-02-12
update to 2.1
   2019-03-15
renamed from lsaf_getpfnotificationinfo to lsaf_getpfsetupnotifinfo
   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 properties
        and attributes for the process flow data, specified as libref.dataset.
        The default value is WORK.LSAFGETPFSETUPNOTIFINFO. The data set contains a row for
        each property or attribute 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 ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
        - displayName: The name of the property as displayed as a label within SAS Life
        Science Analytics Framework. Derived properties (such as name) do not have a value
        for displayName.
        - type: The type of the property. Valid values:STRING, LONG, DATE, and BOOLEAN.
        - isReadonly: Indicates whether the property cannot be modified.
        - isExtended: Indicates whether the property is an extended attribute.
File: lsaf_getpfsetupnotifinfo.sas
First available in version: 1.5

%lsaf_getpfsetupnotifrecips(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupnotifrecips);

[ Exposure: external ]
Gets the recipients for notification setup elements for the process flow within the specified
context. The recipients are stored in a SAS data set.

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

          
History:
   2016-12-13
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfnotifrecipients to lsaf_getpfsetupnotifrecips
   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 metadata
        for the recipients, specified as libref.dataset. The default value is
        WORK.LSAFPFSETUPGETNOTIFRECIPS. The data set contains a row for each recipient
        and columns with the following names. The data set is sorted by the element id,
        recipient type, and principalId.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element.
        - type: The recipient type. Valid values: USER and GROUP.
        - principalId: The name of the recipient. The returned value is either a group
        name or a user ID.
        - description: The description of the recipient. The returned value is either a
        group name or a user display name.
        - grpSrcCtxt: The context path in which the group recipient is defined, if the
        recipient is a group.
File: lsaf_getpfsetupnotifrecips.sas
First available in version: 1.5

%lsaf_getpfsetupsignallocs(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupsignallocs);

[ Exposure: external ]
Gets the locations for the signal setup elements for the process flow within the specified
context. The locations are stored in a SAS data set.

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

          
History:
   2016-12-14
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfsignallocations to lsaf_getpfsetupsignallocs
   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 locations
        for the process flow signal element, specified as libref.dataset. The default
        value is WORK.LSAFGETPFSETUPSIGNALLOCS. The data set contains a row for each signal
        location and columns with the following names. The data set is sorted by element ID
        and location.
        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 ID for the element applicable for the parameter.
        - location: The path for the signal location.
File: lsaf_getpfsetupsignallocs.sas
First available in version: 1.5

%lsaf_getpfsetuptimers(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetuptimers);

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

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

          
History:
   2016-12-10
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpftimerelements to lsaf_getpfsetuptimers
   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 data for
        the process flow timer element, specified as libref.dataset. The default value is
        WORK.LSAFGETPFSETUPTIMERS. The data set contains a row for each timer 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.
        - elementID: The ID for the element.
        - name: The name of the element.
        - description: The description of the timer element.
        - type: The type of data the timer represents. Valid values: DATE and DURATION.
        - value: The value of the timer.
        - years: The years value that is represented by the duration timer.
        - months: The months value that is represented by the duration timer.
        - days: The days value that is represented by the duration timer.
        - hours: The hours value that is represented by the duration timer.
        - minutes: The minutes value that is represented by the duration timer.
        - seconds: The seconds value that is represented by the duration timer.
File: lsaf_getpfsetuptimers.sas
First available in version: 1.5

%lsaf_getpfsetupusercandidates(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupusercandidates);

[ Exposure: external ]
Gets the candidates for the user setup elements for the process flow within the specified
context. The candidates are stored in a SAS data set.

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

          
History:
   2016-12-13
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfusercandidates to lsaf_getpfsetupusercandidates
   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 metadata for
        the candidates, specified as libref.dataset. The default value is
        WORK.LSAFGETPFSETUPUSERCANDIDATES. The data set contains a row for each candidate
        and columns with the following names. The data set is sorted by the element id,
        candidate type, and principalId.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element.
        - type: The candidate type. Valid values: USER and GROUP.
        - principalId: The name of the candidate. The returned value is either a group name
        or a user ID.
        - description: The description of the candidate. The returned value is either a
        group name or a user display name.
        - grpSrcCtxt: The context path in which the group candidate is defined, if the
        candidate is a group.
File: lsaf_getpfsetupusercandidates.sas
First available in version: 1.5

%lsaf_getpfsetupuserinfo(lsaf_path=, lsaf_processflow=, sas_dsname=work.lsafgetpfsetupuserinfo);

[ Exposure: external ]
Gets the properties for the user setup elements for the process flow within the specified
context. The properties are stored in a SAS data set.

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

          
History:
   2016-12-08
original creation.
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_getpfuserelementinfo to lsaf_getpfsetupuserinfo
   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 properties
        attributes for the process flow data, specified as libref.dataset. The default
        value is WORK.LSAFGETPFSETUPUSERINFO. The data set contains a row for each property
        or attribute 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 ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
        - displayName: The name of the property as displayed as a label within SAS Life
        Science Analytics Framework. Derived properties (such as name) do not have a
        value for displayName.
        - type: The type of the property. Valid values: STRING, LONG, DATE, and BOOLEAN.
        - isReadonly: Indicated whether the property cannot be modified.
        - isExtended: Indicates whether the property is an extended attribute.
File: lsaf_getpfsetupuserinfo.sas
First available in version: 1.5

%lsaf_updatepfsetupjobinfo(sas_dsname=);

[ Exposure: external ]
Updates the properties for process flow job elements using a data set as input.

Properties for multiple job elements can be modified using a single data set. Each property
is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupjobinfo macro can be used to determine the name
and current values of the job element properties. Rows where the name matches an existing job
element property are used to attempt to update the property. If the specified value is
invalid for the property type, the update is aborted and the appropriate error message is
written to the SAS log file.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_JOBINFOTEMP__. In the event that a
failure occurs during processing, this temporary data set is retained as a reference. If all
updates are performed successfully, this data set is deleted from the work library. A message
is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the beginning
of each new run of the macro. The data values and sort order of the original input data set
are maintained.

All records that pertain to the same job element are processed as a single transaction by the
macro. Messages are written to the SAS log file as each job element is processed. If the update
of a job element fails, the macro stops processing and a failure message is written to the SAS
log file. Successful updates to job elements made prior to the observation that contains the
failure are maintained in SAS Life Science Analytics Framework.

Syntax:
%LSAF_UPDATEPFSETUPJOBINFO(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-09
original coding
   2019-02-12
rename from lsaf_updatepfjobelementinfo to lsaf_updatepfsetupjobinfo
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the properties
        information for all of the job element properties to modify, specified as
        libref.dataset. The data set must contain at least the variables that are listed
        below. Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
File: lsaf_updatepfsetupjobinfo.sas
First available in version: 1.5

%lsaf_updatepfsetupjobparameters(sas_dsname=);

[ Exposure: external ]
Updates the job parameter overrides for process flow job elements using a data set as input.

The override parameters for multiple job elements can be modified using a single data set.
Each parameter is represented as a single row in the input data set.

The job element stores only the values to use as overrides at the time the job is run.
The output data set from the lsaf_getPFSetupJobParameters macro can be used to determine the
name and default values of all of the parameters for the job associated with the process flow
element. The output data set from the lsaf_getpfjobparameters macro can be used to determine
the name and value for the overrides currently set on the job element.
The output data set from the lsaf_getpfjobelementinfo can be used to determine the job
elements for a process flow and the job that is associated with the elements. If the job path
has not been set on the job element, parameter overrides cannot be set.

The job parameter overrides that are represented in the input data set replace the list of
parameter overrides currently saved on the job element. A single row where both NAME and TYPE
are blank results in clearing all of the job parameter overrides for the specified element.
If an invalid value is specified for a parameter, the updates are aborted and the
appropriate error message is written to the SAS log file.

If duplicate valid parameters are provided for the same element, only the first value is
maintained.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_JOBELEMENTPARMSTEMP__. In the event
that a failure occurs during processing, this temporary data set is retained as a reference.
If all updates are performed successfully, this data set is deleted from the work library.
A message is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of the success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records pertaining to the same job element are processed as a single transaction by the
macro. Messages are written to the SAS log file as each job element is processed. If the update
of a job element fails, the macro stops processing and a failure message is written to the
SAS log file. Successful updates to job elements made prior to the observation that contains
the failure are maintained in SAS Life Science Analytics Framework.

Syntax:
%LSAF_UPDATEPFSETUPJOBPARAMETERS(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-09
original coding
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_updatepfjobparameters to lsaf_updatepfsetupjobparameters
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the override parameters
        for the job elements to modify, specified as libref.dataset. The data set must
        contain at least the variables listed below. Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - name: The name of the job parameter.
        - type: The type of the override property. Valid values:CHARACTER, CHARACTER_MASKED,
        NUMERIC, DATE, FILE, or FOLDER.
        - value: The override value of the property.
        - fileVersion: The file version, if the parameter is of type FILE. A blank value
        specifies the latest version of the file.
        - includeSubFolders: Indicates whether the container includes subfolders. Valid
        values: 0 and 1.
File: lsaf_updatepfsetupjobparameters.sas
First available in version: 1.5

%lsaf_updatepfsetupnotifinfo(sas_dsname=);

[ Exposure: external ]
Updates the properties for process flow notification elements using a data set as input.

Properties for multiple notification elements can be modified using a single data set. Each
property is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupnotifinfo macro can be used to determine the
name and current values of the notification element properties. Rows where the name matches an
existing notification element property are used to attempt to update the property. If the
specified value is invalid for the property type, the update is aborted and the
appropriate error message is written to the SAS log file.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_NOTIFICATIONSTEMP__. In the event that a
failure occurs during processing, this temporary data set is retained as a reference. If all
updates are performed successfully, this data set is deleted from the work library. A
message is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records that pertain to the same notification element are processed as a single transaction
by the macro. Messages are written to the SAS log file as each notification element is
processed. If the update of a notification element fails, the macro stops processing and a
failure message is written to the SAS log file. Successful updates to notification elements
made prior to the observation that contains the failure are maintained in SAS Life Science
Analytics Framework.

Syntax:
%LSAF_UPDATEPFNOTIFICATIONINFO(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-19
original coding
   2019-02-12
update to 2.1
   2019-03-15
rename from lsaf_updatepfnotificationinfo to lsaf_updatepfsetupnotifinfo
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the properties
        information for all of the notification element properties to modify, specified as
        libref.dataset. The data set must contain at least the variables that are listed
        below. Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
File: lsaf_updatepfsetupnotifinfo.sas
First available in version: 1.5

%lsaf_updatepfsetupnotifrecips(sas_dsname=);

[ Exposure: external ]
Updates the recipients for process flow notification elements using a data set as input.

The recipients for multiple notification elements can be modified using a single data set.
Each recipient is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupnotifrecips macro can be used to determine
the recipients currently set on the notification element.
The output data set from the lsaf_getassignedmembers macro can be used to determine the
principals (users and groups) that are available at the context level eligible to be
recipients. The output data set from the lsaf_getprocessflowelements can be used to determine
the IDs for all notification elements for a process flow.

The notification recipients that are represented in the input data set replace the list of
recipients currently saved on the notification element. A single row where TYPE and PRINCIPALID
are blank result in clearing all of the notification recipients for the specified element.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK._SASMACRO_NOTIRECIPIENTSTEMP__. In the event that a
failure occurs during processing, this temporary data set is retained as a reference.
If all updates are performed successfully, this data set is deleted from the work library.
A message is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records that pertain to the same notification element are processed as a single transaction
by the macro. Messages are written to the SAS log file as each notification element is
processed. If the update of a notification element fails, the macro stops processing and a
failure message is written to the SAS log file. Successful updates to notification elements
made prior to the observation that contains the failure are maintained in SAS Life Science
Analytics Framework.

If duplicate valid recipients are provided for the same element, only one of the values is
maintained.

Syntax:
%LSAF_UPDATEPFSETUPNOTIFRECIPS(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-16
original coding
   2019-02-12
update to 2.1
   2019-03-25
rename from lsaf_updatepfnotifrecipients to lsaf_updatepfsetupnotifrecips
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the recipients for the
        notification elements to modify, specified as libref.dataset. The data set must
        contain at least the variables that are listed below.
        Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - type: The recipient type. Valid values: USER and GROUP.
        - principalId: The name of the recipient. The value is either a group name or a
        user ID.
        - grpSrcCtxt: The context path in which a group recipient is defined. The value
        is ignored, if the recipient is of type USER.
File: lsaf_updatepfsetupnotifrecips.sas
First available in version: 1.5

%lsaf_updatepfsetupsignallocs(sas_dsname=);

[ Exposure: external ]
Updates the locations for process flow signal elements using a data set as input.

The locations for multiple signal elements can be modified using a single data set.
Each location is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupsignallocs macro can be used to determine the
locations that are currently set on the signal element.
The output data set from the lsaf_getpfsetupelements can be used to determine the signal
elements for a process flow.

The signal locations that are represented in the input data set replace the list of locations
currently saved on the signal element. A single row where LOCATION is blank result in
clearing all signal locations for the specified element.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

Signal locations must adhere to the valid format of a SAS Life Science Analytics Framework
repository item with the exception of container paths, which must end in slash star "/*".
If an invalid value is specified for a location, the updates are aborted and the
appropriate error message is written to the SAS log file.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_SIGNALLOCATIONSTEMP__. In the event
that a failure occurs during processing, this temporary data set is retained as a reference.
If all updates are performed successfully, this data set is deleted from the work library.
A message is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records that pertain to the same signal element are processed as a single transaction by
the macro. Messages are written to the SAS log file as each signal element is processed. If the
update of a signal element fails, the macro stops processing and a failure message is
written to the SAS log file. Successful updates to signal elements made prior to the
observation that contains the failure are maintained in SAS Life Science Analytics Framework.

If duplicate valid locations are provided for the same element, only the first value is
maintained.

Syntax:
%LSAF_UPDATEPFSETUOSIGNALLOCS(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-13
original coding
   2019-02-12
update to 2.1
   2019-03-18
renamed from lsaf_updatepfsignallocations to lsaf_updatepfsetupsignallocs
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the locations for the
        signal elements to modify, specified as libref.dataset. The data set must contain
        at least the variables that are listed below.
        Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - location: The path for the signal location.
File: lsaf_updatepfsetupsignallocs.sas
First available in version: 1.5

%lsaf_updatepfsetuptimers(sas_dsname=);

[ Exposure: external ]
Updates the values of process flow timer elements using a data set as input. Each row of the
data set represents a timer element.

The output data set from the lsaf_getpfsetuptimers macro can be used to determine the ID
and current values of the process flow timer elements. Rows where the ID matches an existing
process flow timer element are used to attempt to update the element. If the specified value
is invalid for the element type, the update is aborted and the appropriate error message is
written to the SAS log file.

Values of type DATE 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).

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

If a failure occurs while processing a specific timer element, the macro stops processing
and a failure message is written to the SAS log file. Successful updates made to elements
prior to the element that contains the failure is maintained in SAS Life Science Analytics
Framework.

Syntax:
%LSAF_UPDATEPFSETUPTIMERS(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-03
original code
   2019-02-12
update to 2.1
   2019-03-18
rename from lsaf_updatepftimerelements to lsaf_updatepfsetuptimers
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the timer values to
        set on the timer elements, specified as libref.dataset.
        The data set must contain at least the variables that are listed below. Additional
        variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element.
        - value: The value of a date timer. This is ignored when timer type is DURATION.
        DATE.
        DATE.
        - days: The days value duration timer. This is ignored when timer type is DATE.
        DATE.
        - minutes: The minutes value for duration timer. This is ignored when timer type
        is DATE.
        - seconds: The seconds value for duration timer. This is ignored when timer type
        is DATE.
File: lsaf_updatepfsetuptimers.sas
First available in version: 1.5

%lsaf_updatepfsetupusercandidates(sas_dsname=);

[ Exposure: external ]
Updates the candidates for process flow user task elements using a data set as input.

The candidates for multiple user task elements can be modified using a single data set. Each
candidate is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupusercandidates macro can be used to determine the
candidates that are currently set on the user task element.
The output data set from the lsaf_getassignedmembers macro can be used to determine the
principals (users and groups) available at the context level that are eligible to be candidates.
The output data set from the lsaf_getpfsetupelements can be used to determent the IDs for all of
user elements for a process flow.

The user task candidates that are represented in the input data set replace the list of
candidates that is currently saved on the user task element. A single row where TYPE and
PRINCIPALID are blank result in clearing all user task candidates for the specified element.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set has
the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_USERCANDIDATESTEMP__. In the event that a
failure occurs during processing, this temporary data set is retained as a reference. If all
updates are performed successfully, this data set is deleted from the work library.
A message is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records that pertain to the same user task element are processed as a single transaction by
the macro. Messages are written to the SAS log file as each user task element is processed. If
the update of a user task element fails, the macro stops processing and a failure message is
written to the SAS log file. Successful updates to user task elements made prior to the
observation that contains the failure are maintained in SAS Life Science Analytics Framework.

If duplicate valid candidates are provided for the same element, only one of the values is
maintained.

Syntax:
%LSAF_UPDATEPFSETUPUSERCANDIDATES(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-16
original coding
   2019-02-12
update to 2.1
   2019-03-18
rename from lsaf_updatepfusercandidates to lsaf_updatepfsetupusercandidates
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the candidates for the
        user task elements to modify, specified as libref.dataset. The data set must contain
        at least the variables that are listed below.
        Aditional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - type: The candidate type. Valid values: USER and GROUP.
        - principalId: The name of the candidate. The value is either a group name or a
        user ID.
        - grpSrcCtxt: The context path in which a group candidate is defined. The value
        is ignored, if the candidate is of type user.
File: lsaf_updatepfsetupusercandidates.sas
First available in version: 1.5

%lsaf_updatepfsetupuserinfo(sas_dsname=);

[ Exposure: external ]
Updates the properties for process flow user elements using a data set as input.

Properties for multiple user elements can be modified using a single data set. Each property
is represented as a single row in the input data set.

The output data set from the lsaf_getpfsetupuserinfo macro can be used to determine the name
and current values of the user element properties. Rows where the name matches an existing
user element property are used to attempt to update the property. If the specified value is
invalid for the property type, the update is aborted and the appropriate error message is
written to the SAS log file.

Failure and Message Handling:
The macro performs a series of validation procedures to determine whether the input data set
has the necessary structure for processing. If any of these validation procedures fail, an
appropriate failure message is written to the SAS log file and the macro stops additional
processing.

In addition to other modifications, the macro sorts the input data set and stores the modified
data in a temporary data set called WORK.__SASMACRO_USERELEMENTSTEMP__. In the event that a
failure occurs during processing, this temporary data set is retained as a reference. If all
updates are performed successfully, this data set is deleted from the work library. A message
is written to the SAS log file, reporting whether the data set was retained or not.
Regardless of success or failure of previous runs, this data set is deleted at the
beginning of each new run of the macro. The data values and sort order of the original input
data set are maintained.

All records that pertain to the same user element are processed as a single transaction by the
macro. Messages are written to the SAS log file as each user element is processed. If the
update of a user element fails, the macro stops processing and a failure message is written to
the log. Successful updates to user elements made prior to the observation that contains the
failure are maintained in SAS Life Science Analytics Framework.

Syntax:
%LSAF_UPDATEPFSETUPUSERINFO(SAS_DSNAME=SAS-data-set);

          
History:
   2017-01-18
original coding
   2019-02-12
update to 2.1
   2019-03-18
rename from lsaf_updatepfuserelementinfo to lsaf_updatepfsetupuserinfo
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
sas_dsname - - Required - The name of a SAS data set that contains the properties
        information for all the user element properties to modify, specified as
        libref.dataset. The data set must contain at least the variables that are listed
        below. Additional variables are ignored.
        - processFlowPath: The path of the context in which the process flow is located.
        - processFlowName: The name of the process flow.
        - elementID: The ID for the element applicable for the property.
        - name: The name of the property.
        - value: The value of the property.
File: lsaf_updatepfsetupuserinfo.sas
First available in version: 1.5