Building Applications¶

Add Variables¶

1. Click the Variables tab at the bottom of the workspace pane. A list of current variables will be shown.

2. Right-click in the workspace pane, and then click Add Variable.

3. Type the Name of the variable. This name must be less than 32 characters and contain only alphanumeric characters and underscores.

4. Select the variable Type.

5. Type an initial Value for the variable.

6. Select the Variable Scope. If you select Function, you must also select the specific function that the variable will be defined in.

7. Click Add.

The new variable is listed on the workspace pane under Variables and under its selected scope. Variables defined for specific functions will be listed on the Functions tab under the function that they are associated with.

8. Add more variables as needed and click Close when you have finished adding variables.

Modify Variables¶

1. Right-click the variable that you want to modify.

2. Click Modify.

3. Make changes to the variable as needed.

4. Click Close.

Delete Variables¶

1. Right-click the variable that you want to delete.

2. Click Delete.

3. Verify that you want to delete the variable.

4. Click OK.

Assign Standard Prefixes to Variable Names¶

Naming conventions allow you to automatically populate the type prefix and scope prefix of a variable based on its name.

For example, if you specify that variables with a prefix of n are of type int, the SCE automatically populates the Type field with int whenever you add a variable with a name that begins with n.

1. Click Edit ‣ Options.

2. Click the Naming Conventions tab.

3. Select the Order for the type of prefix to appear in the variable name.

4. Enter the Scope Prefix to be used.

For example, to have global variables start with g_, type g_ in the Global field.

5. Enter the Type Prefix to be used.

For example, to have string variables start with str, type str in the string field. 6. Click OK.

Add Event Handlers¶

To build functions that respond to specific events, you must first add event handlers for the associated events. For more information about events, see Working with Events.

1. Click the Events tab at the bottom of the workspace pane.

2. Expand the folder that contains the event.

For example, to add a handler for the SessionStart event, expand the Application Server Events folder.

3. Right-click the event that you want to add a handler function to, and then click Add Handler. The Add Event Handler window appears.

4. Type an Event Handler Name or use the default name.

5. Click OK.

The event appears in bold to indicate that it has been added. Additionally, a handler function is added to your application. Now you can build a function that the application server will call when the associated event occurs.

Add Called Functions¶

Called functions are useful when you have a set of actions common to multiple functions. Rather than adding the actions to each function individually, you can create one function that is called from the appropriate places throughout the application.

1. Click the Functions tab at the bottom of the workspace pane.

2. Right-click in the workspace pane, and then click Add Function.

3. Type the Name of the function.

4. Select a Returns option if a value is returned by the function.

5. Click Add to add parameters that can be accepted by the function as variables that contain information passed to this function from another function.

6. Click OK.

The new function is listed on the workspace pane under Functions.

Now you can build a function that can be called using the Call a Function PAC.

Add PACs¶

1. From the drop-down list on the tool bar, select the function that you want to build, and the drawing pane will be updated with any PACs that can currently be defined for that function.

2. Click the Actions tab at the bottom of the workspace pane.

3. Click the plus sign (+) next to the folder to expand the list of PACs.

4. Click and drag a PAC into the drawing pane. The PAC appears in the drawing pane.

Delete PACs¶

1. Select the PAC in the drawing pane.

2. Click Edit ‣ Delete or press the Delete key.

Configure PACs¶

Most PACs require configuration. Each PAC has a properties window associated with it, which has a Description tab, a Custom tab, and one or more tabs containing fields for the configuration information.

The Description tab is used to enter a text description that appears on the PAC in the drawing pane.

For information about using the Custom tab, see Custom Results.

The following image shows an example of a PAC properties window and shows the key features of a tab.

1. Double-click a PAC, or right-click and then click Properties. The properties window associated with that PAC appears.

2. Click the Description tab and enter a brief description of the PAC function. This description is displayed on the PAC in the drawing pane.

3. Select the additional tabs and enter the required values.

4. When all tabs have been completed, click OK.

Custom Results¶

Each PAC has a set of possible results, or exit paths, that are used to determine call flow. The SCE distinguishes between predefined and custom results. The predefined results are displayed the first time you put the PAC in the drawing pane.

