4. Configuration

The recommended first step in configuring Promptar TAPI 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:

The general outline of the configuration procedure is described on the following table. Tasks should be completed left to right, as defined in the line describing your scenario:

scenario TSP TAPI Adapter TAPI Connector

Third-party TSP

TSP on server system

-

On server system

Multiple first-party TSPs on the server system

Multiple TSPs on server system

-

On server system

Single first-party TSP on multiple systems

TSP on each client system

On each system with TSP

On server system

4.1. TSP

Refer to your TSP’s documentation to complete its installation and setup as per your scenario.

4.2. TAPI Adapter

If your scenario is fully centralized, whether using one or more TSP instances, no particular configuration is needed for the adapter and you can continue on to the next section.

When working in a Single first-party TSP on multiple systems scenario, the distributed TSPs and TAPI Adapters must be setup before proceeding. For that, please:

  • Refer to your TPS’s documentation to complete its installation and setup across client systems.
  • Refer to Remote TAPI Adapter Setup section in the next chapter to complete the TAPI Adapter setup on each client system.

The remainder of this chapter describes the Promptar TAPI Connector configuration on the server system, common to all environments.

4.3. TAPI Connector

The installation procedure for Promptar TAPI Connector, creates one sample configuration file in the platform dependent configuration directory: it is named prptTAPI.conf.sample and contains, within itself, multiple comments and examples. Please take your time having a look at it.

Start by copying the prptTAPI.conf.sample file to prptTAPI.conf 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, most of the initial work will be going through it uncommenting the appropriate ones for the given environment.

 

prptTAPI.conf

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

[log]

; Recommended configuration
; -------------------------
; type = file
; file = C:/Program Files/Promptar TAPI Connector/Log/prptTAPI.log
; file = C:/Program Files (x86)/Promptar TAPI Connector/Log/prptTAPI.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 32 or 64 bit Windows host; pay particular attention to the lines starting with file, defining the path of the log file. The recommended configuration results in daily log file rotation, keeping 7 days worth of history. If you want to change these settings, please refer to the comments preceding these lines.

Continue scrolling down, skipping the optional [network] section and the subsequent [server], [tapi] and [pbx-features] sections. The defaults should be used at this stage [3].

The [extensions] section should now be filled-in with declarations for the Promptar extensions to be used, along with the associated TAPI lines: for each extension / TAPI line association, a new line should be added, formatted like:

<extension> = <tapi-line-name>

DYNAMIC LINE NAMES

 

When using a system that changes line names dynamically, the linenames.match setting in the [tapi] section can be set to regexp: this will interpret the configured <tapi-line-name> as a regular expression to be matched against existing TAPI line names. The default should be adequate for most scenarios, though. See the Fine Tuning section for more information.

To obtain a list of the TAPI lines available to the connector, run the following in a command line shell [4]:

> prptTAPI -x listlines

 

NOTES:

  • The command may take a while before producing output:

    • It may need to startup the Windows tapisrv which, in turn, will initialize each TSP.
    • The time it takes for each TSP to initialize can vary from near-immediate to one minute or more, in extreme cases; this depends exclusively on the TSP and associated phone system.
    • If using remote TAPI Adapters and TSPs, an additional delay may result: of generally less than 10 seconds.
  • Depending on the log configuration, in particular whether the file setting is already set or not, the output may include log lines.
  • If no output is produced, refer to the log file to understand the possible underlying motives:

    • Often, timeout.start needs to be set to a larger value in the [tapi] section of the configuration file.
    • Also, confirm the remote TAPI Adapter to TAPI Connector TCP connectivity is operational and that no firewall is preventing the connections between them.

Under normal conditions, the command will output the available TAPI lines, including a few standard ones provided by Windows itself. An example of the output, with no configuration in place and with no TSP installed, results in:

prptTAPI 30 com.promptar.prptTAPI-1.5.1 - no config file loaded - using defaults
AgileVPN
PPTP
RAS PPPoE Line
SSTP
WAN Miniport (L2TP)

 

NOTES:

  • The first line is a log line [5].
  • The remaining 5 lines are TAPI line names. These are the standard ones available on a freshly installed Windows 2008 R2 server.
  • If one or more TSPs are installed and operational, you should obtain the associated lines. These often include one or more of the following: extension number, directory name and/or phone system name. Please, refer to the TSP’s documentation to help you in identifying such TAPI lines.
  • If using remote TAPI Adapters and TSPs, you may get duplicate line warnings (either referring to the standard Windows ones or when using first party TSPs reporting a common name):

    • These are to be expected: Promptar TAPI Connector will see all lines from all systems.
    • Filtering can be put in place such that no such duplicates are visible centrally.
    • Alternatively, lines from remote adapters may be prefixed with configurable keys.

 

Completing the Promptar TAPI Configuration is, thus, a matter of adding extension / TAPI line association declarations in the [extensions] section and saving the configuration file:

  • For the <extension> side of the declaration, the number people are accustomed to dial on their phones should be used.
  • For the <tapi-line-name> use the associated TAPI line name, obtained from the command above, including any spaces in the middle but excluding leading and trailing ones [6] [7].

 

At this stage, the system should be ready for starting up Promptar Server and performing phone system integration tests.



[3] Refer to the next chapter for details on these sections.

[4] For the purpose of illustrating the operations, the command line example below strives to be platform neutral, assuming the connector’s binary is in the PATH.

[5] It is directed at STDERR and could have been redirected via "2>" in the command line. TAPI lines are directed at STDOUT.

[6] Leading spaces after the = sign in the declaration are discarded.

[7] Using TAPI line names with accented characters and, in general, non-ASCII characters, may fail. This is a currently known limitation. If you face such cases, please contact us directly for support.