• 4.2.1. Siemens ROLM Programming Requirements
• For ROLM 9006 PBX or ROLM integration on the Hicom 300E
• For ROLM 9005 PBX
• 4.2.2. Using the PBX Integration Board
• 4.2.3. Programmable Feature Keys
• Reading LED Indicators
• Pressing Feature Keys
• 4.2.4. Alphanumeric Display
• Called/Calling Number ID (within the PBX)
• 4.2.5. Setting the Message Waiting Indicator
• 4.2.6. Transferring a Call

4.2. Siemens ROLM PBX

The ROLM product family actually includes three generations of ROLM and related PBXs:

1. The original ROLM
2. IBM ROLM 9751 series
3. Siemens Hicom 300 with the appropriate interface cards

The PBX Integration board emulating the ROLM 400 telephone can be used with any of these switches. The ROLM PBXs use digital signaling to control their station sets and digitized voice.

The PBX Integration board has either four or eight channels that are connected directly to a station module in a Siemens ROLM PBX. The PBX switch has many standard features that are supported by the PBX Integration board, such as:

• direct inward dialing (DID)
• hands free operation
• speed dialing
• hunt groups
• message waiting indication
• user programmable feature keys
• called/calling number identification
• call forwarding.

4.2.1. Siemens ROLM Programming Requirements

There are specific switch programming requirements for using a PBX Integration Board with a Siemens ROLM PBX. You must ensure that these features are set exactly (and assigned to the right keys) so that the PBX Integration Board and the Unified API function correctly.

• All PBX Integration Board ports on a ROLM system must be programmed as ROLMphone 400 telephones.
• LINE must be programmed on Feature Key 09, and the ROLMphone must be programmed to select this line when going offhook.
• XFER (transfer) must be programmed on Feature Key 38.
• MWI (Message Waiting Indication) mechanisms are different with ROLM 9006 (or ROLM integration on the Hicom 300E) and ROLM 9005 PBX.



For ROLM 9006 PBX or ROLM integration on the Hicom 300E

• DDS (speed dial) must be programmed on Feature Key 03 for the correct message waiting "ON" feature access code, which is *59 (default, but is dependent on the PBX setup. Consult the PBX Administrator for the correct feature access code) when you are using the ROLM integration on the Hicom 300E or when you are using the ROLM 9006 PBX. To program this key on the ROLMphone:

  1. Press PROG (Feature Key 20).

  2. Then press Feature Key 03.

  3. Dial *59 (or the correct PBX dependent Feature Access Code), and press PROG again.

  4. The phone display indicates "STORED" and message-waiting light (or Mailbox indicator light) ON is now set for Feature Key 03.

• DDS (speed dial) must be programmed on Feature Key 04 for the correct message-waiting OFF feature access code, which is #60 (default, but is dependent on the PBX setup. Consult the PBX Administrator for the correct feature access code) when using the ROLM integration on the Hicom 300E or when you are using the ROLM 9006 PBX. To program this key on the ROLMphone:

  1. Press PROG (Feature Key 20).

  2. Then press Feature Key 04.

  3. Dial #60 (or the correct PBX dependent Feature Access Code), and press PROG again.

  4. The phone display indicates STORED and message-waiting light (or Mailbox indicator light) OFF is now set for Feature Key 04.




For ROLM 9005 PBX

• In this case the MWI ON/OFF key is a toggle key and it must be programmed to be the feature key 37.

NOTE:

For transferred calls, the called-party ID appears as a direct call because the PBX does not write the called-party ID to the display.

NOTE:

For message waiting, only the port that sets a message-waiting indicator can clear it.

4.2.2. Using the PBX Integration Board

The PBX Integration board performs functions available to a ROLMphone 400 telephone set (see Figure 5). An ROLMphone 400 telephone set uses an LED displays to show key status (next to the keys) and user prompts and messages on the display to provide various options. The PBX Integration board can:

• transfer calls
• set the message waiting indicator
• read the LCD display
• read LED indicators
• read the called/calling number ID
• press keys.

Figure 4. Siemens ROLMphone 400

4.2.3. Programmable Feature Keys

As illustrated in Figure 4, there are 40 Feature Keys located below the display on the ROLMphone 400 telephone. These keys are configured either during PBX installation or by the user (using the telephone set or the PBX Integration board). The CLEAR, SPEAKER, MUTE, XFR, and LINE keys are assigned during PBX configuration and cannot be user programmed. The MAILBOX indicator programmed on each phone (see 4.2.1. Siemens ROLM Programming Requirements above) for Feature Key 01. Feature Keys 39 and 40 are used for volume control and cannot be programmed either. There is an LED Indicator associated with each key, except those discussed in the following paragraph. The LED Indicators are circular and can take on one of the six states listed in Table 7.

Table 7. ROLMphone 400 LED Indicator States

Reading LED Indicators

The PBX Integration board can determine the state of its LED Indicators by using the d42_indicators( ) function to retrieve the LED Indicators data. This function places the LED Indicator data (37 bytes) in an application buffer. Bytes 00-36 contain the indicator status for Feature Keys 01-37, respectively (see Table 8). As indicated in the example below, Feature Keys 10, 30, and 38-40 do not have LED indicators.

Table 8. ROLMphone 400 Direct Key Dialing Strings for Feature Keys

*MWCTR = Message Waiting Control

Example

