File Formats 
The file format determines what data is saved to the data files, and in what format.
The file format is a string with the following grammar:
Element |
Definition |
File Format |
<ELEMENT> * |
ELEMENT |
<OPCODE> | <LITERAL> | <SPECIAL_CHAR> |
OPCODE |
%O<OpCode>[(<Parameter>)]% See below for a list of valid opCodes and their parameters. |
LITERAL |
, | : | ; |
SPECIAL_CHAR |
%S<Special character code>% See below for a list of valid special character codes. |
OpCodes and Parameters
OpCodes return information about the portal request, or the iView/page and portal component that were run in response to the request.
Some opCodes require one or more parameters, which are specified in parentheses immediately following the opCode, without quotation marks. Multiple parameters are separated by a comma.
The following opCodes return information derived directly from the request:
Code |
Description |
rfo.rh()<header name> |
Value of the request header specified in the <header name> parameter. For example, the opCode rfo.rh(Content-Type) returns a string similar to application/x-www-form-urlencoded. |
rfo.hrh()<header name> |
Hashed value of the request header specified in the <header name> parameter. |
rfo.an |
Portal application of the portal component triggered by the request. |
rfo.cn |
Portal component triggered by the request. |
rfo.in |
Name of iView triggered by the request. |
rfo.pu |
PCD URL of the iView triggered by the request. |
rfo.hpu |
Hashed value of the PCD URL of the iView triggered by the request. |
rfo.ct |
Indicates whether a page or iView was triggered by the request. Returns either page or iView. |
rfo.up(<namespace>,<property name>) |
Value of the user property as specified by the namespace and property name attributes, where the namespace attribute is optional. If no namespace is added, the default UME namespace is used. |
rfo.un |
Name of the logged-in user. |
rfo.hun |
Hashed value of the name of the logged-in user. |
rfo.ut |
Type of user, either authenticated (n) or anonymous (a). |
rfo.sid |
HTTP session ID. |
rfo.qs |
Query string of the URL that triggered the request. |
rfo.hqs |
Hashed value of the query string of the URL that triggered the request. |
rfo.bt |
Browser type. |
rfo.uid |
A unique ID for the portal request, which can be used to correlate the current request record with a record for the same request in a different data collector file. |
rfo.st |
Indicates whether the iView/page is embedded in a page (child) or not embedded in a page (root). |
The following opCodes return information not derived from the request:
rfo.np |
Navigation path of the iView/page. The path is the navigation node name of the iView/page. |
rfo.sh |
Server host name. |
rfo.sp |
Server port. |
rfo.nid |
Node ID. |
rfo.t(<time pattern>)<time zone> |
Current time when request was made, in the specified format and time zone. See Time Pattern and TimeZone. |
adc.pt |
Time to process the request, in milliseconds. |
Special Character Codes
The following are valid special characters:
Character Code |
Description |
nl |
new line |
dq |
double quote |
sq |
single quote |
bs |
backspace |
tab |
tab |
Time Pattern
The time pattern is a string that is similar to the pattern used for the java.text.SimpleDateFormat class, and is made up of the following characters:
Symbol |
Description |
y |
Year |
M |
Month in Year |
w |
Week in year |
W |
Week in month |
D |
Day in year |
d |
Day in month |
F |
Day of week in month |
E |
Day in week |
a |
AM/PM |
H |
Hour in day (0-23) |
k |
Hour in day (1-24) |
K |
Hour in am/pm (0-11) |
h |
Hour in am/pm (1-12) |
m |
Minute in hour |
s |
Second in minute |
S |
Millisecond |
z |
Time zone |
A time pattern may contain any separator character except the following: % ( ) , { }
Time Zone
The time zone is a string with the following grammar:
Element |
Definition |
Time Zone |
GMT<SIGN><HOURS>:<MINUTES> |
SIGN |
+ | - |
HOURS |
<DIGIT> | <DIGIT><DIGIT> |
MINUTES |
<DIGIT><DIGIT> |
DIGIT |
[0-9] |
For example, GMT+2:00 is a valid time zone.
Example
For example, the following is a valid file format:
%Orfo.t(d-MMM-yyyy kk:mm:ss,z)%%Stab%%Orfo.un%%Stab% %Orfo.rh(Content-Type)%%Snl%
The format writes the following for each portal request:
The time of the request, in the given format
A tab character
The user who was authenticated for the request
A tab character
The value for the Content-Type request header
A new line character