Release Notes

Summary of enhancements, fixes, and open issues for this release.
lac52
The
CA Live API Creator
Release Notes summarizes new features, enhancements, release comparison, known issues, and other important information specific to this release.
4
Licensing Updates in
CA Live API Creator
5.2
If you are licensed to use
CA Live API Creator
under a standard license that the CA Support site issues, including standard microservice licenses, you must install the license for
CA Live API Creator
5.x. You can also consent to
CA Live API Creator
collecting and sending telemetry data, or system and usage data.
If you have signed an Enterprise Software Portfolio License Agreement (PLA), the PLA licenses you to use a portfolio of software products as defined in the agreement. You do not have to install the license for
CA Live API Creator
5.x. As part of the agreement, the PLA subscription model requires that you activate
CA Live API Creator
and configure it to collect and send usage data.
If you are running
CA Live API Creator
4.x or earlier, you can obtain a license for
CA Live API Creator
5.x by contacting Broadcom Support.
For more information:
  • About telemetry and consenting to
    CA Live API Creator
    collecting and sending usage data, see the "Telemetry" section.
  • For more information about licensing, see Licensing.
Migrate (or Upgrade) to
CA Live API Creator
5.2
Migrate and Upgrade from
CA Live API Creator
4.x or Earlier
Use 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 (the admin repository) that is used in
    CA Live API Creator
    5.x.
    For more information:
  2. Upgrade to this version of
    CA Live API Creator
    .
    CA Live API Creator
    4.1.01 is a patch release that addresses an out of memory issue (see DE407411 in the "Fixed Issues" section). This release also includes the fix.
    For more information about the patch releases, see the Readme for the patches.
    The
    LAC_PATCH_USE_IN_MEMORY_LOGGING
    option to turn off in-memory logging at the API Server level has been deprecated. Replace this option with the
    LAC_USE_IN_MEMORY_LOGGING
    option and set it to
    false
    when you start API Server during the upgrade process.
    For more information about the
    LAC_USE_IN_MEMORY_LOGGING
    option and the other options that you can add when you start API Server, see API Server Startup Options.
    Best Practice:
    Turn off in-memory logging at the API Server level, especially in test and production environments, and then configure external logging.
    For more information:
    For more information about how to upgrade to this version of
    CA Live API Creator
    , see Upgrade Live API Creator.
Upgrade from
CA Live API Creator
5.x
If you are running
CA Live API Creator
5.x, upgrade to the latest version of
CA Live API Creator
.
CA Live API Creator
5.0.01 is a patch release that addresses an out of memory issue (see DE407411 in the "Fixed Issues" section). This release also includes the fix.
For more information about the patch releases, see the Readme for the patches.
The
LAC_PATCH_USE_IN_MEMORY_LOGGING
option to turn off in-memory logging at the API Server level has been deprecated. Replace this option with the
LAC_USE_IN_MEMORY_LOGGING
option and set it to
false
when you start API Server during the upgrade process.
For more information about the
LAC_USE_IN_MEMORY_LOGGING
option and the other options that you can add when you start API Server, see API Server Startup Options.
Best Practice:
Turn off in-memory logging at the API Server level, especially in test and production environments, and then configure external logging.
For more information:
For more information about how to upgrade to this version of
CA Live API Creator
, see Upgrade Live API Creator.
Table-based Resources with Primary Keys
In previous versions of
CA Live API Creator
,
CA Live API Creator
returned the primary key in all table-based resources, even though you did not select a resource attribute as an effective primary key for the resource (the
Key
checkbox is cleared for the resource attribute).
If your client-side applications expect and reference the primary key, and your resource does not include the primary key explicitly, review the table-based resources in your API, and then define a resource attribute as an effective primary key for the resource.
For more information about how to define resource attributes as effective primary keys for resources, see Manage Resource Attributes.
New Features and Enhancements
This section outlines the new marquee features and enhancements in
CA Live API Creator
5.2.
To view feature and enhancement descriptions for previous
CA Live API Creator
releases, use the
Versions
drop-down.
Enhanced Resources
Resources have been enhanced to include the following:
Virtual Resource Attributes
You can now add virtual resource attributes to table-based resources. Virtual resource attributes are attributes that return computed or derived attributes.
CA Live API Creator
computes and sets the value for virtual resource attributes by way of GET events. An example of a virtual resource attribute is the value of a full name, computed from the first name (string) and the last name (string).
For more information about how to add virtual resource attributes, see Manage Resource Attributes.
Parent Resource Attributes
You can now add parent resource attributes to table-based resources. Parent resource attributes are lookup attributes from the resource's parent as part of the resource.
CA Live API Creator
computes and sets the value for parent resource attributes in the root resource. Parent resource attributes look up to the parent resource using the to-parent relationships that are defined for the resource. For example, you want to include the name of an employee's company, even though the employee record only includes the company ID.
For more information about how to add parent resource attributes, see Manage Resource Attributes.
"Fuzzy" Joins
You can now join resources across multiple databases using a virtual resource attribute. You can do a "fuzzy" join of child records that do not include an exact match for the join by way of a manual join, using a virtual resource attribute. You define a GET event that normalizes the value of the attribute to enable the join.
You do a "fuzzy" join by referring to the virtual resource attribute in a containing resource using the double square bracket ([[]] ) syntax.
The
B2B Northwind
API sample includes the
ShipperMemos
subresource that illustrates a join of "fuzzy" child records. For more information about this sample, see B2B API Sample.
The following syntax shows an example of doing a "fuzzy" join of child records where the value for the
phone_number
does not exactly match the
phone
virtual resource attribute of the containing resource:
phone_number = [[phone]]
For more information:
Resource Row Events as GET Events
You now create resource row events as GET events. If your API includes resources with defined row events,
CA Live API Creator
merges them into the GET event code for the resources when you upgrade to this version of
CA Live API Creator
.
For more information about GET events, see Manage Resource Events.
Improved User Experience
This release of
CA Live API Creator
includes the following improved user experience for resources:
  • The user interface (UI) for managing resources has been enhanced to allow you to easily shape your resource, including ordering of resource attributes.
  • The resource attributes (and the description) that you define for table-based resources are now properly reflected in the OpenAPI (Swagger) documentation for your API.
