Chapter 7
Voice Script Editor


The Voice Script Editor is a powerful tool which gives you total control over the way MacComCenter Plus will answer and process incoming calls. With the proper script file, MacComCenter Plus can be configured to differentiate among incoming voice, fax, data or AppleTalk Remote Access (ARA) calls, and handle the calls appropriately.

The Editor uses icons to create a graphical representation (like a flowchart) of how calls will be processed. The Voice Script Editor dialog appears as follows:

          [Voice Script Editor]

On the left is the floating toolbar, which contains the icons used to represent Editor commands. On the right is the script window. To create scripts, drag and drop the icons from the toolbar onto the script window. Icons are connected with arrows (using the arrow tool), which directs the call processing flow.

The execution of each icon can either Succeed or Fail. When creating scripts, you use arrows to show the path the script will take when a successful result is obtained. You can also use arrows to show the path the script will take when a failure occurs. The successful path is shown with a green arrow. The failure path is shown with a red arrow. To draw a red arrow (failure path) hold down the Option key when using the Arrow Tool.

To create a new script, select New from the File menu. . To open an existing script, Open from the File menu.You can change the appearance of the icons in the script window the Use Graphics Icons option under the Scripts menu. Each icon has a unique number assigned to it by the Script Editor. You can view these numbers by selecting the Show Item Numbers option from the Scripts menu. When you complete a script file, select Save from the File menu to store the script on your hard drive.

You can print scripts by going to the File menu and selecting Print. You can also make the Script you are working on the 'Default Script' by selecting Make Default Script from the Scripts menu. The Default Script is the script which is used when MacComCenter Plus answers the phone in Voice and Fax mode. There is only one Default Script, although there can be many script files. Scripts can also call other scripts for more complex call processing scenarios.


Voice Script Tools

There are four tools used by the Voice Script Editor to create and modify scripts. The tools appear as follows:

                  [Tools]


From left-to-right the tools are:


Voice Script Icons

The script icons are used to define tasks in the Voice Script Editor. Each icon represents a different task.
The following section describes each icon and its function.

F  Note: Every icon dialog contains call processing termination options. These options are Hang Up on Failure and Hang Up on Success. If Hang Up on Failure is selected and the specified task returns a failure code, the call will be immediately terminated. This will occur even if a failure path is available from the selected task. If Hang Up on Success is selected and the specified task returns a success code, the call will be immediately terminated. This will occur even if a success path is available from the selected task.


[Icons][Icons] Start Icon

This icon allows you to configure the initial call processing options. When the Start icon is selected, the following configuration dialog appears:

             [Icons]

Select the default voice messages which will be used when the specified action occurs. Use the provided popup menus to select the voice files. All scripts must begin with a Start icon.


[Get Tones][Get Tones]Get Tones Icon

This icon allows you to define how and when recordings will play.

Look for tones for x seconds -- MacComCenter Plus will wait for the specified number of seconds for the tones to be entered by the caller. If the tones are not entered in the allowed time, a failure code will be returned.

Stop checking after x tones -- Specify the number of tones that MacComCenter Plus will expect to be entered.

Play Beep before looking for tones -- When selected, a beep will be played before MacComCenter Plus will begin waiting for tones.


[Play Message][Play Messsage]Play Message Icon

This icon will cause MacComCenter Plus to play a greeting message. When the Play Message icon is selected, the following configuration dialog appears:

            [Play Message]

Play Options:

Message Options:


[Play Beep][Play Beep]Play Beep Icon

This icon allows you to control the playing of a beep tone. When the Play Beep icon is selected, the following configuration dialog appears:

            [Play Beep]

Repeat Beep x times -- Specify the number of times the beep will be played.

Use Standard Beep -- When selected, the standard beep will be played. The standard beep is a 1/3 second tone.

Play this as the Beep -- Use the popup menu to specify an audio file to be used in place of the standard beep.


[Record Message][Record Message]Record Message Icon

This icon allows you to control the recording of incoming messages. When the Record Message icon is selected, the configuration dialog shown on the next page appears:

           [Record Message]

Record Call for x seconds -- Specify the maximum length of an incoming message.

Enable Call Screening -- When selected, this option will cause the callers message to be played through your modem's speaker while it is being recorded.

Play Beep before Recording -- When selected, the caller will hear a beep before MacComCenter Plus will begin recording their message.


[Do Command] Do Command Icon

