Release Notes

Summary of enhancements, fixes, and open issues.
lac51
The
CA Live API Creator
Release Notes summarizes new features, enhancements, release comparison, known issues, and other important information specific to this release.
4
Install and Migrate (or Upgrade) to
CA Live API Creator
5.1
CA Live API Creator
5.1 requires that you install a 5.x license. If you are an existing CA customer and you are running version 4.x or earlier, you can obtain a
CA Live API Creator
5.x license by contacting CA Support.
If you are running
CA Live API Creator
4.x or earlier
, complete the following process:
  1. Migrate to
    CA Live API Creator
    5.0 using the migration service. The migration service upgrades your API definition to the new format that is used in
    CA Live API Creator
    5.0 and later.
    For more information about how to migrate to
    CA Live API Creator
    5.0, see Migrate CA Live API Creator.
  2. Upgrade to this version of
    CA Live API Creator
    .
If you are running
CA Live API Creator
5.0
, upgrade to this version of
CA Live API Creator
.
For more information:
New Features and Enhancements
This section outlines the marquee features and enhancements in
CA Live API Creator
5.1.
For feature and enhancement descriptions for previous releases, use the
Versions
drop-down.
Newly Supported Business Data Sources
You can now connect
CA Live API Creator
to the following data sources.
IBM Db2 for i as a Data Source
You can now connect
CA Live API Creator
to a Db2 for i (formerly known as Db2 for iSeries) data source.
For more information about how to set up this connection, see IBM Db2 for i Data Source.
IBM Informix as a Data Source
You can now connect
CA Live API Creator
to an Informix data source.
For more information about how to set up this connection, see IBM Informix Data Source.
PostgreSQL Data Source Updates
When connecting to a PostgreSQL database,
CA Live API Creator
now supports more data types, such as
Enum
,
xml
,
json
, and arrays of built-in data types.
For more information about the data types that
CA Live API Creator
supports in PostgreSQL data sources, see PostgreSQL Data Source.
Oracle Data Source Updates
The following updates have been made to Oracle data source connections in this release.
Identity and ROWID Columns Reflected in your Schema
When connecting to an Oracle database,
CA Live API Creator
now:
  • Recognizes identity columns and reflects them within your schema in API Creator.
  • Exposes the ROWID column for tables that do not have a primary key. You can now access tables that do not have a primary key from
    CA Live API Creator
    .
For more information about these data types, see Oracle Data Source.
Oracle as Managed Database
You can now use Oracle as a managed database. This expands the list of databases that you can use for the
App-first
approach to creating APIs. With a managed data server and a data source for a managed database, you can add, update, and delete tables, fields, and relationships in the data source.
For more information:
SQL Server Data Source Updates
When connecting to a SQL Server database,
CA Live API Creator
now returns and displays stored procedures that have the same name within your schema in API creator.
For more information about how to view SQL Server stored procedures that have the same name, see Microsoft SQL Server Data Source.
Support for Database Sequences in Other Data Sources
In previous versions of
CA Live API Creator
, you could use the database sequences that
CA Live API Creator
detects in your schema for only for Oracle data source connections.
CA Live API Creator
now detects the sequences that are defined in your schema when you connect to the following other data sources:
  • DB2 for z/OS
  • DB2 for LUW
  • PostgreSQL
  • Microsoft SQL Server
