Contents


IBM Business Analytics Proven Practices

IBM Cognos TM1 Audit Log Helper

Product(s): IBM Cognos TM1; Area of Interest: Infrastructure

Comments

Content series:

This content is part # of # in the series: IBM Business Analytics Proven Practices

Stay tuned for additional content in this series.

This content is part of the series:IBM Business Analytics Proven Practices

Stay tuned for additional content in this series.

Purpose of Document

This document describes how to use the IBM Cognos TM1 Audit Log Helper tool.

Applicability

The IBM Cognos TM1 Audit Log Helper has been developed to work with IBM Cognos TM1 version 10.2 on Microsoft Windows operating systems. It is likely to work with future versions of IBM Cognos TM1.

Assumptions

To use the IBM Cognos TM1 Audit Log Helper the user should be familiar with IBM Cognos TM1. To update the source code, the user should also be familiar with Microsoft Visual Studio.

Overview

The IBM Cognos TM1 Audit Log Helper is designed to get information out of the IBM Cognos TM1 audit log. Place the AuditLogHelper.exe and AuditLogHelper.ini files into the <tm1_install>\bin directory and update the AuditLogHelper.ini file with the parameters desired before running this program.

AuditLogHelper commands

This section lists the available AuditLogHelper commands and what the command will return.

List TM1 object types

From a command prompt, execute AuditLogHelper.exe list. This will return a list of TM1 object types.

List Event Codes for a Specific Object Type

From a command prompt, execute AuditLogHelper.exe list ObjectType where ObjectType is any valid TM1 object type. This will return a list of TM1 event codes for the specified object type.

Query the Audit Log

From a command prompt, execute AuditLogHelper.exe query. This will query the audit log based on the parameters specified in the AuditLogHelper.ini file and return the result.

AuditLogHelper.ini

The AuditLogHelper.ini file specifies the TM1 server, the user, and the filter parameters to use when executing the command AuditLogHelper.exe query. Any line beginning with the hashtag symbol (“#”) is considered to be a comment and will be ignored by the program.

Connection Information

The four connection information parameters specified in Table 1 are all required.

Table 1 - Connection parameters
ParameterDescription
AdminHostMachine name or IP address
ServerName of the TM1 server such as SData or GO_New_Stores
UserLogin name used to connect to TM1 server
PasswordPassword associated with this user to connect to TM1 server

Filters

The list of filters is presented in Table 2. Any filters may be deleted or commented out if you choose not to filter on that field.

Table 2 - Filters
FilterDescription
StartTimeOnly match entries after this time. Specified as GMT (UTC) in the format YYYYMMDDhhmmss where YYYY is the four digit year, MM is the two digit month number, DD is the two digit day number, hh is the two digit hour number in 24 hour time, mm is the two digit minute and ss is the two digit second.
EndTimeOnly match entries before this time. Specified as GMT (UTC) in the same format as StartTime.
EventOwnerOnly match entries by the specified user or scheduled chore. This may be a single name or a comma separated list of names.
ObjectTypeOnly match entries on the specified object type. This may be a single object type or a comma separated list of types. You can get a list of valid object types with the command AuditLogHelper.exe list.
ObjectNameOnly match objects with the specified name. This may be a single object name or a comma separated list of names.
EventCodeOnly match entries with the specified event code. This may be a single event code or a comma separated list of codes. You can get a list of valid event codes for a specific object type with the command AuditLogHelper.exe list ObjectType. For example, to get all the event codes associated with cubes, you would execute the command AuditLogHelper.exe list cube.
GetDetailsSome audit log entries, such as creating a cube, have additional details that may be of interest. Set this field to False to omit these details or to True to see these details.

Modifying the Source Code

The C++ source code file used to create AuditLogHelper.exe is included so that you may learn how to access the TM1 audit log from the TM1 API or so that you can modify this example program for your own use.

To compile the executable, you will need the AuditLogHelper.cpp file as well as the TM1API.h and TM1API.lib files from the <tm1_install>\tm1api directory.


Downloadable resources


Related topic


Comments

Sign in or register to add and subscribe to comments.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Big data and analytics
ArticleID=966398
ArticleTitle=IBM Business Analytics Proven Practices: IBM Cognos TM1 Audit Log Helper
publish-date=03212014