An application uses the d42_indicators( ) function to retrieve the current data for the LED Indicators on a given channel on a PBX Integration board. The data placed in the application buffer is shown below. If the data for byte 08is 0x01, the circular indicator for Feature Key 09 is on. Refer to the PBX Integration board Software Reference for more information about using the d42_indicators( ) function.

Pressing Feature Keys

The PBX Integration board can "press" any of the ROLMphone 400 Feature Keys using the dx_dial( ) function. Refer to the PBX Integration board Software Reference for more information about dialing programmable keys. Each Feature Key on the ROLMphone 400 telephone is assigned a dial string sequence (refer to Table 8). By using the dx_dial( ) function and the appropriate dial string, the PBX Integration board can press any Feature Key.

4.2.4. Alphanumeric Display

The alphanumeric display is a two row, 60-character LCD that is used to show the activity of the phone. Some examples are:

• date and time
• feature names
• text messages
• error messages
• called/calling identification
• phone status
• line selection

The data used to display information in the LCD alphanumeric display is in ASCII format. When the telephone is not in use, the display normally 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 feature).

The PBX Integration board can retrieve the information on its alphanumeric display using the d42_display( ) function. The function places the display data (48 bytes) in an application buffer. Refer to the PBX Integration board Software Reference for more information about using the d42_display( ) function.

Example

An application uses the dx_dial( ) function and the appropriate dial string to press keys dial extension number 1045. The d42_display( ) function is used to retrieve the display data and place it in an application buffer (shown below). The information for the top row (first 30 characters) of the display is checked. Data in bytes 00 through 03 indicate that extension 1045 is being dialed.

data	01 00 04 05 4C 4C 20 20 20 20 20 20 20 20 20 20 20 20 20 20
byte	00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19
data	20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
byte	20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
data	20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
byte	40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

Called/Calling Number ID (within the PBX)

When receiving a call on a PBX Integration board from another extension, the PBX sends calling number ID data (by default, the extension number of the telephone placing the call) to the station set between the first and second rings. The station set processes the data and sends an ID message to the display. The calling number ID data sent from the PBX to the station set differs from the calling number ID data presented on the display.

When placing a call to another extension, the called number ID (by default, the extension of the telephone being called) is shown in the display.

Both the calling and called number IDs can be retrieved using the d42_gtcallid( ) function. The d42_gtcallid( ) function retrieves the called/calling number ID message sent from the PBX to the station set, not the data sent to the display. Refer to the PBX Integration board Software Reference for more information about using d42_gtcallid( ) function.

The contents of the called/calling number ID are shown in Table 13 (as seen by the receiver of the call).

Table 9. Called/Calling Number ID Data for the ROLM

Call Route	Called/Calling Number ID Data
Call received from trunk line 1	_0-1
Call received from station set 221	_221
Call originally received on trunk line 1, then transferred to station set 223	223_0-1
Call originally received by extension 221, then forwarded to extension 224	224_221

NOTE:

The called/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

An application uses the d42_gtcallid( ) function to retrieve the calling number ID for a call received on a specified channel on a PBX Integration board. The calling number ID data and corresponding ASCII values are shown below.

data

byte

text

data

byte

4.2.5. Setting the Message Waiting Indicator

The PBX Integration board can set the Message Waiting Indicator (on or off) on another extension using the dx_dial( ) function and the appropriate dial string, as described in the PBX Integration board Software Reference for your particular operating system.

NOTE:

Message Waiting can also be set using the dx_dial( ) function and appropriate dial string to press the Feature Key assigned to send messages; however, you should use the dx_dial( ) function as described so that your application will maintain functionality across different manufacturers' switches.

MWI On

The recommended technique to turn on the MWI in this switch, using dx_dial( ) with the dial string is:

1. Go Off Hook using dx_sethook( )
2. Call the dx_dial( ) function. The dial string is <ESCO><extention><ESCO> (Optional pause character may be used)
3. Go On hook using the dx_sethook( ) again

<ESCO> means Escape character followed by O.

MWI Off

The recommended technique to turn off the MWI in this switch, using dx_dial( ) with the dial string is:

1. Go Off Hook using dx_sethook( )
2. Call the dx_dial( ) function. The dial string is <ESCF><extention><ESCF> (Optional pause character may be used)
3. Go On hook using the dx_sethook( ) again

<ESCF> means Escape character followed by F.

The PBX Integration board can determine the state of its Message Waiting Indicator using the d42_indicators( ) function to retrieve the LED Indicators data. Byte 40 contains the Message Waiting indicator status (0x00 is off; 0x01 is on). Refer to the PBX Integration board Software Reference for more information about using the d42_indicators( ) function.

Example

An application uses the d42_indicators( ) function to retrieve the LED Indicators data for a specified channel on the PBX Integration board to determine if a message is waiting. The LED indicators data is shown below. The data 0x01 shows that the MWI indicator is on (there are messages waiting).

4.2.6. Transferring a Call

The PBX Integration board can transfer calls using the dx_dial( ) function. By using the dx_dial( ) function and the appropriate dial string (&,<extension>), the PBX Integration board can transfer a call to any extension connected to the switch. Refer to the PBX Integration board Software Reference for more information about dialing programmable keys.

NOTE:

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

The PBX Integration board can perform both supervised and blind transfers (Refer to the 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 a call and plays a greeting message prompting the caller to enter the extension she wish to reach (the caller enters 221). Using the dx_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