The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Cisco SCA BB provides several types of CSV flat files. You can review and configure these files using third-party applications such as Excel.
This section describes the file formats of the CSV files created when exporting service configuration entities into CSV files. The same format must be used for importing such entities into service configurations.
For more information about exporting and importing service configuration entities, see the “Managing Service Configurations” section in the “Using the Service Configuration Editor” chapter of Cisco Service Control Application for Broadband User Guide.
Note There is no need to repeat the same values in subsequent rows of the CSV file. If a field is left empty in a row, the value of that field from the previous row is used.
This section consists of these sub-sections:
Lines in Service CSV files have the following fixed format:
The following is an example of a Service CSV file:
Lines in Protocol CSV files have the following fixed format:
One protocol can have multiple entries in the file (see the following example).
Port range has the format MinPort-MaxPort. For example, 1024-5000 means port 1024 to port 5000.
The following is an example of a Protocol CSV file:
Two formats—Standard and Easy—are available for Zone CSV files.
Lines in Zone CSV files in Standard format have the following fixed format:
Where IP range is an IP address in dotted notation, followed by a mask.
The following is an example of a Zone CSV file in Standard format:
Lines in Zone CSV files in Easy format have only Zone items.
The following is an example of a Zone CSV file in Easy format:
The format of Flavor CSV files depends on the flavor type.
Each line of every Flavor CSV files begins with the same three fields:
The formats of the CSV files of different flavors are described in the following sections.
The following is an example of a line from a Flavor CSV file:
For information on flavors, see the “Managing Flavors” section in the “Using the Service Configuration Editor: Traffic Classification” chapter of Cisco Service Control Application for Broadband User Guide.
Two formats—Standard and Easy—are available for HTTP URL CSV files.
Lines in HTTP URL CSV files in Standard format have the following fixed format:
The following is an example of an HTTP URL CSV file in Standard format:
Lines in HTTP URL CSV files in Easy format have a single URL format.
The following is an example of an HTTP URL CSV file in Easy format:
Two formats—Standard and Easy—are available for HTTP Referer CSV files.
Lines in HTTP Referer CSV files in Standard format have the following fixed format:
The following is an example of an HTTP Referer CSV file in Standard format:
Lines in HTTP Referer CSV files in Easy format have a single URL format.
The following is an example of an HTTP Referer CSV file in Easy format:
Lines in HTTP User Agent CSV files have the following fixed format:
Lines in HTTP Composite CSV files have the following fixed format:
Where HTTP_URL_name and HTTP_User_Agent_name are the names of existing flavors of types HTTP URL and HTTP User Agent, respectively.
Lines in RTSP User Agent CSV files have the following fixed format:
Lines in RTSP Host Name CSV files have the following fixed format:
Lines in RTSP Composite CSV files have the following fixed format:
Where RTSP_Host_Name and RTSP_User_Agent_name are the names of existing flavors of types RTSP Host Name and RTSP User Agent, respectively.
Lines in SIP Destination Domain CSV files have the following fixed format:
Lines in SIP Source Domain CSV files have the following fixed format:
Lines in HTTP Composite CSV files have the following fixed format:
Where SIP_Destination_Domain_name and SIP_Source_Domain_name are the names of existing flavors of types SIP Destination Domain and SIP Source Domain, respectively.
Lines in SMTP Host Name CSV files have the following fixed format:
Lines in ToS CSV files have the following fixed format:
This section describes the file formats of various subscriber CSV files used by the Cisco SCMS Subscriber Manager.
This section consists of these subsections:
For more information about these CSV file formats, see the following documents:
Some of the CSV files include a mappings field. This field can include one or more of the following values delimited by colons (“:”) or semicolons (“;”):
Note Specifying VLAN and IP mappings together in the same line is not allowed.
Lines in SCE Subscriber CSV files have the following fixed format:
The following is an example CSV file for use with the SCE CLI:
Lines in SCMS SM Subscriber CSV files have the following fixed format:
If no domain is specified, the default domain (subscribers) is assigned.
The following is an example CSV file for use with the SM CLI:
Lines in SCE Anonymous Group CSV files have the following fixed format:
If no subscriber-template-number is specified, the anonymous subscribers of that group use the default template (equivalent to using a subscriber-template-number value of zero).
The mapping between subscriber-template-number and package-id is defined in the SCE Subscriber Template CSV file, which is described in the “SCE Subscriber Template CSV File” section.
The following is an example of an anonymous group CSV file:
Lines in SCA BB Anonymous Group Import CSV files have the following fixed format:
The following is an example of an anonymous group CSV file for SCA BB:
Lines in Subscriber Template CSV files have the following fixed format:
Cisco SCA BB includes a default one-to-one mapping between package-id and subscriber-template-number for values from 0 to 199.
Subscriber-template-numbers can take values from 0 through 199. You can map more than one subscriber-template-number to the same package-id.
For more information about this file, see either the Cisco SCE 8000 10GBE Software Configuration Guide or the Cisco SCE 8000 GBE Software Configuration Guide.
This section describes the file formats of the CSV files created by adapters of the Cisco SCMS Collection Manager.
Each RDR is routed to the appropriate adapter—the CSV Adapter, the TA Adapter, or the RAG Adapter—converted, and written to a CSV file.
For more information about the Collection Manager and its adapters, see Cisco Service Control Management Suite Collection Manager User Guide.
By default, the CSV Adapter writes files to subdirectories of ~/cm/adapters/CSVAdapter/csvfiles, where each subdirectory name is the RDR tag of the RDR that generated the CSV file.
Each CSV file created by the CSV Adapter has a structure matching the RDR represented in the file. It is possible to include the SE IP (for example, record source) which generated the RDR in the CSV line. To turn this option on, edit the csvadapter.conf file and set the value of includeRecordSource property under [csvadapter] section to true.
The TA Adapter receives Subscriber Usage RDRs, aggregates the data they contain, and outputs statistics to CSV files. By default, these files are created once every 24 hours, at midnight.
The name of the CSV file is the date and time of its creation. The default format of the file name is yyyy-MM-dd_HH-mm-ss.csv (for example, 2005-09-27_18-30-01.csv). By default, the location of the CSV files is /cm/adapters/TAAdapter/csvfiles.
By default, the fields in each row of the CSV file are as follows:
Where subsID is the Subscriber ID and svcXY is the aggregated volume of metric Y for service X. (The N in svcN is the highest service number, which is the configured number of services minus 1.)
The combined volume is not stored in the CSV file, because it is easily obtained by adding the upstream and downstream volumes.
You can configure the adapter to insert a comment at the beginning of every CSV file. This comment contains a time stamp showing when the file was created, and an explanation of its format. By default, this feature is disabled. To turn on this option, edit the taadapter.conf file and set the value of the write_headers property under the [csv] section to true.
The RAG Adapter processes RDRs of one or more types and aggregates the data from predesignated field positions into buckets. When a RAG Adapter bucket is flushed, its content is written as a single line into a CSV file, one file per RDR, in the CSV repository of the adapter.
The name of the CSV file is the date and time of its creation. The default format of the file name is yyyy-MM-dd_HH-mm-ss.csv (for example, 2005-09-27_18-30-01.csv). By default, the CSV repository is flat (all CSV files in one directory), and located at /cm/adapters/RAGAdapter/csvfiles. Alternatively, you can configure the adapter to use a subdirectory structure. The CSV files are written to subdirectories of /cm/adapters/RAGAdapter/csvfiles, where each subdirectory name is the RDR tag of the RDR type that was written to this CSV file.
Each line written to the CSV file may have some synthesized fields added to it, such as time stamps of the first and last RDRs that contributed to this bucket and the total number of RDRs in this bucket. Other fields may be removed altogether. Fields in the output line that are not used for aggregation have values corresponding to the values in the first RDR that contributed to the bucket. However, the time stamp field that is prepended to the line in the CSV file has a value corresponding to the time stamp of the last RDR in the bucket.