Configuration CSV Files

The Comma Separated Values (CSV) file is a text format file supported by spreadsheet applications. You can import a CSV file to the Oracle Enterprise Communications Broker that contains its configuration, or you can export the current configuration on the Oracle Enterprise Communications Broker to the CSV file. Also, you can upload parts of your Oracle Enterprise Communications Broker configuration separately, such as users, dial plans and routes.

In the CSV file format, each row is defined on its own line and each column is separated by a comma.

You can create your own CSV configuration files, but be aware of the following rules for proper formatting.

Empty lines are ignored.
If an entry contains a comma, enclose it in quotes to prevent it from being treated as a separator.
The first non-empty line must be the keyword “object:”, followed by the configuration object name that is being configured (shown below as “sip-interface”).
```
object:sip-interface
```
The second non-empty line must be the parameter names of the object(s) to be configured, each parameter name in its own column. This row defines the “labels” for each column for the subsequent rows. Only the attributes you want defined need to be present. You can specify the parameter names in any order, but the data in subsequent rows must be consistent with the “labels” that you define in this row.
```
state,realm-id,description
```
The third non-empty rows define instances (values) for the configuration object, each instance in its own column. In the following example, the third line defines a new sip-interface with state “enabled”, realm-id “public”, and description “public SIP interface”. These values are based on the “labels” defined in the second row.
```
enabled,public,public SIP interface
```
On all subsequent rows, you can define any number of instances.
The next row with an “object” keyword selects a new configuration object that is based on the previous object. You continue to input the data for this object according to the rules stated above. The following example shows a “sip-port” object added that is related to the sip-interface object.
```
object:sip-port
address,port,transport-protocol
192.168.1.1,5060,UDP
192.168.1.1,5061,TCP
```
In the previous example, “sip-port” is a sub-object of “sip-interface” that creates new sip-ports from the last sip-interface instance (of realm-id “public”).
Note that the Description field displays all text as one continuous line, unless you insert line breaks. When you want to insert line breaks in the Description field, for example between sentences that you want displayed on separate lines, do the following:
- From the GUI, in the Description field of a Configuration object, add Line1 to the end of the line where you want the first break to occur. Add Line2 to the end of the next line where you want a break to occur, and so on.
- In a .csv configuration file, add \010Line1 to the end of the line where you want the first break to occur. Add \010Line2 to the end of the next line where you want a break to occur, and so on.

To create a CSV file that contains system configuration, do the following:

Open an application that supports a CSV file.
In the first row, first column, enter “object:” followed by a configuration object you want to import.object:sip-interface
In the second row, and each in its own column, enter the parameter names of the objects to be configured. state,realm-id,descriptionstate,realm-id,description
In the third row, and each in its own column, enter the instances (values) for the configuration objects.enabled,public,public SIP interface
In subsequent rows, define additional instances (values), as needed.
In the next empty row, first column, enter another object if needed, related to the first object (sip-interface).object:sip-port
Repeat steps 3 through 5 for this object.
Save the file as a .CSV.
Upload the configuration file using the upload button from the applicable dialog. (For example, upload a CSV file of users from the User database.)

Caveats surrounding the creation of CSV configurations include:

Files are written to the volatile directory of the file system on the system. For the Acme Packet 4500, this is the “/ramdrv/” directory. For the appliance and virtual machines, it is the “/var/” directory.
Import and export occurs to and from the editing configuration.
All error messages are printed to the screen, where the command was issued. Line numbers are provided with the error when possible.
Objects and attributes cannot be set to instances (values) that are not allowed. For example, you cannot set an IP address to "enabled". Parsing continues normally after this error.
If an object cannot be written (i.e. key field is missing), then that object is discarded and parsing continues as normal.
The import is additive. Each object that is imported is expected to be new to the configuration. If there is already an object with the same key present, it generates an error 409 and is discarded. Parsing continues as normal after the error.