2. Requirements

Before starting an installation, in-advance planning is recommended. Refer to the Promptar Server Setup Guide for general planning. Regarding Asterisk integration specifics, the following elements should be collected before starting:

No changes to Asterisk’s dial plan are required for most functionality.

2.1. General

Promptar AMI Connector runs on both Linux and Windows operating systems. The technical requirements are outlined in the following table:

Linux Windows

Operating System

RHEL 5 or later

32/64 bit

Windows Server 2003 SP2 or later

32/64 bit

Available RAM

64 MB

64 MB

Disk Space

50 MB

50 MB

Notes:

  • Promptar is 32 bit software. If you’re targeting 64 bit Linux, 32 bit software dependencies must be installed; these are described below in 64 Bit Linux Requirements.
  • Promptar Server and connectors are packaged in RPM format for Linux installation and are tested and supported on RHEL or equivalent distributions, like CentOS. If you require, we know Promptar to successfully run on top of distributions like Debian or Ubuntu; in those cases, a special support agreement may be delivered.
  • Both RAM requirements and disk space requirements may grow depending on the complexity of the installation and on the implemented logging policies; the specified requirements are adequate for typical installations.

64 Bit Linux Requirements

To ensure Promptar Server and connectors run on 64 bit Linux installations, a few 32 bit packages need to be installed. Before any 32 bit package installation, ensure your system is fully up to date by running:

# yum update

For 64 bit CentOS 5, install 32 bit zlib and its dependencies by running:

# yum install zlib.i386

For 64 bit CentOS 6 or 7, install 32 bit zlib and its dependencies by running:

# yum install zlib.i686

2.2. Connector Specific

In addition to the requirements listed above, Promptar AMI Connector requires:

  • TCP connectivity to the Asterisk Manager Interface of your Asterisk based PBX.
  • You are running Asterisk versions between 1.4, 1.6, 1.8, 10 or 11 [3]
  • That the AMI user has, at least, the following permissions in Asterisk’s manager.conf [4] configuration file:
[promptar]
secret = <your-secret>
read = system,call,agent,user
write = system,call,agent,command,originate,reporting
  • If you want to be able to detect call hold/resume events to SIP based channels/extensions, please ensure you have the following setting in Asterisk’s sip.conf under the [general] section:
callevents = yes
  • If any of your channels/extensions is a member of an Asterisk queue, you will need to ensure that each queue you want events for, includes the following setting:
eventwhencalled = yes

2.3. Limitations

Current Asterisk and Promptar combined software versions have the following limitations:

  • Regarding call control from within the Promptar Desktop Client:

    • Call hold/resume is not possible since it is not natively supported by Asterisk without requiring dial plan changes. It is, however, detected and signaled by the client if you hold/resume the call on your phone device.
    • Assisted call transfers are only supported on Asterisk versions 1.6 and above; earlier Asterisk versions do not support remote controlled assisted transfers without dial plan changes.
  • Current Promptar AMI connector logs in to AMI over a non-encrypted network connection; you may want to take extra care in keeping that connection protected and private.
  • The Promptar AMI Connector has been extensively tested in a multitude of Asterisk systems and across multiple versions. As of this writing, however, very little testing has been performed on top of BRIstuff [5] patched Asterisk systems. We confirm that these systems display inconsistent behaviors that negatively impact Promptar’s integration. So far, these have been mitigated by implementing a few workarounds. In the future such workarounds may or may not be easy to keep without affecting the standard Asterisk integration code.



[1] In common terms, this is the number you dial internally to reach that particular extension/phone/device.

[2] SIP/2301, DAHDI/8 and IAX2/johnny are examples for the channel technologies supported by this connector.

[3] There’s preliminary support for Asterisk 12 and 13 in place, so it is reasonable to explore and see if it works for your particular environment.

[4] Some products do not provide access to Asterisk configuration files but allow you to achieve the required settings in some other way. Please refer to your product’s documentation or contact us for guidance.

[5] BRIstuff is a set of patches on top of Asterisk and associated software products. It was commonly used throughout Europe in the mid/late-2000s in supporting ISDN BRI interfaces. As far as we can tell its deployments have become rarer in the recent years.