Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Siebel Analytics Web SOAP API Methods >

SAWSessionService

Defines authentication services such as logon and logoff, and other session-related services. Table 50 shows the supported methods.

getCurUser() Method

The getCurUser() method gets the current user name for the session.

Signature

String getCurUser(String sessionID);

Returns

Returns a string indicating the current user name for the session.

impersonate() Method

The impersonate() method in the SAWSessionService service logs on and impersonates the user. This method is useful when you need to create sessions for multiple users and have only the administrator's name and password. You do not need to use the (logon) method if you use the impersonate() method.

If user authentication or impersonation fails, an exception is thrown.

Signature

String impersonate(String name, String password, String impersonateID);

Returns

impersonateex() Method

The impersonateex() method in the SAWSessionService service logs on and impersonates the user. Similar to the impersonate method, but impersonateex can specify optional session parameters. This method is useful when you need to create sessions for multiple users and have only the administrator's name and password. You do not need to use the (logon) method if you use the impersonateex() method.

If user authentication or impersonation fails, an exception is thrown.

Signature

String impersonateex(String name, String password, String impersonateID, SAWSessionParameters sessionparams);

Returns

keepAlive() Method

The keepAlive() method instructs Siebel Analytics Web not to end particular Siebel Analytics Web user sessions due to inactivity. The effect of this call on session lifetime is the same as if those users performed an activity in the browser such as clicking a report, or invoking a SOAP call. For more information about ending Siebel Analytics Web user sessions due to inactivity, see Setting the Time to Log Users Off Siebel Analytics Web Automatically.

Signature

void keepAlive(String[] sessionIDs);

logoff() Method

The logoff() method logs the user off Siebel Analytics Web.

Signature

void logoff(String sessionID);

logon() Method

The logon() method authenticates the user. If authentication fails, an exception is thrown.

Signature

String logon(String username, String password)

Returns

logonex() Method

The logonex() method authenticates the user. Similar to the logon method, but logonex can specify optional session parameters. If authentication fails, an exception is thrown.

Signature

String logonex(String username, String password, SAWSessionParameters sessionparams);

Returns

This method returns the session ID and sets an HTTP session cookie. The session ID is used in other SOAP API calls to identify your SOAP session.