ADSI script statements

This section contains descriptions and syntax for all the statements you can include in an ADSI script file. The description of each statement shows whether you can use the statement in an SDC or a FDM script, or in both.

There are four types of statement:

• High level statements (main, softkey, overlay, and function).
• Softkey return string statements. All of these statements are valid for FDM scripts, and most are valid for SDC functions.
• FDM script definition statements. Some of these are identical to the corresponding softkey return string statements.
• SDC function statements.

The description of each statement contains references to the following Bellcore specifications, which contain more detailed information:

SR-INS-002461

Customer Premises Equipment Compatibility Considerations for the Analog Display Services Interface

TR-NWT-001273

Generic Requirements for an SPCS to Customer Premises Equipment Data Interface for Analog Display Services.

Table 1 lists all the statements and shows where they are each described.

For quick reference, Table 1 lists the script statements. It gives the terse version, the type, and the parameters for each statement.

If you want to add comments to your script file to explain the statements you use, start each comment line with the two characters //.

To see examples of the script statements, see:

• Example SDC statements
• Example FDM statements
• The adsicb.sdc script file

  Table 1. The ADSI script statements

  Statement	See
  backspace	backspace
  change_state_to	change_state_to
  clear_call_buffer	clear_call_buffer
  clear_clipboard	clear_clipboard
  clear_display	clear_display
  clear_soft_key_table	clear_soft_key_table
  clear_the_screen	clear_the_screen
  clear_timer	clear_timer
  clear_type_ahead	clear_type_ahead
  clear_user_input	clear_user_input
  clear_virtual_display	clear_virtual_display
  clear_virtual_display_line	clear_virtual_display_line
  connect_session	connect_session
  delay	delay
  dial_pulse_1	dial_pulse_1
  disconnect_session	disconnect_session
  display	display
  display_call_buffer	display_call_buffer
  display_clipboard	display_clipboard
  display_clipboard_if_flag	display_clipboard_if_flag
  do_hookflash	do_hookflash
  end_user_input	end_user_input
  exit	exit
  exit_but_retain_display	exit_but_retain_display
  function	function
  go_down_by	go_down_by
  go_offhook	go_offhook
  go_onhook	go_onhook
  go_to_line	go_to_line
  go_up_by	go_up_by
  information	information
  initialise_soft_key_line	initialise_soft_key_line
  input_control	input_control
  input_format	input_format
  install_softkey	install_softkey
  line_control	line_control
  load_default_soft_key_tuple	load_default_soft_key_tuple
  load_overlay	load_overlay
  load_soft_key_table	load_soft_key_table
  load_virtual_display	load_virtual_display
  main	main
  move_data_down	move_data_down
  move_data_up	move_data_up
  on	on
  overlay	overlay
  page_down	page_down
  page_up	page_up
  put	put
  query_for_configuration	query_for_configuration
  query_for_cpe_id	query_for_cpe_id
  reset_flag	reset_flag
  send_dtmf	send_dtmf
  send_encoded_dtmf	send_encoded_dtmf
  send_encoded_user_input	send_encoded_user_input
  send_ldtmf	send_ldtmf
  send_line_number	send_line_number
  send_nothing	send_nothing
  send_user_input	send_user_input
  set_flag	set_flag
  set_info_flags	set_info_flags
  set_timer_for	set_timer_for
  softkey	softkey
  softkeyparms	softkeyparms
  start_user_input	start_user_input
  switch_to_alternate_character_set	switch_to_alternate_character_set
  switch_to_application	switch_to_application
  switch_to_data	switch_to_data
  switch_to_peripheral	switch_to_peripheral
  switch_to_voice	switch_to_voice
  tab_field	tab_field
  tab_to_primary	tab_to_primary
  tab_to_secondary	tab_to_secondary
  timed_switch_to_voice	timed_switch_to_voice
  trigger	trigger
  wait_for_dial_tone	wait_for_dial_tone

Syntax conventions

This section uses the following typographic conventions to describe the syntax of each ADSI statement:

< >

The name of a parameter. You must substitute a value for this name. Do not type the symbols < >.

[ ]

The name of an optional parameter. Substitute a value for this name if you want to use this parameter. Do not type the symbols [ ].