Troubleshooting

This page identifies issues you may encounter and how to resolve them.

Discover Issues

When Live API Creator (LAC) is not working properly, you can:
  1. View the logs on the Logs page in LAC.
  2. View the container's logs, such as Apache Tomcat or Jetty.
  3. If the problem is client-only, view the browser's debug page.

Resolve Errors

For more information about resolving errors, see errors and Error Handling.

Database Connections

General Connection Issues

To assist in support, identify:
  • The main container log (catalina.out for Tomcat, console output for Jetty).
  • The exact scenario (explain the exact steps used to connect to the DB).
  • An export of the database, whenever possible. This enables us to identify issues.

Verify Connectivity

Use SQL Tools (Toad, DbViz, MySqlWorkbench, SQL/Server Enterprise Manager, etc) to verify that you can connect to the database from the machine hosting LAC.  It is common to ecnounter firewalls issues, particularly in large organizations.

Database Connects but no tables - ensure Active

Ensure your data source is marked Active. Schema information is not retrieved for inactive data sources.

For more information about activating data sources, see Data Sources.

Large Schemas

Schemas are cached in the AdminDB, so a full load is only required initially, or when you refresh the schema. For very large schemas, the initial load time may exceed the browser time-out time. In this case, you will see an error, but the API Server continues the load process.

Reload LAC in your browser and you should see that the schema has loaded.

Otherwise, contact CA Support.

SQL Server

For more information about connecting to Microsoft SQL Server, see Microsoft SQL Server.

Reset the Database Password After API Project Import

LAC does not store passwords in the .json file on export. LAC requires a re-entry of all database passwords when you import an API project. Reset your database password on the Data Sources, Connection tab.

For more information:
  • About the fields on this tab, see context help.
  • About data sources, see Data Sources.

Authentication Provider not set after Project Import

LAC does not store the authentication provider in the .json file and requires re-selection after project import. Set the authentication provider on the API Properties, Details tab.

For more information:

Named Filters gives SQL Error

The use of named filters allows creation of named parameter values to be used in place of column attributes. However, each database has its own rules on how to handle mixed case and quotes. Make sure the column attribute names are in single quotes ('name'), double quotes ("name"), or back-ticks (`name`) depending on Derby, MySQL, Oracle requirements.

Connect to Large Schemas

For schemas in excess of several hundred tables, you may run into browser time-outs and heap errors. Browser timeouts reflect that the time to load the schema exceeded the browser timeout: log in to the LAC again.

For heap errors, increase the heap size provided to the API Server. For example, in the Jetty version, the Start command file (.sh or bat) has the following:

java -DSTOP.PORT=8123 -DSTOP.KEY=stop_caliveapicreator -jar ../start.jar $1 $2 $3 $4 $5 $6 $7 $8 $9

Change it as follows:

java -Xmx1024m -DSTOP.PORT=8123 <<< etc >>>

Data Explorer does not Show Tables

Make sure the user logon has at least one role assigned and the role has at least one table with read access. If you have changed your URL fragment and/or your project name, switch API projects (click Home, select a different API project, and then repeat the process selecting your original API project). This clears the internal API cache and allows LAC to rebuild the new URL endpoints.

For more information about defining roles and table access, see Security

Resource Properties not Visible

This occurs because the browser is attempting to auto-fill values. LAC disables such functionality, though certain browsers ignore such disabling. Correct the browser from ignoring the disabling.

The following image shows the Resource type and Resource name fields:

Google Chrome

Customize Google Chrome. Click the Chrome burger, Settings. For more information, see Google Chrome help.

Safari

Safari > Preferences > AutoFill. Clear the User names and passwords checkbox.