A replay link can be created in any application supporting the HTML anchor (<a>) tag. The replay link will replay a Tealeaf session through a web service call on the Portal server.
LinkType value RTV is selected.Structure of Query URL
The following explains the structure of Query URL.
The URL for the web service call is as follows:
http://<host>/<WebServiceName>/cxConnect.asmx/GetSessionReplayLink?
SessionType=<location>
&LinkType=<linktype>&Field=<field>&Value=<value>&MD5=<md5>&
SessionDate=<sessiondate>&
SessionPreference=<sessionpreference>&Redirect=<redirect>
The GetSessionReplayLink function supports the use of NT/AD and Single Sign On authentication methods.
| Parameter | Required? | Type | Description |
|---|---|---|---|
Host |
Y | [string] | Hostname of the Portal server. The host value might also be an alias for the DNS resolved Portal server.
Note: Users attempting to replay sessions through a Replay Link must be using computers that are able to resolve through DNS the supplied host value.
|
WebServiceName |
Y | [string] | Virtual directory for the web service. By default, the installed virtual directory is PortalAPI. |
SessionType |
Y | [string] | Determines the session type scope of the web service search request. Sessions transition from active to complete based on a defined timeout value or through an explicit session close action:
|
LinkType |
Y | [string] | Controls how the session is replayed by the user. RTV represent the CX RealiTea Viewer, a Microsoft™ Windows-based client application. BBR represents Browser-Based Replay, a web-based replay mechanism delivered through the Portal. |
Field |
Y | [string] | Data field parameter of the web service search request.
Note: The number of sessions that are retrieved by the web service search request are influenced by the uniqueness of the field/value combination. In most cases,
TLTSID should be used.
|
Value |
Y | [string] | Corresponding value of the web service search request data field parameter. |
MD5 |
N | [string] | Determines whether to perform an MD5 hash on the provided value before running the search request. |
SessionDate |
Y | [string] | The GMT date parameter of the web service search request. The performance and number of sessions returned by the web service search request will be influenced by the date scope of the request. An empty value causes the web service search request to search all available data.
Format: Note: The known SessionDate and time when the session closes might differ. For example, a popup form might be submitted 30 minutes after the user's last activity of the site. As a result, SessionDate is dynamically adjusted to include the most likely date ranges for the session. For sessions that occur within +/- two hours of 'end of day' (00:00:00), the range is extended to include the previous (<= 02:00:00) or next (>= 22:00:00) day in the search.
|
SessionPreference |
Y | [string] | Determines which session to replay when multiple sessions are retrieved by the web service search request.
Note: In most cases the Any option (
3) should be used as it causes the web service search request to complete after the first session is retrieved. The Earliest (1) and Latest (2) options require that the web service search request perform a sort operation after all sessions are retrieved.
|
Redirect |
Y | [string] | Determines whether or not the resulting replay action, based on the LinkType parameter, will be invoked.
Note: In most cases, the redirect value should be
TRUE as it automates the replay action. In situations where additional application logic is required, setting the redirect value to FALSE causes the web service search request to return an XML node that includes the LinkType URL. |
http://<host>/<WebServiceName>/cxConnect.asmx. The GetSessionReplayLink link will exercise the aforementioned search request method.Examples
For all examples, use the Host and WebServiceName.
- Host:
tealeafReplay - WebServiceName:
PortalAPI
Example 1 - Completed Sessions, RTV, TLTSID, Specific Date
Create a link to replay the first completed session retrieved, which occurred on June 3, 2019, with a TLTSID value of 6ADC032CE62410E601D18F0E83F2F02A. When clicked, the link automatically opens the CX RealiTea Viewer (RTV) to replay the session.
http://tealeafReplay/PortalAPI/cxConnect.asmx/GetSessionReplayLink?
SessionType=CLOSED
&LinkType=RTV&Field=TLTSID&Value=6ADC032CE62410E601D18F0E83F2F02A
&SessionDate=2019-06-03&SessionPreference=ANY&Redirect=TRUE
Example 2 - All Sessions, RTV, TLTSID, Any Date
Create a link to replay the first session retrieved, which occurred on any date in the past, with a TLTSID value of 6ADC032CE62410E601D18F0E83F2F02A. When clicked, the link will automatically open the CX RealiTea Viewer (RTV) on the client's computer to replay the session.
http://tealeafReplay/PortalAPI/cxConnect.asmx/GetSessionReplayLink?
SessionType=ALL
&LinkType=RTV&Field=TLTSID&Value=6ADC032CE62410E601D18F0E83F2F02A
&SessionDate=&SessionPreference=ANY&Redirect=TRUE
Example 3 - All Sessions, BBR, UserDef1, Any Date
Create a link to replay the first session retrieved, which occurred on any date in the past, with a CustomVar3 value of ProductID1234. When clicked, the link will automatically open the Portal and browser-based replay (BBR) to replay the session.
http://tealeafReplay/PortalAPI/cxConnect.asmx/GetSessionReplayLink?
SessionType=ALL&LinkType=BBR&Field=CustomVar3&Value=ProductID1234
&SessionDate=&SessionPreference=ANY&Redirect=TRUE
Example 4 - Completed Sessions, RTV, CustomQuery, Any Date
Create a link to replay the first completed session retrieved, which occurred on June 3, 2019, with a TLTSID value that matches the MD5 hash of 6ADC032CE62410E601D18F0E83F2F02A. When clicked, the link will automatically open the CX RealiTea Viewer (RTV) on the client's computer to replay the session.
http://tealeafReplay/PortalAPI/cxConnect.asmx/GetSessionReplayLink?
SessionType=CLOSED
&LinkType=RTV&Field=TLTSID&Value=6ADC032CE62410E601D18F0E83F2F02A&MD5=TRUE
&SessionDate=2019-06-03&SessionPreference=ANY&Redirect=TRUE