Copyright © Cloud Software Group, Inc. All Rights Reserved

Reporting

The Central Logger component stores reporting information to the database. The Apache HTTP server also generates access logs.

The data from the Central Logger database can be used for reporting. It contains the following data:

•	High level Transaction Auditing

−	One entry for every received request

−	Timing information

−	Service, operation and partner identities

−	Status of overall transaction

•	Detailed level Transaction Auditing

−	Request payload before and after every transformation

−	Multiple identities associated with each transaction

−	The list of stages through which the transaction passed

−	Ad-hoc messages generated during transaction processing

•	Key performance indicators

−	Count of transactions received in a given time interval

−	Per partner, service and operation

−	Default time intervals one minute, five minutes and one hour

TIBCO Spotfire Integration

TIBCO API Exchange Gateway provides a sample TIBCO Spotfire analysis based on data captured by the Central Logger component. The sample shows the following metrics:

•	Transaction rate per partner and service

•	Throttle violation, Service quality and Service timeouts failures

•	Load Visualization for operations and management

−

Volume

−

Latency

−

Peaks

•	Defect detection

•	System Usage

Spotfire Configuration

This section describes the steps for TIBCO Spotfire Professional configuration. The Spotfire client will retrieve the data stored in TIBCO API Exchange Gateway database to display the reports.

 

Task A Configure TIBCO Spotfire Server and Client

This section assumes that you have a running instance of Spotfire server. Ask the Spotfire administrator to create a username and password to allow access on the Spotfire server instance.

Spotfire User Permissions

Make sure that the Spotfire Administrator creates a user to be part of the Library Administrator group on the Spotfire server instance. Ensure that the Administrator grants the library administration permissions to this user. This allows the users to:

−	Create library contents (such as data sources, information links).

−	Import and Export the library content.

−	Store the analysis files.

1.	Install TIBCO Spotfire Professional software. Refer to the product readme for the supported version.

2.	Launch the TIBCO Spotfire Professional.

3.	Connect to the appropriate TIBCO Spotfire server instance by providing the correct URL in the Server field.

4.	Download the software package updates from the server, if prompted.

5.	Verify you have successfully connected to the TIBCO Spotfire server instance for TIBCO API Exchange Gateway and updated your TIBCO Spotfire client to the version that is deployed on the TIBCO Spotfire server.

Task B Setup a Spotfire Data source

1.	Within TIBCO Spotfire Professional, open the Information Designer from the menu bar as: Tools -> Information Designer.

2.	Click the Setup Data Source link.

3.	Input the Data Source fields, as appropriate.

For MySql database, example values are shown as follows:

Name: asgstat

Type: MySQL5

Connection URL: jdbc:mysql://database host:port/database

(where database host is the machine database server runs, by default the port is 3306, and database is the database name such as asgstat).

No. of connections:

−

Min: 1

−

Max: 10

Username: asguser

Password: asgpass

For Oracle database, example values are shown as follows:

Name: asgstat

Type: Oracle

Connection URL: jdbc:oracle:thin:@database host:port:service name

(where database host is the machine database server runs, by default the port is 1521, and the service name is the Oracle service name)

No. of connections:

−

Min: 1

−

Max: 10

Username: asguser

Password: asgpass

For SQL Server database, example values are shown as follows:

Name: asgstat

Type: SQL Server

Connection URL:jdbc:sqlserver://database host:1433/database

(where database host is the machine database server runs, by default the port is 1433, and database is the database name such as asgstat).

No. of connections:

−

Min: 1

−

Max: 10

Username: asguser

Password: asgpass

4.	Click the Save button.

5.	Click Save button again, if pop window appears.

6.	Verify that this data source appears in the left panel of the Information Designer dialog with a + sign next to it.

Task C Create a Spotfire Information Model for Central Logger

1.	Within TIBCO Spotfire Professional, open the Information Designer from the menu bar as: Tools -> Information Designer.

2.	Select the Elements tab.

3.	Create a new directory as follows:

a.	Click New -> Folder

