Overview

The Logon component allows you to create a form that is used to authenticate and log a user on to a BusinessObjects Enterprise session. The basic information required is a user name and password that can be entered in two separate input fields. The text on the user name and password input field labels can be customized with the userNameText and passwordText attributes.

In addition to the general attributes of the component, there are attributes that must be set to property classes.

• authentication attribute

The authentication attribute accesses instances of the AuthenticationProps class, which contains two properties: visible and text. By default, the visible property is set to true, and a user group alias input field is displayed on the form. This alias may be an Enterprise user group alias, or a third-party authentication provider such as Windows NT, Windows AD, or LDAP. The text on the authentication input field label can also be set with the text property. If the visible property is set to false, the authentication input field is not displayed.

• logoffButton and logonButton attributes

The logoffButton and logonButton attributes accesses instances of the SubmitButtonProps class, which contain properties for specifying how the logon and logoff button are displayed. The button that is displayed depends on the state of the component. These attributes operate in the same manner as the submitButton attribute, that is detailed in Common component attributes.

• system attribute

The system attribute accesses instances of the SystemProps class, which contains similar properties as the AuthenticationProps class. By default, the visible property is set to true, and a system input field is displayed on the form. This field is used to enter the name of the BusinessObjects Enterprise system to access. When the system input field is visible, you can set the readOnly property to determine how the contents of the input field are displayed. If set to true, the BusinessObjects Enterprise system name will be disabled and the field will not be editable by the user. If set to false, the user can edit the system name. The text on the system input field label can also be set with the text property. If the visible property is set to false, the system input field is not displayed.

Note:    For more information on property classes, see How do I use property classes in combination with JavaServer Faces Components for BusinessObjects Enterprise?

Event Handling

To enable the automatic event handling capabilities of the Logon component, set the autoHandleEvents attribute to true. When set to true, this attribute implements default behavior on action events that are triggered when the user interacts with the component. For example:

Event	Default Behavior
LogoffClicked	When the logoff button is clicked, the user is logged off BusinessObjects Enterprise.
LogonClicked	When the logon button is clicked, the authentication information specified in the component is submitted to BusinessObjects Enterprise and an attempt is made to log on.

If the autoHandleEvents attribute is set to false, these events will not be handled automatically. When autoHandleEvents is set to true, these events call the Logon component’s submit method, which implements the default functionality. If you set autoHandleEvents to false, you may write your own event handler that calls the submit method to capture these other events.

Data Binding

Use the identity attribute to bind an Identity bean to the Logon component. An Identity bean supplies the end user authentication credentials that are required to log on to a BusinessObjects Enterprise system.