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>
Note: All parameter values should be URL encoded.
- The GetSessionReplayLink function supports the use of NT/AD and Single Sign On authentication methods. See "Authentication" in the IBM® Tealeaf cxImpact Administration Manual.
Parameter | Required? | Type | Description |
---|---|---|---|
Host | Y | [string] | Hostname of the Tealeaf® Portal
Server. The host value might also be an alias for the DNS resolved Tealeaf 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: ACTIVE - Active sessions CLOSED - Completed sessions ALL - All session |
LinkType | Y | [string] | Controls how the session is replayed by the user. RTV represent
the Tealeaf IBM Tealeaf CX RealiTea Viewer,
a Microsoft Windows-based
client application. BBR represents Browser-Based
Replay, a web-based replay mechanism delivered through the Tealeaf Portal: RTV - IBM Tealeaf CX RealiTea Viewer BBR - Browser-Based Replay |
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. TRUE FALSE |
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.
|
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.
EARLIEST - Returns the earliest session retrieved by the search, sorted by date-time LATEST - Returns the most current session retrieved by the search, sorted by date-time ANY - Returns the first session retrieved by the search |
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.
TRUEFALSE |
Note: A series of web service test interfaces are provided by navigating
a browser to the web service URL: http://<host>/<WebServiceName>/cxConnect.asmx.
The GetSessionReplayLink link will exercise the aforementioned
search request method.
Field Compatibility Mapping
To maintain compatibility with pre-Release 8.0 integrations, Tealeaf maintains support for the following Field values. The values in the left column correspond to user-defined variables in pre-Release 8.0 systems. When URL queries are submitted, the Tealeaf server automatically maps the fields and their values to the Release 8.0 or later values in the right-hand column.
- In all cases, the value for Field must match
the values that are listed below. Note: In a future release, support for pre-Release 8.0 integrations, including these query parameters, might be deprecated. Tealeaf recommends adopting the new standards below.
- Pre-Release 8.0
User Variables - Release
8.0 or later
Session Attributes - LoginID
- CustomVar0
- UserDef1
- CustomVar1
- UserDef2
- CustomVar2
- UserDef3
- CustomVar3
- UserDef4
- CustomVar4
- SessionAttribute0
- CustomVar5
- SessionAttribute1
- CustomVar6
- ...
- ...
- SessionAttribute57
- CustomVar62
- SessionAttribute58
- CustomVar63
Note: SessionAttribute59 through SessionAttribute63 are
not supported in Release 8.0 or later.