You can upload the following file types from your local server or PC to the Oracle Enterprise Communications Broker (ECB).

1. Access File Management: System tab, File Management.
2. On the File management page, select the type of file you want to upload.
3. In the Name column, select the file you want to upload.
4. Click Upload.
5. In the Upload file dialog, do the following:
   1. Click Browse.
   2. Select the file that you want to upload.
   3. Optional. For the Backup configuration file, select Restore the configuration after upload to apply a previous backed up configuration file immediately to the after the upload is complete.
   4. Optional. For the Local Subscriber Table file type, select Activate the LST file after upload to apply the LST upon upload.
   5. Optional. For the SPL Plug-in file type, select Activate the SPL file after upload to apply the SPL file upon upload.
   6. Click Upload.

Use this procedure to download a file from the Oracle Enterprise Communications Broker (ECB).

1. Access File Management: System tab, File Management.
2. On the File Management page, select the type of file you want to download from the File type list.
3. Place your cursor on the row of the file that you want to download.

   Note:

   For Log file types, you can select multiple log files to download, or place a checkmark in the box to the left of the Name column heading to select all log files to download. When downloading multiple log files, the File Management GUI compresses the files into one .tar file and downloads that file to your local server or PC.
4. Right-click the selected row, and click Download.
5. Do one of the following:
   • Click Open With and select the application to open the file.
   • Click Save File to save the file to your local server or PC.
6. Click OK.
   The system downloads the file to the folder on your local server or PC where your Browser sends all downloads (typically your “Download” folder) or opens (decompresses) the file type on your local server or PC (typically in the “Download” folder).

The following information describes the procedure and conditions for deleting a file from the Oracle Enterprise Communications Broker (ECB).

1. Access File Management: System tab, File Management.
2. From the File Management list, select the type of file that you want to delete.
3. Put your cursor in the row of the file you want to delete, and right-click.
   Note: If the GUI does not display a menu upon right-click, use the Delete All control located above the list of files.
4. Click Delete. The system displays following message.
   Are you sure you want to delete the file?
5. Click Delete.

You can back up a configuration file from the Oracle Enterprise Communications Broker (ECB) to your local server or PC. Back up allows you to save configurations that you can restore to the ECB at a later time.

1. Access File Management: System tab, File Management.
2. Select a file from the list in the table.
3. Click Backup.
4. Click OK.
   The system adds the file to the Backup Configuration table.

You can restore a backed up configuration file to the Oracle Enterprise Communications Broker (ECB).

1. Access File Management: System tab, File Management.
2. On the File Management page, select Backup Configuration.
3. Select a back up, and right-click.

   Note:

   Restore activates only when you select a back up file.
4. Click Restore.
   The GUI displays a confirmation dialog.
5. Click Restore.
   The system downloads the back up file to the ECB. The ECB re-boots and restores the configuration from the back up file.

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

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.

• The ECB ignores empty lines.
• 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 state the operation to perform, which can be ADD, MODIFY, or DELETE.

  operation: ADD

• The third non-empty line must state the parameter name of the object to be configured, and each parameter name must be 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 fourth 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
  operation:ADD
  address,port,transport-protocol
  192.168.1.1,5060,UDP
  192.168.1.1,5061,TCP

• In the preceding 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.

Caveats

• 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.

When you want to automatically update selected configuration objects on the Oracle Enterprise Communications Broker (ECB), you can enable the system to periodically check for updates and automatically upload the CSV configuration file. Within the CSV file, you can specify the operation that you want the ECB to perform upon upload, such as add, modify, and delete data. The supported configuration objects include Agents, Dial Plan, Users, and Routing.

When enabled, the ECB checks /code/csv every two minutes for a new file and uploads it to the ECB. (The time interval is not configurable.)

When preparing the CSV file for upload, you specify each object and operation that you want the ECB to act on.

The following example shows the first three lines of the CSV file format:

object:user-number
operation:ADD/MODIFY/DELETE
AOR,number-or-pattern,description,dialing-context,agent,policy,tags

123@oracle.com,555[2000-3999],APAC,Server,

The ECB uses only one CSV file at a time as the source file, but the file can contain multiple objects and multiple operations. The following example shows a CSV file with multiple objects, operations, and parameter data:

