Troubleshooting Common REST API issues

The error message indicates that the CRA server environment is not correctly pointing to the Java 17 for one of the following reasons:

1. You applied the latest PTF and the IBM SDK Java 17 is not in the default /usr/lpp/java/J17.0_64 directory.
2. Your CRA server is pointing to the correct Java directory, but updates to the Java package changed the Java SDK library location in your mainframe.

To resolve this error, if you have not yet applied the latest PTF, apply the PTF and complete the configuration. When the job is finished, restart the CRA server. 

If you still see the error, your CRA server is probably not in the default directory. Perform the following steps:

1. Open the CRATCSRV started task and update the installation path for CRA.
2. Use the absolute path (for example, JAVAHOME='/usr/lpp/java/J17.0_64') to the Java 17 directory in your environment. 
3. Restart the CRATCSRV started task and make sure it runs with return code 0.

The started task seems to be running, but the URL https://CRA server_host:CRA server_port/cra is not accessible.

The issue can have one of the following causes:

• The protocol (HTTP or HTTPS) is not set properly in the CRACMNEV member of the UBBSAMP data set.
• The configuration.JSON is not present in the USS directory of your CRA server.

• Incorrect CRA_HOME, Java Home, DSN on the mainframe, or Java version
• The user that started the task has no permissions for CRA_HOME
• The port is already in use
• Incorrect security configurations
• The system or user abend (S878 R=00000014) occurred during the initialization of the CRA server

• The following message appears in the STDOUT log:

  CEE3501S
  
  The module libjvm.so was not found. From entry point JzosVM::initializeVMArgs() at compile unit offset +000 00094 at entry offset +00000094 at address 4310620C.

• Verify that the security configurations are correct. For more information, see Setting-up-CRA-to-work-as-a-stand-alone-server.
• If the working folder has changed, verify that the following files exist in CRA_HOME:
  • cra.jar
  • configurations.json
  • cra.war
  •  mapping.json
  • m3mapping.json
  • gpmlog4j2.xml
  • gpm.jar
  • gpm_configurations.json
  • gpm_custom.properties
  • gpm.war
  • cralog4j2.xml
  • cra_custom.properties

Following are some of the probable causes:

• Incorrect configurations.json in CRA_HOME/config
• You receive the following errors:
  • 400—Service registered via RTCS and cannot be deleted
  • 404—The path is not valid
  • 500—Failed to edit the configuration.json file

• Verify that the configurations.json file is in the correct form. For more information, see Registering-services-with-the-Common-REST-API.
• Verify that manual changes to the configurations.json file are made using an ASCII editor, such as VI. The configuration.json file is ASCII-encoded.

• Verify the data-collector-service.log file from the DCC or Logs folder after changing the log level from INFO to DEBUG in log4j2.xml
• Obtain the following files and check the output: 
  • result.txt
  • application.yaml
  • StartCRADataCollector.bat
• Verify that you have followed the steps listed in Using-the-Data-Collector-Client-utility-to-extract-data-from-the-BMC-AMI-Ops-products

• Security violation when trying to access a resource profile: "EZB.SOCKOPT.xxxx.TCPIP.SO_BROADCAST ... ".

• Specified incorrect user ID or password or you get the following message:

  Unable to verify password for user <userId> Success: false, errno: 157, errno2: 151782063, errnoMsg: EDC5157I An internal error has occurred.

• Specified incorrect passphrase
• The Host server version is not supported
• A certificate was created with incorrect keystore and truststore

• Verify that you follow the listed steps in the Setting-up-CRA-to-work-as-a-stand-alone-server section
• Verify that you have specified the correct credentials and that the required certificates are in place
• Verify that the Host server version is 7 and above

• Verify that the CRA server is installed and running. For more information, see Installing-and-configuring-the-Common-REST-API.
• Verify that the BMC AMI OpsA is installed and running. For more information, see product documentation.
• Check the opsa.auth value in the application.properties file. If it is true, authentication is required. 
• Verify that the parameters in the body are correct according to Triggering-BMC-AMI-Ops-Automation-using-the-Common-REST-API.
• View the following error codes:
  • 401—Authentication error
  • 404—Invalid path
  • 500—BMC AMI OpsA server is not accessible

• In the BBPARM member BBISSPxx for the PAS, verify that the following product codes were entered:
  • PRODUCT=AAO
  • PRODUCT-IIZ
• Verify that it is possible to send events from the producer in the terminal session in Kafka to the consumer in another terminal session in Kafka. For more details, see: https://kafka.apache.org/quickstart.
• Verify in Kafka that it is possible to consume and produce the topic from the request.
• The Kafka can work in one of these three configurations: plain, SSL, or SASL_SSL. Perform the next two steps according to the configuration you choose. We recommend checking the plain configuration first.
• Verify the correction of the security configuration in the Kafka server (plain, SSL, or SASL_SSL). These files must be checked: server.properties, zookeeper.properties, producer.properties, consumer.properties, and yourZookeeper-client.properties. 
• Verify the correction of the Kafka properties in the CRA environment file, cra_custom.properties.
• Verify that it is possible to produce events from CRA and consume them in Kafka. If there is still a problem - bring the cra_custom.properties.

• Verify that Java 17 is installed and that the JAVA_HOME environment variable is set correctly.
• Verify that the cra.war file exists in the installed WebSphere Liberty Server location, the dropins/spring folder.
• Verify that the following files exist in the configuration folder:
  • cralog4j2.xml
  • cra_custom.properties
  • configurations.json
• Open the server.env file that is located in the USS directory. Verify that the following parameters are defined correctly:
  • CRA_HOME,
  • config.folder
  • JAVA_HOME
    For more details, see Setting-up-CRA-to-work-with-the-IBM-WebSphere-Liberty-server.
• If using https, you must add <feature>transportSecurity-1.0</feature> in the feature manager. 
  For more details, see Setting-up-CRA-to-work-with-the-IBM-WebSphere-Liberty-server.

• Verify that the cralog4j2.xml file, which is located in CRA_HOME was defined correctly.
• The log level is defined in the Loggers tag. It must be INFO by default. 
• Verify the correction of the rollover policy in the cralog4j2.xml. For more details, see Managing-file-spaces-in-USS-logs.