Login
Most users of an application created with Aware IM need to log in before they can use it. The exception to this are “guest users” who do not need to log in – these users however are always assigned the Guest access level, which is normally heavily restricted, so not many operations are available to such users (see Predefined Access Levels). Guest users may register themselves with the system if the system has been configured to allow this (to configure such an operation a menu type of the “Register User” type has to be defined and made available to a “guest” user – see Operations). Another exception are users logging in through LDAP/Active Directory – see the Using LDAP/Active Directory for Login section for more details.
As explained in the Access Level section the system administrator must create instances of the user object before any users can log in. Once this is done the users log into the system by pointing their Internet browser to one of the system’s URL’s.
These URL’s have the following format:
BaseURL/action?param1=value1¶m2=value2¶m3=value3...
Where BaseURL is the address of the Aware IM server. For a local machine installation it is usually http://localhost:8080/AwareIM; action is a login option-dependent operation; param1=value1 – zero or more name=value parameters, depending on the login option.
The table below presents a summary of the supported login options. The following sections describe each option in detail.
| Type | Action | Business space | Login name | Password | Testing mode |
|---|---|---|---|---|---|
| Guest entry | logonGuest.aw | Param | N/A | N/A | No |
| Full login, interactive (old UI) | logonAdmin.html | UI | UI | UI | UI |
| Full login, interactive (new UI) | logonAdmin.jsp | UI | UI | UI | UI |
| Full login, parameterised | logonOp.aw | Param | Param | param | param |
| Simple login, default business space (old UI) | logon.html | Default | UI | UI | No |
| Simple login, default business space (new UI) | logon.jsp | Default | UI | UI | No |
| Simple login with the “forgotten password” link, default business space | logon2.html | Default | UI | UI (with “forgot your password?” link) | No |
| Simple login, custom business space | logonOp.aw | Param | UI | UI | No |
| Invoke “forgotten password” functionality | logonFp.aw | Param | N/A | N/A | N/A |
The following table lists the URL parameters that can be optionally added to the logonGuest.aw and logonOp.aw URL’s. For example:
logonOp.aw?domain=CRM&userName=admin&password=password&testingMode=false
| URL parameter name | Value | Comments | |
|---|---|---|---|
| 1 | domain | Name of the business space | Instructs the system to login into the specified business space. |
| 2 | userName | Login name of the user | Instructs the system to use the specified name rather than take it from the user interface. |
| 3 | password | Password of the user | Instructs the system to take the specified value rather than take it from the user interface. |
| 4 | testingMode | true or false | If the value is “true” the login will be into the test database. |
| 5 | logonPage | Name of the logon page to use | This can be used to in logonOp.aw to indicate a page to be displayed. For example, logonOp.aw?domain=CRM&logonPage=logon2.html will display a page with “forgotten password” link |
| 6 | perspective | Name of the visual perspective | Instructs the system to display a particular visual perspective, rather than the default one, upon user login. It can be used to bring the user to a specific section of the system, rather than the default page (see Visual Perspective). |
| 7 | firstCommand | The command to execute after the startup | The command is assumed to be in the following format: commandName,parameter Where commandName is the name of the Javascript function that can be invoked from links (see Links to Aware IM Operations) and the parameter is a combination of parameters to the Javascript function separated by the comma symbol. For example, firstCommand=editObject,MyObject,256 This will invoke editing of the object with the name MyObject and id 256 |
| 8 | dynamic | True | If this parameter is specified Aware IM will allow to directly enter the system without logging in if the current browser already has an active session. In this case you do not need to specify userName and password parameters |
| 9 | captcha | true | If this parameter is specified the login form will include “captcha” – the user will have to enter characters displayed by a random image. This is a standard protection against robots. For example:logonOp.aw?domain=CRM&captcha=trueThis will load the page logon_captcha.html. This page is fairly basic. You can edit it to add your own style, logo etc |
| 10 | e | All the above parameters encrypted using the ENCRYPT_B64 function | This parameter should be used if you don’t want users to see values of other parameters, for example, password object ID’s etc. In this case you can encrypt all parameters and then use the encrypted string as a value of the “e” parameter, for example:DISPLAY URL ‘localhost:8080/AwareIM/logonOp.aw?e=ENCRYPT_B64(‘domain=MyBusinessSpace&userName=john&password=123’) |
Examples of typical URL’s:
Show a dialog to enter user name and password. Once the user enters the values the system will log into the default business space in the regular mode using the specified credentials
Show a dialog to enter user name and password. Once the user enters the values the system will log into the specified business space (CRM) in the regular mode using the specified credentials
Log into the CRM business space in the regular mode without showing a dialog. Use “admin” as user name, “password” as password.
Show a dialog to enter business space, user name, password and testing mode. Once the user enters the values the system will log into the specified business space in the specified mode using the specified credentials
Enter the default business space as a guest user
Enter the CRM business space as a guest user
Invoke a process that handles “forgotten password” functionality. Can be used in links on custom login forms.
note
Login parameter tables above do not include login options for Aware IM mobile applications. For details how to login to the mobile applications see “Aware IM for Mobile Devices”Handling Login and Logout Events
It may be necessary for a system to execute certain rules when a new user logs in or out the application. For example, the system might collect the statistics of how many users are online or how many people have been using the system.
To handle login and logout events the configurator needs to define a special login notification or logout notification and attach rules to these notifications – see Handling Login Events and Handling Logout Events.