TIBCO BusinessEvents Business Process Orchestration Release Notes

TIBCO BusinessEvents Business Process Orchestration Release Notes Software Release 1.1.1 May 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, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO ActiveSpaces, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Runtime Agent, 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 2004-2014 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

iii Contents Preface........................................................................ v Typographical Conventions.................................................................. vi 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 Release 1.1.1......................................................................... 2 Release 1.1.0......................................................................... 2 Release 1.0.1......................................................................... 2 Release 1.0.......................................................................... 2 Changes in Functionality.................................................................... 3 Release 1.1.1......................................................................... 3 Release 1.1.0......................................................................... 3 Release 1.0.1......................................................................... 3 Release 1.0.......................................................................... 5 Deprecated and Removed Features........................................................... 6 Deprecated Features................................................................... 6 Removed Features..................................................................... 6 Migration and Compatibility.................................................................. 8 Release 1.1.1......................................................................... 8 Release 1.1.0......................................................................... 8 Release 1.0.1......................................................................... 8 Release 1.0.......................................................................... 8 Closed Issues............................................................................ 9 Known Issues............................................................................ 11 Appendix A Documentation for New Functionality.................................. 13 Configure WebService Task For HTTPS-SSL................................................... 14 Configure WebService Task For JMS-SSL..................................................... 16

iv Contents

v Preface TIBCO BusinessEvents Process Orchestration software is an add-on to TIBCO BusinessEvents. It provides CEP functionality within the context of a BPM process, enabling you to segregate different CEP rule sets within the flow of a BPM process. Topics Typographical Conventions, page vi Connecting with TIBCO Resources, page ix

vi Typographical Conventions Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention ENV_NAME TIBCO_HOME BE_HOME code font bold code font Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other 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. TIBCO BusinessEvents installs into a directory within a TIBCO_HOME. This directory is referenced in documentation as BE_HOME. The default value of BE_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\be\5.2. 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 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]

Preface vii Table 1 General Typographical Conventions (Cont d) Convention italic font Key combinations Use Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrixBusinessWorks 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 name separated by a plus sign indicate keys pressed simultaneously. For 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. Table 2 Syntax Typographical Conventions Convention Use [ ] An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand param1 param2 param3

viii Typographical Conventions Table 2 Syntax Typographical Conventions Convention Use { } A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 param2} {param3 param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 param4}

Preface ix Connecting with TIBCO Resources This section provides links to helpful TIBCO resources. How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, 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 http://www.tibcommunity.com. How to Access TIBCO Documentation You can access TIBCO documentation here: http://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.

x Connecting with TIBCO Resources

1 Release Notes 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 one. You must have a valid maintenance or support contract to use this site. Topics New Features, page 2 Changes in Functionality, page 3 Deprecated and Removed Features, page 6 Migration and Compatibility, page 8 Closed Issues, page 9 Known Issues, page 11

2 Release Notes New Features This section lists features added since the last major (x.0.0) release of this product. Release 1.1.1 A new catalog function is added to set the default exception handler function URI for the given template. void Process.Template.setExceptionHandler(Object template, String handlerfunctionuri) Release 1.1.0 Support for looping functionality in process is now added. Release 1.0.1 Following features are introduced in this release: Support for secure HTTP (SSL) is added. See Configure WebService Task For HTTPS-SSL on page 14 for details. Support for secure JMS (SSL) is added. See Configure WebService Task For JMS-SSL on page 16 for details. For Business Rule and Inference tasks, double clicking the resource allows you to open the editor. Release 1.0 This is a new add-on product. See TIBCO BusinessEvents Process Orchestration Developer s Guide for details.

Changes in Functionality 3 Changes in Functionality This section lists changes in functionality since the last major (x.0.0) release of this product. Release 1.1.1 Behavior has changed for the following the catalog functions. If the projects are already using these functions, then update the projects in BusinessEvents Studio. Process.Template.newJobContext() signature changed to String newjobcontext(object template, String extid) Process.Template.getTemplate() signature changed to Object gettemplate(string name, int revision) Process.Activity.moveTo() signature changed to int moveto(object job, String activityname) Release 1.1.0 There are no changes in functionality in this release. Release 1.0.1 The following are changes in functionality in this release. Signature Changes for Fork and Join Rule Functions Signatures have changed for the Fork and Join rule functions, manually update these functions within the projects containing parallel gateways. Fork Function Signatures The new signature is defined as below: Object forkfn(object jobcontext,string seqflowid) This is called for every sequence flow originating from the fork.

