There is a range of state table actions, from very general (such as AssignData, which performs a variety of computational functions) to very specific (like ControlMusic, which is used to turn up or down the volume of background music). Because the general actions can be combined in so many ways, the following list may not be exhaustive, but it does give a goal-oriented overview of which action to choose to perform application functions.
Telephony activity
Task |
State Table Action |
|---|---|
| Respond to a ringing line (incoming call) |
AnswerCall |
| Make an outbound call |
MakeCall |
| Send a set of numbers, a hook flash, or a ground key signal to the switch |
Dial |
| Detect the presence of a dial tone |
Dial |
| Transfer a caller to an agent or another caller |
TransferCall |
| Reconnect a caller to the voice application (for example, if a TransferCall failed) |
ReconnectCall |
| Disconnect a caller |
TerminateCall |
Voice segments
Task |
State Table Action |
|---|---|
| Record a segment of voice data |
RecordVoiceSegment |
| Store a segment of voice data in a voice directory |
SaveVoiceSegment |
| Remove a segment of voice data |
DeleteVoiceSegment |
| Play a prompt, which may include one or more prerecorded voice segments |
PlayPrompt |
| Play a single segment of prerecorded voice data |
PlayVoiceSegment |
Output to the caller
Task |
State Table Action |
|---|---|
| Play a prompt, which may include one or more prerecorded voice segments |
PlayPrompt |
| Play a single segment of prerecorded voice data |
PlayVoiceSegment |
| Play speech from a text-to-speech server, database server, or another Blueworx Voice Response system |
PlayVoiceFromHost |
| Play voice data sent from another Blueworx Voice Response system and received by a custom server |
PlayVoiceFromHost |
| Play a pacing or other feedback tone |
PlayBeep |
Background music
Task |
State Table Action |
|---|---|
| Start or stop playing a background music tune |
ControlMusic |
| Turn the volume of background music up or down |
ControlMusic |
Key input from the caller
Task |
State Table Action |
|---|---|
| Get a single key from the caller |
GetKey |
| Get multiple keys from the caller, as digits |
GetData |
| Get multiple keys from the caller, as digits or letters |
GetText |
| Use keys pressed by the caller to retrieve data from a 3270 server or custom server |
GetFindData |
| Retrieve an application profile, using keys pressed by the caller |
GetFindName |
| Check the password keyed by the caller with the password defined in the application profile specified by SV20 for the mailbox ID specified by SV32 |
GetPassword |
Program logic and flow of control
Task |
State Table Action |
|---|---|
| Wait for a specified period of time |
DoNothing |
| Wait until one of a number of events occurs |
WaitEvent |
| Log an event |
LogEvent |
| Compare one value with another value |
EvaluateData |
| Select the next state to go to on the basis of the value of a character variable |
Case |
| Invoke another state table |
InvokeStateTable |
| Start communication with a custom server |
OpenHostServerLink |
| Start communication with a 3270 server |
OpenHostServerLink |
| Send data to a custom server |
SendData |
| Send data to a 3270 server |
SendData |
| Receive data items and return codes, from a custom server |
ReceiveData |
| Receive data items and return codes, from a 3270 server |
ReceiveData |
| Find out it there is enough storage available in the Blueworx Voice Response file system for an application to execute as planned |
CheckStorage |
Computation and string handling
Task |
State Table Action |
|---|---|
| Define a constant |
AssignData (Assign) |
| Assign a value to a variable |
AssignData (Assign) |
| Add two numbers and assign the result to a variable |
AssignData (Add) |
| Subtract one number from another and assign the result to a variable |
AssignData (Subtract) |
| Multiply one number by another and assign the result to a variable |
AssignData (Multiply) |
| Divide one number by another and assign the result to a variable |
AssignData (Divide) |
| Divide one number by another and assign the remainder to a variable |
AssignData (Modulus) |
| Assign the absolute value of a number to another variable |
AssignData (Absolute Value) |
| Truncate one number by the length specified by another and assign the result to a variable |
AssignData (Truncate) |
| Round one number at the digit specified by another and assign the result to a variable |
AssignData (Round) |
| Concatenate one character string to another and assign the result to a variable |
AssignData (Concatenate) |
| Take a specified number of characters from the beginning of one character string and assign them to a variable |
AssignData (Left) |
| Take a specified number of characters from the end of one character string and assign them to a variable |
AssignData (Right) |
| Take the character that occurs in a specified position of one character string and assign it to a variable |
AssignData (Index) |
| Search for a specified character string in another character string and assign the position of it in the second string to a variable |
AssignData (Search String) |
| Count the number of characters in a character string and assign the result to a variable |
AssignData (Length) |
| Convert all the characters in a string to uppercase, and assign the result to a variable |
AssignData (Uppercase) |
| Convert all the characters in a string to lowercase, and assign the result to a variable |
AssignData (Lowercase) |
| Remove a tag string designated by a tag label |
AssignData(RemoveTag) |
| Remove the attribute substring |
AssignData(RemoveAttribute) |
| Find a tag label and append the corresponding tag string to the result |
AssignData(GetTag) |
| Find a tag and attribute substring and assign the attribute value to a variable |
AssignData(GetAttributeValue) |
| Find a tag label and assign its value to a variable |
AssignData(GetTagValue) |
| Build a tag string and assign it to a variable |
AssignData(PutTag) |
| Build an attribute and assign it to a variable |
AssignData(PutAttribute) |
| Find and replace a tag value |
AssignData(ChangeTagValue) |
Voice mailboxes
Task |
State Table Action |
|---|---|
| Set or change the attributes of a voice mailbox |
UpdateProfile |
Voice messages
Task |
State Table Action |
|---|---|
| Record a new voice message |
RecordVoiceMessage |
| Add more to the beginning of a voice message |
RecordVoiceMessage |
| Add more to the end of a voice message |
RecordVoiceMessage |
| Set or change the attributes of a voice message |
ChangeMessageAttributes |
| Send a voice message to the mailbox specified by the application profile ID and mailbox ID |
SendVoiceMessage |
| Retrieve all voice messages of a specified type for the application profile specified by SV20 and mailbox ID specified by SV32 |
CheckVoiceMessages |
| Play a voice message from a mailbox |
PlayVoiceMessage |
| Save a voice message, which has been retrieved using CheckVoiceMessages, in the mailbox for later retrieval |
SaveVoiceMessage |
| Play back a voice message which has just been recorded |
PlayVoiceMessage |
| Remove a voice message previously retrieved using CheckVoiceMessages |
DeleteVoiceMessage |
Distribution lists
Task |
State Table Action |
|---|---|
| Retrieve names of all recipients on a specified distribution list for a specified application profile and mailbox ID |
GetDistributionList |
| Retrieve names of all distribution lists for a specified application profile and mailbox ID |
GetDistributionList |
| Add a mailbox to a distribution list |
UpdateDistributionList |
| Add a distribution list to a distribution list |
UpdateDistributionList |
| Remove a name from a distribution list |
UpdateDistributionList |
| Remove a distribution list |
UpdateDistributionList |
| Copy a distribution list |
UpdateDistributionList |
| Append a distribution list to another distribution list |
UpdateDistributionList |
Audio names
Task |
State Table Action |
|---|---|
| Record an audio name |
RecordAudioName |
| Store the audio name for the application profile and mailbox ID |
SaveAudioName |
| Play the audio name of the specified application profile and mailbox ID |
PlayAudioName |
| Remove the audio name of the specified application profile and mailbox ID |
DeleteAudioName |
Greetings
Task |
State Table Action |
|---|---|
| Record a greeting |
RecordUserGreeting |
| Store the greeting for the specified application profile and mailbox ID |
SaveUserGreeting |
| Play the greeting associated with the specified application profile and mailbox ID |
PlayUserGreeting |
| Remove the greeting specified by system variable SV102 |
DeleteUserGreeting |
Endings
Task |
State Table Action |
|---|---|
| Terminate a nested state table and return to the invoking state table |
ExitStateTable |
| Terminate a link with a custom server |
CloseHostServerLink |
| Disconnect a caller |
TerminateCall |
| Terminate an application and clean up all resources |
CloseEverything |