Module AuthenticationService

Macros to create and close interactive sessions to SAS Life Science Analytics Framework.

Since: 2.3

Macro Summary
external

LSAF
%lsaf_login(lsaf_url=, lsaf_userid=, lsaf_password=, proxy_host=, proxy_port=, proxy_userid=, proxy_password=);
Creates a connection to the SAS Life Science Analytics Framework instance.
external

LSAF
%lsaf_logout;
Closes an open connection to SAS Life Science Analytics Framework.

Macro Detail

%lsaf_login(lsaf_url=, lsaf_userid=, lsaf_password=, proxy_host=, proxy_port=, proxy_userid=, proxy_password=);

[ Exposure: external ]
Creates a connection to the SAS Life Science Analytics Framework instance.

This macro is required only when running the macros from a PC SAS session. It must be called
before any other SAS Life Science Analytics Framework macro.

NOTE: This macro is supported only from a PC SAS session. Using this macro within an active
SAS Life Science Analytics Framework application session results in a failure.

Syntax:
%LSAF_LOGIN(LSAF_URL=url, LSAF_USERID=user-id , LSAF_PASSWORD=password
<,PROXY_HOST=proxy-host, PROXY_PORT=proxy-port, PROXY_USERID=proxy-userid,
PROXY_PASSWORD=proxy-pw>);

Examples:

1. The parameters that are passed to the login macro are often strings that contain special characters
that might cause problems when resolved by SAS. You will probably need to wrap each of the parameters
in a SAS function call to prevent any issues, such as:
%lsaf_login(lsaf_url=%str(https://lsafinstance), lsaf_userid=%str(lsaf-user-id),
lsaf_password=%str (lsafpassword ));

2. Certain special characters that are common in passwords (such as ampersands and percent signs) might
require quotation marks, such as:
%lsaf_login(lsaf_url=%str(https://lsafinstance), lsaf_userid=%str(lsaf-user-id),
lsaf_password=%nrbquote(lsafpassword ));

          
History:
   2013-06-26
version 1.2 update - trusted session
   2013-08-30
updates for standardization and coding conventions
   2014-03-04
updates for proxy
   2016-08-26
rebrand as LSAF
   2019-01-30
update to 2.1
   2020-02-07
move to AuthenticationService
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
Parameters:
lsaf_url - - Required - The URL of the SAS Life Science Analytics Framework instance to use, specified
        in the form https://lsafname.sas.com or http://lsafname.sas.com.
lsaf_userid - - Required - The SAS Life Science Analytics Framework ID for the user account.
lsaf_password - - Required - The SAS Life Science Analytics Framework password for the user account.
proxy_host - - Conditional - The name of the host computer, when the SAS Life Science Analytics
        Framework system is accessed through a proxy server.
proxy_port - - Conditional - The port number that is required for the proxy host computer.
        Required when a proxy_host is designated.
proxy_userid - - Conditional - The user ID when the proxy computer requires authentication.
proxy_password - - Conditional - The password when the proxy computer requires authentication.
File: lsaf_login.sas
First available in version: 1.1

%lsaf_logout;

[ Exposure: external ]
Closes an open connection to SAS Life Science Analytics Framework.

This macro is used only when running the macros from a PC SAS session. This should be the
last macro you call in any program. If the logout operation is successful, all variables
(such as _lsafRC_) that are related to SAS Life Science Analytics Framework macros are
deleted.

NOTE: This macro is supported only from a PC SAS session. Using this macro within an active
SAS Life Science Analytics Framework application session results in a failure.

Syntax:
%LSAF_LOGOUT();

          
History:
   2013-06-26
version 1.2 update - trusted session
   2013-08-30
updates for standardization and coding conventions
   2016-08-26
rebrand as LSAF
   2020-02-07
move to AuthenticationService
Expected Macro Variables:
_lsafMsg_ - The return message.
_lsafRC_ - The return code.
File: lsaf_logout.sas
First available in version: 1.1