4 Release Notes Table 3 Fork Function Parameters Parameters See Fork Function Parameters on page 4. Parameter Type Description jobcontext Object The cloned job context containing the process variables from the parent job. seqflowid String The id of the sequence flow. Join Function Returns A Object: New or original jobcontext passed as the argument. Signatures The new signature is defined as below: Object joinfn(object seqflowjobcontextmap,string mergekey) Table 4 Join Function Parameters Parameters See Join Function Parameters on page 4. Parameter Type Description seqflowjobcontextmap Object This is a map of sequence flow id's to the corresponding job context i.e Sequence Flow id(string) -> (Object: Process concept) Job Context, for all the sequence flows merging at this gateway. merge key Object This is a String key derived from an expression which extracts the same key value from each merging job context process variables. Returns A Object: The function can return a new jobcontext or an incoming job context from seqflowjobcontextmap after a data merge is done.

Changes in Functionality 5 Release 1.0 This is a new add-on product, so this section is not relevant in this release.

6 Release Notes Deprecated and Removed Features This section describes deprecated features and lists equivalent features that accomplish the same result, if relevant. Any use of a deprecated feature should be discontinued as it may be removed in a future release. You should avoid becoming dependent on deprecated features and become familiar with the equivalent feature. Deprecated Features Release 1.1.1 No features are deprecated in this release. Release 1.1.0 No features are deprecated in this release. Release 1.0.1 No features are deprecated in this release. Release 1.0 This is a new add-on product, so this section is not relevant in this release. Removed Features Release 1.1.1 No features are removed in this release. Release 1.1.0 No features are removed in this release. Release 1.0.1 No features are removed in this release.

Deprecated and Removed Features 7 Release 1.0 This is a new add-on product, so this section is not relevant in this release.

8 Release Notes Migration and Compatibility This section explains how to migrate from a previous release to this release. Release 1.1.1 See TIBCO BusinessEvents Release Notes for full details. No special action is required for this add-on. Release 1.1.0 See TIBCO BusinessEvents Release Notes for full details. No special action is required for this add-on. Release 1.0.1 Signatures have changed for the Fork and Join rule functions, so any existing projects using parallel gateways with these functions should be manually updated for the new signatures. See Signature Changes for Fork and Join Rule Functions, page 3 for details. Sometimes, the input mappers for activities in the project being migrated might show errors. These errors should be taken care automatically by using Project -> Clean menu option and rebuilding the ear files. Alternatively, you should open the Input Map and Output Map tabs for the activities with error markers and click on the Mapper Check and Repair option to fix them manually. Release 1.0 This is a new add-on product, so this section is not relevant in this release.

Closed Issues 9 Closed Issues The table in this section lists issues that were closed in the named releases. Closed in Release Key Summary 1.0.1 BE-17436 In Studio, the modified icons for tasks in the process graph were not available when custom palette was loaded. 1.0.1 BE-17404 An exception was thrown when generating code if the output mapping included array mappings. 1.0.1 BE-17398 A NullPointerException was thrown when executing a mapping for the referenced concept if a process variable was defined as a referenced concept. 1.0.1 BE-17373 For a Web Service task, changing the value of the JNDI Context Factory in a JMS WSDL caused an unhandled event loop exception to be thrown. 1.0.1 BE-17370 An error was thrown during startup if rule functions that return array types (int[], Concept[]. and so on) were used in the rule function tasks. 1.0.1 BE-17366 In Studio mapper, the value of a particular index in the array was null if the number of occurrences in WSDL file is unbounded (maxoccurs = unbounded). 1.0.1 BE-17355 Removing a virtual rule function from a business rule task did not remove the associated decision table. 1.0.1 BE-17354 A concept could incorrectly be contained in more than one process as a contained concept. 1.0.1 BE-17353 The process engine incorrectly waited for a response from a one-way web service request. 1.0.1 BE-17352 When a Fork or Join rule function was moved, the process properties were not updated with the new path. 1.0.1 BE-17350 Exclusive gateways did not handle null conditions for the test variable. If the test variable was empty or null, a NullPointerException was thrown at runtime and execution did not continue along the default path.

