Product Name:    TIBCO ActiveMatrix(R) BPM
Release Version: 3.1.0_HF-006
Release Date:    October 2017

================================================================================

Hotfixes are cumulative. This hotfix includes the issues listed in the Closed
Issues section.

A TIB_AMXBPM_3.1.0-HF1_Addendum_CaseManagement.zip file is supplied as
part of this Hotfix distribution.

Extract TIB_AMXBPM_3.1.0-HF1_Addendum_CaseManagement.zip to a temporary
directory. The .zip file contains:

- TIBCO ActiveMatrix® BPM Hotfix Addendum. This addendum provides updated
  documentation for changes and fixes that have been implemented in TIBCO
  ActiveMatrix BPM 3.1 Hotfix 001.

- TIBCO ActiveMatrix BPM 3.1 Hotfix 001 compatible versions of the BPM public
  web service API (in the public_api folder).

================================================================================

Closed issues in 3.1.0_HF-006 (This Release)

WRM-9877 (CN-00708438, CN-00728410, CN-00712381, CN-00800718)
-------------------------------------------------------------
Setting TRACE level logging for the com.tibco.pvm logger sometimes resulted in
an exception that caused a process instance to halt. The following exception was
reported to the BPM log file:

   com.tibco.pvm.api.exceptions.PmModelException: PVM-MODEL-102001: Invalid
   Object:

WRM-9876 (CN-01477120)
----------------------
A business service was used to start a process that contained a mandatory
parameter of type Integer. The process failed to start and the following error
was written to the BPM log file:

   IllegalArgumentException: parameter type mismatch

The problem only occurred if the parameter was defined with a length of 10 or
more.

WRM-9875 (CN-01474007)
----------------------
After deploying a new minor version of a case data model (containing additional
attributes), users were unable to open any work items that were created using
a process version that referred to the older version of that case data model.

This problem only affected processes that used pageflows or calls to service
processes, and was caused by the way that case reference were handled internally
when being passed between these entities.

WRM-9858 (CN-01311541)
----------------------
A user task failed when rescheduling the timeout of a timer event on the task,
if the Reschedule Timer Script generated a negative duration. The user task
failed with the error:

   com.tibco.bx.core.faults.BxException: BX-200002: Parsing Error:
   [XsDateTime invalid: -P2D]
   
WRM-9840 (CN-01519185)
----------------------
Following migration, process instances were hanging (using CPU). This occurred
because migration rules had been specified where the "from" version was the same
as the "to" version.
 
WRM-9838 (CN-01486745)
----------------------
A process instance failed when attempting to reschedule a timer on a user task.
The following error was reported:

   com.tibco.bx.core.faults.BxException: BX-100002: Invalid expression value

even though the value specified for the timer in the process data was valid. The
error occurred if the user task had multiple timers, only some of which had
reschedule scripts. When ActiveMatrix BPM processed the timers, it would
sometimes run the wrong reschedule script for a timer.

WRM-9778 (CN-01486185)
----------------------
The ActiveMatrix BPM application now generates additional DEBUG, WARN and ERRROR
logging statements relating to Process Engine module deployment. This additional
logging has been added to make it easier to investigate issues that involve
starting, stopping, deploying or undeploying BPM applications.

WRM-9763 (CN-01484112, CN-01521719)
-----------------------------------
On a distributed BPM system, an API call using the queryDone operation (in the
ProcessManagerService) returned a Fault response if the paged query was held on
a different node to the one on which the queryDone operation was being executed.
(This occurred because the queryDone operation was incorrectly only trying to
locate the referenced query on the same node.)

WRM-9709
--------
On a DB2 version of ActiveMatrix BPM, the PVM_WORK_ITEM database kept getting
larger over time.

WRM-9618 (CN-01477393)
----------------------
Deployment of a new minor version of an existing case data project sometimes
failed with an error like this:

   Incompatible changes made during upgrade of version <number> of model <name>

This error could occur if you made a change to the case data project that
resulted in the BOM becoming larger - for example, adding a new optional
attribute to a class. The BPM runtime then incorrectly detected incompatible
changes, even though the project did not contain any such changes. (Adding a new
optional attribute to a class is a non-destructive change.)

This error was more likely to occur with very large BOMs, and could be triggered
by any non-destructive change (not just the addition of a new optional
attribute).

WRM-9400 (CN-01311541)
----------------------
If a negative duration was specified in a Reschedule Timer script calculation,
the duration was treated as a positive value and added to the existing deadline
instead of being subtracted from it.