object:user-number
operation:MODIFY
AOR,number-or-pattern,description,Dialing-context,agent,policy,tags
123@oracle.com,555[2000-3999],APAC,Server,

object:dialing-context
operation:ADD
Name, geographic location, description, country code, outside line prefix, Dial patterns, remove prefix, pattern, description, country code, replacement prefix, replacement uri, go to context
APAC.Nepal,CALA.Uraguay,EMEA.Andorra

object:policy
operation:DELETE
Name, description, name, contains codecs, codec condition, time condition, next hop compare condition, contains codecs, missing codecs, name, days, start time, end time, name, next hop compare mode, name, routing mode, name redirect to agent, hairpin signaling, name, egress number translation mode, number of digits for n digit dialing, prepend calls on egress, name, ignore constraints, name, header name, dialing ccontext, result store, new value, name, display name
<policy name>, next hop compare condition, time condition

object:session-agent
operation:ADD
hostname,ip-address,port,state,RURI-with-Hostname,app-protocol,app-type,transport-method,TLS-profile,realm-id,egress-realm-id,description,source-context,egress-uri-mode,egress-number-translation-mode,number-of-digits-for-n-digit-dialing,prepend-prefix-on-egress,outbound-translate-from-number,tags,carriers,allow-next-hop-lp,associated-agents,stop-recurse,constraints,max-sessions,max-inbound-sessions,max-outbound-sessions,max-burst-rate,max-inbound-burst-rate,max-outbound-burst-rate,max-sustain-rate,max-inbound-sustain-rate,max-outbound-sustain-rate,min-seizures,min-asr,session-max-life-limit,time-to-resume,ttr-no-response,in-service-period,burst-rate-window,sustain-rate-window,req-uri-carrier-mode,proxy-mode,redirect-action,loose-routing,send-media-session,response-map,ping-method,ping-interval,ping-send-mode,ping-all-addresses,ping-in-service-response-codes,out-service-response-codes,load-balance-dns-query,options,spl-options,media-profiles,in-translationid,out-translationid,apply-outbound-manipulation-on,trust-me,request-uri-headers,local-response-map,ping-to-user-part,ping-from-user-part,in-manipulationid,out-manipulationid,manipulation-string,manipulation-pattern,p-asserted-id,trunk-group,max-register-sustain-rate,early-media-allow,invalidate-registrations,rfc2833-mode,rfc2833-payload,codec-policy,enforcement-profile,early-media-inhibit,enable-OPTIONS-ping,ldap,additional-target-group,fork-group,refer-call-transfer,refer-notify-provisional,reuse-connections,tcp-keepalive,tcp-reconn-interval,max-register-burst-rate,register-burst-window,sip-profile,sip-isup-profile,kpml-interworking,precedence,monitoring-filters,session-recording-server,session-recording-required,hold-refer-reinvite,send-tcp-fin,sip-recursion-policy,sm-icsi-match-for-invite,sm-icsi-match-for-message
Client,1.1.1.1,1234,enabled,disabled,SIP,,UDP,,ecb,,,,no-conversion,E164,4,,disabled,,,enabled,,,disabled,0,0,0,0,0,0,0,0,0,5,0,0,0,0,0,0,0,None,,,enabled,enabled,,,0,keep-alive,disabled,,,hunt,,,,,,next-hop-only,disabled,,,,,,,,,,,0,,disabled,none,0,,,disabled,disabled,,,1,disabled,none,NONE,none,0,0,0,,,inherit,0,,,disabled,disabled,disabled,,,
 

When the ECB discovers a new CSV configuration file in /code/csv, it creates a log message and a temporary copy of the existing file before uploading the new file. Upon successful upload, the system creates an audit entry, deletes the temporary file, and moves the original file to an archive folder in the same location you specified for the source CSV file. The ECB retains the last 10 successfully uploaded CSV files.

Should an error occur during the upload, the ECB creates a message in the error log, moves the file to an error folder, generates a trap ( SAVE_CSV_CONFIG_FAIL_TRAP), and raises an alarm in the Alarms dialog on the GUI. (Under Notifications.) The log notes errors for improperly formatted files and inaccessible files. The ECB puts the error log in the same location as the CSV file (/code/csv). The ECB retains the last 10 unsuccessfully uploaded CSV files.

To enable automatic CSV file uploads, you enable the service in system config. See "Configure Automatic CSV Configuration File Uploads."