The following sections list and describe the extension points and application global variables that can be overridden using application extensions. 

Extension Points

The table below lists the extension points that you can override using application extensions. 

Extension PointDescriptionContext
agentPopupRenderer
Answers and Flow tabs of the History Flow page
  • pm: Current protocol manager
  • panel: Parent panel of the History Flow page
  • container: The History Flow page
 
autocompleteRenderer
Auto complete dropdown list pageElement
breadcrumbRenderer
Breadcrumbs portion of the screen breadcrumbs
callbackPageRenderer
Page for entering a phone number for call return none
callPageRenderer
Call Now page
  • dnisGroup
  • phoneNum
  • voiceQueue
  • queueDescription
 
chatPageRenderer
Chat page renderer none
choiceSwitchRenderer
 Switch element  
  • pageElement
  • detailsForm
clickToContinueCategoryRenderer
Two level click to continue element
  • choice
  • contentSectionId
 
clickToContinueMatrixLayoutRenderer
Click to continue matrix   contentSection
clickToContinueRenderer
Click to continue button
  • clickToContinue
  • choiceId
collectionRenderer
Collection list contentSection
contactUsPageRenderer
Contact Us page  
contactSectionsRenderer
Header, label, choices and footer
  • contentSections
  • detailsForm
headerFooterRenderer
Header and footer of a page or a section
  • pageElement
  • isHeader
InteractionsListPageRenderer
List of Interactions page
  • doneFunction
  • createFunction
longTextInputRenderer
Multiline input element
  • choice
  • textareaHeight
  • detailsForm
pageContentRenderer
Header, content and footer of a page (most basic page layout) pageContent
pageFooterRenderer
Page footer, including the menu buttons
  • pageElement
  • footerElement
pageHeaderRenderer
Page header, including the navigation buttons (Back and Next)
  • pageElement
  • headerElement
pageRenderer
Root renderer

Note: This extension point is not supported in the Agent (History Only) Application. Use the agentPopupRenderer extension point instead.
pageElement
radioButtonRenderer
Radio button element contentSection
sectionChoicesRenderer
One renderer above the leafs
  • contentSection
  • detailsForm
sectionLabelRenderer
Label just before the question
  • pageElement
  • isMandatory
selectFromListRenderer
Dropdown list
  • pageElement
  • detailsForm
sendEmailPageRenderer
Email Us page none
shortTextInputRenderer
Input element
  • choice
  • detailsForm
uploadPhotosMatrixRenderer
Upload page matrix of thumbnails
  • uploadPhotoList
  • counterBadge
uploadPhotosRenderer
Upload photos question pageElement
viewFullSizePhotoRenderer
Full screen of uploaded photos
  • openingPage
  • dataUrl

Special Extension Points

Some special extension points are listed in the following table.

Extension PointDescriptionContext
loaded
Called when a page is finished rendering. You can use this event to modify the completed page and find elements using reference names.

Note: This extension point is not supported in the Agent (History Only) Application.
 page
onError
Called just before displaying the default server error. ResponseError from the server

Global Variables

In addition to the context data obtained while rendering page elements, global variables of the application can be accessed through the app parameter passed to the extension. These variables, which provide access to many aspects of the application, can be used to make your extension more powerful.
The global variables are listed and described in the following table.

VariableDescription
channelType
MOBILE_WEB, AGENT, or WEB_SELF_SERVICE
options
All the parameters passed from the URL to the application.
protocolManager
An object that handles all communications. It contains all the data needed to keep the session of the client.
Refer to the table below for protocolManager variables.
translator
Holds the strings of all the languages.
mPage
The current page being navigated.
nextButton
backButton
Next and Back buttons DOM element.

protocolManager Variables

VariableDescription
applicationKey
Application key for the application.
baseUrl
For example: http://gointeract.io
designerId
Unique identifier of an Interaction, as displayed in the Interaction Designer.
imei
Identifier for the mobile device.
JAS_TIMEOUT
The default timeout value for all communication with the Jacada Interact Server.
jasUrl
The prefix for all the REST APIs: /interact/version/1/account/
lastPage
The last page retrieved from the previous navigation.
objectId
Identifier for an Interaction in the mongo db id field.
objectInstanceId
Instance of the currently running Interaction.
objectStepId
Instance of the current page.
retryOpts
Communication retry options.
securityToken
The security token (used for access to secured Interactions).
userId
A unique identifier for the currently running Interaction. Using this ID, the full flow of the Interaction can be obtained.

Revision:

Comments