|
|
Alias Tell A Friend
Documentation
| [logging] |
| name |
active |
|
description |
Specifies whether the tell-a-friend
form activity must be logged. |
|
mandatory |
parameter : yes, value : yes |
| format |
- |
| value
list |
'true' or 'false'. Any other value
than 'true' is considered as 'false'. |
|
example |
active = true |
| usage |
1. When set to true, each time a
user successfully submits the form, an entry containing the
following information:
a. date of submission.
b. time of submission.
c. URL of the refered link.
d. IP address of the visitor submitting the tell-a-friend form.
e. the email address of the visitor submitting the tell-a-friend
form.
is appended to a log file named<path>/<YYYYMM>_usage.log
where :
a. <path> is the value provided in the [logging]/path parameter.
b. YYYY is the current Year on a four digit format e.g. 2005.
c. MM is the current Month on a two digit format e.g. 02 for
February.
2. When set to 'false', no logging occurs. |
| [logging] |
| name |
path |
|
description |
Specifies the path where the <YYYYMM>_usage.log
file must be stored. |
|
mandatory |
parameter : yes, value : no |
| format |
a full or relative (compared to the
Alias Tell-A-Friend script location) path to
a directory. |
| value
list |
- |
|
example |
path = ./ would store the file in
the current directory i.e. the directory where the Alias
Tell-A-Friend script is located. |
| usage |
1. If the [logging]/active
parameter is set to 'true', each time a user successfully submits
your tell-a-friend form, a record is appended to the log file
named <YYYYMM>_usage.log located in the <path> folder. Refer to the [logging]/active parameter description for further details on
logging. |
| [logging] |
| name |
separator |
|
description |
specifies the record separator to
be used in the log file. |
|
mandatory |
parameter : yes, value : yes |
| format |
- |
| value
list |
'lf' or 'crlf'. Any other value
than carriage return (cr, ascii code 13) or carriage return + line
feed (lf, ascii code 10) will be defaulted to 'lf'. |
|
example |
separator = lf |
| usage |
1. Each line in the log file <path>/<YYYYMM>_usage.log
is separated by lf or crlf |
<Previous Page> <Next Page>
|
|
|