Newly Supported Data Sources
The following enhancements have been made to support connecting to CA mainframe databases as data sources.
Connections to the following data sources are beta features. We recommend that you connect to these data sources only in test environments. If you are interested in evaluating connections to these data sources, contact your account manager.
CA IDMS Data Source
You can now connect
CA Live API Creator
to IDMS databases.
For more information:
CA Datacom Data Source
You can now connect
CA Live API Creator
to Datacom databases.
For more information:
Telemetry
You can now activate
CA Live API Creator
and configure it to collect and send telemetry data. Telemetry is a foundational element of the PLA subscription model. CA Technologies, a Broadcom company, uses the data to offer additional products from the portfolio in support of the PLA subscription model. Support uses the data to improve customer experience, to troubleshoot customer issues, and to improve the services that Broadcom offers.
For more information about telemetry, see Licensing.
Call Multiple HTTP Requests In Parallel
You can now have
CA Live API Creator
call multiple HTTP requests in parallel using the
SysUtility.processHTTPInParallel()
method in your JavaScript code. If your code makes more than a few REST calls, using this method can improve performance. This method optimizes your API by creating separate threads to call the HTTP service requests, and then it returns an array of JSON responses. You can iterate through the responses to perform more processing or API mashups before returning the response to the client.
For more information about this method, including the syntax to use, see The SysUtility Object.
Db2iDataQueue Listeners
You can now create listeners that subscribe to messages from data queues residing on IBM Db2 for i databases. These listeners are called Db2iDataQueue listeners.
CA Live API Creator
executes the JavaScript code that you define in these listeners to process the incoming messages.
For more information about how to create these listeners, see Db2iDataQueue Listeners.
User Experience Enhancements
This release includes the following user experience enhancements:
Enhanced Code Editors
The code editors in API Creator, such as the code editor in resources and in rules, have been enhanced. They now provide an enhanced coding experience that is more inline with modern development tools.
You can now do the following:
  • Resize the code editor. By default, the size is medium, but you can enlarge the screen or display the full screen. In previous versions of API Creator, you could resize the code editor by clicking
    BIGGER CODE
    and
    SMALLER CODE
    .
  • Access code editor commands and the code examples from the code editor menu bar.
  • Access the following shortcuts:
    • CTRL + S:
      Save your changes by pressing
      CTRL + S
      on your keyboard.
    • CTRL + SPACE:
      Activate intelligent code completion by pressing
      CTRL + SPACE
      on your keyboard.
    • CMD + F:
      Search by pressing
      CMD + F
      on your keyboard.
Resources and Functions as Part of the Admin Repository
CA Live API Creator
now includes your resource and function definitions as part of you API metadata in the admin repository. They are located in the directory for your API within the
apis
directory of the admin repository, for example, the
demo
directory for the
Demo
API sample.
Starting in this release, you retrieve your resource or function definitions directly from the admin repository. In previous versions of
CA Live API Creator
, you moved resources or functions from one API to another by way of importing and exporting them using API Creator. You can continue to retrieve your resource or function definitions by exporting and importing them using the
CA Live API Creator
CLI (Admin CLI),
lacadmin
(or the alias
liveapicreatoradmin
).
For more information:
Listener Providers as Part of the Admin Repository
Listener providers are sets of JavaScript code that
CA Live API Creator
uses to implement a listener. Starting in this release,
CA Live API Creator
includes the listener provider definition in the admin repository. They are located in the
listener_providers
directory within the
system
directory of the admin repository.
For more information about the listener provider definitions that are in the admin repository, see View your API Definition.
MongoDB Resource Deprecation and the Migration or Upgrade Process
MongoDB resources have been deprecated in this version of
CA Live API Creator
. If you have migrated or upgraded from a previous version of
CA Live API Creator
, and you are using the MongoDB resource type to connect to a MongoDB database,
CA Live API Creator
converts your existing MongoDB resources into disabled table-based resources.
CA Live API Creator
copies the field information from the MongoDB resources into the
Description
field of these table-based resources.
You must migrate or upgrade your MongoDB resources to table-based resources.
Use the following process to migrate or upgrade your MongoDB resources to table-based resource:
  1. Copy the information that is in the
    Description
    field of the disabled table-based resource that
    CA Live API Creator
    created.
  2. Create a MongoDB data source. Use the information that you copied from the
    Description
    field of the disabled table-based resource to complete the fields for this data source.
    For more information about how to create a MongoDB data source, see MongoDB Data Source.
  3. Create a table-based resource. Name this resource using the same name as the disabled table-based resource that
    CA Live API Creator
    created. Select the collection name.
    For more information about how to create a table-based resource, see Define Table-Based Resource Types.
  4. Delete the disabled table-based resource that
    CA Live API Creator
    created.
