4. PBX Systems

• 4.1.1. MITEL Switch Programming Requirements
• MITEL SX-50 Requirements for using MWI
• 4.1.2. Using the D/42D-SX Board
• 4.1.3. Line Select/Speed Dialing Keys (15)
• Reading LCD Line Indicators
• Example
• Pressing Line Select/Speed Dialing Keys
• 4.1.4. Soft keys
• Reading Soft Key Prompts
• Example
• Pressing Soft Keys
• 4.1.5. Supplementary Feature Keys
• Example 1
• Example 2
• Example 3
• Pressing Supplementary Feature Keys
• 4.1.6. Alphanumeric Display
• Example 1
• Calling Number ID
• Example 2
• 4.1.7. Setting the Message Waiting Indicator
• Example
• 4.1.8. Transferring a Call
• Example
  

4.1. MITEL SUPERSWITCH PBX

MITEL PBXs use digital signaling to control its station sets and analog signals for voice. The COV Line card provides an interface between the station sets and the switch.

The D/42D-SX board has four channels that are connected directly to a MITEL COV Line card. The COV Line card can be used in the SX-50, SX-100, SX-200, SX200D, and SX-2000 PBXs. These MITEL PBXs have many standard features that are supported by the D/42D-SX, such as:

• direct inward dialing (DID)
• hands free operation
• speed dialing
• hunt groups
• message waiting lamps
• call forwarding.

4.1.1. MITEL Switch Programming Requirements

There are no specific switch programming requirements for using a D/42D-SX with a MITEL SUPERSWITCH PBX. However, you must ensure that the features you want to access using the D/42D-SX and the Unified API are enabled on the extension(s) connected to your system. For example, if you want your application to be able to read the name assigned to an extension, the name must be programmed by PBX.

The PBX uses Class of Service (COS) to determine which features are available to an extension. The features available to an extension are shown in the telephone set's LCD Features display. Any feature not in the COS will not be displayed.

MITEL SX-50 Requirements for using MWI

If you are using a MITEL SX-50 and wish to use the set Message Waiting Indicators (MWI) feature, the D/42D-SX must be assigned to a COS with Auxiliary Attendant capabilities, and a line key must be set to act as the Attendant Console MWI. Use the following procedures only if you have a high degree of understanding of the MITEL SX-50 PBX and it's configuration. To configure MWI on a MITEL SX-50 you will:

• configure the COS that will be assigned to the D/42D-SX to include Auxiliary Attendant capabilities
• assign the COS to a channel on the Dialogic D/42D-SX
• program a Line Key on the D/42D-SX to act as an Attendant Console "Message Waiting" function key.

Configure a COS to have enhanced Auxiliary Attendant capabilities

1. From a test phone set, enter Programming Mode.
2. Enter the Command Number corresponding to the COS to which you want to add Auxiliary Attendant capabilities. Use commands 121 through 129 for COS 1 through COS 9. For example, if you want to change COS 9, use Command Number 129.
3. Set register 7, field "d" (Auxiliary Attendant Position) to 1 for the desired COS (1 - 9). The illustration below shows the Auxiliary Attendant feature enabled on COS 9.

4. Press Exit.

Assign ports connected to the D/42D-SX cards to have the newly configured COS.

1. Determine the circuit card number and port connected to your
   D/42D-SX. The PBX can have up to 10 circuit cards, and a COV circuit card has 8 ports. (example: circuit card 1, port 5).
2. From a test phone set, enter Programming Mode.
3. Enter the Command Number of the circuit connected to your D/42D-SX port (use commands 301 through 310 for circuit card 1 through 10). For example, if you are using a COV card in circuit card position 1, use Command Number 301.
4. Select the port connected to the D/42D-SX (example: port 5).
5. Set field "d" to the COS configured above. The illustration below shows COS 9 is assigned to circuit card 1, port 5.

6. Press Exit.

Program a Line key on the D/42-SX to act as an Attendant Console "Message Waiting" function key.

1. Determine the circuit number connected to your D/42D-SX port. The PBX can have up to 10 circuit cards, and a COV circuit card has 8 ports. For example, if you have two COV cards and the D/42D-SX is connected to circuit card 2, port 1, the is circuit number is 9.
2. From a test phone set, enter Programming Mode.
3. Enter the Command Number 4xx, where xx is the circuit number connected to your D/42D-SX port. For example, if you are using a COV card in circuit card position 2, port 1, use Command Number 409.
4. Select a Line key (other than 1) to use as the Message Waiting Indicator (example: Line Key 02). Set the Line Key field c (Line Appearance Type) to 8 (Attendant Function Key) and field d to 1 and field e to 0 (Message Waiting). The illustration below shows that Line Key 2, for the D/42D-SX connected to Circuit 9, is assigned as a Message Waiting indicator.

