CorporateTime for the Web 3.0 Administrator's Guide

Quiet sign-in

The quiet mode sign-in is used to authenticate a user and save his or her session information on the browser. A company with many on-line activities (including CorporateTime for the Web) can then authenticate the user to all services with one form.

The quiet mode sign-in can be run with a URL or from the command line.

---

Parameter

userid

Description

Userid for signing in. It must already exist on the calendar server. Also needed for logout in command-line mode.

Required for URL

Yes

Required for command line

Yes

Accepted values

String of size 0 to 64 characters

---

Parameter

password

Description

User's password must be passed and encoded using the encode utility.

Example of how to encode the password test:

./encode test

%a3%bd%aa%ae

Required for URL

Yes

Required for command line

Yes

Accepted values

String of size 0 to 16 characters.

---

Parameter

quiet

Description

Used to indicate that the quiet sign-in should work in the background to set the appropriate cookies and then redirect to the URLs provided as input. Also need for logout with URL-based quiet sign-in.

Required for URL

Yes. Otherwise the default behaviour is for sign-in to run in verbose mode.

Required for command line

No. It is assumed to be running in quiet mode always.

Accepted values

on=Run in quiet mode. Works only with URL-based quiet sign-in.

---

Parameter

autologin

Description

Used to allow automatic sign-in.

Required for URL

No. Default is off.

Required for command line

No. Default is off.

Accepted values

on: Set automatic sign-in.

off: Automatic sign-in is disabled

---

Parameter

local_cookie

Description

The cookie pref is where the CorporateTime for the Web maintains permanent user preferences. If local_cookie is set, then the Web Calendar will also look for the parameter pref from which to read the default preferences.

Enable this parameter to make sure any preferences the user sets in his or her Agenda are remembered the next time quiet sign-in is used. Otherwise new preferences are constructed each time the user signs in.

Other cookies such as ssnInfo, preSign and viewid can also be read if they are available on the user's browser side.

Required for URL

No.

Required for command line

No.

Accepted values

on: User's localinfo cookie exists on the user's browser side.

off: Default value. Construct a new localinfo cookie as if the user has never used CorporateTime for the Web before.

---

Parameter

localinfo

Description

The cookie pref is where CorporateTime for the Web maintains permanent user preferences. If local_cookie is set, CorporateTime for the Web 3.0 will also look for the parameter pref from which to read the default preferences.

Enable this parameter to make sure any preferences the user sets in his or her Agenda are remembered the next time quiet sign-in is used. Otherwise new preferences are constructed each time the user logs in.

Other cookies such as ssnInfo, preSign and viewid can also be read if they are available on the user's browser side.

Required for URL

No.

Required for command line

No.

Accepted values

The value for this HTTP cookie must be taken from the browser. The calling program must request this cookie and pass its value to the Web Calendar.

---

Parameter

SocketPath

Description

Use the directory path to your socket file (IPC_DIR in your Apache httpd.conf) followed by the name of the socket file (SOCKET_FILE).

Required for URL

No.

Required for command line

No.

Accepted values

Any valid directory path.

Output

In URL-based sign-in mode

A successful sign-in returns 4 cookies set on the user's browser: preSign, ssnInfo, viewid and pref.

The user is sent to the value defined in succ_redirect_url; if the parameter is not provided, the user is redirected to the normal Agenda View.

A failed sign-in sends the user to fail_redirect_url; if the parameter is not provided, an error message is displayed on the screen.

To avoid service errors and other problems:

• Make sure the values for succ_redirect_url and fail_redirect_url are not blank
• Make sure each value contains //

In command-line sign-in mode

Quiet sign-in can also be called from the command line, with arguments passed in the same format as with an http "get" method.

A successful sign-in returns 4 cookies to standard output: pref, ssnInfo, viewid and preSign. The exit status will be returned to the calling process. A 0 exit status indicates a successful sign-in; any other value indicates an error.