Globals for Roles and the Migration or Upgrade Process
If you have defined globals for roles and you have selected
SQL
as the language option, you must now append a SELECT to your SQL statement in the SQL code for the global.
For more information about how to define the SQL code for globals, see Authorization and Role-Based Endpoint Access.
Optimize API Performance by Turning Off In-Memory Logging
You can now turn off in-memory logging at the API Server level by adding the
LAC_USE_IN_MEMORY_LOGGING
option when you start API Server and setting it to
false
.
For more information about this option, see API Server Startup Options.
You can also turn off in-memory logging at the API level by clearing the
Enable In-Memory Logs
checkbox that is on the
Settings
tab for your API. By default, API Creator displays the in-memory logs for your API (this checkbox is selected).
For more information about this API level setting, see API Properties.
Best Practice:
Turn off in-memory logging at the API Server level, especially in test and production environments, and then configure external logging.
For more information:
Supported Web Browsers
You can now use the following Web browsers with
CA Live API Creator
:
  • Google Chrome
  • Safari
  • Microsoft Edge
  • Firefox
For more information about the Web browsers that
CA Live API Creator
supports, see Installation Requirements and Supported Platforms.
Supported Data Sources
As of this release,
CA Live API Creator
does not support PostgreSQL 9.0 through 9.3.
For more information about the PostgreSQL data source versions that
CA Live API Creator
supports, see Installation Requirements and Supported Platforms.
Release Comparison
This table compares the key features in recent releases of
CA Live API Creator
:
Key Features
5.2
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
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
yes
yes
yes
yes
yes
no
no
no
no
no
no
yes
yes
yes
yes
yes
yes
yes
yes
yes
yes
no
no
no
no
no
no
yes
no
no
no
no
no
no
no
yes
no
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
yes
yes
yes
no
yes
yes
yes
yes
yes
yes
yes
no
yes
yes
yes
yes
yes
yes
no
no
yes
yes
yes
yes
yes
yes
no
no
yes
yes
yes
yes
yes
no
no
no
yes
yes
yes
no
no
no
no
no
yes
yes
yes
no
no
no
no
no
Messaging Capabilities
yes
yes
yes
yes
yes
no
no
no
yes
yes
yes
yes
no
no
no
no
yes
no
no
no
no
no
no
no
Time-Based Triggers
yes
yes
yes
yes
yes
no
no
no
yes
yes
yes
yes
yes
no
no
no
Developer Productivity
yes
yes
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
yes
yes
no
no
Server Configuration & Management
yes
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:
  • 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.
  • DE397042:
    CA Live API Creator
    exposes the Informix stored procedures that are defined as mode "O"-owner and "R"-restricted. You can define schema filters to filter out the stored procedures that you do not want to expose as REST endpoints.
  • DE410170: Unexpected error when Informix database scan detects database type (IFX_TYPE_UDTVAR)
  • DE396530: CSV Delimited(|) does not parse data.
  • DE397086: CSV data source with double quotes and Chinese character error.
  • DE402321: When creating a table-based resource,
    CA Live API Creator
    returns the primary key even though you do not have it selected as an attribute.
    CA Live API Creator
    should return the primary key only if you select it as an attribute and modify the resource to select the primary key as an attribute.
  • DE404830: NullPointerException error with MySQL when using user filter
  • DE404926: Error inserting row into tables that have direct or indirect recursive relationships
  • DE409355: The lacadmin documentation in GitHub includes typos (namecollsion instead of namecollision).
  • DE409673: APICreator UI: Dynamic authentication tokens do not display all enabled roles.
  • DE409159: Combined subresource with non-persistent attributes (NPAs) are not returned.
  • DE410360: You cannot connect to a PostgreSQL 9.6 database if you are running
    CA Live API Creator
    version 5.1.
  • DE407411: APIs with response events having recursive REST calls can incur increased heap usage, which can lead to OutOfMemoryError errors
  • DE413913: You cannot set rows equal to null in resource row events.
Known Issues
The following are known issues. Where available, workarounds are provided:
  • DE402883: The JDBC driver for Datacom includes a limitation that prevents you from testing the connection to Datacom data sources.
  • 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:
  • 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 are not Cross-Origin Resource Sharing (CORS) requests.