Alpaca 10.6

Alpaca: CDR Processing Guide

The CDR Processing feature allows Alpaca Users to view, monitor, and run reports on BroadWorks call processing data. The feature requires that the AlpacaRemote is set up on the BroadWorks Application Server(s) and configured to process CDRs. Alpaca Remote 2.1.0+ is required to process CDRs.

Migrating from Call Reporter to Alpaca

The call data from Call Reporter can be imported into the Alpaca database.

Requirements

  • Alpaca 9.5.0+
  • Access to the mongodump tool on the old Call Reporter/ECGCDRLoader server.
  • Access to the mongorestore tool on the Alpaca server.
  • Alpaca Remote is not currently sending CDRs to Alpaca.

Process

CallReporter/ECGCDRLoader Server

  • Steps:
    1. Shutdown CallReporter - service callreporter stop
    2. Shutdown ECGCDRLoader - service ecgcdrloader stop
    3. Dump users database collection
      • mongodump --db=ecgcdrloader --collection=users --archive=users_export.gz --gzip
    4. Dump calls database collection
      • mongodump --db=ecgcdrloader --collection=calls --archive=calls_export.gz --gzip
    5. Transfer users_export.gz and calls_export.gz to the Alpaca Server.

Alpaca Server

  • Steps:

    1. Shutdown Alpaca - alpacactl stop
      • Also verify that Alpaca Remote is currently shutdown before proceeding.
    2. Restore users database collection
      • mongorestore --host=localhost:27017 --nsFrom="ecgcdrloader.users" --nsTo="alpaca.users_temp" --archive=users_export.gz --gzip
      • Note that the host here localhost:27017 is the default, this may need to be updated depending on your setup.
    3. Restore calls database collection
      • mongorestore --host=localhost:27017 --nsFrom="ecgcdrloader.calls" --nsTo="alpaca.calls_temp" --archive=calls_export.gz --gzip
      • Note that the host here localhost:27017 is the default, this may need to be updated depending on your setup.

    4. Configure cluster mapping in Alpaca configuration located at /etc/alpaca/eureka/cloud-config/alpaca-server-prod.yml

      • This mapping is used to map a Call Reporter Cluster to an Alpaca Cluster. If Call Reporter has a clusters ' Prod' and 'Lab1' and Alpaca has equivalent clusters 'Production' and 'Lab1', the configuration would be as follows
         cdrprocessor:
     callReporterClusterToAlpacaClusterMap:
       Prod: Production
       Lab1: Lab1

5. Start Alpaca - `alpacactl start`
6. Once Alpaca is started, an `ImportCallReporterCallsToAlpacaTask` will be launched. Once that task is complete,
   all data from Call Reporter will have been imported and converted to the Alpaca format.
7. Start Alpaca Remote on the application server(s).

Configuration

See the CDR Processing guide for configuration information.

Licensing

The CDR Processing feature requires that the CDR/CallReporter module is licensed. An Alpaca license is not required to use the CDR Processing feature. If Alpaca is not licensed but CallReporter is, Alpaca will be put in CallHistory-only mode, and only those features will be exposed. Contact your ECG account representative for more licensing information.

Concepts

When licensed, the Call History and Call Summary features are available to Alpaca Users that are assigned a role that includes the Call History authority.

Call History

Call History provides an easy-to-read interface to inspect BroadWorks calls.

Call History is available at the following levels:

  • Cluster
  • Service Provider/Enterprise
  • Group
  • User
  • Auto Attendant
  • BroadWorks Anywhere Portal
  • Call Center
  • Collaborate Bridge
  • Find-Me/Follow-Me
  • Hunt Group
  • Instant Group Call
  • Meet-Me Conferencing Bridge
  • Paging Group
  • Voice XML

The following fields are available in the Call History interface:

  • User - The associated BroadWorks user. This links to the user (if they still exist) in Alpaca.
  • Number - The user's number.
  • Call Direction - Originating or Terminating
  • Calling Number - The number that called.
  • Called Number - That number that was dialed (if available)
  • Caller Id - The caller id field from the CDR (if available)
  • Call Category - The call category from the CDR. Options: Emergency, Interlata, Intralata, International, Local, National, Private (intra-group), Other
  • Answered - Whether the call was answered.
  • Redirected - True if the redirecting reason in the CDR is not empty.
  • Start Time - The time the call started.
  • End Time - The time the call ended.
  • Additional Details - Additional details can include any custom fields that are configured, the group, the service provider, and the duration.

Each field that is not an additional detail can be sorted and filtered upon.

Export

The Call History data within the table can be exported to .xlsx format by using the table's download button. The exported file will include all calls that match the current filters that are in use.

Call Summary

The Call Summary page provides call statistics based off of provided filters. The filters are as follows:

  • Call Range - The date range that the calls fall within.
  • Number Query - Limits to calls that include the number sequence provided.
  • Account Code Query - Limits to calls that were placed with the provided account code.
  • Call Category - Limits to calls that match the selected call categories.
  • Include Originating - Results will include originating calls.
  • Include Terminating - Results will include terminating calls.
  • Include Un-Answered - If selected, un-answered calls will be included in the results. Otherwise, only answered will be included.
  • Inlcude Redirecting - If selected, redirected calls will be included in the results. Otherwise, only non-redirected calls will be included.

Note that at least Include Originating or Include Terminating must be selected, otherwise no data will be returned.

All search parameters are saved and will be automatically loaded the next time the page is visited.

Results

  • Totals
    • Originating Calls - The total number of originating calls that match the filters.
    • Terminating Calls - The total number of terminating calls that match the filters.
    • Total Calls - The total number of calls that match the filters (originating + terminating).
  • Group Summary (not available at user or service instance levels)
    • GroupId - The group.
    • Cumulative Minutes - Total number of minutes for all calls for the specific group that matches the filters.
  • Account Summary
    • Account Code - The account code. Blank for calls without an account code.
    • Cumulative Minutes - Total number of minutes for all calls placed with that account code that matches the filters.
    • Call Count - Total number of calls for the specified account that matches the filters.
    • Average Minutes - The average call duration for calls with the specified account code that matches the filters.
  • User Summary
    • User Number - The user's number.
    • User Id - The user that correlates to the call. This is a link if the user still exists.
    • Name - The user's name.
    • Originating Minutes - The total originating minutes for that user for calls that match the filters.
    • Originating Calls - The total originating calls for that user for calls that match the filters. Click this will redirect to that user's call history (with matching filters).
    • Terminating Minutes - The total terminating minutes for that user for calls that match the filters.
    • Terminating Calls - The total terminating calls for that user for calls that match the filters. Click this will redirect to that user's call history (with matching filters).
    • Average Minutes - The average call duration for that user for calls that match the filters.