5. Press Exit.

4.1.2. Using the D/42D-SX Board

The D/42D-SX board performs functions available to a SUPERSET 4 telephone set. A SUPERSET 4 telephone set uses two LCD displays to show line status (next to the line keys) and user prompts (above the soft keys) - refer to
Figure 6). The D/42D-SX can:

• transfer calls
• set the message waiting indicator
• read the LCD alphanumeric display
• read the LCD features display
• read the LCD prompts display
• read LCD line indicators
• read the calling number ID
• press buttons.

Figure 6. MITEL SUPERSET4 Telephone

4.1.3. Line Select/Speed Dialing Keys (15)

There are 15 Line Select/Speed Dialing keys located on the top-right of the SUPERSET 4 telephone - see Figure 6. These keys are configured when the PBX is programmed to select preassigned lines. Line keys that are not configured can be defined by the user (using the telephone set or the D/42D-SX) as speed dial keys. There is an LCD Line Indicator associated with each Line Select/Speed Dialing key.

NOTE:

The indicator for the HOLD key is usually covered by the line identification card.

Each LCD Line Indicator is made up of two segments; a square and a circle. Each segment can take on one of the seven states listed in Table 1.

Table 1. SUPERSET 4 LCD Line Indicator States

Reading LCD Line Indicators

The D/42D-SX can determine the state of its Line Indicators by using the d42_indicators( ) function to retrieve the Line Indicators data. This function places the Line Indicator data (16 bytes) in an application buffer. Each byte
(8 bits) contains data for both segments of an indicator (bits 0-3 represent the square, bits 4-7 represent the circle - see Table 1). Bytes 1-15 contain the indicator status for line keys 01-15, respectively. Byte 0 contains the status for Hold (see Table 2).

Table 2. MITEL SUPERSET 4 LCD Line Indicators and Dial Strings

Example

An application uses the d42_indicators( ) function to retrieve the current data for the LCD Line Indicators for a given channel on a D/42D-SX. The data placed in the application buffer is shown below. If the data for byte 7 is 0x02, the circle segment corresponding to the Line Select/Speed Dial Key 7 is off and the square segment is flashing at 250 ms. - see Figure 7. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_indicators( ) function.

Figure 7. SUPERSET LCD Line Indicator

Pressing Line Select/Speed Dialing Keys

The D/42D-SX can "press" any of its Line Select/Speed Dial key using the dial( ) function. Refer to the D/42 Series Software Reference for your particular operating system for more information about dialing programmable keys. Each Line Select/Speed Dial key on the SUPERSET telephone is assigned a dial string sequence (refer to Table 2). By using the dial( ) function and the appropriate dial string, the D/42D-SX can dial any Line Select/Speed Dial key.

4.1.4. Soft keys

There are six Soft Keys located below the LCD display - see Figure 6. These keys are associated with specific prompts depending on the current state of the phone. Figure 8 shows all the possible prompts that can be displayed.

Figure 8. SUPERSET 4 Prompt Display

Reading Soft Key Prompts

The D/42D-SX can determine which of its prompts are currently displayed by using the d42_lcdprompt( ) function to retrieve the Prompt Display data. The function places the Prompt Display data (48 bytes) in an application buffer. Each byte represents a specific prompt and is either off (0x00) or on (0x01) - see
Table 3. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_lcdprompt( ) function.

Table 3. SUPERSET 4 Prompt Descriptions

Byte	Prompt	Byte	Prompt	Byte	Prompt
0	PROGRAM	16	PICKUP	32	REDIAL
1	CAMP	17	OVERRIDE	33	CANCEL
2	SWAP	18	TRANS	34	PRIVACY
3	PAGE	19	CALL	35	READ
4	PROGRAM	20		36	_
5	ON	21	OVERRIDE	37	NO
6	SPLIT	22	CONF	38	REL
7	EXIT	23	FWD	39	MSG
8	NIGHT	24	HELP	40	RELEASE
9	CALL	25	SEND	41	HANG
10	ON	26	ADD	42	NEXT
11	NAME	27	REMINDER	43	SPEED
12	ANS	28	CALL	44	_
13	BACK	29	MSG	45	UP
14	OFF	30	HELD	46	YES
15	SAVE	31	REMINDER	47	CALL

