ADSI_FDM_SKEYS

Use the ADSI_FDM_SKEYS state table to download to an ADSI telephone the softkey definitions from an FDM file.

ASCII syntax

InvokeStateTable ("DIRECT", ADSI_FDM_SKEYS, mode, file, NameOfService, FDN,
SecurityCode, VersionNumber, parms);

Entry point

mode

Specify one of the following values:

data_mode

Download the FDM file in data mode and do not allow interruptions.

This is the same as the call to execute an SDC file.

The transmission of data for an on-hook download is not interrupted when the telephone user presses a DTMF key or lifts the handset.

data_mode_i

Download the FDM file in data mode, but allow interruptions.

This is the same as the call to execute an SDC file.

The transmission of the data is interrupted when the telephone user presses a DTMF key or lifts the handset.

voice_mode

Download the FDM file in voice mode and do not allow interruptions.

This is the same as the call to execute an SDC function.

The transmission of data for an on-hook download is not interrupted when the telephone user presses a DTMF key or lifts the handset.

voice_mode_i

Download the FDM file in voice mode, but allow interruptions.

This is the same as the call to execute an SDC function.

The transmission of the data is interrupted when the telephone user presses a DTMF key or lifts the handset.

Description

file

The name of the FDM script file to be downloaded.

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

The name is appended to the directory name $CUR_DIR/adsi/.

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.

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

In this example, the ADSI_FDM_SKEYS state table downloads only the softkey definitions from the file sample.fdm.

InvokeStateTable("DIRECT", ADSI_FDM_SKEYS, data_mode_i,

                "sample.fdm",

                "sample",

                "1",

                "1",

                "1",