Module SubscriptionService

Macros to retrieve subscription information.

Since: 2.1

Macro Summary
external

LSAF
%lsaf_getsubscriptions(sas_dsname=work.lsafGetSubscriptions);
Gets the metadata for all subscriptions for the current user. The metadata is stored in a ...
external

LSAF
%lsaf_setitemsubscriptions(lsaf_path=, lsaf_events=, sas_dsname=work.lsafSetItemSubscriptions);
Sets the event subscriptions for a job file for the current user. Only job files can have ...

Macro Detail

%lsaf_getsubscriptions(sas_dsname=work.lsafGetSubscriptions);

[ Exposure: external ]
Gets the metadata for all subscriptions for the current user. The metadata is stored in a
SAS data set.

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

          
History:
   2014-03-11
initial coding
   2016-08-26
rebrand as LSAF
   2019-02-15
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:
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the subscriptions, specified as libref.dataset. The default value is
        WORK.LSAFGETSUBSCRIPTIONS. The data set contains a row for each subscription
        with the following names. The data set is sorted by the event and path.
        - event: The name of the event subscription.
        - path: The path of the item to which a subscription applies.
File: lsaf_getsubscriptions.sas
First available in version: 1.4

%lsaf_setitemsubscriptions(lsaf_path=, lsaf_events=, sas_dsname=work.lsafSetItemSubscriptions);

[ Exposure: external ]
Sets the event subscriptions for a job file for the current user. Only job files can have
subscriptions.

Syntax:
%LSAF_SETITEMSUBSCRIPTIONS(LSAF_PATH=lsaf-path <,LSAF_EVENTS=lsaf-events,
SAS_DSNAME=sas-dsname>);

          
History:
   2020-02-12
initial coding
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_path - - Required - The name of the job file. If the path is blank, is not found,
        or is not a job file, the macro fails.
lsaf_events - - Optional - The name of the event subscription. Specify mutiple events
        by separating the events with commas. Valid values:
        - JOB_START_EVENT
        - JOB_FAILED_EVENT
        - SCHEDULED_JOB_START_EVENT
        If an unknown event is included in the value, the macro fails. If the event
        parameter is blank, all subscriptions to the job are removed. To unsubscribe to
        a job, specify a blank events parameter.
sas_dsname - - Optional - The name of the output SAS data set to contain the metadata
        for the subscriptions, specified as libref.dataset. The default value is
        WORK.LSAFSETITEMSUBSCRIPTIONS. The data set contains a row for each subscription
        with the following names. The data set is sorted by the event and path.
        - event: The name of the event subscription.
        - path: The path of the item to which a subscription applies.
File: lsaf_setitemsubscriptions.sas
First available in version: 2.3