TIBCO API Exchange Gateway Release Notes - … · 2016-06-08 · TIBCO® API Exchange Gateway...

TIBCO® API Exchange Gateway Release Notes Software Release 2.2.0October 2015

Document Update: June 2016

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO and Two-Second Advantage are either registered trademarks or trademarks of TIBCO SoftwareInc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2004-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

2

TIBCO® API Exchange Gateway Release Notes

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

New Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Changes in Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Deprecated and Removed Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Migration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Migrating the Project Configuration and Properties Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Migrating ASG_DefaultImplementation Project Customizations (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Migrating CDD Files (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Migrating TRA Files (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Update Database Schema for Central Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Updating Oracle Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Updating MS SQL Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Updating MySQL Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Updating DB2 Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Updating Foreign Key Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Closed Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

3


TIBCO Documentation and Support Services

Documentation for this and other TIBCO products is available on the TIBCO Documentation site:

https://docs.tibco.com

Documentation on the TIBCO Documentation site is updated more frequently than any documentationthat might be included with the product. To ensure that you are accessing the latest available helptopics, please visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site. To directly access documentation for this product, double-click thefollowing file:

The following documents for this product can be found on the TIBCO Documentation site:

● Installation

● User's Guide

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

http://www.tibco.com/services/support

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://www.tibcommunity.com

4




http://www.tibco.com/services/support

https://support.tibco.com

https://www.tibcommunity.com

New Features

The following new features have been added to version 2.2.0 of TIBCO API Exchange Gateway.

Log Privacy Policies

Log masking policies are able to remove or mask private or sensitive information from messages beforethey are sent to the Central Logger or system logs. The masking policies auto-detect XML and JSON, orform URL encoded messages.

Throttles

The TIBCO API Exchange Gateway clusters now use the data grid for coordinating throttles instead ofthe TIBCO Rendezvous-based Global Throttle Manager (GTM).

Throttles now leverage a shared counter providing a highly accurate counter across a cluster. Earlierbehavior can be enabled with the new setting Use Approximate Monitor.

Quota throttles now release limit if requests fail.

Message Policies

Anti-Virus Scanning of Payloads

TIBCO API Exchange Gateway can call a virus scanner to block malicious messages. TIBCO APIExchange Gateway scans the request or response messages for viruses and other malware byintegrating with anti-virus servers through ICAP. TIBCO API Exchange Gateway supports McAfeeWeb Gateway.

Correlation ID SupportTIBCO API Exchange Gateway generates a correlation identifier such as X-Request-ID to grouprelated transactions and messages for debugging, auditing and analysis.

Custom Authentication

TIBCO API Exchange Gateway provides an extensible authentication framework to support non-standard authentication. For example, when you want to extract user credentials from a request that arestored in a proprietary way or verify the credentials against a custom identity store, you can extend thebase login module. An authentication policy defines a custom shared resource using this custommodule.

New Global Variables

Support SSLv3 for native HTTP ChannelThe following global variables have been added to enable SSLv3 for the native HTTP Channel tosupport facade operation requests:

tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPSSLConnection/SSLServerProtocolstibco.clientVar.DefaultImplementation/Connections/HTTP/OAuthWebappsSSLConnection/SSLServerProtocols

Set Hostname for native HTTP ChannelThe following global variable has been added to set the hostname for the native HTTP channel:

tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPConnection/Host

Access Config UI using HTTPS for Mutual SSL

5


The following global variables have been added to configure the Config UI for mutual SSL.java.property.com.tibco.asg.designtime.configui.launcher.secure=falsejava.property.com.tibco.asg.designtime.configui.launcher.scheme=httpjava.property.com.tibco.asg.designtime.configui.launcher.keyAlias=tomcatjava.property.com.tibco.asg.designtime.configui.launcher.keystorePass=changeitjava.property.com.tibco.asg.designtime.configui.launcher.keystoreFile=java.property.com.tibco.asg.designtime.configui.launcher.keystoreType=JKSjava.property.com.tibco.asg.designtime.configui.launcher.clientAuth=falsejava.property.com.tibco.asg.designtime.configui.launcher.sslProtocol=TLSjava.property.com.tibco.asg.designtime.configui.launcher.SSLEnabled=falsejava.property.com.tibco.asg.designtime.configui.launcher.server=Apachejava.property.com.tibco.asg.designtime.configui.launcher.truststoreFile=java.property.com.tibco.asg.designtime.configui.launcher.truststorePass=changeitjava.property.com.tibco.asg.designtime.configui.launcher.truststoreType=JKS

Payload Size LimitThe following global variables have been added to limit the size of payload at which logging istruncated.tibco.clientVar.ASG/ForwardLargePayloadLimit=10000tibco.clientVar.ASG/ReverseLargePayloadLimit=10000

Enhancement of OAuth Validation APIThe following global variable has been added to enable the OAuth validation API to return the extraattributes of access token.tibco.clientVar.oauth.access.token.attributes=true

Access plan type to HTTP Header

TIBCO API Exchange Gateway adds the plan type to HTTP header using the XSLT file. To include theplan type as an HTTP request header with the header name as X-Plan-Type, include the following inthe request mapper:<h:override-header name="X-Plan-Type"><xsl:value-of select="mapperUtils:getProperty($requestId,'X-Plan-Type')" xmlns:mapperUtils="java:com.tibco.asg.tools.MapperProperties"/></h:override-header>

Optional Client Secret for OAuth Password Credential Flow

The client secret is now optional during the token request for public clients using the OAuth PasswordCredential flow. For example, if you are using the file based client adapter, the third column (reserved)of ASG_HOME\examples\OAuth\resources\client.properties file must be explicitly set topublic since the default is confidential. Refer to the following entry:

#[name]|[password]|(confidential|public)|[attribute=value]*|scopes

OAuth

The OAuth 2.0 Implicit Grant Flow is now supported.

Custom Error Message on Failure of the OAuth User Credential Grant

The new Java system property oauth.error.use.adapter.message gives the option to return acustom error message from the adapter. If the adapters (owner or client) returns an error, and thesystem property is set to true, then the authorization server returns the error message from the owneror client authentication. To enable and disable error from the adapter:

Set java.property.oauth.error.use.adapter.message=true to enable.

Set java.property.oauth.error.use.adapter.message=false to disable.

6


Performance Improvements

● Optimization for Payload Handling

TIBCO API Exchange Gateway skips the logging and payload processing for request or responsepayloads over the Payload Size Limit.

● Throughput and latency improvements

PingIdentity Authorization Server

TIBCO API Exchange Gateway supports PingIdentity authorization server for OAuth policies.

Partner Identification for native HTTPS Channel

TIBCO API Exchange Gateway supports partner identification using the client certificate for the nativeHTTPS channel.

New APIs for Config UI

TIBCO API Exchange Gateway provides new APIs to support the Config UI functionality.

Analytics

The analytics provided by the TIBCO Spotfire Server components has been enhanced to display thefollowing fields:

● Operation URI

● HTTP Headers

● SOAP Action

● Request Payload Size

● Response Payload Size

ASG_KPI Table with the Time of the Period End

The ASG_KPI table now includes the time of the period end making it easier to use third-partyreporting tools.

Logging

Access Logging for native HTTP and HTTPS ChannelTIBCO API Exchange Gateway now provides access logging. Previously this was only availablethrough the Apache HTTP Server.

Storing Request HeadersTIBCO API Exchange Gateway logs the service URI, complete HTTP headers, and SOAP Action of therequest message in the Central Logger database when the detail level logging is enabled.

Asynchronous Option for Target Operations

TIBCO API Exchange Gateway provides new asynchronous option for target operations to improve thegateway resource utilization when large numbers of concurrent long services are running.

New Platforms and Third Party Software

Support for the following third party software has been added in this release:

7


Third Party Software

● Oracle 12c

● McAfee Web Gateway 7.4.2

Support for XML JSON Mediation

XML to JSON schema based conversion

To convert XML to JSON using a schema, call the following function from your mapper:public static String convertXMLToJSONWithXsd(String xmlString, String xsd, boolean removeRoot, boolean badgerfish, boolean strictBadgerfish, boolean forwardSlashEscaping, boolean ignoredSpecialSign, boolean ignoredNamespace, boolean empty2null, boolean validateInput, boolean checkEmptyElement)

For example:<xsl:variable name="jsonBody"> <xsl:value-ofselect="mapperUtils:convertXMLToJSONWithXsd($httpPayload,'~/MapperTest/BookStoreParse.xsd',not(true()),not(true()),not(true()),not(true()),not(true()),not(true()),not(true()),true(),not(true()))"xmlns:mapperUtils="java:com.tibco.asg.saxon.mapper.PayloadMapper"/></xsl:variable>

XML to JSON non schema based conversion

To convert XML to JSON without a schema, call the following function from your mapper:public static String convertXMLToJSON(String xmlString,boolean removeRoot, boolean badgerfish, boolean strictBadgerfish, boolean forwardSlashEscaping, boolean ignoredSpecialSign, boolean ignoredNamespace, boolean empty2null)

For example:<xsl:variable name="jsonBody"><xsl:value-of select="mapperUtils:convertXMLToJSON($httpPayload, true(),not(true()),not(true()),not(true()),not(true()),not(true()),not(true()))" xmlns:mapperUtils="java:com.tibco.asg.saxon.mapper.PayloadMapper"/></xsl:variable>

JSON to XML, schema based conversion

To convert JSON to XML using a schema, call the following function from your mapper:public static String convertJSONToXMLWithXsd (String jsonString, String xsd, boolean validateOutput, boolean badgerfish, boolean strictBadgerfish, boolean forwardSlashEscaping, boolean ignoredSpecialSign)

For example:<xsl:variable name="xmlBody"><xsl:value-of select="mapperUtils:convertJSONToXMLWithXsd($httpPayload,'~/MapperTest/BookStoreParse.xsd',true(),not(true()),not(true()),not(true()),not(true()))" xmlns:mapperUtils="java:com.tibco.asg.saxon.mapper.PayloadMapper"/></xsl:variable>

JSON to XML non schema based conversion

To convert JSON to XML without a schema, call the following function from your mapper:public static String convertJSONToXML (String jsonString, String jsonRoot, boolean badgerfish, boolean strictBadgerfish, boolean forwardSlashEscaping, boolean ignoredSpecialSign)

For example:<xsl:variable name="xmlBody"><xsl:value-of select="mapperUtils:convertJSONToXML($httpPayload,'BookStore',not(true()),not(true()),not(true()),not(true()))"

8


xmlns:mapperUtils="java:com.tibco.asg.saxon.mapper.PayloadMapper"/></xsl:variable>

Config UI

Search fields available on each tab make it easier to locate desired entries.

Choose operation features from a drop-down menu.

The New Reload Project Configuration button reloads project configuration files from a disk.

9


Changes in Functionality

The following are changes in functionality in version 2.2.0 of TIBCO API Exchange Gateway.

Central Logger Database Schema ChangesThe Central Logger database tables schema has been changed. The following new columns have beenadded to the database schema:

Database Table Changes

Table Name Columns

ASG_TRANSACTIONS● TRN_REQUEST_PAYLOAD_SIZE

● TRN_RESPONSE_PAYLOAD_SIZE

● TRN_CORRELATION_ID

ASG_KPI● KPI_END_TIMESTAMP

ASG_TRANSACTION_DETAILS● DET_SERVICEURI

● DET_SOAPACTION

● DET_HTTPHEADERS

● DET_PAYLOAD_SIZE

Replacing TIBCO Rendezvous with TIBCO ActiveSpaces for TransportTIBCO API Exchange Gateway uses TIBCO ActiveSpaces instead of TIBCO Rendezvous as the defaulttransport for communication between various components of the gateway.

Error Handling

Error responses in JSON now include error codes (same as the XML error responses). When a requestfails due to Partner or APU Key not being authorized, a fault transform, if available, is now applied.

10


Deprecated and Removed Features

The following tables list any features that have been deprecated or removed as of version 2.2.0 ofTIBCO API Exchange Gateway.

For deprecated features, if relevant, useful alternatives are listed. Any use of a deprecated featureshould be discontinued because it might be removed in a future release. To avoid becoming dependenton deprecated features, ensure that you become familiar with the suggested alternative features.

Deprecated Features

AffectedComponent Description

DeprecatedRelease

Reporting Support for Spotfire 6.0 has been deprecated.

Support for Spotfire 5.5 has been removed.

2.2.0

11


Migration

This section explains the migration process to migrate TIBCO API Exchange Gateway product from aprevious release to version 2.2.0.

Migration ProcessPerform the following tasks to migrate from a previous version TIBCO API Exchange Gateway toTIBCO API Exchange Gateway 2.2.0.

● Stop the existing version of TIBCO API Exchange Gateway.

● Install TIBCO API Exchange Gateway 2.2.0.

● Migrate the ASG configuration directory, including the project configuration and properties files.See Migrating the Project Configuration and Properties Files.

After completion, manually update the substitution variables %TIBCO_ASG_CONFIG_HOME_ESC% and%TIBCO_ASG_HOME_ESC% in the asg.properties and asg_portal.properties files.

If you are installing both TIBCO API Exchange Gateway and TIBCO API ExchangeManager, perform this step when installing TIBCO API Exchange Manager.

● Manually migrate customizations made to the ASG_DefaultImplementation project. See MigrateASG_DefaultImplementation Project Customizations (Optional).

● Manually migrate customizations made to the CDD files. See Migrate CDD Files.

● Manually migrate customizations made to the TRA files. See Migrating TRA Files (Optional).

● Update the database schema. See Update Database Schema for Central Logger.

● Start TIBCO API Exchange Gateway 2.2.0.

If you are installing both TIBCO API Exchange Gateway and TIBCO API ExchangeManager, start after installing TIBCO API Exchange Manager.

Migrating the Project Configuration and Properties FilesUse the migration tool to migrate the project configuration containing the *.cfg files and runtimeproperties files.

Procedure

1. Navigate to the ASG_HOME/bin directory.

2. Type the following command to run the tool:asg-tools -u migrate-config -cc Source_Configuration_Directory -dc Destination_Configuration_Directory -sv Source_Version

The arguments of the asg-tools migration tool are defined as follows:

● cc : specifies the full path of the source configuration directory to be migrated.

For example, this is the configuration directory for a previous release such as 2.1.0.

● dc: specifies the full path of the destination configuration directory where the migratedconfiguration is stored.

For example, this is the configuration directory for the current release such as 2.2.0.

● sv: specifies the release version of the source configuration directory to be migrated.

For example, this is the version for a previous release such as 2.1.0.

12


For example, on the Windows platform, run the tool as follows to migrate the project configurationand runtime properties files from version 2.1.0 to version 2.2.0:

Any changes made to the project configuration or properties files in the directory specifiedby -dc parameter are overwritten by the asg-tools tool. Any change to be made to theconfiguration directory as specified by the -dc parameter have to be made aftercompleting the migration process.

The original configuration files are saved in <TIBCO Config Home>/tibco/cfgmgmt/asg/../asg.bak/asg.

asg-tools.exe -u migrate-config -cc C:/TIBCO_CONFIG/tibco/cfgmgmt/asg/../asg.bak -dc C:/TIBCO_CONFIG/tibco/cfgmgmt/asg -sv 2.1.0

Migrating ASG_DefaultImplementation Project Customizations (Optional)You must migrate the ASG_DefaultImplementation project only if you have made any customchanges to the default ASG_DefaultImplementation project to extend the default behavior of CoreEngine in a previous release.

If you have made any changes to the ASG_DefaultImplementation Project, redo the changes manuallyin the ASG_DefaultImplementation project of TIBCO API Exchange Gateway 2.2.0.

Migrating CDD Files (Optional)If you have made any changes to the CDD files, redo the changes manually in the CDD files of TIBCOAPI Exchange Gateway 2.2.0.

Migrating TRA Files (Optional)You must manually migrate any changes made to the TRA files located in the ASG_HOME/bindirectory.

If you have made any changes in the TRA files (for example, ASG_HOME/bin/asg_engine.tra) in aprevious release, redo the changes manually in the TRA files of TIBCO API Exchange Gateway 2.2.0.

Update Database Schema for Central LoggerTIBCO API Exchange Gateway 2.2.0 introduces few changes to the database schema of asgstatdatabase used by the Central Logger.

The schema for the following tables have been changed:

● ASG_KPI

● ASG_TRANSACTION_DETAILS

● ASG_TRANSACTIONS

ASG_KPI Table Changes

The following column has been added to the ASG_KPI table in the asgstat database:

● KPI_END_TIMESTAMP

ASG_TRANSACTION_DETAILS Table Changes

The following columns have been added to the ASG_TRANSACTION_DETAILS table in the asgstatdatabase:

● DET_SERVICEURI

● DET_SOAPACTION

● DET_HTTPHEADERS

13


● DET_PAYLOAD_SIZE

ASG_TRANSACTIONS Table Changes

The following columns have been added to the ASG_TRANSACTIONS table in the asgstat database:

● TRN_CORRELATION_ID

● TRN_REQUEST_PAYLOAD_SIZE

● TRN_RESPONSE_PAYLOAD_SIZE

This section explains the steps required to migrate the existing databases from a previous version (suchas 2.0.0) to version 2.2.0 of TIBCO API Exchange Gateway.

Updating Oracle Database

Complete the following steps to upgrade the oracle database with the schema changes.

Procedure

1. Back up the existing data in the ASG_KPI, ASG_TRANSACTION_DETAILS, and ASG_TRANSACTIONStable of the database.

2. Execute the following SQL statements on the asgstat database:

ALTER TABLE ASGSTAT.ASG_KPI ADD KPI_END_TIMESTAMP TIMESTAMP;

ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS ADD (DET_SERVICEURI VARCHAR(256),DET_SOAPACTION VARCHAR(256), DET_HTTPHEADERS CLOB, DET_PAYLOAD_SIZE INTEGER);

ALTER TABLE ASGSTAT.ASG_TRANSACTIONS ADD (TRN_CORRELATION_IDVARCHAR(256), TRN_REQUEST_PAYLOAD_SIZE INTEGER, TRN_RESPONSE_PAYLOAD_SIZEINTEGER);

Updating MS SQL Server Database

Complete the following steps to upgrade the MS SQL Server database with the schema changes.

Procedure



ALTER TABLE ASG_KPI ADD KPI_END_TIMESTAMP DATETIME default getdate();

ALTER TABLE ASG_TRANSACTION_DETAILS ADD DET_SERVICEURI VARCHAR(256), DET_SOAPACTION VARCHAR(256), DET_HTTPHEADERS NVARCHAR(max), DET_PAYLOAD_SIZE BIGINT;

ALTER TABLE ASG_TRANSACTIONS ADD TRN_CORRELATION_ID VARCHAR(256), TRN_REQUEST_PAYLOAD_SIZE BIGINT, TRN_RESPONSE_PAYLOAD_SIZE BIGINT;

Updating MySQL Database

Complete the following steps to upgrade the MySQL database with the schema changes.

14


Procedure



ALTER TABLE ASG_KPI ADD COLUMN KPI_END_TIMESTAMP TIMESTAMP NULLAFTER KPI_TIMESTAMP;

ALTER TABLE ASG_TRANSACTION_DETAILS ADD (DET_SERVICEURI VARCHAR(256),DET_SOAPACTION VARCHAR(256), DET_HTTPHEADERS MEDIUMTEXT, DET_PAYLOAD_SIZEBIGINT);

ALTER TABLE ASG_TRANSACTIONS ADD (TRN_CORRELATION_ID VARCHAR(256),TRN_REQUEST_PAYLOAD_SIZE INTEGER, TRN_RESPONSE_PAYLOAD_SIZE INTEGER);

Updating DB2 Database

Complete the following steps to upgrade the DB2 database with the schema changes.

Procedure



ALTER TABLE ASGSTAT.ASG_KPI ADD KPI_END_TIMESTAMP TIMESTAMP;

ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS ADD COLUMN DET_SERVICEURIVARCHAR(256) ADD COLUMN DET_SOAPACTION VARCHAR(256) ADD COLUMN DET_HTTPHEADERSCLOB ADD COLUMN DET_PAYLOAD_SIZE BIGINT;

ALTER TABLE ASGSTAT.ASG_TRANSACTIONS ADD COLUMN TRN_CORRELATION_IDVARCHAR(256) ADD COLUMN TRN_REQUEST_PAYLOAD_SIZE BIGINT ADD COLUMNTRN_RESPONSE_PAYLOAD_SIZE BIGINT;

Updating Foreign Key Constraints

The foreign key constraints on the tables of the asgstat database has been updated to include the ONDELETE CASCADE clause.Execute the following steps to update the foriegn key constraints of database tables:

Procedure

1. Back up the existing data of ASG_TRANSACTION_KEYS , ASG_TRANSACTION_MESSAGES, andASG_TRANSACTION_DETAILS tables.

2. Depending on the database server, execute the following SQL statements on the asgstat database:

Oracle

ALTER TABLE ASGSTAT.ASG_TRANSACTION_KEYS DROP CONSTRAINT ASG_TRANSACTION_KEYS_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_KEYS ADD (constraint ASG_TRANSACTION_KEYS_FK foreign key (KEY_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

ALTER TABLE ASGSTAT.ASG_TRANSACTION_MESSAGES DROP CONSTRAINT

15


ASG_TRANSACTION_MESSAGES_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_MESSAGES ADD (constraint ASG_TRANSACTION_MESSAGES_FK foreign key (MSG_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS DROP CONSTRAINT ASG_TRANSACTION_DETAILS_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS ADD (constraint ASG_TRANSACTION_DETAILS_FK foreign key (DET_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

MS SQL Server

ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_KEYS DROP CONSTRAINT ASG_TRANSACTION_KEYS_FK;ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_KEYS ADD CONSTRAINT ASG_TRANSACTION_KEYS_FK foreign key (KEY_TRN_GUID) references [asgstat].[dbo].[ASG_TRANSACTIONS] (TRN_GUID) ON DELETE CASCADE;

ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_MESSAGES DROP CONSTRAINT ASG_TRANSACTION_MESSAGES_FK;ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_MESSAGES ADD CONSTRAINT ASG_TRANSACTION_MESSAGES_FK foreign key (MSG_TRN_GUID) references [asgstat].[dbo].[ASG_TRANSACTIONS] (TRN_GUID) ON DELETE CASCADE;

ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_DETAILS DROP CONSTRAINT ASG_TRANSACTION_DETAILS_FK;ALTER TABLE [ASGSTAT].[DBO].ASG_TRANSACTION_DETAILS ADD CONSTRAINT ASG_TRANSACTION_DETAILS_FK foreign key (DET_TRN_GUID) references [asgstat].[dbo].[ASG_TRANSACTIONS] (TRN_GUID) ON DELETE CASCADE;

MySQL

ALTER TABLE ASG_TRANSACTION_KEYS DROP FOREIGN KEYASG_TRANSACTION_KEYS_FK;ALTER TABLE ASG_TRANSACTION_KEYS ADD (CONSTRAINT ASG_TRANSACTION_KEYS_FK foreign key (KEY_TRN_GUID)references ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

ALTER TABLE ASG_TRANSACTION_MESSAGES DROP FOREIGN KEY ASG_TRANSACTION_MESSAGES_FK;ALTER TABLE ASG_TRANSACTION_MESSAGES ALTER ADD (CONSTRAINT ASG_TRANSACTION_MESSAGES_FK foreign key (MSG_TRN_GUID) references ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

ALTER TABLE ASG_TRANSACTION_DETAILS DROP FOREIGN KEY ASG_TRANSACTION_DETAILS_FK;ALTER TABLE ASG_TRANSACTION_KEYS ADD (CONSTRAINT ASG_TRANSACTION_DETAILS_FK foreign key (KEY_TRN_GUID) references ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE);

DB2

ALTER TABLE ASGSTAT.ASG_TRANSACTION_KEYS DROP FOREIGN KEY ASG_TRANSACTION_KEYS_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_KEYS ADD CONSTRAINT ASG_TRANSACTION_KEYS_FK foreign key (KEY_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE;

ALTER TABLE ASGSTAT.ASG_TRANSACTION_MESSAGES DROP FOREIGN KEY ASG_TRANSACTION_MESSAGES_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_MESSAGES ADD CONSTRAINT

16


ASG_TRANSACTION_MESSAGES_FK foreign key (MSG_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE;

ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS DROP FOREIGN KEY ASG_TRANSACTION_DETAILS_FK;ALTER TABLE ASGSTAT.ASG_TRANSACTION_DETAILS ADD CONSTRAINT ASG_TRANSACTION_DETAILS_FK foreign key (DET_TRN_GUID) references ASGSTAT.ASG_TRANSACTIONS (TRN_GUID) ON DELETE CASCADE;

17


Closed Issues

The table lists closed issues in version 2.2.0 of TIBCO API Exchange Gateway.

Key Summary

ASG-7306 With 2.1.1_HF-001, Gateway did not recognise HTTP Status 204 - No Content(Content-Length=Zero) in Response and threw Service Timeout errors.

ASG-7288 ConfigUI successfully validated a Project with blank values for mandatory fields.

ASG-7235 Keystores were corrupted when published from the portal to the gateway.

ASG-7294 Throttle's maxCount was set to 0 causing Premature Throttle error

ASG-6915 Error message "Rate Throttle reached for throttle <MONITOR_NAME>" was beingthrown even when the Rate Monitor was valid.

ASG-6879 TIBCO API Exchange Gateway did not search for the correct format of OAuthaccess token in the header of the request.

ASG-6847 The Config UI did not allow the users to login when the authentication wasconfigured to use the LDAP server with SSL connectivity.

ASG-6817 The update configuration did not work for the remote project settings when thekeystore and shared resource files were updated to the master project settings.

ASG-6816 The header buffer size was too small when TIBCO API Exchange Gatewayprocessed the requests using Kerberos SPNEGO authentication mechanism.

ASG-6800 TIBCO API Exchange Gateway did not support the redirect with POST methodusing the authorization code flow of OAuth server.

ASG-6794 TIBCO API Exchange Gateway did not support the substitution of ownerID valuesin the OAuth authentication policy.

ASG-6786 The Studio could not open the CONSTANTS scorecard for editing.

ASG-6769 TIBCO API Exchange Gateway reset the 403 HTTP status code generated by thegateway to 500 HTTP status code when the request was sent to the gatewaythrough the Apache module.

ASG-6711 TIBCO API Exchange Gateway did not support SOAP 1.2 protocol for credentialmapping policies.

ASG-6488 For SOAP/HTTP and REST/HTTP requests, Client IP / Host / SOAPAction /ServiceURI of incoming request to APIX was not logged for a lower log level.

ASG-6547 TIBCO API Exchange Gateway OAuth server generated the access token when thedatabase as backing store was not available.

18


Key Summary

ASG-6511 TIBCO API Exchange Gateway did not provide an option to specify the OAuthaccess token in the header of the request. To generate the OAuth access token in therequest header, specify {access_token} in the headersToForward field of an facadeoperation request.

ASG-6399 The updated configuration was incomplete for the OAuth security binding entrieswhen the user tried to publish the master configuration settings to remote gatewayinstances from the portal Config UI of TIBCO API Exchange Manager.

ASG-6451 TIBCO API Exchange Gateway did not include the special characters in theparameter values of the query string for a facade operation request.

ASG-6432 /ASG-6479

TIBCO API Exchange Gateway did not support a property to set the timeout valuefor HTTP native transport when the target service took more than one minute tosend the response to client.

ASG-6431 /ASG-6059

TIBCO API Exchange Gateway did not set the Content-Length header when theclient sent a HTTP request with 1.0 or 0.9 protocol version.

ASG-6414 TIBCO API Exchange Gateway did not provide a script to purge the log data forMicrosoft SQL Server database.

ASG-6407 TIBCO API Exchange Gateway did not forward the Authorization header nameto the target service when the Headers To Forward field of the request containedthe Authorization header name.

ASG-6392 TIBCO API Exchange returned a misleading Operation Not Found error messagewhen a request with an invalid or missing API Key was sent to the gateway.

ASG-6391 /ASG-6419

TIBCO API Exchange did not export the data from Spotfire analytics dashboard toPDF, CSV and PPT formats correctly.

ASG-6276 TIBCO API Exchange Gateway returned an error response when the client sent arequest with no user name and password in HTTP header for HTTP basicauthentication using non-preemptive mode.

ASG-6234 The purge database script for MySQL shipped with TIBCO API Exchange Gatewaymay throw a foreign key constraint error.

ASG-6226 The value set in the items per page field under Pagination of Config UI did notwork as expected.

For example, the page entries only displayed 10 entries per page irrespective of thevalue set in the items per page field.

ASG-6221 The Kerberos SPNEGO authentication did not work correctly in TIBCO APIExchange Gateway.

ASG-1193 TIBCO API Exchange Manager displayed an alert error for Linked Data Reportwhen the report was opened with TIBCO Spotfire. The error report referred toinvalid column in the ASG_TRANSACTION_MESSAGES table of Central Loggerdatabase.

19


Key Summary

ASG-1103 The Central Logger of TIBCO API Exchange Gateway threw a null pointerexception when it was deployed in cluster mode.

ASG-6243 TIBCO API Exchange Gateway did not handle the responses correctly whencontent-typewas multipart or mixed.

ASG-6217 TIBCO API Exchange Gateway did not provide the properties on the Config UI tosupport SSL V3 for native HTTP channel.

ASG-6215(ASG-6297)

When AS channels were enabled, TIBCO API Exchange Gateway did not use theasg.properties file specified with -p parameter of asg-engine command to startCore Engine, and it searched for ASG_CONFIG_HOME/asg.properties file.

ASG-6195 An error WSS AuthN Failure - Request is not authenticated withusername token was thrown by TIBCO API Exchange Gateway if the multiplerequests were processed for WSS authentication.

ASG-6156 TIBCO API Exchange Gateway did not correctly encode the query parameters inthe facade operation URL of northbound request.

ASG-6137(ASG-6294)

TIBCO API Exchange Gateway did not provide the properties in theASG_CONFIG_HOME/asg.properties file to enable the SSLv3 support for thenorthbound request received through the native HTTP channel.

ASG-6114 TIBCO API Exchange Gateway did not log the Client IP, Host, SOAPAction, andServiceURI headers of the incoming request at the INFO level.

ASG-6107 The REST serializer of TIBCO API Exchange Gateway used the payload as NULL ifthe Transfer-Encoding: Chunked header was set instead of the Content-Lengthheader.

ASG-6106 When the token API was used to retrieve an access token details, the status of theaccess token was shown Active in the response message for an expired token.

ASG-5422 TIBCO API Exchange Gateway returned different response messages to clientswhen the request was sent to the gateway using the facade HTTP channel insteadof being sent using the Apache module.

ASG-5264 Using the Config UI, when the new target operations are added and saved onTarget Operation Groups tab, they were not shown in the Target OperationGroups tab.

ASG-4352 When a remote configuration update was done from the Config UI, TIBCO APIExchange Gateway did not push the keystore and shared resource files to remoteconfiguration from the master configuration.

ASG-4006 TIBCO API Exchange Gateway did not support mutual SSL authentication forHTTPS transport.

ASG-3813 The event payload validation did not work with Apache RV module of TIBCO APIExchange Gateway.

20


Key Summary

ASG-6252 TIBCO API Exchange Gateway threw an ActiveSpaces error when the field namestarting with the underscore (_) character causes AS error when backingstore isenabled on response cache.

ASG-5689 The Central Logger threw the following runtime exception :

java.lang.RuntimeException: com.mysql.jdbc.MysqlDataTruncation: Data

truncation: Data too long for column 'THM_MESSAGE'.

ASG-3988 The Config UI did not allow user to change the value of Request Transform fieldfor a facade access due to the incorrect validation.

ASG-4826 The CLASSPATH variable in the asg-engine.tra file did not includeTIBCO_HOME/tools/lib directory.

ASG-6231 TIBCO API Exchange Gateway changed the user-defined Partner Timeout value todefault vlaue (25 seconds) for a facade access when a new user, application or APIkey was created from TIBCO API Exchange Manager for the API associated withthe product.

ASG-6555 The Config UI did not validate a project before the publish configuration wasexecuted. The publish configuration deleted data from configuration of a gatewayinstance when the data was published to multiple gateway instances.

ASG-6446 TIBCO API Exchange Gateway did not execute the fault transform for a requestwhen the processing of request failed due to the partner or API key not beingauthorized.

21


Known Issues

The table lists known issues in version 2.2.0 of TIBCO API Exchange Gateway.

Key Summary

ASG-5262 Summary: Unable to start Apache HTTP 2.4.9 as a Windows Service whenmod_RV is included in HTTP config.

Workaround: Instead of using the Windows Service, use scripts to start the ApacheHTTP server.

ASG-7066 Summary: Importing the default ASG_DefaultImplementation project in theStudio gives the resource validation errors.

Workaround: Update the asg_core.projlib project library file. To update theproject library file, follow these steps:

1. Open the Studio.

2. Import ASG_DefaultImplementation project in the Studio.

3. Click Project > Properties.

4. Select Build Path.

5. Click Project Libraries.

6. Expand the Project library node.

7. Select the existing ASG_HOME/lib/projectlib/asg_core.projlib file, thenclick Remove.

8. Click Add Library.

9. Browse the file path and select ASG_HOME/lib/projectlib/asg_core.projlib file.

10. Click OK.

11. Click Yes to rebuild your project after changing the build path.

12. Verify that the resource validation errors are resolved.

13. Click Project > Build Enterprise Archive to generate the EAR file, if needed.

22


Key Summary

ASG-7106 Summary: The asg-tools migration tool gives the following error when thedefault ASG_DefaultImplementation project is migrated:

java.lang.IllegalArgumentException: CDD file content is not valid,

at: ASG_HOME_211/projects/ASG_DefaultImplementation/default.cdd

Workaround: Use the cep-common.jar from an installation prior to TIBCO APIExchange Gateway 2.2.0 (such as 2.1.1) in the CLASSPATH of asg-tools migrationtool.

Update the CLASSPATH in the ASG_HOME/bin/asg-tools.tra file, as follows:

tibco.env.CUSTOM_EXT_PREPEND_CP=TIBCO_HOME/be/5.1/lib/cep-common.jar

%PSP%%ASG_HOME%/lib%PSP%%ASG_HOME%/lib/ext/hotfix%PSP%%ASG_HOME

%/lib/ext/per%PSP%%ASG_HOME%/lib/ext/tibco%PSP%%ASG_HOME%/lib/ext/

tpcl

Ensure that the location of cep-common.jar points to an installationprior to TIBCO API Exchange Gateway 2.2.0 release.

23


TIBCO API Exchange Gateway Release Notes - … · 2016-06-08 · TIBCO® API Exchange Gateway...

Documents

Transcript of TIBCO API Exchange Gateway Release Notes - … · 2016-06-08 · TIBCO® API Exchange Gateway...