From the drawing pane, you can add one or more custom results to any action. Custom results are given a display name and a set of conditions that are evaluated to determine whether the custom result is true or false. The conditions for the custom result can compare the values of any variables in the application and consider the predefined result returned by the action. These conditions can be combined into more complex statements using standard and, or, and not comparative statements.

When the PAC has completed processing, the predefined and custom results are evaluated in the following order:

• The action returns a single predefined result as the outcome.

• If custom results are defined for this action, they are evaluated in turn (from top to bottom as they are displayed in the SCE drawing pane). The first custom result found to be true becomes the operative result.

• If a custom result is found to be true and there is an output path for that result, then that path is followed to the next PAC.

• If there is an output path for the predefined result, then that path is followed to the next action.

• If there is an output path from the default result, then that path is followed to the next action.

Add Custom Results

1. Double-click a PAC, or right-click and then click Properties. The properties window associated with that PAC appears.

2. Click the Custom tab.

3. Click Add to add a result other than the default.

4. In the Result field, type the name of the result.

5. Select the Visible checkbox to display the result on the PAC.

6. Click Apply and then click OK.

Connect PACs¶

To specify the flow of actions, you must connect one or more results of each PAC to another PAC that will be executed when that result is received.

Establish a Single Connection

1. Click the green result arrow on the PAC. The selected arrow turns red.

2. Drag to the PAC that will be executed next if that result is received. A line is created between the two PACs to indicate their relationship.

Establish Multiple Connections

While the common use case will be connecting results to PACs individually, you can also connect multiple results to a single PAC at the same time.

1. Press the [Ctrl] key while clicking the result triangles of each result that you want to initiate a connection from.

2. Click the destination PAC.

Delete Connections

1. Click the line that represents the connection that you want to delete. The selected line will turn red.

2. Click Edit ‣ Delete or press the Delete key.

View the Source Code¶

After you save an application, you can view the XTML text by opening the file in Internet Explorer, Notepad, or another text editor.

Print an Application¶

You can print the drawing pane flow-chart view of an application for reference.

1. Click File ‣ Print Setup.

2. Choose the orientation best suited to your application.

3. Click OK.

4. Click File ‣ Print.

5. Choose the print options.

6. Click OK.

Add a Transfer Location¶

1. Click Tools ‣ Transfer ‣ Locations. The File Transfer Locations window appears.

2. Select the type of location from the Existing Servers.

3. Type a Name for the location. This name will appear in the Tools menu.

4. Type the corresponding IP Address for the location.

5. Type the Port for an HTTP server, or a User and Password for an FTP or PSCP server.

6. Type the Destination Directory where the application is to be copied. This should be the app subfolder under PS_ROOT.

7. Click Add. The new server now appears as an option in the Tools ‣ Transfer menu.

8. With the new server selected, click Test Connection to verify a successful connection. If the test does not succeed, contact your system administrator.

9. Click OK.

Find Errors with the SCE¶

The Console produces a ps_syslog.txt log file. Error messages in this log file specify both the application and the PAC in which the error occurred. Some errors with PACs can be found using the SCE.

1. Click Edit ‣ Find an Action. The Find an Action window appears.

2. In the Function/Event Name field, select the function that contains the PAC.

3. In the Component Number field, type the PAC ID. This is the number that appears above the PAC in the drawing pane.

4. Click OK.

The function appears in the drawing pane, and the PAC in question is selected. The PAC ID is red.

Resolve XTML Libraries¶

When an application is loaded, libraries that the application depends on are also loaded. The application server must be configured with the following information:

• The names of the XTML libraries to search for unresolved function names.

• The search path to look for the identified XTML library documents in.

The search path is a list of directory names or HTTP URLs separated by semi-colons. HTTP URLs are useful because they allow reusable library functions to be retrieved from a centralized web server.

This configuration information is in the <xtml-server> element of the ps_master_config.xml file. For more information about configuring the <xtml-server> element in this file, see the Application Server User’s Guide.

Since references to external functions are resolved at application load time, it is possible to update an XTML library and distribute it without requiring any recompilation or redistribution of the XTML applications or libraries that use it. The next time an XTML application is loaded in a new XTML server process, it reloads the library with the changes.

Load XTML Library Documents into the SCE¶

As you create applications, it can be helpful to have the XTML library documents available within the SCE for reference.

1. Click File ‣ Project Dependencies.