b.	Enter the name of the new folder. For example, ASGTEST

4.	Select the Data Sources tab. In the left panel of the Information Designer dialog, expand the data source name by clicking on the + sign. Expand the asguser schema.

5.	Verify that following database tables are listed from the Central Logger database schema:

−

ASG_KPI

−	ASG_LOG_MESSAGES

−	ASG_THROTTLE_MESSAGES

−	ASG_THROTTLE_USAGE

−	ASG_TRANSACTION_DETAILS

−	ASG_TRANSACTION_KEYS

−	ASG_TRANSACTION_MESSAGES

−	ASG_TRANSACTIONS

6.	Shift-click on the first table and the last table to select all tables. With all the tables selected, right-click on your mouse and select the option Create default Information Model link from the context menu.

7.	On the next window, select Destination folder from the Library as ASGTEST.

8.	Click the OK button on the next new dialog window.

9.	On the Create Default Information Model Settings window, ensure that the radio button Automatically assign a new name to the created item is selected. Click the OK button.

10.	Verify that the Information Links has been created for each table of the Central Logger database, which appears in the left pane of the Information Designer window on the Elements tab.

11.	In the Information Designer window, follow these steps to create the join between the ASG_TRANSACTIONS and ASG_TRANSACTION_KEYS tables:

a.	Click New and select Join from the drop-down list.

b.	From the database schema, expand the ASG_TRANSACTIONS table. Select TRN_GUID and click Add on the right side of the Information Designer window.

c.	From the database schema, expand the ASG_TRANSACTION_KEYS table. Select KEY_TRN_GUID and click Add on the right side of the Information Designer window.

d.	Click Save to save changes.

e.	On the next window, select Destination folder from the Library as ASGTEST.Verify that this creates ASG_TRANSACTIONS - ASG_TRANSACTION_KEYS Inner Join join under ASGTEST folder.

12.	In the Information Designer window, follow these steps:

a.	Go to Elements tab and select ASGTEST folder.

b.	Click New button and select Information Link from the drop-down list.

c.	Select the ASG_TRANSACTIONS data model folder. Add TRN_GUID and TRN_STATUS columns.

d.	Select the ASG_TRANSACTION_KEYS data model folder. Add KEY_TRN_GUID, KEY_TYPE, KEY_VALUE columns.

e.	Expand the Join Path tab. Add the ASG_TRANSACTIONS - ASG_TRANSACTION_KEYS Inner Join join.

f.	Save the Information link as Transaction-Transaction Keys.

13.	Click the Close button to close the Information Designer.

Task D Deploy the Default TIBCO API Exchange Gateway Audit Trail DXP File on TIBCO Spotfire Server

1.	Within TIBCO Spotfire Professional, open the ASG_HOME/templates/spotfire/ASG_LogData.dxp Spotfire visualization file by selecting the menu option File -> Open.

2.	If the analysis file opens with Missing Information Link warnings, follow the steps:

−	Select the Browse for the missing information link radio button and click the OK button.

−	In the Select Information Link dialog window, select the ASG_TRANSACTIONS information link (with the paperclip icon next to it) and click the OK button.

−	Repeat these steps for the following missing information links:

ASG_KPI

ASG_TRANSACTIONS

ASG_TRANSACTION_DETAILS

ASG_TRANSACTION_MESSAGES

ASG_TRANSACTION_KEYS

Transaction-Transaction Keys

3.	Note that the analysis file opens without any errors. This file does not show any data as the Central Logger database is empty.

4.	Save the ASG_LogData.dxp analysis file in the Spotfire Server by selecting menu option File -> Save as -> Library Item. In the Save As Library Item dialog window that opens, Click the Finish button.

5.	Click the Close button in the dialog window.

6.	After the tests are run, use the menu option File -> Reload Data to refresh the data. Verify that the audit trail data from the database is loaded in the visualization file.

7.	Select File -> Exit to close the Spotfire Professional.

Copyright © Cloud Software Group, Inc. All Rights Reserved