Previous Topic: Event RedirectionNext Topic: Sending Mail


Generational & Other Automatic Redirection

Generational Redirects only apply to LDAP and ODBC User Directories.

Starting with Version 3.0, APS supports Generational Redirects. This type of redirect is distinctly different from the event redirects described in the previous section.

While Generational Redirects are not strictly in the purvey of APS, APS already has the infrastructure in place to provide this useful functionality.

Generational Redirects are redirections that are to be applied to the user base at least once. The generational nature is because there can be multiple generations for a specific URL, each user is required to "see" all known generations of that target.

Each generational redirect has a name that is used as a key to describe that redirect. Two typical uses of generation redirects might use PROFILE and LICENSE, in order to force each user to see the user profile and the on-line access agreement.

In addition to a name, each redirect also needs a generation, which is a number and a URL.

Generational Redirect

Default: none

Complexity Level: Advanced

When a user accesses a site, APS looks at values stored in the smapsGenerationalRedirects attribute of the user. This attribute is multi-valued (on LDAP) and will contain key/value pairs, such as:

LICENSE=2 <comment info, usually date & IP>
PROFILE=1 <comment info, usually date & IP>

APS compares the number associated with a specific key with the generation specified in the APS configuration file. If the number is less in the user record (or the key does not exist), the user will be redirected to the URL specified in the configuration file and the user's value for the smapsGenerationalRedirects attribute is updated with the new value.

Under normal conditions, only version 1 would ever be used. However, some sites might require, for example, that all users see an On-Line Access Agreement every time changes. In this case, merely update the version number in APS.cfg and all users will be sent to the associated URL (since new users have no value and existing users will have a stored generation of 1 instead of the new value, 2).

Unlike most settings in APS.CFG, all generational redirects will be processed, in the order in which they appear in the file.

Note that APS can only redirect the user to the URL, it cannot force the user to actually take an action once there.

APS will redirect the user to any applicable generational redirection pages after processing any applicable events. If multiple generational redirects are triggered, the user will be redirected to each, in the order that they appear in the APS.cfg file.

Generational Redirect=LICENSE=1 http://www.yoursite.com/Profile.jsp
Generational Redirect=PROFILE=1 http://www.yoursite.com/Profile.jsp
Message of the Day

Default: none

Complexity Level: Advanced

This setting will show the designated page to all applicable users the first (and only the first) time that they log in each day.

This setting uses the smapsGenerationalRedirects attribute to "remember" whether a user has been redirected on any given day, with a key value of APS_MOTD. The generation number will be the current date.

The user will be redirected to the message of the day after all APS events and all applicable generational redirects.

If multiple Message of the Day settings exist, the last which applies will be used.

Message Of The Day = http://www.yoursite.com/motd.htm
Message Of The Day ={@Employees} http://www.yoursite.com/EmpMotd.htm
Message Of The Day ={@Customers} http://www.yoursite.com/CustMotd.htm
Always Redirect

Default: none

Complexity Level: Advanced

This setting will show the designated page to all applicable users every time that the user authenticates.

This setting does not use the smapsGenerationalRedirects attribute.

If multiple Always Redirect settings exist, the last that applies will be used.

Always Redirect=http://www.yoursite.com/notices.htm
Always Redirect={@Employees} http://www.yoursite.com/EmpNotices.htm
Always Redirect={@Customers} http://www.yoursite.com/CstNotices.htm
Always Redirect AZ

Default: none

Complexity Level: Advanced

This setting will show the designated page to all applicable users every time that the user accesses a page. This setting should be used very carefully, since users will be unable to access all or part of your site.

It is often used to temporarily present a page to users that are trying to access part of your site that is being upgraded.

This setting does not use the smapsGenerationalRedirects attribute.

If multiple Always Redirect settings exist, the last that applies will be used.

This setting requires the use of the AZRedirect Active Expression.

Always Redirect AZ = {NOT @Tester AND %Realm="AppA"} http://www.yoursite.com/offline.htm