Accessing Stack Trace
This feature restricts the business users to view the stack traces displayed on OIPA UI.
Based on user's interaction or during the run time, OIPA throws stack traces on its UI for the exceptions such as, "out of memory, null pointer exceptions, and network timeout errors". OIPA provides a secure way of viewing / accessing these stack traces displayed on its UI, for specific user roles such as configuror or a technical team to troubleshoot the errors thrown by the application.
Security
The stack traces can be disabled /removed to be displayed on OIPA UI to ensure the system security, and to provide user friendly error messages to the Business User (CSR).
Only the Palette Admin or users with specific roles and security enabled, can view the stack trace information on UI to debug/fix the errors. For example. If you are a business user and an exception is thrown, you can view only the "user friendly exception message without the stack trace” (the business users are prohibited to view the stack trace), but if you are a user with Admin role, you can view that “user friendly error message, with stack trace."
The Palette user (Admin) can create a Show Stack Traces security button with enable and disable options, which can be used either to restrict / allow the users to access the stack traces on OIPA UI in both the Development and Production modes. The button can be enabled/disabled for specific user roles with security access. When an exception occurs, only the users having security can view Show Stack Traces button and access the stack traces on clicking Show Stack Traces in the Error page.
If Show Stack Traces is disabled, the button will not appear on OIPA screen, and only user friendly messages are displayed to the business users (CSR). A CSR can view and click only the Return to Application button.
If Show Stack Traces is enabled, the button is displayed on OIPA screen in both PROD and DEV modes and the user roles that have access to the button to Show Stack Traces, are allowed to view and access the stack traces.
When a user clicks Show Stack Traces, the button name changes to Hide Stack Traces and displays the stack trace details. On clicking Hide Stack Traces, the full-stack error message disappears and button name changes back to Show Stack Traces.
Note: The Error Catalog lists all the user friendly messages for SRE and APE errors that are supported currently in OIPA. Refer XML guide for Error Catalog details.
Steps to Enable/Disable ShowStackTraces
- Navigate to Admin Explorer>Security>Application Security>Security Groups> Prototype Super> Company Security> Company pages>Prototype>ShowStackTraces
- Right click on the ShowStackTraces node and checkout.
- Select ShowStackTraces check box to enable the button in ShowStackTracespage and check-in. The ShowStackTraces page controls the access of ShowStackTraces button for accessing the stack traces by specific user roles.
Note: The ShowStackTracesnode represents a record in AsAuthPage and when an access is provided to the configuror, a new AsCompanyAuthPage will be added.