2. In the Library Modules field, type the name of the library document or browse to find the name.

3. In the Library Path field, type the path to the library document or browse to find the path.

4. In the Include Path field, if needed, type the path to the JavaScript file or browse to find the path.

5. Click OK.

The XTML library document is listed on the workspace pane under External Function Libraries.

Create an Object Variable¶

Object variables are created in the same way simple variables are created.

1. Click Edit ‣ Add Variables. The Add Variable window appears.

2. Type the Name of the variable.

3. Select object in the Type field.

4. If required, type a Value to initialize the variable.

• If no value is provided, the variable is simply created as an empty object. It can then be populated at runtime via JavaScript or values returned from PACs.

• If a single integer value is provided, the object is created as an array with the number of entries specified by the integer. The array can then be dynamically extended or truncated at runtime via JavaScript.

• If a comma-separated list of values is provided, the object is created as an array with the initial values provided for each element. For example, if the following initial value was provided, the object would be created as an array with three elements:

10, 3.5, "hello"

The first value in the array is an integer (10), the second is a float (3.5), and the third is a string (“hello”).

5. Select the Variable Scope.

6. Click Add.

For more information about working with variables, see Define Variables.

Similar to JavaScript, indexed or named member variables of a complex XTML variable are created when accessed if they do not already exist. For example, if you declare an object variable called myObject, and you do not provide an initial value, the variable initially has no member variables. However, executing the code below causes the variable to have 10 indexed member variables and 1 named member variable.

//creates elements [0] through [9]. All but [9] are uninitialized
Session.myObject[9] = 10 ;
//creates a property called 'speeddial'
Session.myObject.speeddial = "8005551234" ;

Object Variables with Array Data¶

To use an object variable to hold array values that are accessed by number, you can assign them to the object using the array notation ([]). The following applies to array operations:

• Arrays are zero-based so the first entry is referenced as object [0].

• You can assign a value to any element of an array at any time.

• You can determine the length of an array at any time by accessing the .length property of the object that returns an integer indicating the current number of elements in the array.

• You can truncate or extend an array dynamically by setting the value of the .length property of the array.

The following example shows handling and object type variable as an array:

//assume I have an xtml variable 'myObject' of type object
Server.logInfo("Number of elements is " + Session.myObject.length ) ;
//assign a progression of squares to the first ten indices
for( var i = 0; i < 10; i++ ) {
{
Session.myObject[i] = i * i ;
}
Server.logInfo("Number of elements is now" + Session.myObject.length ) ;
//truncate the array back to five elements
Session.myObject.length = 5 ;
Server.logInfo("Number of elements is now" + Session.myObject.length ) ;

Object Variables with Structure Data¶

To use an object variable to hold a set of values that are accessed by name, use the dot (.) operator.

To create a named property of an object variable, you will need to assign a value to that property name using JavaScript.

The following is an example of the dot (.) operator in use:

//assume I have an xtml variable 'myCall' of type object

Session.myCall.DNIS = "8005551234" ;
Session.myCall.ANI = "7815551234" ;

A common reason to use object variables in this way is to group a set of related data for maintenance. Since object variables can be passed to functions, it is simpler to pass a single object variable to a function rather than passing multiple individual variables.

Object Variables with Array and Structure Data¶

Array accessors and property accessors can be used together in the same object, and there is no limit to how array data and structure data can be combined.

The example below shows a rowset returned from a database stored procedure. In this example, the entire data set is returned into an object variable. The object variable has an array of values. Each index in the array represents one row and has multiple properties, each representing one column value.

for( var i = 0; i < Session.g_oRowSet.length; i++ ) {
        Session.g_strBatchExpireDate = Session.g_oRowset[i].batchExpireDate;
        Session.g_intParentCompanyId = Session.g_oRowset[i].parentCompanyId ;
        Session.g_intUnitsStart = Session.g_oRowset[i].units;
        Session.g_intOutCallCountT= Session.g_oRowset[i].outCallCountT;
        Session.g_intOutCallCountR= Session.g_oRowset[i].outCallCountR;
        Session.g_bFirstOutdialAttempt = Session.g_oRowset[i].firstOutAttempt;
        Session.g_bFirstSds = Session.g_oRowset[i].firstSDS;
        Session.g_bCardActive = Session.g_oRowset[i].cardActive;
}