Example

An application uses the d42_lcdprompt( ) function to retrieve the current data for the Prompt Display on a given channel on a D/42D-SX. A simulation of the Prompt Display is shown in Figure 9. The data placed in the application buffer is shown below. Data of 0x01 in bytes 4, 23, and 29 indicate that the prompts PROGRAM, FWD, and MSG are on.

Figure 9. Example SUPERSET 4 Prompt Display

Pressing Soft Keys

The D/42D-SX can respond to a prompt and "press" its appropriate Soft Key using the dial( )function. Refer to the D/42 Series Software Reference for your particular operating system for more information about dialing programmable keys. Each soft key on the SUPERSET 4 telephone is assigned a dial string sequence (refer to Table 4). By using the dial( ) function and the appropriate dial string, the D/42D-SX can press any of its soft keys.

Table 4. MITEL SUPERSET 4 Direct Key Dialing Strings for Soft Keys

4.1.5. Supplementary Feature Keys

There are four Supplementary Feature Keys located next to the keypad keys - see Figure 6. The functions of these keys are as follows:

Display - Selects the type of information shown on the LCD Features display (see Alphanumeric Display below). The information to be displayed is selected by pressing the "display" key followed by a Line Select/Speed Dialing key or an appropriate soft key.

Select Features - Selects one of five features to be activated and is used in combination with a keypad key. Features are programmed by the PBX (i.e., do not disturb, auto answer, messaging, account code, and call forward). When the "select features" key is pressed, the features available are displayed on the Features Display. The D/42D-SX can determine which of its feature(s) are available by using the d42_flags( ) function to retrieve the Features Display data. The d42_flags( ) function places the Features Display data (16 bytes) in an application buffer. Each byte represents a specific message on the Feature Display and is either off (0x00), on (0x01), or flashing (0x02) - see Table 5. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_flags( ) function.

NOTE:

The d42_flags( ) function is only available in MS-DOS.

Table 5. SUPERSET 4 LCD Feature Display Descriptions

Example 1

To activate the Autoanswer feature, an application uses the dial( ) function to press the "select features" and "3" keys. To verify that the feature was activated, the application uses the d42_flags( ) function to retrieve the Feature Display data for the display shown in Figure 10 and check that bytes 14 (3:) and 11 (AUTO ANS) are on. The Features Display data is shown below.

Figure 10. Example SUPERSET 4 Features Display

Speaker On/Off - Turns on the speaker and microphone then goes off hook (this is called hands free operation), or turns off the speaker and microphone and then goes on hook. The D/42D-SX can determine the state of its "speaker on/off " key by using the d42_lcdprompt( ) function to retrieve the Prompt Display data and read the state of the HANG-UP prompt (bytes 41 and 45). The function places the Prompt Display data (48 bytes) in an application buffer. The prompt is either off (0x00) or on (0x01) - refer to Table 3.

Example 2

To activate the speaker phone feature, an application uses the dial( ) function to press the "speaker on/off" key on a specified D/42D-SX channel. To verify that the feature was activated, the application uses the d42_lcdprompt( ) function to retrieve the Prompt Display shown in Figure 11 and check that bytes 41 (HANG) and 45 (UP) are on. The Prompt Display data is shown below.

Figure 11. SUPERSET 4 Prompt Display for Speaker On/Off

MIC. On/Off - Turns the microphone off or on during hands free operation. The D/42D-SX can determine the state of its microphone using the d42_flags( ) function to retrieve the Features Display data and read the state of the MIC ON prompt (byte 1). The function places the Features Display data (16 bytes) in an application buffer. The prompt is either off (0x00), on (0x01), or flashing (0x02) - refer to Table 5. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_flags( ) function.

Example 3

An application uses the d42_flags( ) function to retrieve the Features Display data for a specified channel on a D/42D-SX and check if byte 1 is on (the microphone is on). If the microphone is on, the application uses the dial( ) function to press the "mic. on/off" key and turn the microphone off. The Features Display data shown below (obtained using the d42_flags( ) function) is read for the MIC ON feature shown in Figure 11.

Pressing Supplementary Feature Keys

The D/42D-SX can "press" any of its supplementary feature key using the dial( ) function. Each supplementary feature key on the SUPERSET 4 telephone is assigned a dial string sequence (refer to Table 6). By using the dial( ) function and the appropriate dial string, the D/42D-SX can dial any of its supplementary feature keys. Refer to the D/42 Series Software Reference for your particular operating system for more information about dialing programmable keys.

