Activity Reporting (SAP Library - Knowledge Management)

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.
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>/ defaultDirectoryName is used internally by the system. 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/ server<n>/folder/subfolder. 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% %Stab%%Orfo.un%%Stab%%Okmc.et% %Stab%%Okmc.{http://sapportals.com/ xmlns/cm}linktype%%Stab%%Okmc.hr% %Stab%%Okmc.g%%Stab%%Okmc.hor%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}resourcetype%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}contenttype%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}created%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}createdby%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}modified%%Stab% %Okmc.{http://sapportals.com/ xmlns/cm}modifiedby%%Snl% More information: File Formats 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%} {%Okmc.hor%%Stab%%Okmc.or%%Snl%} More information: File Formats
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: 301 DELETE 302 SET 311 CREATE_CHILD 313 GET 321 CREATE_COLLECTION 331 CREATE_LINK 332 UPDATE_LINK 340 MOVE 341 RENAME 342 COPY 351 CHECKIN
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.rt	Type of KM resource: 0: Folder 1: File 2: Internal link 3: External link
rfo.uid	ID of a portal component request that is used to interrelate KM and portal activities

To log a KM property, use the following syntax for the opcode: kmc.{<PROPERTY_NAMESPACE>}<PROPERTY_NAME>

Example

For example, to log the KM property linktype, specify the following opcode:

%Okmc.{http://sapportals.com/xmlns/cm}linktype%

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 Listparameter must be activated, otherwise the system monitors all directories. If you deactivate the Active parameter instead, you have to restart the portal.

Note

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.