This command allows
you to configure EDR file parameters.
Privilege:
Security Administrator,
Administrator
Syntax
file [ charging-service-name { include | omit } ] [ compression { gzip | none } ] [ current-prefix string ] [ delete-timeout seconds ] [ directory directory_name ] [ edr-format-name ] [ exclude-checksum-record ] [ field-separator { hyphen | omit | underscore } ] [ file-sequence-number
rulebase-seq-num ] [ headers ] [ name file_name ] [ reset-indicator ] [ rotation [ num-records number | time seconds | volume bytes ] ] [ sequence-number { length length | omit | padded | padded-six-length | unpadded } ] [ storage-limit limit ] [ single-edr-format ] [ time-stamp { expanded-format | rotated-format | unix-format } ] [ trailing-text string ] [ trap-on-file-delete ] [ xor-final-record ] +
default file [ charging-service-name ] [ compression ] [ current-prefix ] [ delete-timeout ] [ directory ] [ edr-format-name ] [ field-separator ] [ file-sequence-number ] [ headers ] [ name ] [ reset-indicator ] [ rotation { num-records | time | volume } ] [ sequence-number ] [ storage-limit ] [ time-stamp ] [ trailing-text ] +
default
Configures the default
setting for the specified keyword(s).
charging-service-name { include | omit }
Specifies to include/exclude
name of the charging service in the file name.
- include:
Include name of the charging service in the EDR file name.
- omit: Exclude
name of the charging service in EDR file name.
compression { gzip | none }
Specifies compression
of EDR files.
- gzip: Enables
GNU zip compression of the EDR file at approximately 10:1 ratio.
- none: Disables
Gzip compression.
current-prefix string
Specifies a string
to add to the beginning of the EDR file that is currently being
used to store EDR records.
string must
be an alphanumeric string of 1 through 31 characters.
Default: curr
delete-timeout seconds
Specifies a timeout
period (in seconds) when completed EDR files are deleted. By default, files
are never deleted.
seconds must
be an integer from 3600 through 31536000.
Default: Disabled
directory directory_name
Specifies a subdirectory
in the default directory in which to store EDR files.
directory_name must
be an alphanumeric string of 1 through 191 characters.
Default: /records/edr
edr-format-name
Specifies creation
of separate files for EDRs that have different formats. Name of
the EDR format is included in the file name.
exclude-checksum-record
When entered, this
keyword excludes the final record containing #CHECKSUM
followed by the 32-bit Cyclic redundancy check (CRC) of all preceding
records from the EDR file.
Default: Disabled
(inserts checksum record into the EDR file header)
field-separator [ hyphen | omit | underscore ]
Specifies the field
inclusion/exclusion type of separators between two fields
of EDR file name:
- hyphen:
Specifies to use “-” (hyphen) as the field separator.
- omit: Excludes
the field separator.
- underscore:
Specifies to use “_” (underscore) as
the field separator.
file-sequence-number
rulebase-seq-num
Specifies that the
file name sequence numbers must be unique per rulebase and EDR format name
combination.
headers
Includes a file header
summarizing the record layout.
name file_name
Specifies a string
to be used as the base file name for EDR files.
Default: edr
file_name must
be an alphanumeric string of 1 through 31 characters. The file name
format is as follows:
base_rulebase_format_sequencenum_timestamp
- base: Specifies
the type of record in file or contains the operator-specified string.Default: edr
- rulebase:
Specifies the name of the ACS rulebase. EDRs from different rulebases
go into different EDR files.
- format: Specifies
the name of the EDR format if single-edr-format is
specified, else the format field (and the trailing underscore) is omitted
from the file name.
- sequencenum:
This is a 5-digit sequence number to detect the missing file sequence.
It is unique among all EDR files on the system.
- timestamp:
Contains a timestamp based on file creation time in UTC time in
MMDDYYYYHHMMSS format.
EDR files that have
not been closed have a string added to the beginning of their filenames.
Filename for an EDR
file in CSV format that contains information for rulebase named rulebase1 and
an EDR schema named edr_schema1 appears
as follows:
edr_rulebase1_edr_schema1_00005_01302006143409
If the file name is
not configured the system will create files for EDRs/UDRs/FDRs
(xDRs) using the following template with limits to 256 characters:
basename_ChargSvcName_timestamp_SeqNumResetIndicator_FileSeqNumber
- basename:
A global-based configurable text string that is unique per system
that uniquely identifies the global location of the system running ACS.
- ChargSvcName:
A system context-based configurable text string that uniquely identifies
a specific context-based charging service
- timestamp:
Date and time at the instance of file creation. Date and time in
the form of “MMDDYYYYHHmmSS” where HH is a 24-hour
value from 00-23
- SeqNumResetIndicator:
A one-byte counter used to discern the potential for duplicated
FileSeqNumber with a range of 0 to 255, which is incremented by
a value of 1 for the following conditions:
- Failure of an ACS
software process on an individual PSC.
- Failure of the system
such that a second system takes over. For example, a backup or standby
system put in place according to Interchassis Session Recovery.
- File Sequence Number
(FileSeqNumber) rollover from 999999999 to 0
- FileSeqNumber:
Unique file sequence number for the file with 9 digit integer having
range from 000000000 to 999999999. It is unique on each system.
File name for a closed
xDR file in CSV format that contains information for ACS system xyz_city1 and
charging service name preapaid2 with
timestamp 12311969190000,
and file sequence number counter reset indicator to 002 for
file sequence number 034939002 appears
as follows:
xyz_city1_preapaid2_12311969190000_002_034939002
File name for a running
xDR file, not closed, in CSV format that contains information for the
same parameters for file sequence number 034939003 prefixed with curr_ and
appears as follows:
curr_xyz_city1_preapaid2_12311969190000_002_034939002
IMPORTANT:
When the "rulebase name" and "edr-format-name"
options are enabled through this file command,
if the "field-separator" value is "underscore" (default value) then,
in the filename, the fields Rulebase name and EDR format name will
be separated by "hyphen". If the "field-separator" value is "hyphen"
then, in the filename, the fields Rulebase name and EDR format name will
be separated by "underscore". This will ensure that the number of
the fields in the filename is not increased and does not affect
the backend billing system.
reset-indicator
Specifies inclusion
of the reset indicator counter value, from 0 through 255, in the
EDR file name, and is incremented (by one) whenever any of the following
conditions occur:
- An ACSMgr/SessMgr
process fails.
- A peer chassis has
taken over in compliance with our Interchassis Session Recovery feature.
- The sequence number,
see the sequence-number keyword,
has rolled over to zero.
rotation { num-records number | time seconds | volume bytes }
Specifies when to
close an EDR file and create a new one.
- num-records number:
Specifies the number of records that should be added to the file.
When the number of records in the file reaches the specified value,
the file is complete.number must
be an integer from 100 through 10240.Default: 1024
- time seconds:
Specifies the period of time (in seconds) to wait before closing
the EDR file and creating a new one.seconds must
be an integer from 30 through 86400.Default: 3600
- volume bytes: Specifies the
maximum size (in bytes) of the EDR file before closing it and creating
a new one.bytes must
be an integer from 51200 through 62914560.Note that a higher
setting may improve the compression ratio when the compression keyword
is set to gzip.
sequence-number { length length | omit | padded | padded-six-length | unpadded }
Specifies including/excluding
sequence number in the file name.
- length length: Includes
the sequence number with the specified length.length must
be the length of the file sequence number, with preceding zeroes,
in the file name, and must be an integer from 1 through 9.
IMPORTANT:
The length keyword
is applicable in both EDR and UDR modules. When applied in both
modules without the file
udr-seq-num configuration, the minimum among the two values
will come into effect for both the modules. With the file udr-seq-num keyword,
each module will use its own value of length.
- omit: Excludes
the sequence number from the file name.
- padded:
Includes the padded sequence number with preceding zeros in the
file name. This is the default setting.
- padded-six-length:
Includes the padded sequence number with six preceding zeros in
the file name.
- unpadded:
Includes the unpadded sequence number in the file name.
single-edr-format
Creates separate files
for EDRs having different formats.
Default: Disabled
storage-limit limit
Specifies deleting
files when the specified amount of space (in bytes) is used up for
EDR/UDR file storage RAM on packet processing cards.
IMPORTANT:
ASR 5000 and
ASR 5500: limit must
be an integer from 10485760 through 536870912. Default: 33554432
IMPORTANT:
The total storage
limit is 536870912 bytes (512 MB). This limit is for both UDR and
EDR files combined.
time-stamp { expanded-format | rotated-format | unix-format }
Specifies the timestamp
of when the file was created be included in the file name.
- expanded-format:
Specifies the UTC MMDDYYYYHHMMSS format.
- rotated-format:
Specifies the time stamp format to YYYYMMDDHHMMSS format.
- unix-format:
Specifies the UNIX format of x.y, where x is the
number of seconds since 1/1/1970 and y is the
fractional portion of the current second that has elapsed.
trailing-text string
Specifies the inclusion
of an arbitrary text string in the file name.
string must
be an alphanumeric string of 1 through 30 characters.
trap-on-file-delete
Instructs the system
to send an SNMP notification (starCDRFileRemoved) when an EDR/UDR
file is deleted due to lack of space.
Default: Disabled
xor-final-record
Specifies inserting
an XOR checksum (in place of the CRC checksum) into the EDR file header
if the exclude-checksum-record is
left at its default setting.
Default: Disabled
+
Indicates that more
than one of the keywords can be entered in a single command.
Usage:
Use this command to
configure EDR file characteristics.
Example:
The following command
sets the prefix of the current active EDR file to
Current:
file current-prefix Current
The following command
sets the base file name to
EDRfile:
file name EDRfile