Service Gateway has two main components: The backend database and the frontend UI. Like the backend systems, Service Gateway’s UI can run on several different Application Servers depending on the customer environment; however, most customers use JBoss or WebLogic.
This article provides an overview of the usage, features, and common issues you may encounter related to the UI.
The Service Gateway UI is accessed by visiting http://hostname:9090/ by default, where the hostname is the name of the server hosting the Service Gateway application.
Note: The System Administrator can configure this address and port, so the exact address may vary.
After logging in, users see the main Home Screen, which provides shortcuts to features available through the menu. It can be used as a starting place to access most Service Gateway features, as well as recently viewed reports.
The left sidebar of the Service Gateway UI contains the main categorical items for the review and configuration of the environment. Below you can find a summary of the contents of each menu item within the UI.
- Allows the monitoring of Performance KPIs, configuring Security Features, managing External Servers, and configuring the Service Gateway Environment.
- Allows the management of Devices, Device Files, Firmware, Hardware, and Subscribers.
- Allows you to manage Attributes, Capabilities, Data Models and Data Model Definitions, Domains, Parameter Mappings, Services, Software Modules, and Templates.
- Allows you to set Policy Definitions, Device List Queries, and Logging details.
- Allows you to configure and generate reports for various components of the product.
- Provides a web-based copy of the User Guide and general release version details.
The Service Gateway UI is the main point of access for managing and configuring the hardware assets. For this reason, one of the most disruptive and readily apparent issues facing our customers is performance trouble within the UI. For example:
- The Service Gateway UI is entirely unresponsive.
- The UI is inaccessible, throwing 500 Server errors.
- The ACS configuration is not functioning correctly.
While the exact scope of the performance trouble can vary, the issues can often be traced back to Memory Issues within the Application Server that Service Gateway is hosted on. As Java is the primary language used within Service Gateway and its 3rd-party components, improperly allocated memory can result in a system-wide issue.
When a customer reports issues with UI responsiveness, the best first step will be to verify whether or not the trouble is memory-related. To isolate the problem quickly, you can search the related logs (cited below) for the “OutOfMemoryError” string.
If confirmed to be a memory issue, restarting the AppServer can help free up memory on the server to restore functionality. You can then consider making adjustments to the Application Server’s allocated memory.
Related Config Files, Logs, and Processes
JBoss Invoke Script
This file is responsible for the configuration of JBoss and can be used to adjust the available memory.
|Adjusting the Heap Memory Size:
The main log file for the system often contains the Java Errors and stack traces.
Performance Related Error Messages to Look for:
A secondary log that may contain Java Errors and stack traces.
The main JBoss process used by Service Gateway.
Restarting the Process to free up memory on the system:
- Long configuration times for large device batches
- Service Gateway UI Inaccessible due to low allocated memory