Realm Accounting Settings

Click "+" button to add a server from the list of configured RADIUS servers. Click "-" to remove a server from the list.

Click Logged Status Types to select what type of accounting packets should ClearBox forward to a target server. At least one should be selected.

Click Proxy Policy to bring up the proxy filtering dialog. It defines the rules applied to attributes and their values in the packets being forwarded to a remote RADIUS server. You may add or remove attributes, change them or their values.

Changes in the forwarded request packet. This list displays the policies for the packets forwarded to a remote server.

Click '+' near the list to add a new rule.

Select Add this attribute to add a new RADIUS attribute to the request packet. Select an attribute from the list and type in its Value.

Select Remove this attribute to make ClearBox remove the specified RADIUS attribute from a request packet, if it's present there. Select an attribute from the list and type in its Value. If Value is an empty string, all attributes with the specified name and any value will be removed.

Select Change this attribute to to make ClearBox replace one RADIUS attribute in a request packet with another, if it's present there. Select the source attribute from the list and type in its Value. If Value is an empty string, all attributes with the specified name will be replaced. Select the destination attribute and its value.

Say, you've selected 'Change this attribute to', selected 'Service-Type' as a source attribute with empty 'Value' field, selected 'Service-Type' as a destination attribute and typed 'Framed' in the 'Value' box. This will make ClearBox always change any value of the Service-Type attribute to Service-Type=Framed being sent in Access-Request forwarded to a remote RADIUS server.

Note that ClearBox doesn't send a request to all the servers from the list simultaneously, rather it uses them in turn when some remote server didn't reply appropriately several times (see retransmission parameters).

Process forwarded packets locally. When this option is turned on, ClearBox both forwards accounting requests and process them locally if any of Log packets to database and Log packets to file options are turned on.

You may set up one of two possible logging types: via a SQL command or through declaring RADIUS attributes-to-database fields mapping. The latter option is useful when no data transformation is needed while the first option is useful when stored procedures or functions are invoked. Note that sequence of several queries may be issued in the latter case.

Data source ID. Select one from the list of configured data sources.

Click Logged Status Types to select what type of accounting packets should ClearBox log to a database. At least one should be selected.

Select Use commands option to insert accounting data via one or several SQL commands. A command should include INSERT or UPDATE SQL statements as it should not return any values. Each command is placed on the new line in the edit box, so no command string should contain line breaks. Besides, depending on the data source type, commands may be placed on one line and separated by a semicolon (;).

You may use the special keys $u, $r, $c, $n, $f in a command to substitute user name, realm, etc. from a request packet. Besides these keys, you may insert attribute values from an accounting request packet into the command string. Read more about it.

Sample command: <INSERT INTO ACCOUNTING(User, Duration, IPAddress) values('$u', {Session-Time}, '{Framed-IP-Address?0.0.0.0}')>

Cisco-specific attribute-value pairs are handled correctly.

Select Insert attributes to specify the list of attributes from the request to be logged into a database table specified in the Table name box.

Click "+" button to add new attribute to the list. In the opened dialog select an attribute name that is logged to the database, specify Database field name to which attribute is bound, then select database field type - either literal or numeric. You may define the Default value which is used when a specified attribute is not present in an accounting request.

NOTE: Currently several realms cannot have separate setting for file logging. That means that the settings of last realm in the list overrides those set by previous realms configuration.

Select one of these two types, then click Logging Options to set them up.

The following settings have common meaning for both Livingston and CSV formats:

File name [Mandatory]. This parameter sets the path and name of the log file (without file extension). It may be a fully-qualified path (e.g. 'c:\Logs\accounting') or may start with the dot and slash (.\), then it's created in the same folder with the server module (e.g. '.\accounting'). This file name is appended with a suffix depending on Rollover selection or on Name pattern. See their description below.

File name extension. This optional parameter specifies the extension appended to the file name. If it's empty, then log file has no extension.

Rollover. This parameter defines how often should ClearBox Server switch to a new log file.

Rollover selection	Description	Suffix mask
None	ClearBox never uses rollovers and always logs data into the same file.	No suffix is used
Hourly	ClearBox creates a new log file hourly (e.g. 18:00, 19:00,...)	yyyyMMddHH
Daily	ClearBox creates a new log file on every day midnight	yyyyMMdd
Weekly	ClearBox creates a new log file on the midnight of every first day of the week (Sunday or Monday, depending on the system regional settings).	yyyyMMdd
Monthly	ClearBox creates a new log file on every first day of the month.	yyyyMM
On file size	ClearBox creates a new log file when existing file exceeds its size limit set by the Maximum size limit parameter.	yyyyMMddHH

All characters used in suffixes and name patterns and having the special meaning are described here.

As you see, the suffix depends on Rollover selection. The actual values are substituted in the suffix mask described above and are appended to File name. You may change the default suffix specifying your own in the Name pattern box. Thus if File name is ".\acctlog_", File name extension is "txt", Rollover mode is "Daily" and Name pattern parameter is empty, then ClearBox will create a new log file in the same folder with the server executable module with names acctlog_20031015.txt on October, 15, then acctlog_20031016.txt on October, 16, etc.

Name pattern. You may customize the mask of the suffix appended to the file name. You may use any symbols allowed in file names, while these symbols have special meaning and are replaced by the actual values in server run time.

Maximum file size. This parameter is used when On file size is selected as Rollover mode. ClearBox Server creates a new log file when the current log file size exceeds this limit.

Auto flush data. Check this option on to make the server write data to the disk immediately on receiving. Turning flushing on may decrease the performance slightly but prevents possible loss of data.

The following settings are specific to CSV format:

Place attribute names in the first line of each file. Check this option to write logged attribute names at are logged, in the first line of each newly-created file. This may be useful when exporting a log file to some spreadsheet to make columns named automatically.

Write names of numeric attributes if possible. Some RADIUS attributes, such as Service-Type, a numeric by themselves but have human-readable aliases for their values. For example, Service-Type=Framed is equal to ServiceType=2. Check this option on to write string aliases of such attributes.

Delimiter. Specifies a character (exactly one) which separates values of attributes in a log file.

Click "+" button to add an attribute name to the list of logged attributes. Use Move Up and Move Down buttons to change the order of attributes as they will appear in log file in this order. Besides RADIUS attributes you may add these pseudo-attributes:

Date - current date in format MM/dd/yyyy (Month/Day/Year).
Time - current time in format Hours:Minutes:Seconds
@username - username after all transformations.
@realm - current realm name.
@time - current date and time ('Date' and 'Time' combined together.
@client - IP address of the RADIUS request sender.