Fortinet black logo

FortiVoice Phone System Administration Guide

Submitting CDRs to a database

Copy Link
Copy Doc ID bd5a3cc8-fd65-11ec-bb32-fa163e15d75b:838837
Download PDF

Submitting CDRs to a database

If you have a remote third party database, you may submit the Call Detail Records (CDR) to the database. Each CDR contains the full life cycle of a call. Using the database’s interface, you can display and review the CDRs.

Note

To enable CDR submission, make sure to select Remote CDR name. For more information, see Setting up an IVR.

This section includes the following topics:

Configuring CDR submission

The Log & Report > CDR > Submit CDR submenu lets you configure sending CDR to a database. The configuration values should match those of the database server.

To submit a CDR

  1. Go to Log & Report > CDR > Submit CDR.
  2. Click New and configure the following:

    GUI field

    Name

    Enter a name for the configuration.

    Status

    Select to enable the configuration.

    Description

    Click to enter any notes you have for the configuration.

    Remote RESTful Server

    Configure the database to which CDRs are submitted. For more information, see Configuring RESTful service.

    Protocol

    Select the protocol used for information transmission between the FortiVoice unit and the database server.

    HTTP headers

    Select Click to edit to enter a HTTP header for sending information to the database server.

    HTTP timeout

    Enter the time allowed for the submission to be processed. The range is 1-60 minutes.

    Authentication

    None: Select to log onto the restful server without entering the user name and password.

    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    Password: Select to enter the user name and password for logging onto the restful server.

    • Username: Enter the login user name registered on the restful server.
    • Password: Enter the login password registered on the restful server.
    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    OAuth: Select to use Open Authorization to access the restful server without exposing your account credential.

    • Service format: Select Salesforce or other restful services configuration format.
    • Username: Enter the login user name registered on the restful server.
    • Password: Enter the login password registered on the restful server.
    • Login server: Enter the IP address of the restful server.
    • Client ID: Enter the consumer key from the restful server.
    • Client secret: Enter the consumer secret from the restful server. If you choose Salesforce as Service Format, enter the consumer key and the token from the server in the format of <consumer key><token>. For information on FortiVoice and Salesforce integration, see Integrating FortiVoice with Salesforce.
    • URL suffix: Enter the Salesforce object name, for example, /query/, and click Get Salesforce API URI to populate the Base URL field. Note the leading and trailing "/" must be entered before and after the object name.
      This option is only available if you choose Salesforce for Service format.
    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    Options

    Retry

    Set the retry times for CDR submission.

    Retry interval

    Set the time interval between submission retries.

    CDR template

    Click Edit to customize the default CDR submission template based on the requirements of the database server. Click OK when it is done.

    For more information, see Modifying CDR templates.

    CDR filter

    Choose or create a new CDR filter to screen CDRs submitted to the database. For more information, see Creating CDR filters.

    Custom value

    Click New to add a custom value (a token, for example) that is required by the database server for information exchange. Click Create.

  3. Click Create.

Modifying CDR templates

When configuring CDR submission, you need to customize the default CDR submission template based on the requirements of the database server.

To modify a CDR template

  1. Go to Log & Report > CDR > CDR Template.
  2. Select the default CDR template and click Edit.
  3. Modify the template and click OK.

Creating CDR filters

You can use filters to limit the amount of CDRs submitted to the database.

To create a CDR filter

  1. Go to Log & Report > CDR > CDR Filter.
  2. Click New.
  3. Enter a name for the filter.
  4. Using XML, enter the CDR filters based on the values you want, such as call queues or call IDs and so on.
  5. For Description, enter any notes you have for the filter.
  6. Click Create.

Submitting CDRs to a database

If you have a remote third party database, you may submit the Call Detail Records (CDR) to the database. Each CDR contains the full life cycle of a call. Using the database’s interface, you can display and review the CDRs.

Note

To enable CDR submission, make sure to select Remote CDR name. For more information, see Setting up an IVR.

This section includes the following topics:

Configuring CDR submission

The Log & Report > CDR > Submit CDR submenu lets you configure sending CDR to a database. The configuration values should match those of the database server.

To submit a CDR

  1. Go to Log & Report > CDR > Submit CDR.
  2. Click New and configure the following:

    GUI field

    Name

    Enter a name for the configuration.

    Status

    Select to enable the configuration.

    Description

    Click to enter any notes you have for the configuration.

    Remote RESTful Server

    Configure the database to which CDRs are submitted. For more information, see Configuring RESTful service.

    Protocol

    Select the protocol used for information transmission between the FortiVoice unit and the database server.

    HTTP headers

    Select Click to edit to enter a HTTP header for sending information to the database server.

    HTTP timeout

    Enter the time allowed for the submission to be processed. The range is 1-60 minutes.

    Authentication

    None: Select to log onto the restful server without entering the user name and password.

    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    Password: Select to enter the user name and password for logging onto the restful server.

    • Username: Enter the login user name registered on the restful server.
    • Password: Enter the login password registered on the restful server.
    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    OAuth: Select to use Open Authorization to access the restful server without exposing your account credential.

    • Service format: Select Salesforce or other restful services configuration format.
    • Username: Enter the login user name registered on the restful server.
    • Password: Enter the login password registered on the restful server.
    • Login server: Enter the IP address of the restful server.
    • Client ID: Enter the consumer key from the restful server.
    • Client secret: Enter the consumer secret from the restful server. If you choose Salesforce as Service Format, enter the consumer key and the token from the server in the format of <consumer key><token>. For information on FortiVoice and Salesforce integration, see Integrating FortiVoice with Salesforce.
    • URL suffix: Enter the Salesforce object name, for example, /query/, and click Get Salesforce API URI to populate the Base URL field. Note the leading and trailing "/" must be entered before and after the object name.
      This option is only available if you choose Salesforce for Service format.
    • URL: Enter the URL of the server hosting restful service.
    • SSL verification: Select if required.

    Options

    Retry

    Set the retry times for CDR submission.

    Retry interval

    Set the time interval between submission retries.

    CDR template

    Click Edit to customize the default CDR submission template based on the requirements of the database server. Click OK when it is done.

    For more information, see Modifying CDR templates.

    CDR filter

    Choose or create a new CDR filter to screen CDRs submitted to the database. For more information, see Creating CDR filters.

    Custom value

    Click New to add a custom value (a token, for example) that is required by the database server for information exchange. Click Create.

  3. Click Create.

Modifying CDR templates

When configuring CDR submission, you need to customize the default CDR submission template based on the requirements of the database server.

To modify a CDR template

  1. Go to Log & Report > CDR > CDR Template.
  2. Select the default CDR template and click Edit.
  3. Modify the template and click OK.

Creating CDR filters

You can use filters to limit the amount of CDRs submitted to the database.

To create a CDR filter

  1. Go to Log & Report > CDR > CDR Filter.
  2. Click New.
  3. Enter a name for the filter.
  4. Using XML, enter the CDR filters based on the values you want, such as call queues or call IDs and so on.
  5. For Description, enter any notes you have for the filter.
  6. Click Create.