Module ScheduleService
Macros to manipulate and create schedules.
Since: 2.3
Macro Summary |
external
LSAF | %lsaf_createintervalschedule(lsaf_intervaltype=, lsaf_interval=, lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=, lsaf_endtype=, lsaf_endvalue=);
Creates a schedule that runs at the specified interval. Sets the SAS macro variable ...
|
external
LSAF | %lsaf_createonetimeschedule(lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=);
Creates a schedule that runs one time. Sets the SAS macro variable _lsafOneTimeScheduleId_ to ...
|
external
LSAF | %lsaf_createweeklyschedule(lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=, lsaf_endtype=, lsaf_endvalue=, lsaf_daysofweek=);
Creates a schedule that runs on the specified weekdays and sets the SAS macro variable ...
|
external
LSAF | %lsaf_deleteschedule(lsaf_scheduleid=);
Deletes a schedule.
|
external
LSAF | %lsaf_getallschedules(sas_dsname=work.lsafGetAllSchedules);
Gets the metadata for all of the schedules. The metadata is stored in a SAS data set. ...
|
external
LSAF | %lsaf_getmyschedules(sas_dsname=work.lsafGetMySchedules);
Gets the metadata for the schedules that are owned by the current user. The metadata is ...
|
external
LSAF | %lsaf_getschedulejobparameters(lsaf_scheduleid=, sas_dsname=work.lsafGetScheduleJobParameters);
Gets the override parameters for the schedule. The parameters are stored in a SAS data set.
|
external
LSAF | %lsaf_getscheduleproperties(lsaf_scheduleid=, sas_dsname=work.lsafGetScheduleProperties);
Gets the properties for the specified schedule. The properties are stored in a SAS data set.
|
external
LSAF | %lsaf_getschedulestatus(lsaf_scheduleid=);
Gets the status of a schedule. ...
|
external
LSAF | %lsaf_isjobscheduled(lsaf_location=, lsaf_path=);
Indicates whether a job is scheduled.
|
external
LSAF | %lsaf_pauseschedule(lsaf_scheduleid=);
Pauses an active schedule.
|
external
LSAF | %lsaf_resumeschedule(lsaf_scheduleid=);
Resumes a paused schedule.
|
external
LSAF | %lsaf_scheduleexistsbyid(lsaf_scheduleid=);
Indicates whether a schedule with the specified identifier exists.
|
external
LSAF | %lsaf_scheduleexistsbyname(lsaf_name=);
Indicates whether a schedule with the specified name exists. ...
|
%lsaf_createintervalschedule(lsaf_intervaltype=, lsaf_interval=, lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=, lsaf_endtype=, lsaf_endvalue=);
[ Exposure:
external
]
- Creates a schedule that runs at the specified interval. Sets the SAS macro variable
_lsafIntervalScheduleId_ to the identifier for the created schedule. If the schedule cannot be
created, _lsafIntervalScheduleId_ is set to blank.
You can specify a data set that represents the job parameters values to overwrite when the
schedule runs. If no job parameters data set is specified, the default values for all job
parameters are used.
The output data set from the macro lsaf_getjobparameters or lsaf_getworkspacejobparameters
contains all of the data that is relevant to the parameters for a specific job. You can use this
data set as a source for the input parameters data set for this macro. Modify the data set with
changes before calling this macro.
- Rename the defaultValue variable to "value" or add a variable with the name "value" to
indicate the values to use for the scheduled submission.
- Default job parameter values are used for missing parameters (deleted rows).
- Indicating an empty string for a parameter value results in using a blank as the parameter
value for the current submission.
- Added parameters are ignored.
- The parameters in the input data set are matched with the job parameters by name and type.
If no match is found for a parameter, its default value is used.
- Data set rows with duplicate values for parameter name cause an execution error.
- DATE job parameter values must be in SAS datetime18. format (such as 02NOV2013:09:33:22), or
in SAS E8601DZ25. format (such as 2013-11-02T09:33:22-04:00). For SAS datetime18. format, an
offset of zero hours from GMT is used. To specify an offset from GMT, use the E8601DZ25.
format. Date values in formats other than the two described above result in an execution error.
Syntax:
%LSAF_CREATEINTERVALSCHEDULE(LSAF_NAME=lsaf-name <, LSAF_DESCRIPTION=lsaf-description >,
LSAF_LOCATION=lsaf-location, LSAF_PATH=lsaf-path
<, LSAF_VERSION=lsaf-version, SAS_DSNAME=SAS-data-set>,
LSAF_STARTDATE=lsaf-startdate,
LSAF_ENDTYPE=lsaf-endtype, LSAF_ENDVALUE=lsaf-endvalue,
LSAF_INTERVALTYPE=lsaf-intervaltype, LSAF_INTERVAL=lsaf-interval
);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_intervaltype
-
- Required - The case-insensitive type of interval.
Valid values: MINUTELY, HOURLY, and DAILY.
-
lsaf_interval
-
- Required - The integer value for the interval to pass before each
schedule run.
-
lsaf_name
-
- Required - The name of the schedule to create.
-
lsaf_description
-
- Optional - The description of the schedule to create.
-
lsaf_location
-
- Required - The case-insensitive location of the job to schedule.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The path of the job to schedule.
-
lsaf_version
-
- Optional - The version of the repository job to schedule. If
omitted for a repository job, the latest version is scheduled to run. If the lsaf_location
is WORKSPACE, the value is ignored.
-
sas_dsname
-
- Optional - The name of the SAS data set that contains the job parameter
information, specified as libref.dataset. If not specified, the default job
parameters values are used. The data set must contain at least the character
variables that are listed below. Additional variables are ignored.
- name: The name of the parameter.
- type: The parameter type. Valid values: CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- value: The value of the parameter to use in the current job submission.
- fileVersion: The file version to use, if the parameter is of type FILE. For
versioned files, a blank value results in the latest file version used. For
unversioned files, the value is ignored.
- includeSubFolders: Indicates whether the subfolders of a container are included
during job execution.
-
lsaf_startdate
-
- Required - The date and time on which the schedule runs. The value must
be in SAS datetime18. format (such as 02NOV2013:09:33:22), or in SAS E8601DZ25. format
(such as 2013-11-02T09:33:22-04:00). For SAS datetime18. format, an offset of zero hours
from GMT is used. To specify an offset from GMT, use the E8601DZ25. format. Date values in
formats other than the two described above result in an execution error.
-
lsaf_endtype
-
- Required - The case-insensitive value that specifies the method to end
the schedule. Valid values:
NONE - The schedule runs indefinitely or until the schedule is deleted.
DATE - The schedule runs until a specified date and time.
OCCURRENCES - The schedule runs a specified number of times.
-
lsaf_endvalue
-
- Conditional - If lsaf_endtype is DATE, this value must be a valid date
for the last schedule run. See lsaf_startdate for valid date formats.
If lsaf_endtype is OCCURRENCES, this value must be a valid integer value for the number
of times to run the schedule. If lsaf_endtype is NONE, this value is ignored.
-
File: lsaf_createintervalschedule.sas
-
First available in version: 2.3
%lsaf_createonetimeschedule(lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=);
[ Exposure:
external
]
- Creates a schedule that runs one time. Sets the SAS macro variable _lsafOneTimeScheduleId_ to
the identifier for the created scheudule. If the schedule cannot be created,
_lsafOneTimeScheduleId_ is set to blank.
You can specify a data set that represents the job parameters values to overwrite when the
schedule runs. If no job parameters data set is specified, the default values for all job
parameters are used.
The output data set from the macro lsaf_getjobparameters or lsaf_getworkspacejobparameters
contains all of the data that is relevant to the parameters for a specific job. You can use this
data set as a source for the input parameters data set for this macro. Modify the data set
with changes before calling this macro.
- Rename the defaultValue variable to "value" or add a variable with the name "value" to
indicate the values to use for the scheduled submission.
- Default job parameter values are used for missing parameters (deleted rows).
- Indicating an empty string for a parameter value results in using a blank as the parameter
value for the current submission.
- Added parameters are ignored.
- The parameters in the input data set are matched with the job parameters by name and type.
If no match is found for a parameter, its default value is used.
- Data set rows with duplicate values for parameter name cause an execution error.
- DATE job parameter values must be in SAS datetime18. format (such as 02NOV2013:09:33:22), or
in SAS E8601DZ25. format (such as 2013-11-02T09:33:22-04:00). For SAS datetime18. format, an
offset of zero hours from GMT is used. To specify an offset from GMT, use the E8601DZ25.
format. Date values in formats other than the two described above result in an execution error.
Syntax:
%LSAF_CREATEONETIMESCHEDULE(LSAF_NAME=lsaf-name, <, LSAF_DESCRIPTION=lsaf-description >
LSAF_LOCATION=lsaf-location, LSAF_PATH=lsaf-path
<, LSAF_VERSION=lsaf-version><, SAS_DSNAME=SAS-data-set>,
LSAF_STARTDATE=lsaf-startdate
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_name
-
- Required - The name of the schedule to create.
-
lsaf_description
-
- Optional - The description of the schedule to create.
-
lsaf_location
-
- Required - The case-insensitive location of the job to schedule.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The path of the job to schedule.
-
lsaf_version
-
- Optional - The version of the repository job to schedule. If omitted for
a repository job, the latest version is scheduled to run. If lsaf_location is WORKSPACE,
the value is ignored.
-
sas_dsname
-
- Optional - The name of the SAS data set that contains the job parameter
information, specified as libref.dataset. If not specified, the default job
parameters values are used. The data set must contain at least the character
variables that are listed below. Additional variables are ignored.
- name: The name of the parameter.
- type: The parameter type. Valid values: CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- value: The value of the parameter to use in the current job submission.
- fileVersion: The file version to use, if the parameter is of type FILE. For
versioned files, a blank value results in the latest file version used. For
unversioned files, the value is ignored.
- includeSubFolders: Indicates whether the subfolders of a container are included
during job execution.
-
lsaf_startdate
-
- Required - The date and time on which the schedule runs. The value must
be in SAS datetime18. format (such as 02NOV2013:09:33:22), or in SAS E8601DZ25. format
(such as 2013-11-02T09:33:22-04:00). For SAS datetime18. format, an offset of zero hours
from GMT is used. To specify an offset from GMT, use the E8601DZ25. format. Date values in
formats other than the two described above result in an execution error.
-
File: lsaf_createonetimeschedule.sas
-
First available in version: 2.3
%lsaf_createweeklyschedule(lsaf_name=, lsaf_description=, lsaf_location=, lsaf_path=, lsaf_version=, sas_dsname=, lsaf_startdate=, lsaf_endtype=, lsaf_endvalue=, lsaf_daysofweek=);
[ Exposure:
external
]
- Creates a schedule that runs on the specified weekdays and sets the SAS macro variable
_lsafWeeklyScheduleId_ to the identifier for the created scheudule. If the schedule cannot be
created, _lsafWeeklyScheduleId_ is set to blank. At least one weekday must be set.
You can specify a data set to represent the job parameters values to overwrite when the
schedule runs. If no job parameters data set is specified, the default values for all job
parameters are used.
The output data set from the macro lsaf_getjobparameters or lsaf_getworkspacejobparameters
contains all of the data that is relevant to the parameters for a specific job. THe data set can
be used as a source for the input parameters data set for this macro. Modify the data set with
changes prior to calling this macro.
- Rename the defaultValue variable to "value" or add a variable with the name "value" to
indicate the values to use for the scheduled submission.
- Default job parameter values are used for missing parameters (deleted rows).
- An empty string for a parameter value results in using a blank as the parameter value for the
current submission.
- Added parameters are ignored.
- The parameters in the input data set are matched with the job parameters by name and type.
If no match is found for a parameter, its default value is used.
- Data set rows with duplicate values for parameter name cause an execution error.
- DATE job parameter values must be in SAS datetime18. format (such as 02NOV2013:09:33:22), or
in SAS E8601DZ25. format (such as 2013-11-02T09:33:22-04:00). For SAS datetime18. format, an
offset of zero hours from GMT is used. To specify an offset from GMT, use the E8601DZ25.
format. Date values in formats other than the two described above result in an execution error.
Syntax:
%LSAF_CREATEWEEKLYSCHEDULE(LSAF_NAME=lsaf-name <, LSAF_DESCRIPTION=lsaf-description >,
LSAF_LOCATION=lsaf-location, LSAF_PATH=lsaf-path
<, LSAF_VERSION=lsaf-version, SAS_DSNAME=SAS-data-set>,
LSAF_DAYSOFWEEK=lsaf-daysOfWeek);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_name
-
- Required - The name of the schedule to create.
-
lsaf_description
-
- Optional - The description of the schedule to create.
-
lsaf_location
-
- Required - The case-insensitive location of the job to schedule.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The path of the job to schedule.
-
lsaf_version
-
- Optional - The version of the repository job to schedule. If
omitted for a repository job, the latest version is scheduled to run. This value is
ignored when lsaf_location is WORKSPACE.
-
sas_dsname
-
- Optional - The name of the SAS data set that contains the job parameter
information, specified as libref.dataset. If not specified, the default job
parameters values are used. The data set must contain at least the character
variables that are listed below. Additional variables are ignored.
- name: The name of the parameter.
- type: The parameter type. Valid values: CHARACTER, CHARACTER_MASKED, NUMERIC,
DATE, FILE, and FOLDER.
- value: The value of the parameter to use in the current job submission.
- fileVersion: The file version to use, if the parameter is of type FILE. For
versioned files, a blank value results in the latest file version used. For
unversioned files, this value is ignored.
- includeSubFolders: Indicates whether the subfolders of a container are included
during job execution.
-
lsaf_startdate
-
- Required - The date and time for the schedule to run. This value must be
in SAS datetime18. format (such as 02NOV2013:09:33:22), or in SAS E8601DZ25. format (such as
2013-11-02T09:33:22-04:00). For SAS datetime18. format, an offset of zero hours from GMT is
used. To specify an offset from GMT, use the E8601DZ25. format. Date values in formats other
than the two described above result in an execution error.
-
lsaf_endtype
-
- Required - The case-insensitive value that specifies the method to end the
schedule. Valid values:
NONE - The schedule runs indefinitely or until the schedule is deleted.
DATE - The schedule runs until a specified date and time.
OCCURRENCES - The schedule runs a specified number of times.
-
lsaf_endvalue
-
- Conditional - If lsaf_endtype is DATE, this value must be a valid date
for the last schedule run. See lsaf_startdate for valid date formats.
If lsaf_endtype is OCCURERENCES, this value must be a valid integer value for the number
of times to run the schedule. This value is ignored when lsaf_endtype is NONE.
-
lsaf_daysofweek
-
- Required - A case-insensitive, comma-delimited list of the days of the
week on which to run the schedule. The days must be specified with their three-letter
abbreviation. The days can be listed in any order. At least one day must be specified.
Valid values: SUN, MON, TUE, WED, THU, FRI, and SAT.
Note: If specifying all weekdays, consider using the lsaf_createintervalschedule macro
specifying DAILY as the lsaf_intervaltype.
-
File: lsaf_createweeklyschedule.sas
-
First available in version: 2.3
%lsaf_deleteschedule(lsaf_scheduleid=);
[ Exposure:
external
]
- Deletes a schedule.
Syntax:
%LSAF_DELETESCHEDULE(LSAF_SCHEDULEID=lsaf-scheduleid);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can be
retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
File: lsaf_deleteschedule.sas
-
First available in version: 2.3
%lsaf_getallschedules(sas_dsname=work.lsafGetAllSchedules);
[ Exposure:
external
]
- Gets the metadata for all of the schedules. The metadata is stored in a SAS data set.
The global privilege PRIVILEGE_MANAGE_ALL_SCHEDULES is required to retrieve any schedules,
including the schedules that are owned by the current user.
Syntax:
%LSAF_GETALLSCHEDULES(<SAS_DSNAME=SAS-data-set>);
-
History:
- 2019-10-01
- initial code
-
-
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 schedules, specified as libref.dataset. The default value is
WORK.LSAFGETALLSCHEDULES and is sorted by the schedule identifier.
The data set contains a row for each schedule deployed and has columns with the
following names.
- scheduleID: The identifier of the schedule.
- name: The name of the schedule.
- description: The description of the schedule.
- owner: The owner of the schedule.
- status: The status of the schedule.
- lastModified: The date on which the schedule was last modified, represented as a
String.
- dateLastModified: The date on which the schedule was last modified, represented as
a SAS Datetime format.
-
File: lsaf_getallschedules.sas
-
First available in version: 2.3
%lsaf_getmyschedules(sas_dsname=work.lsafGetMySchedules);
[ Exposure:
external
]
- Gets the metadata for the schedules that are owned by the current user. The metadata is
stored in a SAS data set.
Syntax:
%LSAF_GETMYSCHEDULES(<SAS_DSNAME=SAS-data-set>);
-
History:
- 2019-10-01
- initial code
-
-
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 schedules, specified as libref.dataset. The default value is
WORK.LSAFGETMYSCHEDULES and is sorted by the schedule ID.
The data set contains a row for each schedule deployed and has columns with the
following names.
- scheduleID: The identifier of the schedule.
- name: The name of the schedule.
- description: The description of the schedule.
- owner: The owner of the schedule.
- status: The status of the schedule.
- lastModified: The date on which the schedule was last modified, represented as a
String.
- dateLastModified: The date on which the schedule was last modified, represented as
a SAS Datetime format.
-
File: lsaf_getmyschedules.sas
-
First available in version: 2.3
%lsaf_getschedulejobparameters(lsaf_scheduleid=, sas_dsname=work.lsafGetScheduleJobParameters);
[ Exposure:
external
]
- Gets the override parameters for the schedule. The parameters are stored in a SAS data set.
Job schedules maintain a list of the parameters that are used to override the default
parameters when the job 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_GETSCHEDULEJOBPARAMETERS(LSAF_SCHEDULEID=lsaf-scheduleid <, SAS_DSNAME=SAS-data-set>);
-
History:
- 2019-11-20
- original creation.
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can be
retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the override
parameters for schedule, specified as libref.dataset.
The default value is WORK.LSAFGETSCHEDULEJOBPARAMETERS. The data set contains a
row for each override parameter and columns with the following names. The following
metadata is represented in the data set.
- scheduleID: The identifier of the schedule.
- scheduleName: The name of the schedule.
- jobLocation: The location of the job. Valid values: REPOSITORY and WORKSPACE.
- 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, and 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_getschedulejobparameters.sas
-
First available in version: 2.3
%lsaf_getscheduleproperties(lsaf_scheduleid=, sas_dsname=work.lsafGetScheduleProperties);
[ Exposure:
external
]
- Gets the properties for the specified schedule. The properties are stored in a SAS data set.
Syntax:
%LSAF_GETSCHEDULEPROPERTIES(LSAF_SCHEDULEID=lsaf-scheduleid<, SAS_DSNAME=SAS-data-set>);
-
History:
- 2019-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can be
retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata for the
schedule, specified as libref.dataset. The default value is WORK.LSAFGETSCHEDULEPROPERTIES.
The data set contains variables that represent each element of the metadata for the
schedule. The data set is sorted by the NAME variable. The following metadata is
represented in the data set.
- scheduleId: The identifier of the schedule.
- scheduleName: The name of the schedule.
- name: The name of the property.
- value: The value of the property.
-
File: lsaf_getscheduleproperties.sas
-
First available in version: 2.3
%lsaf_getschedulestatus(lsaf_scheduleid=);
[ Exposure:
external
]
- Gets the status of a schedule.
SAS macro variable _lsafScheduleStatus_ is set to the status value. Values returned:
- NORMAL: Active.
- PAUSED: Paused.
- ERROR: Error.
- JOB_NOT_AVAILABLE: The job is not found at the specified path.
Syntax:
%LSAF_GETSCHEDULESTATUS(LSAF_SCHEDULEID=lsaf-scheduleid);
-
History:
- 2020-02-10
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafScheduleStatus_
-
The status of the schedule.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can
be retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
File: lsaf_getschedulestatus.sas
-
First available in version: 2.3
%lsaf_isjobscheduled(lsaf_location=, lsaf_path=);
[ Exposure:
external
]
- Indicates whether a job is scheduled.
The SAS macro variable _lsafJobIsScheduled_ is set to a value of 1 when the job is
scheduled, and 0 when it is not. In the event of an incorrect call to the macro
that results in an error, the return value of _lsafJobIsScheduled_ is set to -1.
This macro returns False, if you do not have access to the schedule. Access to the
schedules is controlled by the global privileges PRIVILEGE_MANAGE_SCHEDULES and
PRIVILEGE_MANAGE_ALL_SCHEDULES.
Syntax:
%LSAF_ISJOBSCHEDULED(LSAF_LOCATION=lsaf-location, LSAF_PATH=lsaf-path);
-
History:
- 2019-11-20
- initial code
-
-
Expected Macro Variables:
-
_lsafJobIsScheduled_
-
Indicates whether the job is scheduled.
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_location
-
- Required - The case-insensitive location of the job.
Valid values: WORKSPACE and REPOSITORY.
-
lsaf_path
-
- Required - The path of the job.
-
File: lsaf_isjobscheduled.sas
-
First available in version: 2.3
%lsaf_pauseschedule(lsaf_scheduleid=);
[ Exposure:
external
]
- Pauses an active schedule.
Syntax:
%LSAF_PAUSESCHEDULE(LSAF_SCHEDULEID=lsaf-scheduleid);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can be
retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
File: lsaf_pauseschedule.sas
-
First available in version: 2.3
%lsaf_resumeschedule(lsaf_scheduleid=);
[ Exposure:
external
]
- Resumes a paused schedule.
Syntax:
%LSAF_RESUMESCHEDULE(LSAF_SCHEDULEID=lsaf-scheduleid);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The case-sensitive identifier of the schedule. This can be
retrieved by calling either the lsaf_getallschedules or lsaf_getmyschedules macro.
-
File: lsaf_resumeschedule.sas
-
First available in version: 2.3
%lsaf_scheduleexistsbyid(lsaf_scheduleid=);
[ Exposure:
external
]
- Indicates whether a schedule with the specified identifier exists.
The SAS macro variable _lsafScheduleExistsById_ is set to a value of 1 when the
schedule exists, and 0 when it does not. In the event of an incorrect call to the macro
that results in an error, the return value of _lsafScheduleExistsById_ is set to -1.
The macro returns False, if the user does not have access to the schedule. Access to the
schedules is controlled by the global privileges PRIVILEGE_MANAGE_SCHEDULES and
PRIVILEGE_MANAGE_ALL_SCHEDULES.
Syntax:
%LSAF_SCHEDULEEXISTSBYID(LSAF_SCHEDULEID=lsaf-scheduleid);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafScheduleExistsById_
-
Indicates whether the schedule exists.
-
Parameters:
-
lsaf_scheduleid
-
- Required - The identifier of the schedule.
-
File: lsaf_scheduleexistsbyid.sas
-
First available in version: 2.3
%lsaf_scheduleexistsbyname(lsaf_name=);
[ Exposure:
external
]
- Indicates whether a schedule with the specified name exists.
NOTE: Schedule names are not unique. If a schedule with the specified name exists,
this macro returns True.
The SAS macro variable _lsafScheduleExistsByName_ is set to a value of 1, if the
schedule exists, and 0, when it does not. In the event of an incorrect call to the macro
that results in an error, the return value of _lsafScheduleExistsByName_ is set to -1.
The macro returns False, if the user does not have access to the schedule. Access to
schedules is controlled by the global privileges PRIVILEGE_MANAGE_SCHEDULES and
PRIVILEGE_MANAGE_ALL_SCHEDULES.
Syntax:
%LSAF_SCHEDULEEXISTSBYNAME(LSAF_NAME=lsaf-name);
-
History:
- 2010-10-01
- initial code
-
-
Expected Macro Variables:
-
_lsafMsg_
-
The return message.
-
_lsafRC_
-
The return code.
-
_lsafScheduleExistsByName_
-
Indicates whether the schedule exists.
-
Parameters:
-
lsaf_name
-
- Required - The name of the schedule.
-
File: lsaf_scheduleexistsbyname.sas
-
First available in version: 2.3