TIBCO ActiveMatrix

BusinessWorks™ Plug-in for

REST and JSON
Release Notes
Software Release 2.0.0
November 2014

Two-Second Advantage®
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE
LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED
IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS
AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN
AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and
treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO
Software Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO Designer,
TIBCO Enterprise Administrator, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Runtime Agent, and
TIBCO Rendezvous are either registered trademarks or trademarks of TIBCO Software Inc. in the United States
and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition
(J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation
in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC
OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE 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 OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 2012-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
 | iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Documentation . . . . . . . . . . . . . . . . . . . . vi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
New Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Changes in Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Deprecated and Removed Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Migration and Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Closed Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
iv
| Contents

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 |v

Preface

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON plugged into
TIBCO ActiveMatrix BusinessWorks, allows you to expose TIBCO ActiveMatrix
BusinessWorks processes as RESTful Web Services, invoke RESTful Web Service
API, and translate data between JSON format and XML format.

Topics

• Related Documentation, page vi

• Typographical Conventions, page vii
• Connecting with TIBCO Resources, page ix

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
vi
| Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON

Documentation
The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in
for REST and JSON documentation set:
• TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON
Installation Read this manual for instructions on site preparation and
installation.
• TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON User’s
Guide Read this manual for instructions on using the product.
• TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release
Notes Read the release notes for a list of new and changed features. This
document also contains lists of known issues and closed issues for this release.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO
products:
• TIBCO ActiveMatrix BusinessWorks™
• TIBCO Administrator™
• TIBCO Designer™
• TIBCO® Enterprise Administrator
• TIBCO Enterprise Message Service™
• TIBCO Hawk®
• TIBCO Rendezvous®
• TIBCO Runtime Agent™

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 Preface vii
|

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use
ENV_NAME TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in other
TIBCO_HOME
installation environments. Incompatible products and multiple instances of the
same product must be installed into different installation environments.
An installation environment consists of the following properties:
• Name Identifies the installation environment. This name is referenced in
documentation as ENV_NAME. On Microsoft Windows, the name is
appended to the name of Windows services created by the installer and is a
component of the path to the product shortcut in the Windows Start > All
Programs menu.
• Path The folder into which the product is installed. This folder is
referenced in documentation as TIBCO_HOME.

RESTJSON_HOME TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON is installed
into a directory within TIBCO_HOME. This directory is referenced in
documentation as RESTJSON_HOME. The default value of RESTJSON_HOME
depends on the operating system. For example, on Windows systems, the
default value is C:\tibco\bw\plugins\restjson.

code font Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.

bold code font Bold code font is used in the following ways:
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
viii
| Typographical Conventions
Table 1 General Typographical Conventions (Cont’d)

Convention Use
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix
BusinessWorks Concepts.
• To introduce new terms. For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace.
For example: MyCommand PathName

Key Key name separated by a plus sign indicate keys pressed simultaneously. For
combinations example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after
the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 Preface ix
|

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to https://www.tibcommunity.com.

How to Access TIBCO Documentation

You can access TIBCO documentation here:
https://docs.tibco.com

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact
TIBCO Support as follows:
• 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 can request one.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
x
| Connecting with TIBCO Resources

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 |1

Release Notes

This document includes release notes for TIBCO ActiveMatrix BusinessWorks

Plug-in for REST and JSON, Software Release 2.0.0.
Check the TIBCO Product Support web site at https://support.tibco.com for
product information that was not available at release time. Entry to this site
requires a username and password. If you do not have a username, you can
request for one. You must have a valid maintenance or support contract to use
this site.

Topics

• New Features, page 2

• Changes in Functionality, page 4
• Deprecated and Removed Features, page 5
• Migration and Compatibility, page 6
• Closed Issues, page 7
• Known Issues, page 9

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
2 Release Notes
|

New Features

The following new features have been added to version 2.0.0 of TIBCO
ActiveMatrix BusinessWorks Plug-in for REST and JSON.

Support for OAuth 2.0 on the Server Side

This release supports using the OAuth 2.0 protocol to secure the exposed RESTful
APIs.

Support for Swagger

This release supports exporting RESTful APIs to Swagger. You can also invoke
RESTful APIs based on a Swagger file.

Support for Exporting WADL

This release supports exporting a RESTful Web Service to a WADL file.

Support for Parsing JSON According to XSD at Runtime

This release supports parsing JSON data according to a defined XSD schema type
at runtime.

Support for Customized Response Code

This release supports customizing the response code in the REST Dispatch and
Reply activity.

Support for Checking Response

This release supports checking the HTTP response from the Output tab of the
REST Dispatch and Reply activity.

Support for Handling Cross-Origin Requests

This release supports handling cross-origin requests in the REST Dispatch and
Reply activity.

Support for Ignoring Namespace with Badgerfish Enabled

This release supports ignoring namespaces when using the Render JSON activity
to render XML to JSON with the badgerfish rule enabled.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 New Features 3
|

Support for mimeEnvelopeElement Response

This release adds the mimeEnvelopeElement response in the Output Binding tab
for the REST Dispatch and Reply activity.

Support for New Platforms

This release supports the following new platforms:
• Oracle Solaris
11 32-bit on SPARC
11 64-bit on SPARC
• Microsoft Windows Server
2012 32-bit on x86-64
2012, 2012 R2 64-bit on x86-64

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
4 Release Notes
|

Changes in Functionality

The following are changes in functionality in version 2.0.0 of TIBCO ActiveMatrix

BusinessWorks Plug-in for REST and JSON.

Invoke REST API Activity

The following changes are made in the Invoke REST API activity:
• In the Configuration tab, the Enable WADL check box is changed to a
Protocol drop-down list. You can select None, WADL, or Swagger from the
drop-down list.

• In the Configuration tab, the Reload WADL button is changed to Reload.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 Deprecated and Removed Features 5
|

Deprecated and Removed Features

No features are deprecated or removed in version 2.0.0 of TIBCO ActiveMatrix

BusinessWorks Plug-in for REST and JSON.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
6 Release Notes
|

Migration and Compatibility

The following are instructions on how to migrate from a previous release to

version 2.0.0 of TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON.
When you open a project that contains the Invoke REST API activity in TIBCO
Designer, you have to click Apply in the Configuration tab of the activity, and
then save the project.

Before migrating TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON
from an earlier version to version 2.0.0, you have to uninstall the earlier version
plug-in, and then install the version 2.0.0 plug-in.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 Closed Issues 7
|

Closed Issues

The table lists closed issues in version 2.0.0 of TIBCO ActiveMatrix

BusinessWorks Plug-in for REST and JSON.

Key Summary
REST-1006 When using the Parse JSON activity to parse JSON data to XML data, the
backslashes (\) contained in JSON data were not parsed.

REST-996 When the debug level was enabled, the debug log information was not
complete. Information such as process ID and activity name were missing.

REST-994 If the WADL file used in the REST Dispatch and Reply activity or the Invoke
REST API activity was loaded from a design-time project library, the WADL file
was not correctly displayed.

REST-983 When using the Invoke REST API activity to invoke a REST API, if the base URL
contained non-ASCII characters, the invocation failed.

REST-850 When using the REST Dispatch and Reply activity and the Send HTTP Response
(Parent activity together, the customized headers were lost after restarting TIBCO
REST-676) Designer and browser.

REST-809 A thread blocking issue occurred when using the REST Dispatch and Reply
activity.

REST-748 If you set EnableMemorySavingMode to true, an error occurred when using the
REST Dispatch and Reply activity.

REST-740 An error occurred when you entered an internet domain name as the base URL
of a RESTful web service in the REST Dispatch and Reply activity.

REST-720 An error occurred when you used global variables for the base URL and
resource path in the REST Dispatch and Reply activity.

REST-717 When using the Invoke REST API activity with a referenced WADL file, the
nested resources were not parsed.

REST-713 If you installed the plug-in in an environment where TIBCO Runtime Agent
5.9.0 and TIBCO ActiveMatrix BusinessWorks 5.12 were installed, when clicking
New empty project or Open existing project, the project were not launched.

REST-705 When using the Parse JSON activity to parse JSON Data to XML data, the
contained special characters were not parsed to Unicode characters.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
8 Release Notes
|

Key Summary
REST-704 The plug-in failed to use the BW_GLOBAL_TRUSTED_CA_STORE Global
Variable to specify a trusted certificate for SSL configuration in Invoke REST
API.

REST-702 The size of the Process Binding window was settled.

REST-695 At run time, too many info logs were printed.

REST-693 The content-type header in the Invoke REST API activity only supported the
following four input formats: application/json, application/xml, text/html, and
text/plain.

REST-688 The REST Dispatch and Reply activity did not send the error message to the
client when an error occurred or the server hung up.

REST-684 The REST Dispatch and Reply activity did not support multiple lines in the
header content.

REST-672 The forward slash (/) was escaped in the URL, when using the Render JSON
activity to render an XML HTTP URL to a JSON string.

REST-631 If you used global variables in a WADL file, the parameter structure loaded in
the Input tab of the Invoke REST API activity was not correct.

REST-386 You could not customize the response error code by using the REST Dispatch
and Reply activity.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
 Known Issues 9
|

Known Issues

The table lists known issues in version 2.0.0 of TIBCO ActiveMatrix

BusinessWorks Plug-in for REST and JSON.

Key Summary/Workaround
REST-224 Summary When using the JSON tool to generate an XML schema file with the
given JSON file, if namespaces are contained in the JSON file, the generated XSD
is incorrect.
Workaround None.

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes
10 Release Notes
|

TIBCO ActiveMatrix BusinessWorks Plug-in for REST and JSON Release Notes