Fortinet Document Library

Version:

Version:

Version:

Version:

Version:


Table of Contents

FortiVoice Phone System Administration Guide

Configuring Station Messaging Detail Record (SMDR)

FortiVoice SMDR component provides FortiVoice call detail records to third party devices on certain communication and format protocols based on third party's device requirements. For example, Property Management System (PMS) uses the FortiVoice SMDR to manage hotel guest call charges.

Caution

Configuring FortiVoice SMDR requires advanced SMDR knowledge and should be performed by advanced administrative users and field engineers.

This section contains the following topics:

Configuring SMDR settings

Configure SMDR Setting to enable the FortiVoice communications with third party devices.

To configure SMDR settings

  1. Go to Log & Report > SMDR Setting > SMDR.
  2. Select Enabled to activate the FortiVoice SMDR function.
  3. Select a format protocol for the FortiVoice communications with the third party devices.

    For information on format, see Setting SMDR formats.

  4. For Port, enter the port number that connects to the third party devices.
  5. For Max clients, enter the number of third party devices to which the FortiVoice unit provides SMDR. The range is 1-10.
  6. For Trusted hosts, enter the IP address and netmask of the third party device.

    If you have multiple third party devices, you may enter up to 10 trusted hosts.

  7. Click Apply.

Setting SMDR formats

To communicate with third party devices, the FortiVoice SMDR format needs to be defined based on the device requirements so that the devices can recognize the FortiVoice SMDR.

The FortiVoice unit provides example XML SMDR format files. You can modify the files to meet with your needs. The following is an example format file:

Example SMDR format file

An SMDR format is composed of parts as shown in the above example:

  • smdr_type id: the name of the SMDR format file.
  • discard_filter: the data you do not want to send to the third party devices.
  • formatting: the body of the SMDR format file in the form of field values (for example, <field name="AnswerTime"/>), plus the field lengths (for example, length="13") required by the third party devices.

To set a SMDR format

  1. Go to Log & Report > SMDR Setting > SMDR Format.
  2. Click New.
  3. Click FortiVoice SMDR field to display the complete list of FortiVoice SMDR field names.
  4. Enter a name and description for the format.
  5. For Content derived from, select an existing format as a base for configuring the new format.
  6. In the Content field, follow the SMDR format requirements of the third party device and the example format file above, choose the displayed FortiVoice field names you need to set your SMDR format.
  7. Click Create.
  8. If errors appear, click SMDR XML Types to view the Fortinet SMDR format file and correct your format file accordingly.

Configuring Station Messaging Detail Record (SMDR)

FortiVoice SMDR component provides FortiVoice call detail records to third party devices on certain communication and format protocols based on third party's device requirements. For example, Property Management System (PMS) uses the FortiVoice SMDR to manage hotel guest call charges.

Caution

Configuring FortiVoice SMDR requires advanced SMDR knowledge and should be performed by advanced administrative users and field engineers.

This section contains the following topics:

Configuring SMDR settings

Configure SMDR Setting to enable the FortiVoice communications with third party devices.

To configure SMDR settings

  1. Go to Log & Report > SMDR Setting > SMDR.
  2. Select Enabled to activate the FortiVoice SMDR function.
  3. Select a format protocol for the FortiVoice communications with the third party devices.

    For information on format, see Setting SMDR formats.

  4. For Port, enter the port number that connects to the third party devices.
  5. For Max clients, enter the number of third party devices to which the FortiVoice unit provides SMDR. The range is 1-10.
  6. For Trusted hosts, enter the IP address and netmask of the third party device.

    If you have multiple third party devices, you may enter up to 10 trusted hosts.

  7. Click Apply.

Setting SMDR formats

To communicate with third party devices, the FortiVoice SMDR format needs to be defined based on the device requirements so that the devices can recognize the FortiVoice SMDR.

The FortiVoice unit provides example XML SMDR format files. You can modify the files to meet with your needs. The following is an example format file:

Example SMDR format file

An SMDR format is composed of parts as shown in the above example:

  • smdr_type id: the name of the SMDR format file.
  • discard_filter: the data you do not want to send to the third party devices.
  • formatting: the body of the SMDR format file in the form of field values (for example, <field name="AnswerTime"/>), plus the field lengths (for example, length="13") required by the third party devices.

To set a SMDR format

  1. Go to Log & Report > SMDR Setting > SMDR Format.
  2. Click New.
  3. Click FortiVoice SMDR field to display the complete list of FortiVoice SMDR field names.
  4. Enter a name and description for the format.
  5. For Content derived from, select an existing format as a base for configuring the new format.
  6. In the Content field, follow the SMDR format requirements of the third party device and the example format file above, choose the displayed FortiVoice field names you need to set your SMDR format.
  7. Click Create.
  8. If errors appear, click SMDR XML Types to view the Fortinet SMDR format file and correct your format file accordingly.