For more information about how to use the database sequences that
CA Live API Creator
detects in your data source, see the data source page for that database.
User Experience Enhancements
This release includes the following user experience enhancements.
View Errors in the Response
You can now view the source of errors from the call stack in your log. You can now also identify the source of errors (for example, the name of the resource/function/rule/library etc.) in the error message that is included in responses that return HTTP 500 status codes. This improves the ability to debug and narrow down the source of the error in your API.
For more information, see View Logging Information.
API Server Startup Option Change
You now bypass the API Creator screen that asks the initial API developer (a TeamSpace user) to log in to accept the user license when starting API Server by adding the
CA_ACCEPT_LICENSE
option. The casing for this option has changed. This option replaces the
ca_accept_license
option.
For historical reasons, you can use the lowercase form of the
ca_accept_license
option. For forward compatibility, use uppercase.
For more information about this option and other options that you can add when you start API Server, see API Server Startup Options.
Release Comparison
This table compares the key features in recent releases of
CA Live API Creator
:
Key Features
5.1
5.0
4.1
4.0
3.2
3.1
3.0
API Creation
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
Database & Data Source Support
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
no
no
no
no
no
yes
yes
yes
yes
yes
yes
yes
yes
no
no
no
no
no
no
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
yes
yes
yes
yes
yes
yes
no
yes
yes
yes
yes
yes
no
no
yes
yes
yes
yes
yes
no
no
yes
yes
yes
yes
no
no
no
yes
yes
no
no
no
no
no
yes
yes
no
no
no
no
no
Messaging Capabilities
yes
yes
yes
yes
no
no
no
yes
yes
yes
no
no
no
no
Time-Based Triggers
yes
yes
yes
yes
no
no
no
yes
yes
yes
yes
no
no
no
Developer Productivity
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
no
Server Configuration & Management
yes
yes
yes
no
no
no
no
* Data source that uses a data source provider
Fixed Issues
The following are issues that are fixed in this release:
  • DE381866: You cannot view the authentication tokens that are created for your API when you are using the Internet Explorer 11 web browser.
  • DE390151: The
    timestamp
    data type has invalid format error on DB2 for z/OS databases.
  • DE389181: The Oracle data source throws null pointer exception error when the SQL user does not have permissions to read parent table schema.
  • DE380871: Logging from JavaScript (JS) library occasionally does not work.
  • DE340970: The
    SysUtility.getResource()
    method does not handle basic filters properly.
  • DE391454: Calling SQL Server stored procedures that have return codes does not return the value in the response.
Known Issues
The following are known issues in this release. Where available, workarounds are provided:
  • DE389002:  The MongoDB JDBC driver (the JAR file) and the Informix JDBC driver (the JAR file) reference different versions of the BSON library. These references conflict while running in
    CA Live API Creator
    . You can install the MongoDB JDBC driver or the Informix JDBC driver, but you cannot have them installed simultaneously.
  • DE379064:
    CA Live API Creator
    includes the encrypted data source password in the export API for those APIs that are connected to data sources that use the data source provider framework (for example, the MongoDB data source) instead of salting them. If you have installed in another environment where you have not changed the encryption key, TeamSpace users can still use this password.
    As a workaround, update and test the password for those data sources that use the data source provider framework after your deploy your API.
    For more information:
  • DE348196: The JavaScript debugger in API Creator does not work properly when you run it on Java SE Development Kit (JDK) 9. Run the debugger using JDK 8.
    For more information about the debugger, see Debugger.
  • DE392245: The variables that display in the Special Variables section of the JavaScript debugger display as empty. The workaround is to evaluate these variables using the
    Evaluate Scope
    tab in the debugger.
  • DE382731: When
    CA Live API Creator
    generates a log statement for a custom endpoint, the log shows the authentication token as
    CORS_Response Key:NA CORS_Response -2
    . These requests are normal unauthenticated requests and not Cross-Origin Resource Sharing (CORS) requests.
  • DE392595:
    CA Live API Creator
    includes the
    camel-core-2.20.2.jar
    Camel library. This library file includes a vulnerability that improperly restricts XML messages.
    For more information about this vulnerability, see CWE-611 on the CWE website.
    If you use RabbitMQ or Java Message Service (JMS) listeners that are built on the Apache Camel framework, as a workaround, replace this Camel library with the
    camel-core-2.20.4.jar
    library file, which contains the fix. Place this library file in the
    WEB-INF/lib
    directory, and then bundle this file into the WAR file by issuing the following command:
    jar uvf CALiveAPICreator.war WEB-INF/lib/camel-core-2.20.4.jar
  • DE396530: The CSV driver that
    CA Live API Creator
    supports cannot parse and read CSV files using the delimited(|) delimiter type.
  • DE410360: Cannot connect to PostgreSQL 9.6 with
    CA Live API Creator
    .