4. Minimal Configuration

The recommended first step in configuring Promptar AMI Connector focuses on the essentials and verifies its basic operation. It consists of setting up a small subset of extensions, validating two fundamental aspects in the setup:

4.1. Sample Configuration File

The installation procedure created one sample configuration file in the platform dependent configuration directory: it is named prptAMI.conf.sample and contains multiple comments and examples.

Start by copying the prptAMI.conf.sample file to prptAMI.conf.

4.2. Editing the Configuration File

The configuration file is an .INI like file and should be edited with a regular text editor. Since we’re starting off with the sample configuration and it includes several pre-defined, commented out settings, the majority of the work will be going through it uncommenting and adjusting the appropriate ones for the environment.

Open the prptAMI.conf file for editing and scroll down to the [log] section. You should find the following:

[log]

; Recommended configuration
; -------------------------
; type = file
; file = /var/log/promptar/prptAMI.log
; file = C:/Program Files/Promptar AMI Connector/log/prptAMI.log
; file = C:/Program Files (x86)/Promptar AMI Connector/log/prptAMI.log
; file.rotate.when  = 1 midnight
; file.rotate.count = 7
; level = warning

Uncomment the lines starting with type, file and level, depending on whether you’re on a Linux or Windows host; pay particular attention to the line starting with file, defining the path of the log file. This configuration ensures daily log file rotation, keeping 7 days worth of history. For different policies refer to the comments preceding these lines.

 

Continue scrolling down to the [ami] section, skipping the commented out [network] section. The sample configuration includes a few settings which should be changed, so that the connector can establish its AMI session with your Asterisk system:

[ami]

address          = 127.0.0.1
port             = 5038
user             = username
pass             = usersecret
reconnectAttempt = 20
version          = 1.1
  • Use your Asterisk system’s IPv4 or hostname for address, instead of 127.0.0.1.
  • Probably you won’t need to change the port setting as this is Asterisk’s standard port for AMI.
  • Update user and pass with the username and secret you have setup in Asterisk’s manager.conf.
  • Set version to 1.0 if connecting to Asterisk 1.4 or earlier; leave it at 1.1, if connecting to Asterisk 1.6, 1.8, 10 or 11 [6].

 

Further down, in the [pbx-features] section, set call.join to no if using Asterisk 1.4 or earlier:

[pbx-features]

call.initiate   = yes
call.redirect   = yes
call.join       = yes
voicemail       = no

 

Scroll down to the [extensions] section and add one line per extension in the format:

<extension> = <context>

Then, further down, in the [channels] section, add one line per extension in the format:

<channel> = <extension>

 

EXAMPLE

Consider that, while planning, the following data was collected as directed by the Requirements Section [7].

User ID User Name Promptar Extension Asterisk Channel Asterisk Context

ann.ash

Ann Ash

2201

SIP/0004f2e7a359

national

bernard.bell

Bernard Bell

2202

SIP/a44c119e5aa9

national

Based on this, the resulting [extensions] and [channels] sections would be:

[extensions]

2201 = national
2202 = national

[channels]

SIP/0004f2e7a359 = 2201
SIP/a44c119e5aa9 = 2202

 

Minimal configuration is now complete. The connector operation should now be verified with test calls, along with the Promptar Server, Client and other components in the environment.



[6] Preliminary support for Asterisk 12 and 13 is in place; even though these releases use AMI 2.0, for now you can leave version at 1.1.

[7] For completeness and integration with Promptar Server configuration, user information is included even though it is not needed here.