Activity Reporting
Use
Activity reporting reports on activities in KM repositories.
You can use activity reporting to find out which users have carried out which file operations at what time in a repository.
Since the written log files are machine-readable, you can also trigger statistical evaluations of the collected data. For example, you can calculate how often a document has been called or which use has created the most documents.
Features
You can define the repositories and activities to be written to the log file in the configuration of the activity reporting service. You edit the parameters in the table below to do this.
KM-Specific Parameters of the Activity Reporting Service
Parameter |
Required |
Description |
Active |
No |
The service is deactivated by default. To activate the service, activate this parameter and enter the folder and events you want to monitor. |
Positive List |
No |
If this parameter is activated, the service monitors all folders specified in the RID List parameter. If it is deactivated, the service monitors all KM folders other than those specified in the RID LIST parameter. |
RID List |
No |
This parameter is for specifying a comma-separated list of folders that the service monitors for activities if the Positive List parameter is activated. Example: /etc,/documents/Public Documents If the Positive List parameter is deactivated, the service monitors all KM folders other than those specified here. |
Read Operation |
No |
This parameter dictates whether or not the service logs read operations (open/download operations) for resources (files, folders, and links). |
Create Operation |
No |
This parameter dictates whether or not the service monitors creation operations for resources. |
Edit Operation |
No |
This parameter dictates whether or not the service monitors edit operations for resources. Edit operations do not include the property changes. |
Delete Operation |
No |
This parameter dictates whether or not the service monitors delete operations for resources. |
Rename Operation |
No |
This parameter dictates whether or not the service monitors rename operations for resources. |
Copy Operation |
No |
This parameter dictates whether or not the service monitors copy operations for resources. |
Move Operation |
No |
This parameter dictates whether or not the service monitors move operations for resources. |
The following
parameters are used internally by the activity reporting framework. For more
information about the parameters, see
Activating and
Configuring the Activity Data Collector.
Parameters of the Activity Reporting Framework
Parameter |
Required |
Description |
Directory Name |
No |
This parameter specifies the directory on the portal server where service stores the log files. If you do not
enter anything here, the path /usr/sap/<System-ID>/JC<xx>/j2ee/cluster/server<n>/ This is also used
as the base path if you specify a relative path (for example, folder/subfolder). This results in the path: /usr/sap/<System-ID>/JC<xx>/j2ee/cluster/ In a cluster environment, the system stores the associated log files on each node in the specified directory. |
Base File Name |
Yes |
This parameter specifies the base name of the written log files. The file name is composed of the base name and other parts as shown below: File name of the main log file: <base file name>_<cluster node ID><timestamp> File name of other log files: add<x>_<base file name>_<cluster node ID><timestamp> Opened log files have the ending .open. Default setting: kmc_activity |
File Encoding |
Yes |
This parameter specifies the encoding used to store the log file. Default setting: UTF-8 |
Main File Format |
Yes |
This parameter specifies the format used to store the log file. Default setting:
%Orfo.t(d-MMM-yyyy
hh:mm:ss,GMT)%%Stab%%Orfo.uid% More information:
You can find a list of KM-specific opcodes below this table. |
Additional File Formats |
Yes |
This parameter specifies the formats in which other log files are saved if the main log file is not sufficient, or if other log files in a different format are required. Default setting:
{%Okmc.hr%%Stab%%Okmc.r%%Snl%} More information:
|
Hour To Close |
Yes |
This parameter specifies the hour of the day at which logging in the file stops and continues in another file. Default setting: 0 |
Maximum File Size |
Yes |
This parameter specifies the maximum file size for a log file in kilobytes. If the maximum file size is reached, the service continues logging in a new file. Default setting: 10240 |
Maximum Buffer Size |
Yes |
This parameter specifies the maximum size of the buffer in the main memory. This is the temporary storage location where the collected data is kept until the service saves it to the log file. The specification is in kilobytes. Default setting: 500 |
KM-Specific Opcodes
Opcode |
Description |
kmc.et |
Event type Activity reporting takes into account the following events, each of which maps to a certain parameter in the service configuration: 301 DELETE – maps to Delete Operation 302 SET – maps to Edit Operation 311 CREATE_CHILD – maps to Create Operation 313 GET – maps to Read Operation 321 CREATE_COLLECTION – maps to Create Operation 331 CREATE_LINK – maps to Create Operation 332 UPDATE_LINK - maps to Edit Operation 340 MOVE – maps to Move Operation 341 RENAME – maps to Rename Operation 342 COPY – maps to Copy Operation 351 CHECKIN – maps to Edit Operation |
kmc.r |
RID of a KM resource |
kmc.hr |
MD5 hash of an RID |
kmc.g |
GUID of a KM resource |
kmc.or |
Original RID of a KM resource that has been moved or renamed |
kmc.hor |
MD5 hash of the original RID |
kmc.{http://sapportals.com/xmlns/cm}linktype |
Type of KM resource: 0: Folder 1: File 2: Internal link 3: External link |
kmc.{<PROPERTY_NAMESPACE>}<PROPERTY_NAME> |
You should use this syntax to log a KM property. Example: To log the KM property link type, specify the following operation code: %Okmc.{http://sapportals.com/xmlns/cm}linktype% |
rfo.uid |
ID of a portal component request that is used to interrelate KM and portal activities |
More information:
Recording access to documents in KM (SDN Blog)
Activities
To activate activity reporting for KM, choose System Administration® System Configuration ® Knowledge Management ® Content Management ® Global Services ® (Show Advanced Options) ® Activity Reporting Service in the portal.
To record events, you have to activate the service, select the required events, and specify the directories that you want to monitor.
To deactivate activity reporting again, remove the entry in the RID List parameter. The Positive List parameter must be activated, otherwise the system monitors all directories. If you deactivate the Active parameter instead, you have to restart the portal.
The default format is a tab-separated list based on a text file.
You can currently only use text editors and programs that can analyze tab-separated lists to display and evaluate the collected data from activity reporting.
In the standard configuration, all users, except for the service users, are enabled for activity tracing. If you want to enable or disable the activity tracing for a certain user, you have to modify the configuration of the system principals accordingly. To do so, navigate to System Administration ® System Configuration ® Utilities ® System Principals ® System User, and then open the relevant configuration object for editing. To enable or disable the activity tracing, select or deselect the Audit Actions checkbox respectively.