Page tree
Skip to end of metadata
Go to start of metadata

Configuration settings can be defined in the of the database or server or in the server's notes.ini. They are retrieved in that order.

Set the OpenLog path by using xsp.openlog.filepath. The default is "OpenLog.nsf".

Set debug level if errors occur in OpenLogItem class using xsp.openlog.debugLevel. The default is 2, to log just full details. 1 will log just the message, 0 will log nothing.

By default SSJS errors will also be added to a FacesMessage, so displayed if a partial refresh occurs. The error also includes the control id the error relates to, if an id has been defined (best practice). To suppress this set xsp.openlog.displayError=false.

xsp.openlog.genericErrorMessage can be used to define a generic error message to be displayed to the users e.g. "Please contact IT, an error has occurred". If xsp.openlog.genericErrorMessage returns an empty string, the default, then the full error is returned can be used to send logs to an OpenLog database that is set up as a mail-in database. The log document is created in the server's and saved with the email address as the recipient.

xsp.openlog.suppressEventStack can be used to suppress stack traces in Event logs. Full stack traces are still recorded for errors. NOTEThe stack trace is the only method I know of to identify which XPages lifecycle phase an Event / Error is logged for, e.g. you may get a message logged for Restore View phase because a variable is not available, but the page displays fine because the relevant variable is available in Render Response.

xsp.openlog.expireDate can be used to set the ExpireDate field used by auto-archiving. This should be a number of days, e.g. 30, to auto-expire the log at 30 days from the date logged.

xsp.openlog.includeQueryString can be used to include any query string values (e.g. ?open&login) in the "Agent" field in the OpenLog log.

xsp.openlog.suppressEventControl can be used to suppress the ID of the control triggering an Event when logging from SSJS.

xsp.openlog.templateFilepath can be used to define a template filepath. If no database exists at the OpenLog path, a new database will be created based on the template.