ADSI_FDM and ADSI_FDM_I

Use the ADSI_FDM and ADSI_FDM_I state tables to download FDM functions to the ADSI telephone when the user calls a number that is answered by a voice application.

The two state tables are very similar, but ADSI_FDM_I is interrupted if the telephone user makes a call.

ASCII syntax

InvokeStateTable ("DIRECT", ADSI_FDM, mode, file, NameOfService, FDN,
SecurityCode,VersionNumber, parms);
InvokeStateTable ("DIRECT", ADSI_FDM_I, mode, file, NameOfService, FDN,
SecurityCode,VersionNumber, parms, interrupt);

Entry point

mode
Specify one of the following values:
data_mode
Download the FDM file in data mode.
Note: Before you invoke this state table to download FDM functions in data mode, you must switch to data mode. To do this, use the ADSI state table (see ADSI and ADSI_I) to send an SDC function that contains the following statements to switch to data mode and enable the softkeys:
		switch_to_data;
	information INSK=1;
main_data
Download the script part of an FDM file in data mode.

This downloads only the main function and the overlays.

skey_data
Download the softkey part of an FDM file in data mode.

This downloads only the softkey definitions.

voice_mode
Download the FDM file in voice mode.
main_voice
Download the script part of an FDM file in voice mode.

This downloads only the main function and the overlays.

skey_voice
Download the softkey part of an FDM file in voice mode.

This downloads only the softkey definitions.

Description

file
The name of the FDM script file to be downloaded.

You must include the file-name extension (.fdm).

Note: In versions of IBM WebSphere Voice Response before Version 2.2, ADSI files were stored in $CUR_DIR/adsi, which is not backed up by Blueworx Voice Response's usual save and restore tools.

We recommend that you store them in $CUR_DIR/ca/ADSI_dir, which is backed up using the standard save and restore tools.

NameOfService
The name of the service that is to appear in the Service (FDM) page of the ADSI telephone.

The name can be a maximum of 18 bytes long.

FDN
The Feature Download Number.

This is the number of the position on the telephone's (FDN) page to which the feature should be downloaded.

This parameter is four bytes long. You can specify decimal values in the range 0 through 6, depending on the type of ADSI telephone being used.

SecurityCode
The security code for the feature.

If you try to download a feature to a specific feature download number, and the security codes for that service do not match the one you are downloading, you will not be authorized to download the feature.

This parameter is four bytes long.

For more information on feature downloads, see Bellcore specification SR-INS-002461 .

VersionNumber
The version number of the feature you are downloading.

This parameter is one byte long.

parms
A string containing parameters to be passed to the ADSI function.

If you want to pass multiple parameters, you must concatenate them into one string, and separate each parameter using a 001 (X'01') delimiter. You could use the ADSI_Parameters state table to do this (see ADSI_Parameters).

If you do not want to pass any parameters to the ADSI function, set the parms parameter to a null string.

interrupt
Set this parameter to allow use of the telephone in an emergency while data is being downloaded.

This parameter is available on the ADSI_FDM_I state table only.

Specify one of the following values:

0
Transmission of data for an on-hook download is not interrupted when the telephone user presses a DTMF key. This is the default.
1
Transmission of data can be interrupted.

Results

The InvokeStateTable action terminates with a result that indicates whether or not the operation was successful. If it was not, the result shows the reason for the failure:

0
Success
3
FDM definition file not found
4
Error communicating with the ADSI device (no CAS tone acknowledgment)
5
Error communicating with the ADSI device (after 5 retries)
6
Line problem
7
Caller hung up
8
FDM download denied
9
ADSI application error, or FDM not supported, or user has rejected the download

Example

InvokeStateTable("DIRECT", ADSI_FDM, voice_mode,
                "sample.fdm",
                "xyz",
                "1",
                "1",
                "1",
                parms)

Related state tables

Parent topic: The ADSI state tables