| Oracle CorporateTime for the Web Administrator's Guide Release 3.1 |
|
The quiet mode sign-in is used to authenticate a user and save his or her session information on the browser. A service provider with many on-line activities (including Oracle 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 behavior 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 Oracle 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 Oracle CorporateTime for the Web before.
Parameter: localinfo
Description: The cookie pref is where Oracle CorporateTime for the Web maintains permanent user preferences. If local_cookie is set, Oracle CorporateTime for the Web 3.1 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.
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:
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.
Parameter: userid
Description: User ID of user. If it is not unique, an error will return and the module will send the user to fail_redirect_url (URL mode).
Required for URL: Yes
Required for command line: Yes
Accepted values:
String of size 4 to 64 characters. To change the default range for this value, consult the parameters in the [register_limits] section of webcal.ini.
Parameters:
pasword1
password2
Description: User's password must be encoded using the encode utility.
Example of how to encode the password test:
./encode test
%a3%bd%aa%ae
The two passwords must be identical. Empty passwords are invalid.
Required for URL: Yes
Required for command line: Yes
Accepted values: String of size 4 to 16 characters.
Parameter: quiet
Description: Used to indicate that the registration module should work in the background to register the provided user.
Required for URL: Yes
Required for command line: No. It is assumed to be always running in quiet mode.
Accepted values:
on (run in quiet mode)
off (do not run in quiet mode)
Parameter: email
Description: The user's e-mail address to be used in notification when creating and modifying calendar Entries.
Required for URL: No
Required for Command line: No.
Accepted values: Any string of 5 to 64 characters.
Parameter: email_hint
Description: The user's hint for the password.
Required for URL: No
Required for command line: No
Accepted values: Any string of 1 to 32 characters.
Parameter: lname
Description: User's last name
Required for URL: No
Required for command line: No
Accepted values: Any string of 1 to 40 characters.
Parameter: address
Description: User's address
Required for URL: No
Required for command line: No
Accepted values: Any string of 1 to 128 characters.
Parameter: city
Description: User's city
Required for URL: No
Required for command line: No
Accepted values: Any string of 1 to 32 characters
Parameter: state
Description: User's state
Required for URL: No
Required for command line: No
Accepted values: Any string of size 1 to 20 characters.
Parameter: zip
Description: User's ZIP code
Required for URL: No
Required for command line: No
Accepted values: Any string of 1 to 20 characters.
Parameter: country
Description: User's country code
Required for URL: No
Required for command line: No
Accepted values: Any string of 2 characters.
Parameter: dob
Description: User's date of birth
Required for URL: No
Required for command line: No
Accepted values: Any string of 6 characters in format MM/DD/YY.
Parameter: sex
Description: User's sex
Required for URL: No
Required for command line: No
Accepted values: Male or female
Parameter: global
Description: User can make Public Entries in his or her Calendar available to anyone.
Required for URL: No. The default is off.
Required for command line: No. The default is off.
Accepted values:
off (user cannot make Calendar global )
on (user can make Calendar global)
Parameter: public
Description: User can make Entries in his or her Calendar available to other users.
Required for URL: No. The default is off.
Required for command line: No. The default is off.
Accepted values:
off (user can publish Calendar)
on (user cannot publish Calendar)
Parameter: autologin
Description: User can sign in to the Web Calendar without providing user ID and password.
Required for URL: No. The default is off.
Required for command line: No. The default is off.
Accepted values:
off (disable automatic sign-in)
on (enable automatic sign-in)
Parameter: tz
Description: User's time zone
Required for URL: No. The default is the server's time zone.
Required for command line: No. The default is the server's time zone.
Accepted values: Acceptable timezone values are listed in timezone.ini.
Output:
To disable validation of user IDs during quiet registration, use the parameters provided in the [admin] section of webcal.ini.
In URL-based registration mode:
A successful registration sends the user to the value defined in succ_redirect_url; if the parameter is not provided, the user is redirected to the normal Calendar View.
A failed registration sends the user to fail_redirect_url; if the redirection parameter is not present, an error message is displayed on screen.
In command-line registration mode:
Quiet registration can also be called from the command line, with arguments passed in the same format as with an http "get" method.
A successful registration returns a 0 exit status; any other value indicates an error.
|
 Copyright © 1998, 2002 Oracle Corporation. All Rights Reserved. |
|