Show TOC

Logging Changes Using the AdminTraceabilityServiceLocate this document in the navigation structure

Use

The admin traceability feature enables the logging of changes made to objects in the PCD (Portal Content Directory) or to portal-related configurations, for supportability purposes. An application can explicitly log critical configuration changes using the AdminTraceablityService . The information that is logged includes the severity level of the log entry, the ID of the changed object, the type of change, such as move or delete, and the user who made the change. Thus, the admin traceability feature is a logger that enables administrators to monitor changes that may cause damage to the portal and trace the person responsible for making the changes. For more information about the admin traceability feature, see Logging Changes Made to PCD Objects .

The AdminTraceabilityService , contained in the package com.sap.portal.admin.admintraceability , provides the method logChange , which serves as an access point to the admin traceability logging capability. The logChange method enables applications, such as Knowledge Management, that do not write to the PCD, to log configuration changes.

Note

The logging category used is System/Changes .

The signature of the logChange method:

public void logChange( int severity, String objectId, String operation, IPrincipal user, String additionalInfo, String appSource);
         
Example
logChange(Severity.ERROR,"pcd:portal_content", IAdminTraceabilityService.MOVE,user,"Portal content catalog was moved", "Property Editor");