The Client Event element enables you to send parameters from the Interaction Server client or the wrapping application, by generating an asynchronous event in the Interaction. The actions triggered by the event can be defined either in the Interaction itself, or in the JavaScript of the containing page of the Interaction. These actions are generally used to determine the direction in which the Interaction progresses. 

Some use cases for including client events in Interactions are:

  • Each time the user reaches a specific step in the Interaction, a client event can open a relevant Help page in a portlet in the hosting web page.
  • A client event can redirect the user to a different web page (e.g., to schedule a technician), or even to another website.

Note: Client events are not supported in the Mobile Web application.

Creating a Client Event Element
Creating a Client Event involves specifying the event name, and then defining action parameters (if relevant). 

To define a client event element:

  1. From the Insert menu, select Client Event. Alternatively, from the Interaction Elements toolbar, click , and then click inside the Interaction Map.
    The Client Event Definition dialog opens.

  2. In the Reference name field, enter a name for the element.
  3. In the Event name field, enter a name for the event.
  4. If relevant, add one or more action parameters:
    a. At the bottom of the Client Event Definition dialog, click Add Parameter
        A row is added to the Parameters frame.


    b. In the param name column, enter a unique name for the parameter. Then, in the param name column, specify the parameter's value. You can either set a hard coded value, or select an existing element that determines the value of the parameter.
    In the following example, a hard coded URL path is set for the value of the image.

  5. To add another action parameter, repeat Step 4.
  6. Click OK.
    The Client Event element is configured. When the Interaction is run in the Designer's simulator, a poup message is displayed to indicate that the event was fired. For example:

  7. Add the required JavaScript to the hosting page of the Interaction. For an example, refer to Client Event Flow Example (below).

Client Event Flow Example
This example presents a sample Interaction that uses Client Event elements. The Interaction is embedded in a website, as shown below:


The following sections describe the Interaction flow, and explain how the Client Event integration is done.

Step 1: Entering an Identifier

In this input question, users are asked to enter a customer ID.

Step 2: Checking the Identifier

In this step, a Decision element checks the input, and sends the user to one of two client events, based on the ID received.

Step 3: Implementing Actions Based on the Client Event

At this point, an action takes place according to the client event that is fired:

  • When the outage event is fired, users are redirected to the Jacada website (www.jacada.com), and the Interaction ends.
  • When the setImage event is fired, the image in the header of the web page is replaced with the Jacada logo, and the Interaction continues with Statement 1.

 

The relevant Javascript added to the container page is shown below. The image set by the setImage function is defined in the action parameter of the setProduct Client Event element (refer to Step 4b in the procedure above). 

Revision:

Comments