10 Release Notes Closed in Release Key Summary 1.0.1 BE-17349 Using drag and drop to move processes from one folder to another within the same project caused a NullPointerException to be logged. This has been fixed to display a warning message instead. 1.0.1 BE-17347 In Studio Properties tab for Receive Message Task, the Key Expression field displayed the xpath expression instead of the key value. 1.0.1 BE-17344 A NullPointerException was thrown during shutdown if any failures had occurred. 1.0.1 BE-17343 When a rule function was used to return an Object into a script task, the output data mapper of the script task was rendered empty. 1.0.1 BE-17342 Using the $Job variable in the Input Mapper of the Call Activity resulted in a compilation error. 1.0.1 BE-17315 Exclusive gateway did not provide the default transition setting for runtime. 1.0.1 BE-17296 When executing a Call Activity task with Parallel Gateway, occasionally the current task was null. This caused a NullPointerException to be thrown while logging at the DEBUG level. 1.0.1 BE-17288 An exception stating "Exclusive Gateway does not have a Default" was thrown when using an Exclusive Gateway with more than two outbound paths. 1.0.1 BE-17260 Studio Help was no longer available when a WSDL file was selected for a Web Service Task and was restored when the WSDL file was removed from the resource. 1.0.1 BE-17206 After associating a private process to the Call Activity Task in Studio, clicking the Resource hyperlink did not open the editor for the associated process. Also, when no process was assigned to the Call Activity Task, the new process creation editor did not open. 1.0.1 BE-17186 Upon starting a process, scorecards were not initialized and an exception was thrown.

Known Issues 11 Known Issues The table in this section lists known issues in this release. Key BE-20003 BE-17936 BE-17791 BE-17753 BE-17701 BE-17571 BE-17361 Summary/Workaround Summary When multiple events sent to the loop over recieve tasks, the task is executed parallely by different threads instead of sequentialy. Workaround None. Summary At runtime, processes containing the receive tasks throw null java.lang.nullpointerexception when the persistence option was set as Shared All/Shared Nothing within the cluster deployment descriptor. Workaround None. Summary Concepts created with Cache Only mode are not returned correctly when the persistence option is None. Workaround None. Summary The Process Orchestration mapper does not support the use of option for each for non-array element types. Workaround Map the individual properties instead of using the for-each option. Summary The rich text editor is not supported on Mac OS. Hence it is not possible to export and view documentation for elements in a process flow, including transitions, from the Documentation tab on Mac OS. Workaround None. Summary The option Copy-contents of is not supported by the Process Orchestration mapper. Workaround After you drag and drop a contained concept from the left to the right panel, select the second option "For each..." on the mapper wizard to copy the mappings. Summary Process Message Start activity,upon receiving events with payload, throws the following exception: Error while generating output transformation code com.tibco.cep.mapper.codegen.unsupportedxsltmappingexception Workaround Payload object instances must be created prior to assigning them values through mappings in output tab.

12 Release Notes Key BE-17229 BE-17135 BE-16793 Summary/Workaround Summary XPath 2.0 functions and operations are not supported in the TIBCO BusinessEvents Process Orchestration Mapper at runtime. Workaround None. Summary Use of task based timeout is not supported in the runtime. It can be used as a modeling element for now. Workaround None. Summary A Cluster can either have an Inference Agent or a process agent, but not both. Workaround None.

Documentation for New Functionality 13 Appendix A Documentation for New Functionality This appendix provides additional details for some items listed in the section New Features on page 2. Topics Configure WebService Task For HTTPS-SSL, page 14 Configure WebService Task For JMS-SSL, page 16