This icon causes MacComCenter Plus to perform a particular command depending upon the touchtone key pressed by the caller. When the Do Command icon is selected, the following configuration dialog appears:

          [Do Command]

The asterisk ('*') is required for each command. Specify the touchtone key which must be pressed by the caller to access the specified functions. During call processing, MacComCenter looks for a '*x' touchtone key combination and then executes that particular command. If this icon return Success (meaning that it detected a command), then voice call processing is terminated. This will occur even if a success path is available from the selected task.


[Receive Fax][Receive Fax]Receive Fax Icon

This icon tells MacComCenter Plus to begin receiving a fax file. The configuration dialog for this icon has no additional options. Voice call processing always terminates after this icon is executed. This will occur even if a success or failure path is available from the selected task.


[Receive Fax][Receive Fax]Data Mode Icon

This icon tells MacComCenter Plus to switch into data mode. The configuration dialog for this icon has no additional options. This icon will run either ARA or the MCC Terminal application, depending on how the Answer Data option is set in the MessageCenter Preferences Port Settings window. Voice call processing always terminates after this icon is executed. This will occur even if a success or failure path is available from the selected task.


[ARA Mode][ARA Mode]ARA Mode Icon

This icon tells MacComCenter Plus to switch into ARA mode. The configuration dialog for this icon has no additional options. Voice call processing always terminates after this icon is executed. This will occur even if a success or failure path is available from the selected task.

F  Note: See MacComCenter Plus and ARA later in this chapter for details on using ARA with MacComCenter Plus.


[ARA Mode][ARA Mode]Remote Message Retrieval Icon

This icon tells MacComCenter Plus to begin a Remote Message Retrieval session. The configuration dialog for this icon has no additional options. Voice call processing always terminates after this icon is executed. This will occur even if a success or failure path is available from the selected task.


[Hang Up][Hang Up]Hang Up Icon

This icon causes MacComCenter Plus to hang up the phone line. The configuration dialog for this icon has no additional options. Voice call processing always terminates after this icon is executed. This will occur even if a success or failure path is available from the selected task.


[Goto][Goto]Goto Icon

Normally, the next icon to be processed is identified by an arrow line connecting the two icons together. This is not always the best way to connect icons, since they may be separated by other parts of the script. The Goto icon provides another method for identifying the next icon to be processed. Goto icons are always paired with Label icons. You can have multiple Goto icons all going to the same Label icon. When the Goto icon is selected, the following configuration dialog appears:

           [Goto]

Select a Label Name -- Specify the target Label icon for the selected Goto task. There are 26 labels per script--one for each letter of the alphabet.


[Label][Label]Label Icon

This icon is the label which corresponds to a Goto icon. When the Label icon is selected, the configuration dialog shown below appears:

           [Label]

Select a Label Name -- Specify the label name for the selected Label icon. Select a letter from the popup menu to identify this label. There can only be one icon identified with the selected letter


[Check Time][Check Time]Check Time Icon

This icon allows you to specify time and date limits which will enable subsequent events in the script When the Check Time icon is selected, the following configuration dialog appears:

            [Check Time]

When the Select Day(s) option is shown, you can click on the day or days you wish to select. When the Select Date option is selected, a monthly calendar will appear, allowing you to specify a specific day in a specific month. The Time from x Until y options allow you to also specify a specific time of day.


[Replay Tones][Replay Tones]Replay Tones Icon

This icon causes MacComCenter Plus to play back a voice description of the touchtone keys the caller has pressed. When the Replay Tones icon is selected, the following configuration dialog appears:

          [Replay Tones]

You must record messages for each touchtone digit and then configure each digit by selecting the appropriate recording from the popup menus. The Replay Tones icon replays the touchtones by playing the audio for each touchtone detected.

Introduction Message -- Use the popup menu to specify the message which will be played when the Replay Tones task is accessed. An example message might say: "The touchtones you have pressed are . . ."

Digit 0 thru 9 -- Use the popup menu to specify the audio files used for each digit. These audio files should just be the name of the digit.

Acknowledgment -- When selected, this option will cause the selected audio file to be played after the replay of the callers tones is finished. An example message might say: "Were the tones just played correct? Press 1 if they were correct, or 0 if they were incorrect."

Look for verification after replaying tones -- This option is used in conjunction with the Acknowledgment option. If a 1 is pressed, verification is considered to be passed and the icon returns success. If a 0 is pressed, verification is considered to have failed and the icon returns a failure. If no verification is required, the icon return success.


[Call Code Resource][Call Code Resource]Call Code Resource Icon