Table 6. SUPERSET 4 Direct Key Dialing Strings for Supplementary Features Keys

4.1.6. Alphanumeric Display

The alphanumeric display is a 16-digit LCD that is used to show:

• date and time
• user name associated with the extension
• saved numbers (speed dialing)
• saved number for redial
• timed reminder setting
• call forward type and destination
• calling number ID
• trunk line ID.

The data used to display information in the alphanumeric display is in ASCII format. When the telephone is not in use, the display shows the date and time. The content of the display is changed automatically (e.g., receiving an incoming call, making an outgoing call, or activating a reminder). The content of the display can also be changed manually by pressing the following:

The D/42D-SX can retrieve the information on its display using the d42_display( ) function. The function places the display data (16 bytes) in an application buffer. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_display( ) function.

Example 1

An application uses the dial( ) function to press the "display" key and "call fwd" soft key on a specified channel on the D/42D-SX to display the call forwarding extension. The d42_display( ) function is then used to retrieve the display data and verify that a call forwarding extension has not been programmed. The display data is shown below.

Byte

Data

Byte

Calling Number ID

When receiving a call on a D/42D-SX, the calling number ID (the extension of the telephone placing the call) is shown on the display and can be retrieved using the d42_gtcallid( ) function. The calling number ID data retrieved using this function is the same data that is sent to the display. Refer to the D/42 Series Software Reference for your particular operating system for more information about using d42_gtcallid( ) function.

NOTE:

On some manufacture's PBXs, the calling number ID data used for the display is not the same as the calling number ID data sent from the PBX to the phone set.

The calling number ID can also be obtained using the d42_display( ) function, however, you should use the d42_gtcallid( ) function so that your application will maintain functionality across different manufacturers' switches.




Example 2

An application uses d42_gtcallid( ) to retrieve the calling number ID for an incoming call received on a specified channel on a D/42D-SX. The calling number ID data and corresponding ASCII values are shown below.

data

byte

data

byte

4.1.7. Setting the Message Waiting Indicator

The D/42D-SX can set (on or off) the Message Waiting Indicator (4:MSG) of any extension using the dial( ) function and the appropriate dial string. Refer to the D/42 Series Software Reference for your particular operating system for more information about dialing programmable keys.

The D/42D-SX can determine the state of its Message Waiting Indicator using the d42_flags( ) function to retrieve the Features Display data. Bytes 3 and 5 are used for the 4:MSG prompt and are either off (0x00), on (0x01), or flashing (0x02) - refer to Table 5. Refer to the D/42 Series Software Reference for your particular operating system for more information about using the d42_flags( ) function.

Example

An application uses the d42_flags( ) function to retrieve the Features Display data for a specified channel on the D/42D-SX to check if "4:MSG" is flashing (bytes 5 and 3). The Features Display data is shown below.

4.1.8. Transferring a Call

The D/42D-SX can transfer calls using the dial( ) function. By using the dial( ) function and the appropriate dial string (&,<extension>), the D/42D-SX can transfer a call to any extension connected to the switch. Refer to the D/42 Series Software Reference for your particular operating system for more information about dialing programmable keys.

NOTE:

The transfer function can be performed using the dial( ) function and the appropriate dial string to press the TRANS CONF soft key, however, you should use the &,<extension> dial string so your application will maintain functionality across different manufacturers' switches.

The D/42D-SX can perform both supervised and blind transfers (refer to Sections 2.1. Supervised Call Transfer and 2.2. Blind Call Transfer). When a blind transfer is performed, the PBX controls where the call is routed if the called extension is busy or does not answer. When a supervised transfer is performed, your application can implement call progress analysis and called/calling number ID to intelligently control where the call is routed and what type of message is played if the called extension is busy or does not answer. Because of this capability, supervised transfer is the preferred method.

Example

An application answers an incoming call and plays a greeting message prompting the caller to enter the extension they wish to reach (the caller enters 221). Using the dial( ) function with the dial string (&,221), the application attempts to transfer (supervised) the call to extension 221. Call progress analysis is used to determine if extension 221 is answered, busy, or there is no answer. If extension 221 answers, the application hangs up and the transfer is complete. If the extension is busy or not answered, the application reconnects to the incoming call and plays a message asking the caller to choose between accessing voice mail or transferring to the operator.

Click here to contact Dialogic Customer Engineering