Automatically Upload Updated CSV Configuration Files

When you want to automatically update selected configuration objects on the Oracle Enterprise Communications Broker (OECB), 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 OECB 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 OECB checks /code/csv every two minutes for a new file and uploads it to the OECB. (The time interval is not configurable.)

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

For each object in the CSV file, the first three lines of the file format include the following information:

object—Specify the object you want the OECB to act on. Valid values: Agents, Dial Plan, Users, and Routing.
operation—Specify the operation to perform. Valid values: ADD, MODIFY, or DELETE. If you do not specify an operation, the system defaults to ADD-MODIFY.
parameters—A system provided list of all of the parameters for the object. The system can perform the specified operation on any of the parameters listed.

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

In the fourth line, you begin listing the parameter data to ADD, MODIFY, or DELETE. For example:

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

The OECB 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,,,

Note:

The OECB also supports the older CSV file format that does not provide the add, modify, delete, and automatic upload operations.

When the OECB 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 OECB retains the last 10 successfully uploaded CSV files.

Should an error occur during the upload, the OECB 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 OECB puts the error log in the same location as the CSV file (/code/csv). The OECB retains the last 10 unsuccessfully uploaded CSV files.

Note:

The OECB does not allow you to manually launch an upload during the automatic upload operation, and the system does not provide a way to queue a manual upload to launch when the automatic upload finishes. You must wait until the automatic upload finishes to launch a manual upload.

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