WSDL

If you use a language that has a web service package that supports reading from a WSDL, the Tealeaf Web Service enables you to retrieve the WSDL.

A WSDL is an XML doc that describes the Web Service can do. Typically, your web service package formulates the code API automatically for you.

The WSDL is available at:

http://hostname/PortalAPI/cxReveal.asmx?WSDL

API methods

The API methods listing and further API specifications are available by navigating to:

http://hostname/PortalAPI/cxReveal.asmx

• Authenticate: Authenticate web service connection with a Portal username and password. A null string is returned if successful, otherwise the error message is returned.
• GetPageResponse: Returns the page content type and response, null on error.
• GetSearchEventsList: Returns a list of canister events available for searching, null on error.
• GetSearchResults: Returns a list of session objects returned from the search, null on error.
• GetSearchSortFields: Returns a list of TLSortField objects representing the description/ID of acceptable search sort fields. Returns null on error.
• GetSearchStatus: Check the current status of a search. Only request results once 'Done' and 'DownloadComplete' are both true. Returns null on error.
• GetSessionAnnotations: Retrieves a list of session annotations in columns Username, Timestamp, and Text for the specified session.
• GetSessionPagesList: Returns a list of pages for a given session, null on error.
• StartSearch: Initiate a search for both active and archived sessions. Dates must supply the time and be ISO formatted. Returns the new query ID for the search. Return -1 on error.
• StartDbSearch: Initiate a cxReveal database search. Dates must supply the time and be ISO formatted. Returns the new query ID for the search. Return -1 on error.
• VerifyAuthentication: Verify that the Authenticate call was successful. Returns true if authenticated.

Session search

Session search queries are passed to Search Server for execution against the appropriate canisters to retrieve sessions.

All parameters must be URL-encoded. All arguments are optional, but nothing will happen if you don't provide either an active query or an archive query. Providing both will perform an All Sessions search using both.

Argument

Value

activequery

The active search query to perform. There is no validation, and it is sent directly to search server as a query.

archivequery

The archive search query to perform.

datespan

The numeric constant representing the dates to search on. Accepted values:

• 0 - All
• 1 - Only Today
• 2 - Only Yesterday
• 3 - Last 2 Days
• 4 - Last 7 Days
• 5 - Last 14 Days
• 6 - Last 28 Days
• 7 - Last 6 Hours
• 8 - Last 12 Hours
• 9 - Last 24 Hours
• 10 - last hour
• 11 - Latest 5 minutes
• 12 - Latest Hour
• -1 - Use Specified Dates and Times

startdate

If datespan is set to -1, this is the ISO-format date for the beginning date of the range (e.g. 2007-01-02 is Jan 02, 2007)

enddate

If datespan is set to -1, this is the ISO-format date for the end date of the range (e.g. 2007-01-02 is Jan 02, 2007)

starttime

If datespan is set to -1, this is the 6-digit, 24-hour time for the beginning of the range, in HHMMss format (e.g. 003015 is 00:30:15 or 12:30:15 AM)

endtime

If datespan is set to -1, this is the 6-digit, 24-hour time for the end of the range, in HHMMss format (e.g. 233059 is 23:30:59 or 11:30:59 PM)

scope

The scope of the search. Does not really apply since the query is already built, if scope is set to 2 for an archive search, it will be and on same page for the query. How the results will be sorted.

timeout

The maximum allotted time for an archive search, in seconds. The search will be stopped once this amount of time has elapsed, but more time may be required to collate the sessions found.

autostop

Specifies the limit at which an archive search will be stopped. When X matching sessions are found, the search is stopped.

Example

All parameters must be URL-encoded. Since this mode goes directly to the search results there is no way for a user to modify a search performed in this way.

Search all text for tealeaf.

URL

SessionSearch.aspx?activequery=%28request_contains_tealeaf%29_OR
   _%28response_contains_tealeaf%29&archivequery=%28tealeaf%29

Active query: (request contains tealeaf) OR (response contains tealeaf)

Archive query: (tealeaf)

Search template fields

Examples of search template fields.

Field

Value

template

• 1 - <Default Active>
• 2 - <Default Archive> (Standard mode)
• 3 - <Default Archive> (Extended mode)
• 4 - <Default All Sessions> (Standard mode)
• 5 - <Default All Sessions> (Extended mode)

datespan

• 0 - All
• 1 - Only Today
• 2 - Only Yesterday
• 3 - Last 2 Days
• 4 - Last 7 Days
• 5 - Last 14 Days
• 6 - Last 28 Days
• 7 - Last 6 Hours
• 8 - Last 12 Hours
• 9 - Last 24 Hours
• 10 - last hour
• 11 - Latest 5 minutes
• 12 - Latest Hour
• -1 - Use Specified Dates and Times

startdate

If datespan is set to -1, this is the ISO-format date for the beginning date of the range (e.g. 2007-01-02 is Jan 02, 2007)

enddate

If datespan is set to -1, this is the ISO-format date for the end date of the range (e.g. 2007-01-02 is Jan 02, 2007)

starttime

If datespan is set to -1, this is the 6-digit, 24-hour time for the beginning of the range, in HHMMss format (e.g. 003015 is 00:30:15 or 12:30:15 AM)

endtime

If datespan is set to -1, this is the 6-digit, 24-hour time for the end of the range, in HHMMss format (e.g. 233059 is 23:30:15 or 11:30:59 PM)

scope

• 0 - AND
• 1 - OR
• 2 - AND On Same Page (all constraints appear on a single page)

timeout

• 0 - No Timeout
• 90
• 180
• 300
• 600

autostop

• 0 - No Limit
• 1000
• 5000
• 10000
• 20000

opX

• 1 - None
  Note: If you have fewer than five specified search field arguments, the operator for the non-specified parameters should be set to none.
• 2 - Equals
• 3 - Not Equals
• 4 - Like
• 5 - Not_Like

sort

Active and All Sessions searches

• 0 - Num Hits
• 1 - Session Index
• 2 - Last Use (Time)

Completed searches

• 0 - Session score
• 1 - Application Errors
• 2 - Client Errors
• 3 - Server Errors
• 4 - Time Errors
• 5 - Size Errors
• 6 - Event Type
• 7 - not used
• 8 - IP Address
• 9 - Num Hits
• 10 - Num Requests
• 12 - Num Responses
• 13 - Random
• 14 - Session Index
• 15 - Text Pages
• 16 - UsrSts0
• 17 - UsrSts1
• 18 - First Use (Time)
• 19 - Last Use (Time)
• 20 - Canister Date

Configuration

When the Portal Application is installed into IIS, all necessary files to enable the Web Services API are installed.

To verify installation, navigate to the following URL:

http://<portalmachine>/PortalAPI/cxReveal.asmx 

If you receive a valid page the API is installed and available.

If not, you must create a PortalAPI virtual directory that maps to:

<install_directory>\Portal\WebService\