This icon will cause an external user supplied plug-in to be activated. By developing custom call processing plug-ins, developers can extend the call processing capabilities of MacComCenter Plus. If you are interested in developing plug-ins for MacComCenter Plus, please check the MacComCenter web page at www.smithmicro.com for availability of the Scripting Developers Kit.

When the Call Code Resource icon is selected, the following configuration dialog appears:

            [Call Code Resource]

Select the custom code resource from the popup menu. The configuration dialog will change to a plug-in specific configuration dialog. If there are no plug-ins installed, the popup menu will be disabled.


[Clear All Tones][Clear All Tones]Clear All Tones Icon

This icon will clear all of the tones entered by the caller to be erased. The configuration dialog for this icon has no additional options.


[Get Mailbox Number][Get Mailbox Number]Get Mailbox Number Icon

This icon allows MacComCenter Plus to request a voice mailbox identification number for a particular mailbox. When the Get Mailbox Number icon is selected, the configuration dialog shown below appears:

            [Phone Dialog]

Look for Mailbox number for x seconds -- Specify the number of seconds MacComCenter Plus will wait for the mailbox number to be entered via touchtones.

Play Beep before looking for Mailbox ID -- When selected, a beep will be sent to the caller before MacComCenter Plus begins waiting for the mailbox number to be entered.

Require a Mailbox password -- When selected, MacComCenter Plus will require that the mailbox's password be entered before it can be accessed.

Use default messages for prompts -- When selected, the default message prompts, defined in the Start icon configuration dialog, will be played.

Play Mailbox Greeting if available -- When selected, the mailbox's greeting message will be played. If the mailbox does not have its own individual message, this option will be ignored.


[Check Tone][Check Tone]Check Tone Icon

This icon allows MacComCenter Plus to check for a particular touchtone key sequence. When the Check Tone icon is selected, the following configuration dialog appears:

            [Check Tone]

Match Any TouchTone -- When selected, this icon will return success if the caller entered any touchtone. The icon will return failure if no touchtones are entered.

Match this TouchTone sequence -- When selected, this icon will return success only if the caller entered the specified touchtone sequence. If the touchtones do not match, the icon will return failure.


[Call Script][Call Script]Call Script Icon

This icon causes MacComCenter Plus to call another script file from within the current script. Up to ten scripts may be chained together. When the Call Script icon is selected, the following configuration dialog appears:

            [Call Script]

Run Script -- Use the popup menu to specify the script to be run. Press Open to open the selected script in the Voice Script Editor.


[Return Icon][Return Icon]Return Icon

This icon is used at the end of a script invoked via the Call Script icon. It causes MacComCenter Plus to return to the original script file and specifies the return status of the called script. When the Return icon is selected, the following configuration dialog appears:

            [Return]

Return 'Success' status -- When selected, the script will return to the original script, and report a success.

Return 'Failure' status -- When selected, the script will return to the original script, and report a failure.


[Loop Count][Loop Count]Loop Count Icon

This icon is used to specify the number of times that a particular section of a script file will be repeated. When the Loop Count icon is selected, the following configuration dialog appears:

           [Loop Count]

Number of times thru Loop -- Specify the number of times that the section will be repeated. If the count is exceeded, the icon will return failure. If the count is less then or equal to the amount specified, the icon will return success.

Count exceeded message -- Use the popup menu to select the audio file which will be played when the loop count exceeds the number specified above.


MacComCenter Plus and ARA

MacComCenter Plus's call discrimination features can be used with ARA 2.x. If you plan on using MacComCenter Plus's call discrimination features to detect an incoming ARA call, you must remove the Serial Port Arbitrator extension from the Extensions folder.

F   Note: This release of MacComCenter Plus's call discrimination feature does not support ARA 3.0.

To use call discrimination with ARA:

  1. Open the Remote Access Setup Control Panel.
  2. Ensure that ARA is configured to use the same port as MacComCenter Plus.
  3. Ensure that the Answer Calls check box is not selected.
  4. Close the Remote Access Setup Control Panel.
  5. When you call your Macintosh to establish an ARA call, use the following dialing string:
    Your Mac's Phone Number,,,,, *5

The ",,,,,*5" shown above causes the computer calling into your Macintosh to wait until the greeting message is playing before sending the *5 tones. These tones are processed by the Do Command icon and they tell MacComCenter Plus to switch to ARA mode.


Return to the Contents page
Return to the top of Chapter 7