Integration Points (IP) are crucial components of most Interactions. To help you monitor the quality of your flows and make sure that your Interactions are running smoothly, the Jacada Interact Admin Console provides a record of all IPs that have been run. This record, known as the IP Logs list, includes data such as whether the IP performed as expected, how long the request took, and other important details.
Note: The IP Logs list is available to users with roles of Interaction Admin and higher. For details about roles, refer to User Roles and Permissions.
This article explains the IP Logs list and how to work with it.
Getting Started with the IP Logs List
Access the IP Logs list by clicking the Logs button at the top of the Web Service Integration Points page.
By default, the IP Logs list contains all Integration Points that have been run, with the most recently run listed first. 50 records are presented on each page of the list.
|1||IP Logs grid||Displays basic information about each IP that was run. The list cannot be sorted manually (according to column header), but can be filtered using the filtering options provided above the list.|
|2||Filtering options||Allow you to filter the list according to various search parameters. For details, refer to Filtering the IP Logs List (below).|
|3||Refresh button||Updates the IP Logs list with the latest data from the server.|
|4||Export button||Saves the logs record to a CSV file. For more information, refer to Exporting the IP Logs List (below).|
|5||Details link||Opens a popup showing more detailed data about the selected IP instance. For more information, refer to Viewing IP Log Details (below).|
|6||Navigation bar||Allows you to navigate quickly to other pages of the IP Logs list.|
Filtering the IP Logs List
The filtering options let you filter the IP Logs list according to various search parameters, so you can quickly locate relevant IP instances. You can use multiple filters simultaneously.
After specifying your filters, click the Filter button to activate filtering.
The filters are:
- Integration Point Name: Lists all Integration Points defined for your account (regardless of whether they have run). Select the relevant IP from the list, or enter the name of the required IP. Autocomplete functionality is supported.
- Status: Select from All, Success or Failure.
Keep in mind that when the web service has returned a success code (e.g., 200 OK, 201 Created, etc.), the status in the log is Success, regardless of whether response mapping succeeded.
- Date: Click the Calendar icons to open the date picker, and select start and end dates for the search. Start and end times can be specified according to hour and minute (at the bottom of the date picker).
- Interaction Name: Lists all Interactions defined for your account. Select the relevant Interaction from the dropdown list, or enter the name of the required Interaction. Autocomplete functionality is supported.
- Interaction Instance ID: If you know the unique identifier of the required Interaction instance, enter it in the textbox.
- Input Parameter: A free text field in which you can enter any of the input values defined for the Integration Point (if relevant). Only one input parameter may be specified.
- Caller Attribute: A free text field in which you can enter any single caller attribute associated with an Interaction instance. Supported caller attributes are:
- DTMF: The DTMF code that is passed with the customer's call (supported when Direct Dial with DTMF Code is selected as the Call Now handling method).
- DNID: An identifier for the number, generally the last 4 or 6 digits of the phone number (relevant when the DNIS Manager is used for call handling).
- Call Return Number: The number entered by the customer as part of a request for a callback. This number is allocated automatically as the Call Return Number Entered Read Only variable.
- Caller ID: Supported when the DNIS Service Application is used for call handling. The value of the attribute is usually the phone number to which the user dialed. During the DNIS Manager or DNIS As a Service flow, it is allocated automatically as the Click to Call Caller ID Read Only variable.
- History Search ID: This attribute can be used when the call center has passed a unique identifier in the historySearchId parameter for the Interaction instance URL, and/or when the historySearchId system variable has been allocated a value in the Interaction. (If the variable is allocated more than once, the latest value is used.)
Viewing IP Log Details
Clicking the Details link on the right side of the IP Logs list opens a popup that displays additional information about the selected IP instance. This data includes the request (including headers) and the response. If a custom Integration Point is selected, the body contains the defined parameters and their values. The format of the response is JSON for REST IPs and XML for SOAP IPs.
Exporting the IP Logs List
The Export feature lets you save the currently displayed IP Logs list as a CSV file. A maximum of 10,000 records can be included in the file. If your IP Logs list contains more records than this, the most recent 10,000 records are exported.
The following information is exported for each record. No data is indicated by the word null in the relevant cell.
- Integration Point name
- Interaction name
- Timestamp of when request was sent (mm/dd HH:MM:SS)
- Duration (in ms)
- Status (success or failure)
- Request (REST or SOAP), including headers
- Response (REST or SOAP)
- Click to Call Caller ID
- Call Return Number Entered
- History Search ID
- Interaction Unique ID
To export the IP Logs list:
- At the upper right corner of the Integration Point Logs page, click Export.
The Export popup opens.
- Click Export.
The list is downloaded in CSV file format.
Note: When reviewing the exported file, keep in mind that due to default settings used by Excel, any leading zeroes do not appear. This can affect values such as DTMF.