10.02.2013 Views

IBM Tivoli Access Manager for e-business: WebSEAL Administration ...

IBM Tivoli Access Manager for e-business: WebSEAL Administration ...

IBM Tivoli Access Manager for e-business: WebSEAL Administration ...

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Macro<br />

Description<br />

%CERTAUTHN%<br />

Substitution<br />

variable<br />

used<br />

to<br />

alter<br />

login<br />

<strong>for</strong>m.<br />

When<br />

authentication<br />

method<br />

valid,<br />

<strong>WebSEAL</strong><br />

removes<br />

the<br />

variable.<br />

When<br />

authentication<br />

method<br />

invalid,<br />

<strong>WebSEAL</strong><br />

comments<br />

out<br />

the<br />

macro.<br />

Used<br />

in<br />

tokenlogin.html,<br />

certlogin.html,<br />

and<br />

stepuplogin.html.<br />

%ERROR%<br />

The<br />

hard-coded<br />

error<br />

message<br />

returned<br />

from<br />

<strong>Tivoli</strong><br />

<strong>Access</strong><br />

<strong>Manager</strong>.<br />

Same<br />

as<br />

%ERROR_TEXT%.<br />

Both<br />

exist<br />

<strong>for</strong><br />

backwards<br />

compatibility.<br />

%ERROR_CODE%<br />

The<br />

numeric<br />

value<br />

of<br />

the<br />

error<br />

code.<br />

%ERROR_TEXT%<br />

The<br />

text<br />

associated<br />

with<br />

an<br />

error<br />

code<br />

in<br />

the<br />

message<br />

catalog.<br />

Same<br />

as<br />

%ERROR%.<br />

Both<br />

exist<br />

<strong>for</strong><br />

backwards<br />

compatibility.<br />

%FAILREASON%<br />

Error<br />

message.<br />

%HOSTNAME%<br />

Fully<br />

qualified<br />

host<br />

name.<br />

%HTTP_BASE%<br />

Base<br />

HTTP<br />

URL<br />

of<br />

the<br />

server<br />

″http://host:tcpport/″.<br />

%HTTPS_BASE%<br />

Base<br />

HTTPS<br />

URL<br />

of<br />

the<br />

server,<br />

″https://host:sslport/″.<br />

%LOCATION%<br />

Contains<br />

the<br />

URL<br />

to<br />

which<br />

the<br />

client<br />

is<br />

being<br />

redirected.<br />

Sent<br />

only<br />

in<br />

redirects<br />

%METHOD%<br />

The<br />

HTTP<br />

method<br />

requested<br />

by<br />

the<br />

client.<br />

%PROTOCOL%<br />

The<br />

client<br />

connection<br />

protocol<br />

used.<br />

Can<br />

be<br />

http<br />

or<br />

https.<br />

%REFERER%<br />

The<br />

value<br />

of<br />

the<br />

referer<br />

header<br />

from<br />

the<br />

request,<br />

or<br />

″Unknown″,<br />

if<br />

none.<br />

%REFERER_ENCODED%<br />

A<br />

URI<br />

encoded<br />

version<br />

of<br />

the<br />

referer<br />

header<br />

and<br />

macro.<br />

%STEPUP%<br />

A<br />

message<br />

specifying<br />

the<br />

step-up<br />

level<br />

required.<br />

Only<br />

sent<br />

when<br />

returning<br />

a<br />

step-up<br />

login<br />

<strong>for</strong>m<br />

%TOKENAUTHN%<br />

Substitution<br />

variable<br />

used<br />

to<br />

alter<br />

login<br />

<strong>for</strong>m.<br />

When<br />

authentication<br />

method<br />

valid,<br />

<strong>WebSEAL</strong><br />

removes<br />

the<br />

variable.<br />

When<br />

authentication<br />

method<br />

invalid,<br />

<strong>WebSEAL</strong><br />

comments<br />

out<br />

the<br />

macro.<br />

Used<br />

in<br />

tokenlogin.html,<br />

certlogin.html,<br />

and<br />

stepuplogin.html.<br />

%URL%<br />

The<br />

URL<br />

requested<br />

by<br />

the<br />

client.<br />

%URL_ENCODED%<br />

A<br />

URI<br />

encoded<br />

version<br />

of<br />

the<br />

URI<br />

and<br />

macro<br />

%USERNAME%<br />

The<br />

name<br />

of<br />

the<br />

logged<br />

in<br />

user.<br />

(See<br />

also<br />

“Customizing<br />

login<br />

<strong>for</strong>ms<br />

<strong>for</strong><br />

reauthentication”<br />

on<br />

page<br />

206.)<br />

<strong>WebSEAL</strong><br />

provides<br />

a<br />

configuration<br />

file<br />

that<br />

specifies<br />

how<br />

the<br />

data<br />

string<br />

specified<br />

by<br />

macro<br />

strings<br />

in<br />

inserted<br />

into<br />

<strong>WebSEAL</strong><br />

HTML<br />

pages.<br />

The<br />

default<br />

setting<br />

specifies<br />

that<br />

data<br />

is<br />

inserted<br />

in<br />

UTF-8<br />

<strong>for</strong>mat.<br />

[content]<br />

utf8-template-macros-enabled<br />

=<br />

yes<br />

<strong>WebSEAL</strong><br />

HTML<br />

pages<br />

use<br />

a<br />

UTF8<br />

charset<br />

by<br />

default.<br />

If<br />

you<br />

modify<br />

charset<br />

to<br />

specify<br />

the<br />

local<br />

code<br />

page,<br />

set<br />

this<br />

entry<br />

to<br />

no.<br />

Note<br />

that<br />

this<br />

setting<br />

affects<br />

files<br />

located<br />

in<br />

the<br />

directories<br />

specified<br />

by<br />

the<br />

error-dir<br />

and<br />

mgt-pages-root<br />

(in<br />

the<br />

[acnt-mgt]<br />

stanza)<br />

configuration<br />

file<br />

entries.<br />

90<br />

<strong>IBM</strong><br />

<strong>Tivoli</strong><br />

<strong>Access</strong><br />

<strong>Manager</strong><br />

<strong>for</strong><br />

e-<strong>business</strong>:<br />

<strong>WebSEAL</strong><br />

<strong>Administration</strong><br />

Guide

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!