Policy Server Guides › Policy Server Configuration Guide › Authentication Schemes › HTML Forms Authentication Schemes › HTML Forms Authentication Templates › Special Name/Value Pairs

Special Name/Value Pairs

SiteMinder's FCC can interpret a number of special name/value pairs (@directives) that invoke non-standard processing. The following are the special @directives and their meanings:

• username

  Name to use to as the login user name.

• password

  Password to use to perform the login.

• target

  Resource to access after login.

• smheaders

  Colon separated list of SiteMinder response names to include in the namespace. The colon separated list must contain an entry for each header that you want to include in a SiteMinder transaction. For example, if you want to pass the value of header1 and header2 as part of a SiteMinder transaction, the following would be included in your FCC:

  @smheaders=header1:header2

• smerrorpage

  If there is an error on a Post to the custom form, the user's browser will be redirected to this page. If this special value is not specified in a .fcc file, SiteMinder uses the .unauth file associated with the .fcc file as the error page.

• smretries

  Specifies the maximum number of login attempts allowed. If you set this directive to 0, the number of retries is unlimited. If you set the number to 1 or greater, that is the number of retries allowed.

  Note: If users log in using a POST to an .fcc form, it may appear that the user is given additional attempts to log in beyond the value of the smretries directive. However, the user is allowed access only if valid credentials are entered in the number of attempts specified by smretries.

• smpasswordfcc

  Determines whether data is posted from the Password Services FCC file or from a different FCC file.

  Default: 1

  Important! It is recommended that the default value remain unchanged. The SafeWord authentication scheme may not work properly if the default value is changed.

• smusrmsg

  Text that describes why the user was challenged / failed to login.

• smauthreason

  Reason code associated with a login failure.

• smsavecreds

  Set to Yes to save user credentials in a persistent cookie on the user's browser.

• smsave

  Colon separated list of names to be saved as persistent cookies.

• save

  Another name for smsave.

• smtransient

  Colon separated list of names to be saved as transient cookies.

• smagentname

  Specifies the agent name that will be supplied to the Policy Server when a user enters credentials and submits the form for authentication. If the Agent parameter, FCCCompatMode=NO, you must specify a value using this directive.

• smlogout

  Logs a user out of SiteMinder, similar to logoffuri. By placing @smlogout=true in your .fcc template, the FCC will log a user out of SiteMinder and redirect the user to the target. As such, the @smlogout directive is typically used in conjunction with the @target directive (@target=<yoururlhere>).

• urlencode(name)

  Replaced by the URL encoded value of the named variable.

• urldecode(name)

  Replaced by the URL decoded value the named variable.

  Note: The "sm" prefix for name/value pairs is reserved for additional special names required by SiteMinder. When creating names for your login page do not use the "sm" prefix.