The error occurred because ActiveMatrix BPM does not support the use of negative
durations in a deadline calculation.

With this fix, a negative duration in a deadline calculation is now treated as a
zero-length duration, not as a positive value.

WRM-9386 (CN-01520603)
----------------------
Work items assigned by RQL were occasionally being sent to the Undelivered group
instead of the intended recipient, even though the RQL query was valid.

WRM-9352 (CN-01443648)
----------------------
When a client application used the saveOpenWorkItem operation (in the
WorkItemManagementService), the request failed if the request body contained a
type-based value for a data field defined as a complex type (complexSpec).
The request succeeded if it used an element-based value.

WRM-9343 (CN-01253006 / SR-722510)
----------------------------------
On a distributed BPM system, if the shared configuration folder (used to store
BPM properties files) is not called <SHARED_DIR>\configuration, upgrading the
ActiveMatrix BPM version could encounter problems.

WRM-9306 (CN-01244087)
----------------------
A TIBCO ActiveMatrix BusinessWorks application failed (with an 'Output data
invalid' error) when calling the openWorkItem operation from the
WorkPresentationService service. The error occurred when the work item invoked a
dynamic pageflow, because the openWorkItem response message did not contain a
formIdenitifier element, which was expected by the schema.

NOTE: If you have developed client applications that use the BPM public web
service API and that call the openWorkItem operation from the
WorkPresentationService service, you will need to modify
the WorkPresentationService schema definition used by your application to
prevent this error from occurring. To do this:

1. If your application uses:

   * a WSDL generated from the WorkPresentationService running on the
     ActiveMatrix BPM runtime, regenerate that WSDL.

   * the BPM public web service API (WSDL and XSD files) directly, updated
     versions of the wp.xsd, wp-basetypes.xsd and wpModel.xsd files are
     supplied with this Hotfix, in the 3.1.0_HF-006_wsdls archive file. (The
     updated versions make the formIdentifier element optional.)

2. Update your application to use the new wp.xsd, wp-basetypes.xsd and
   wpModel.xsd files, or the regenerated WSDL, as appropriate.
     
WRM-9295 (CN-01253006 / SR-722510)
----------------------------------
During an upgrade, the createdb-admin.sql script failed with an "ORA-28007: the
password cannot be reused" error. This occurred because the script used the
database password multiple times (via the IDENTIFIED BY clause), which was not
permitted by the database profile.

WRM-9282
--------
A runaway process generated a large number of tasks within a single process
instance. This resulted in the instance generating large numbers of audit events
and lots of rows in the PVM_* database tables.

Now, when the BPM runtime starts to process an event for a process instance, it
checks (and increments) how many tasks the process instance already has. If this
value equals or exceeds a threshold the process instance halts and writes the
following warning to the BPM log file:

   [WARN] - {MAX_TASKS_PER_INSTANCE_REACHED} - Instance [pvm:xxxxx] has reached
   the maximum number of tasks allowed: [1,000].

and the following audit message:

   BX_INSTANCE_PROCESS_MAX_TASKS_REACHED  Maximum number of tasks per instance
   reached.

You can configure the threshold value (default 1000) using the
com.tibco.bx.maxTasksPerInstance JVM property. You may wish to do this if, for
example:

* your process design contains a large number of loops or tasks.
* you have long running processes, whose task count may get large even though
  the process isn't running away.

If you set a high value, your BPM system could stall if process instances reach
a runaway state, as it will take time to reach the threshold.  If you know your
task per instance count you may wish to set the threshold to a lower value.

NOTE: When this Hotfix has been applied to a BPM system, the count for all
existing process instances starts from 0 - so a process instance will only halt
if the number of tasks created after the Hotfix has been applied reaches the
threshold value.

WRM-9266 (CN-01257104)
----------------------
In some situations, an expression or script was evaluated incorrectly because
the process instance was using an old value (that is, one set earlier in the
process instance's lifecycle) instead of the current value. This could lead to
unexpected behavior - for example, a gateway following an unintended path.

WRM-9230 (CN-00719110 / SR-706408)
----------------------------------
Populating an attribute with a value containing any special characters sometimes
caused the process instance to halt, due to an error in writing the attribute
value to the BPM database.

WRM-9224 (CN-01446081, CN-01239572 / SR-740136)
-----------------------------------------------
When publishing BPM audit date to an external Enterprise Message Server (EMS),
the number of EMS message producers kept increasing, eventually causing a
resource leak. This error occurred if the amx.bpm.ec.threadpool resource
template used different values for its Core Pool Size and Max Pool Size values.
In this case, threads are created and reclaimed dynamically as required, but
reclaimed threads were not being handled correctly, causing the increase in EMS
message producers.

WRM-9128 (CN-00743059)
-------------------------------
Using the Case Data Query Language (DQL) findByCriteria method in a script to
search for case objects by criteria failed at runtime. The following error was
written to the BPM log file:

 [ERROR] com.tibco.bds.core.services.impl.BusinessDataServicesPrivateServiceImpl
 - [ERROR] - {BDS_GLOBAL_DATA_FIND_BY_CRITERIA_FAULT} - Fault while attempting
 to find BDS Class using Criteria...

This error occurred when performing a search against an enumeration attribute,
and occurred only if the case data model referenced by the search was very
large.

WRM-9110 (CN-00740153 / SR-723447)
----------------------------------
An attempt to cancel a number of process instances failed if those process
instances contained large numbers of child instances (either sub-process
instances or user tasks). This occurred because the time taken to process the
cancellation exceeded a transaction timeout value, causing the transaction to
roll back. To resolve this problem, cancellation requests are now processed in
batches.

NOTE: The batch size defaults to 100, and can be configured using the
com.tibco.bx.maxCancelChildrenBatchSize JVM property. Do NOT change the value of
this property unless you are advised to do so by TIBCO Support.

WRM-9090 (CN-00723245)
----------------------
Using a script of the form:

   ScriptUtil.subtract(<DateTime1>, <DateTime2>);

in a timer event caused a process instance to hang in an infinite loop on that
timer event, resulting in high CPU utilization by ActiveMatrix BPM. This error
occurred if the <DateTime1> and <DateTime2> values used different timezones.

WRM-9082 (CN-00737656, CN-01252454, CN-01452206)
------------------------------------------------
A process failed when processing parameters on an invocation of a sub-process
from a pageflow, if the parameters included any BOM fields. A
PROCESS_EXIT_WITH_FAULT error was written to the BPM log file (with exception
detail relating to the classloaders being used for the BOM fields being passed
to the sub-process).

WRM-9057 (CN-00714307, SR-692103)
---------------------------------
A new supportTimeZoneInDateTime property is available in the <CONFIG_HOME>\bpm\
<bpm_app_name>\configuration\bds.properties file. This property controls
timezone support for the "Date Time" data type, when that type is used in a case
data model (and case objects created from that model).

If supportTimeZoneInDateTime=true, or if supportTimeZoneInDateTime is not
present in the bds.properties file (the default), timezone information is
supported. In this case:

- A "Date Time" value that is written to a case object (for example, from a
  script or form) can, optionally specify a timezone. If the value does not
  specify a timezone, it is assumed to be in UTC. In either case, the value
  written to the case object is stored internally (in the case data store) in
  UTC.
 
- A "Date Time" value that is read from a case object is always qualified with
  the 'Z' suffix to indicate that it is in UTC.

If supportTimeZoneInDateTime=false, timezone support is disabled for the "Date
Time" data type. In this case:

- A "Date Time" value that is written to a case object must not specify a
  timezone. If the value does specify a timezone, it will be rejected and the
  case object will not be created or updated.
 
- A "Date Time" value that is read from a case object does not include a
  timezone.

To disable timezone support, add the following entry to the <CONFIG_HOME>\bpm\
<bpm_app_name>\configuration\bds.properties file:

   supportTimeZoneInDateTime=false
   
NOTE: The supportTimeZoneInDateTime property does not affect the behavior of the
"Date Time and Time Zone" data type.

WRM-9001 (CN-00732676 / SR-695323)
----------------------------------
When updating a case, if you nullified a global object that was contained in
the case object, the global object was left as an orphan entry in the case data
store, instead of being deleted as it should have been. (This problem occurred
if the global object was contained in the case object via a one-to-one
containment (or indirectly via other such global objects), and the case object
was updated such that the global object was no longer referenced.)

WRM-8949 (CN-00729540)
----------------------
After migrating a process to a new version, an attempt to resume a previously
halted process instance failed. This problem occurred when the process was
migrated to the new version by setting a migration point on a failed task of the
halted process instance. After migration, on retrying the process instance, the
failed task completed successfully. However, the process instance remained
stuck.

WRM-8944 (CN-00730451)
----------------------
In the ActiveMatrix BPM web service API, using the previewWorkItemFromList
operation allowed the calling user to see the details of a work item that was
currently allocated to another resource in the same offer set, if that work item
had been originally offered to the entity specified in the request.

WRM-8934 (CN-00711501)
----------------------
Additional logging information is now provided to assist users when a
sub-process is being started.

WRM-8878 (CN-00807167 / SR-651541)
---------------------------------
Correlation messages were sometimes not being processed correctly when using
asynchronous Send/Receive tasks, even though the correlation id and correlation
data were identical.

WRM-8793 (CN-00778329 / SR-651342, CN-00807238 / SR-651828)
-----------------------------------------------------------
For correlation processing, the BPM runtime now provides additional information
on INFO level logging messages to show how many matching receivers have been
found for the correlation data. For example:

   [INFO] - {BX_FOUND_WAITING_RECEIVERS_NUMBER} - Found [3] waiting receiver(s)
   for...
   ...
   [INFO] - {BX_FOUND_WAITING_RECEIVERS_NOTIFIED} - Waiting receiver has been
   notified for ID=pvm:001iap PID=204 ...
   ...

WRM-8446 (CN-01248735, CN-01249742)
-----------------------------------
TIBCO ActiveMatrix BusinessWorks returned the following validation error when
processing a JMS message containing audit data published by ActiveMatrix BPM:

   A validation occurred while parsing:  validation error: no declaration for
   element "Event" ({com.tibco.xml.validation}
   COMPLEX_E_MISSING_ELEMENT_DECLARATION) at /Event[1]
   com.tibco.xml.validation.exception.MissingDeclarationException: no
   declaration for element "Event"
 
Messages published in TIBCO ActiveMatrix BPM Event format conform to the
definition of the Event element in the EventCollectorQueryService schema
(ec-basetypes.xsd). However, ActiveMatrix BPM did not include the namespace of
this schema in the "Event" element when publishing an event as a JMS message,
resulting in the validation error reported by TIBCO ActiveMatrix BusinessWorks.

ActiveMatrix BPM now includes the namespace of the EventCollectorQueryService
schema (http://base.api.ec.n2.tibco.com) in the "Event" element when it
publishes the event as a JMS message.

If you want to publish messages without the namespace, add the following (empty)
property definition to the
<CONFIG_HOME>/bpm/<bpm_app_name>/configuration/ec.properties file:

   jmsPublicationRootNamespace=

WBPM-1297 (CN-01462676)
-----------------------
After deploying a new minor version of a case data model (containing additional
attributes), existing process instances were unable to display the associated
case data. The addition of new attributes should not have impacted existing
process instances.

WS-1794 (CN-01488237)
---------------------
In Workspace, a case view displayed cases from the wrong version. This problem
occurred if multiple versions of the same case class were deployed. These
versions were displayed in the Case View wizard. However, selecting one version
and proceeding to the next page sometimes resulted in filter attributes
belonging to another (unselected) version of the class, so that when the Case
View was created it displayed cases from the wrong version.

WS-1793 (CN-01517761)
---------------------
If custom access was defined for custom menus or toolbars in the userAccess.xml
file, the Configuration Administrator did not display those settings correctly
in the Graphical Editor. (The settings did display correctly in the XML Editor.)
Also:

* Using "Add", "Edit" or "Remove" did not properly update the Graphical Editor
  with changes to custom access elements.

* Using "Defaults" did not revert the custom access settings to those in
  userAccess.xml.

WS-1789 (CN-01465136)
---------------------
If Workspace was configured to open work item forms in a separate browser
window, the first attempt to open a form failed and the separate browser window
was blank. This was intermittent and a second attempt to open the same form was
most often successful. When attempting to logout, an error message was
displayed:

   "A work item form is open in a separate browser window"

This message was caused by the form that failed to load and prevented the user
from logging out.

WS-1744 (CN-01437889)
---------------------
When using the filter tool to define filters, if a value was entered in the
attribute edit mask, and the button was clicked to add the expression to the
filter, nothing happened. This only happened when using Google Chrome - all
other browsers properly added the expression.

WS-1741 (CN-01245846)
---------------------
In Workspace, a user defined as the recipient for multiple system views was only
seeing one system view (or no system views) in their view list, instead of all
the system views for which they were defined as a recipient. This problem
occurred when the recipient definitions for each system view pointed to a
different position in the organization model, but the names of those positions
were the same.

================================================================================

See attached Readme document for installation instructions.