14 Appendix A Documentation for New Functionality Configure WebService Task For HTTPS-SSL This section explains the steps to configure a Web Service task to execute a remote service which is SSL enabled using HTTPS transport. 1. Select Web Service task in the process. 2. From the Properties, click Transport tab. 3. End Point Url: Verify that correct https URL is displayed in this field. This defines the URL of the web service to which a request is sent to. This field is automatically populated depending upon the WSDL selected in the General > Resource field. For example, https://xyzserver:9000/receiverservices 4. Click the Configure SSL button and configure the SSL parameters below: Table 5 HTTPS SSL Configuration Parameters Field Trusted Certificates Folder Identity Verify Host Name Description Specifies the folder in the project containing one or more certificates from trusted certificate authorities. This folder is checked to ensure trusted connection with server. This prevents connections to rogue servers that attempt to impersonate trusted servers. Specifies an Identity resource that contains the client s digital certificate and private key. See TIBCO Designer Palette Reference for more information. When checked, this field is used to ensure that the host name of the SOAP server is checked against the host name listed in the server s digital certificate. This provides additional verification that the host name you are connecting to is in fact the desired host. If the host name specified in the Endpoint URL field on the Transport tab is not an exact match to the host name specified in the server s digital certificate, the connection is refused. Note: If you specify an equivalent hostname (for example, an IP address) in the Endpoint URL field on the Transport tab, but the name is not an exact match of the hostname in the host s digital certificate, the connection is refused.

Configure WebService Task For HTTPS-SSL 15 Table 5 HTTPS SSL Configuration Parameters Field Strong Cipher Suites Only Description When checked, this field specifies that the minimum strength of the cipher suites used can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is unchecked, only cipher suites with an effective key length of up to 128 bits can be used. 5. Save the project.

16 Appendix A Documentation for New Functionality Configure WebService Task For JMS-SSL This section explains the steps to configure a Web Service task to execute a remote service which is SSL enabled using JMS transport. 1. Select Web Service task in the process. 2. From the Properties, click Transport tab. 3. Verify the JMS and JNDI parameters are correctly configured. 4. Check the Use SSL checkbox field. When this field is checked, SSL is used for JNDI server connection. 5. SSL Password: Enter the password(if any) to be used to connect to JNDI server. 6. Click the Configure SSL button and configure SSL parameters below: Table 6 JMS SSL Configuration Parameters Field Trusted Certificates Folder Identity Trace Debug Trace Description Specifies the folder in the project containing one or more certificates from trusted certificate authorities. This folder is checked to ensure trusted connection with server. This prevents connections to rogue servers that attempt to impersonate trusted servers. Specifies an Identity resource that contains the client s digital certificate and private key. See TIBCO Designer Palette Reference for more information. Specifies whether SSL tracing is enabled during the connection. If checked, the SSL connection messages are logged and sent to the console. Specifies whether SSL debug tracing is enabled during the connection. Debug tracing provides more detailed messages than standard tracing. If checked, the SSL connection (debug level trace) messages are logged and sent to the console

Configure WebService Task For JMS-SSL 17 Table 6 JMS SSL Configuration Parameters Field Verify Host Name Description When checked, this field is used to ensure that the host name of the SOAP server is checked against the host name listed in the server s digital certificate. This provides additional verification that the host name you are connecting to is in fact the desired host. If the host name specified in the Endpoint URL field on the Transport tab is not an exact match to the host name specified in the server s digital certificate, the connection is refused. Note: If you specify an equivalent hostname (for example, an IP address) in the Endpoint URL field on the Transport tab, but the name is not an exact match of the hostname in the host s digital certificate, the connection is refused. Expected Host Name Specifies the name of the host you are expecting to connect to. This field is relevant only if the Verify Host Name field is checked. If the name of the host in the host s digital certificate does not match the value specified in this field, the connection is refused. This prevents hosts from attempting to impersonate the host you are expecting to connect to. Strong Cipher Suites Only When checked, this field specifies that the minimum strength of the cipher suites used can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is unchecked, only cipher suites with an effective key length of up to 128 bits can be used. 7. Save the project.

18 Appendix A Documentation for New Functionality