User Guide: IBM Cognos Controller Financial Analytics Publisher

IBM Cognos Controller
Financial Analytics Publisher

Version 10.2.1
User Guide
򔻐򗗠򙳰
Note
Before using this information and the product it supports, read the information in “Notices” on page 45.
Product Information
This document applies to IBM Cognos Controller Version 10.2.1 and may also apply to subsequent releases.
Licensed Materials - Property of IBM
© Copyright IBM Corporation 2004, 2015.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1. What's new? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

New features in IBM Cognos Controller Financial Analytics Publisher 10.2.0 . . . . . . . . . . . . . . 1
FAP user groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
One source definition for each Controller database . . . . . . . . . . . . . . . . . . . . . 2
Greater FAP performance and stability. . . . . . . . . . . . . . . . . . . . . . . . . . 2
New features in IBM Cognos Controller Financial Analytics Publisher 10.1.1 . . . . . . . . . . . . . . 3
New log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Ability to choose the ports for Microsoft SQL and IBM DB2 servers . . . . . . . . . . . . . . . . 3
Enhanced naming convention for dimensions . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2. Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Selecting a database type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Defining service settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Trickling fact data from the source . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Defining sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Adding a data mart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Viewing log information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Verifying IBM Cognos Controller Financial Analytics Publisher data . . . . . . . . . . . . . . . . . 9
Chapter 3. How IBM Cognos Controller data is transformed into a reporting format . . 11
FAP overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
FAP components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
FAP concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Initial publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Fact trickling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Structure updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Purging the FAP database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
FAP cubes and dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
FAP cubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Transformation rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Dimension naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Dimension transformation principles . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
The Account dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
The Company dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
The CompanyGroup dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Extended dimensions 1-4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
The ActualityMonthly dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Linked actualities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
The ActualityWeekly dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
The PeriodMonthly dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
The PeriodWeekly dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
The Currency dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
The Transaction currency dimension . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Consolidation perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Closing versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Contribution versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
The Origin company dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
The Counter company dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
The Journal number dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
The Counter dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
The Measurement dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
The Impact of contribution version BASE value in IBM Cognos Controller, versions 8.x . . . . . . . . . . 38
© Copyright IBM Corp. 2004, 2015 iii

Appendix A. FAP extension points . . . . . . . . . . . . . . . . . . . . . . . . 41
Appendix B. Dimension attributes . . . . . . . . . . . . . . . . . . . . . . . . 43
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
iv User Guide
Introduction
With IBM® Cognos® Controller Financial Analytics Publisher you can connect the
IBM Cognos Controller database to the IBM Cognos Controller Financial Analytics
Publisher client so that you can publish data in a TM1® cube.
The solution is optimized for many simultaneous users, and suits both legal and
management reporting.
For installation instructions, see the IBM Cognos Controller Installation and
Configuration Guide.
Audience
Controller application administrators and the report writers who use IBM Cognos
Controller Financial Analytics Publisher.
Finding information
To find product documentation on the web, including all translated

documentation, access IBM Knowledge Center (http://www.ibm.com/support/
knowledgecenter).
Forward-looking statements
This documentation describes the current functionality of the product. References

to items that are not currently available may be included. No implication of any
future availability should be inferred. Any such references are not a commitment,
promise, or legal obligation to deliver any material, code, or functionality. The
development, release, and timing of features or functionality remain at the sole
discretion of IBM.
Accessibility Features
IBM Cognos Controller Financial Analytics Publisher does not currently support
accessibility features that help users with a physical disability, such as restricted
mobility or limited vision, to use this product.
IBM Cognos HTML documentation has accessibility features. PDF documents are
supplemental and, as such, include no added accessibility features.
© Copyright IBM Corp. 2004, 2015 v

vi User Guide
Chapter 1. What's new?
This section contains a list of new features for this release.
For more information, see the IBM Cognos Controller User Guide.
For changes to previous versions, see:

v What’s New in Version 10.2.0
v What’s New in Version 10.1.1
Note: To review an up-to-date list of environments supported by IBM Cognos

Controller 10.2, such as operating systems, patches, browsers, web servers,
directory servers, database servers, and application servers, see the IBM Cognos
Controller 10.2 Supported Software Environments site (http://www.ibm.com/
support/docview.wss?uid=swg27041444).
New features in IBM Cognos Controller Financial Analytics Publisher

10.2.0
This section describes the new features in IBM Cognos Controller Financial
Analytics Publisher 10.2.0.
FAP user groups

You can assign permission levels to a Financial Analytics Publisher (FAP) user by
adding them to one or more of the following user groups: 1) IBM Cognos
Controller User, 2) IBM TM1 User, or 3) User Group Administrator.
You specify the permissions levels in Controller using Maintain > Rights > User.
The access restrictions that you define in IBM Cognos ControllerIBM Cognos
Controller on Cloud also apply in TM1. The access to one or more dimensions is
determined by the Security Group limitations.
If an Initial Publish was performed in a previous Cognos ControllerCognos

Controller on Cloud release, all users from the previous release will still exist on
the TM1 server. If it is no longer required that some of those users be active in the
TM1 server, the TM1 administrator must delete them.
Note: If any unwanted users/clients were not deleted from TM1, those users'
rights are removed after a publish from FAP 10.2. However, the users remain
visible when you view Client Security.
The IBM Cognos ControllerIBM Cognos Controller on Cloud User

group
IBM Cognos ControllerIBM Cognos Controller on Cloud User group members can
use Controller and the IBM Cognos Controller Link for Microsoft Excel.
Note: If a user is assigned only to the IBM Cognos ControllerIBM Cognos

Controller on Cloud User group, they cannot use IBM Cognos TM1.
© Copyright IBM Corp. 2004, 2015 1

The IBM TM1 User group
IBM Cognos TM1 User group members can use TM1.
Note: If a user is assigned only to the IBM TM1 User group, they cannot use IBM
Cognos ControllerIBM Cognos Controller on Cloud or the IBM Cognos Controller
Link for Microsoft Excel.
User names assigned to the IBM Cognos TM1 User group are copied over when
you publish to the IBM Cognos ControllerIBM Cognos Controller on Cloud
Financial Analytics Publisher.
IBM Cognos TM1 User group members can access Controller data in a published
FAP cube in TM1 if they were granted access to the cube. An Initial Publish
transfers all active TM1 users to the TM1 server. Inactive TM1 Users and inactive
IBM Cognos ControllerIBM Cognos Controller on Cloud Users are not transferred
to the TM1 Server.
The User Group Administrator group
User Group Administrator group members can use both Controller and TM1.
A member of the User Group Administrator group can change permissions for
other users in his group, but not for the group itself. This type of user cannot
change permissions for users on a higher level in the hierarchy than his own
group. This option is not available for users who are assigned only to the IBM
Cognos TM1 User group.
Note: After you upgrade a Controller database from an earlier version of IBM
Cognos ControllerIBM Cognos Controller on Cloud, all users are members of the
User Group Administrator group by default. Therefore, if you do not want certain
users to access FAP cubes, you must move them to the IBM Cognos ControllerIBM
Cognos Controller on Cloud User group before you run an Initial Publish.
One source definition for each Controller database

In release 10.2 of IBM Cognos Controller and IBM Cognos Controller Financial
Analytics Publisher, a Controller database can be referenced by only one source
definition.
If you try to reference a Controller database by more than one source definition,
the following message appears:
Cannot add source. Source with this Controller database already exists. Please
choose another Controller database.
Greater FAP performance and stability

In IBM Cognos Controller 10.2, the trickle table for Financial Analytics Publisher
(FAP) is separated from the Audit Trail Log.
You can separate and automate the purge schedules with optimal indexation,
resulting in better overall performance and stability.
Note: After the installation, database conversion can take several minutes while
tables are created and data is copied.
2 User Guide
New features in IBM Cognos Controller Financial Analytics Publisher
10.1.1
This section describes the new features in IBM Cognos Controller Financial
Analytics Publisher 10.1.1.
New log files

As of version 10.1.0 and all subsequent relesases, the log files include history. Two
new log files replace the old log files. This will help you to troubleshoot IBM
Cognos Controller Financial Analytics Publisher.
In previous versions of FAP there were two log files: "FAPFatalError.log" and
"Retry.log". These log files were overwritten, and not appended. The result was
that the history was removed.
There is a new log file: "error.log". This log file includes history. The file "error.log"
is created and appended in the FAP service base directory when errors occur.
Ability to choose the ports for Microsoft SQL and IBM DB2
servers
You can choose the ports for Microsoft SQL servers and IBM DB2® servers.
In previous versions of FAP you only could use standard ports for Microsoft SQL
and IBM DB2 servers.
For more information, see “Defining sources” on page 6.
Enhanced naming convention for dimensions

You can add a suffix, a prefix, or both to a FAP dimension.
By changing the names of the dimensions you are able to avoid possible conflicts if
an IBM Cognos Express® installation with other dimensions is available in the
same IBM Cognos TM1 instance.
For more information, see “Adding a data mart” on page 7.
Chapter 1. What's new? 3

4 User Guide
Chapter 2. Getting started
To get started using IBM Cognos Controller Financial Analytics Publisher, you
need to provide information about the database type, service settings, the source,
the data marts, and the log.
v Select database type
v Define service settings
v Define source
v Add data marts
v Filter log information
Selecting a database type

When you log on to the IBM Cognos Controller Financial Analytics Publisher client
for the first time, you need to enter the database type, which can be either
Microsoft SQL Server, Oracle or DB2.
Procedure
1. Click Start > IBM Cognos Controller Financial Analytics Publisher.
2. In the FAP Connect window, provide the following information:
For MS SQL Server:
v Database type - select which type of database server you want to use
v Server - select the database server name
v Database - select the name of the Financial Analytics Publisher database
v Username - enter a valid Financial Analytics Publisher user
v Password - enter the valid Financial Analytics Publisher user password
For Oracle:
v Data source - service name
v Password - enter the Financial Analytics Publisher user password
For IBM DB2:
v Server - select the database server name
v Database - select the name of the Financial Analytics Publisher database
v Password - enter the valid Financial Analytics Publisher user password
The next time you log on, you only need to enter the password.
3. Click Log On.
Defining service settings

Service settings allow you to manage factors that might have an impact on
performance and disk space.

You can modify how often the different service settings should be run by using the
Service Settings tab.
Procedure
1. In the IBM Cognos Controller Financial Analytics Publisher window, click the
2. From the Clock Interval list, select how long the interval should be between
each time the service is run.
3. From the Log file items for list, select how often the log table is purged in the
FAP database.
4. From the Trickle tables purge every list, select how often the xdbtrickle table is
purged.
Trickling fact data from the source

You can enable and disable trickling of fact data from the source.
Procedure
2. You can enable and disable trickling of fact data from the source.
v Click Start to enable trickling.
v Click Stop to disable trickling.
Defining sources
You can define the source, which is used to connect the IBM Cognos Controller
database with the data mart.
It includes information about the source status, purged date, last purged index,
and the IBM Cognos Controller database last moved index.
Before you begin
When you define a source, then a check will be done on the existence of a new
consolidation model. If only old consolidation models exists, then an error will be
displayed that old consolidation models are not supported.
Procedure
1. In the IBM Cognos Controller Financial Analytics Publisher window, click
the Sources tab.
2. Click New.
3. In the Name field, enter the name of the source.
4. From the Log level list, select Low, Normal, or High. Normal is selected by
default.
5. Select an interval.
6. Optional: in the Description field, enter a description of the source.
7. Set the database options:
v For MS SQL Server, select the database type, the server, the port, and the
database you want to use.
v For Oracle, select the database type, the server, the SID, and the port.
6 User Guide
v For DB2, select the database type, the server, the port, and the database you
want to use.
8. Enter a valid username and password.
9. To test the new connection, click Test Connection.
10. Click Save.
You can change the source settings by clicking the Edit button.
Adding a data mart

You can add data marts in IBM Cognos Financial Analytics Publisher to define
which data you want to publish, and save the information as a definition.
You can choose to publish the company structure, start period, and actuality. You
can edit the definition and add a new company structure when needed. You can
also specify which forms are to be published, edit naming conventions for specific
structures, and select a company details or a consolidated groups cube.
Note: IBM Cognos Financial Analytics Publisher must be used in conjunction with
IBM Cognos Controller databases that have verified structures and validated data.
Before publishing, verify the structures and validate the data using IBM Cognos
Controller.
Before you begin
When you define a source, then a check will be done on the existence of a new
consolidation model. If only old consolidation models exists, then an error will be
displayed that old consolidation models are not supported.
Procedure
Data Marts tab.
2. Click New.
3. Set the data mart options:
v Name - Enter the name of the data mart.
v Source - Select a defined source
v Log level - Select Low, Normal, High, or Detailed. It is usually best to use
log level High.
v Interval - Specify how many service clock intervals will elapse until the tasks
for this data mart are performed.
v Specify forms - Specify which forms you want to publish.
v Naming conventions - Specify which names you want to use. When IBM
Cognos Express is installed, then naming conflicts can occur because other
dimensions are available in the same IBM Cognos TM1 instance. To avoid
naming conflicts you can add a suffix and a prefix to FAP dimensions. The
valid characters for the prefix and suffix are:
– Alphanumeric
– Special characters: ( ) * , . / < > @ \ _ |
The maximum length of a prefix or suffix is 10 characters. The maximum
combined length of a prefix and a suffix is 20 characters.
v Company details - Publish the company details cube.
v Consolidated groups - Publish consolidated groups.
Chapter 2. Getting started 7

v Description - Enter text that describes the data mart.
v Company Structure - Select one or more consolidation types for the
company structure in the data mart, and enter the period (YYMM) from
which the company structure in the data mart will be set up.
v Start period/Actuality - Decide from when data will be visible in the data
mart. You can select one or more periods of the same consolidation type.
v Admin host - Specify the name of the server that hosts the TM1 servers.
v Server - Specify the name of a specific TM1 server.
v Client - Use TM1 Admin.
v Password - Specify a valid password for the TM1 user.
4. Click Save.
5. Confirm that the new data mart is visible in the list on the Data Marts tab.
You can change the source settings by clicking the Edit button.
6. Select the data mart that you want to run, and click Start. The status changes
from Under definition to Ready for publish.
Results
The next time that the FAP Service runs, it detects the Ready for publish status,
creates the cube, and starts the initial publishing of data. When the initial
publishing is finished, the data mart status changes to Running. The cube is then
updated on a regular basis according to the Clock Interval setting on the Service
Settings tab.
Viewing log information

In IBM Cognos Controller Financial Analytic Publisher you can view log
information about the status of the data mart and the source.
This allows you to keep track of every task that is performed.
For troubleshooting purposes, you can look at the file "error.log", which is located
in the FAP service base directory. The file "error.log" contains history.
Procedure
1. Click the Logs tab.
2. Under Filter, select the filter options:
v Type - you can specify log information type: Any, Log, Source and Data
Mart.
v Object - you can specify which objects you want to see the log information
about.
v Severity - you can specify severity level: Any Severity, Info, Error and
Critical Error.
v Page size - you can specify a page size of 50, 100, 500 or 1000.
3. On the View menu, click Refresh to update the log.
4. If you want to update the log information automatically, select the Update
automatically check box.
8 User Guide
Verifying IBM Cognos Controller Financial Analytics Publisher data
Use IBM Cognos Business Intelligence studios, or other TM1 compatible reporting
tools to verify the data and the structures in the TM1 cube.
Chapter 2. Getting started 9

10 User Guide
Chapter 3. How IBM Cognos Controller data is transformed
into a reporting format
IBM Cognos Controller Financial Analytics Publisher (FAP) automates the process
of extracting data from IBM Cognos Controller and inserting it into IBM Cognos
TM1.
From the TM1 cube(s), the IBM Cognos Controller data can be accessed by IBM
Cognos Business Intelligence studios, and other TM1 compatible reporting tools.
FAP overview
Financial Analysis Publisher (FAP) is delivered with IBM Cognos Controller. FAP
provides additional ways of solving both in-process reporting requirements, as
well as management reporting agendas, and using data without any time lags.
Users want access to consolidated data to perform analytic-style reporting and

distribute reports on a global scale. FAP extracts the information from the IBM
Cognos Controller relational database and inserts it into a TM1 cube environment.
Any changes made to the data in the IBM Cognos Controller database, including
those generated by the users or fed from source systems, are automatically
propagated through to TM1.
Figure 1. FAP overview
FAP combines two different technologies: a relational database technology

optimized for transactions and data entry and an OLAP technology optimized for
reporting and analytics.
The peak load on FAP occurs during the initial publish, during the closing period,
when the majority of changes are processed in IBM Cognos Controller, and during
the reporting peaks in the cube.
FAP components
FAP consists of four main components.

v FAP client - This is an administrative console where the basic settings are
applied, some events are triggered, and the FAP log information can be
monitored.
v FAP database - This is a temporary database to which changed facts and data
and dimension updates are moved prior to their transformation into the cube.
The information in this database is purged at regular intervals.
Note: The FAP database should not be used by more than one FAP service.
v FAP service - This moves and transforms the relational IBM Cognos Controller
data and the dimensions into the cube.
v TM1 (FAP) cubes - These are the read-only TM1 cubes that contain the IBM
Cognos Controller dimensions and trickle-published data.
FAP requires additional server resources for TM1 and the FAP database. For more
information about network set up and resource requirements, see the IBM Cognos
Proven Practices document (http://public.dhe.ibm.com/software/dw/dm/
cognos/performance/cognos_specific/
architecture_and_server_sizing_for_cognos_controller85.pdf).
FAP concepts
It is important to understand the process when designing a reporting solution.
v Initial publish
v Fact (data) trickling
v Structure update
v FAP database purging
You can add extension points both before and after each of these processes. For
more information, see Appendix A, “FAP extension points,” on page 41.
Initial publish
The initial publish process creates the FAP dimensions and cubes and fills the
cubes with facts and data.
If the dimensions are already present on the TM1 server, they are emptied and not
re-created.
12 User Guide
Figure 2. FAP Initial publish
The initial publish process:

1. Select the IBM Cognos Controller data to publish in the FAP client.
2. Start the initial publish from the FAP client. You can initiate a full or partial
initial publish process.
3. The FAP Service transfers facts and dimensions from IBM Cognos Controller to
the FAP database.
4. A TM1 API call is initiated, building dimensions and creating the cubes.
5. A TM1 Turbo Integrator (TI) script is run to collect facts and data from the FAP
database and fill the cube.
Verify all IBM Cognos Controller structures prior to starting the initial publish.
Once the initial publish is completed it is shown in the FAP client log. Please note
that a full initial publish may take some time, depending on the volumes to be
moved from the source to the target.
Fact trickling
Fact (data) trickling is the repetitive process in which the FAP Service looks for
changes (inserts, updates, deletions) in the IBM Cognos Controller database, and
updates the FAP cubes accordingly.
Chapter 3. How IBM Cognos Controller data is transformed into a reporting format 13
Figure 3. Fact trickling
The fact trickling process:

1. Based on the clock interval defined in the FAP client, the FAP Service searches
for changes in the IBM Cognos Controller database.
2. The FAP Service transfers all changes from the IBM Cognos Controller database
to the FAP database.
3. A TI process fetches facts from the FAP database and updates the nodes in the
FAP cubes.
Each data trickle cycle generates a log in the FAP client log.
Structure updates
The initial publish process moves all dimensions as they currently appear in IBM
Cognos Controller.
As it is possible to store measures on aggregation nodes in IBM Cognos Controller,

but not in TM1, the structure update process needs to manage both aggregation
nodes as well as dimension changes. For more information, see “Dimension
transformation principles” on page 25.
The structure updates process consists of two parts:

v Publish children - structures are automatically moved to TM1 for the fact trickle
to work.
v Update structures - the TM1 dimensions are re-generated. This is done manually
by the user in the FAP client.
Workflow for the first part of the structure updates:

1. Based on the clock interval defined in the FAP client, the FAP Service searches
for changes in the IBM Cognos Controller database.
2. The FAP Service transfers structural changes from the IBM Cognos Controller
database to the FAP database.
3. The FAP Service calls the TM1 API and initiates a TI script.
4. Members are added in the TM1 dimensions. The cube can be reported on but is
not updated during this operation.
14 User Guide
Note: At this point new members are not inserted in the right place in the TM1
hierarchy. This is done in the second part of the update.
Figure 4. Structure update process, structural changes transferred
Workflow for the second part of the structure updates:

1. The user notices that there are pending dimension updates in the FAP client.
2. The user initiates the structure update in the FAP Client.
3. The FAP Service transfers structures from IBM Cognos Controller to the FAP
database.
4. A TM1 API call is triggered to move updates from the FAP database to the FAP
cubes.
5. Dimensions are updated according to the IBM Cognos Controller hierarchy.
Fact and data are kept during this operation.
Users and authorization groups are also handled in this step, which is also seen as
slowly moving dimensions. Slowly moving dimensions are dimensions that change
infrequently.
The update of slowly changing dimensions is a manual process due to process and
technical reasons. A dimensional update could potentially invalidate reports, and
even a small change in IBM Cognos Controller could generate costly operations on
the TM1 side. Typically, it is beneficial to have a level of user control over this step,
for example to collect a number of changes before updating the cube.
Figure 5. Structure update process, TM1 dimensions updated
Purging the FAP database

The FAP Service also purges the FAP database. On a regular basis, the FAP Service
cleans the temporary storage.
This purging is done to prevent the temporary storage from getting too big over
time.
Figure 6. Purging the FAP database
The purging is based on the clock interval set in the FAP client.
16 User Guide
FAP cubes and dimensions
For information about set-up and configuration, see the Install IBM Cognos
Controller Financial Analytics Publisher chapter in the IBM Cognos Controller
Installation and Configuration Guide.
FAP cubes
Depending on the FAP client settings and on the IBM Cognos Controller
configuration, you can create up to three different FAP cubes.
In the figure that follows, the different FAP cubes hold the following data:
1. A monthly detailed cube that holds leaf level data for all companies as they
appear in IBM Cognos Controller (named <Data mart
name>MonthlyCompanyDetails, where you can configure <Data mart name>).
2. A monthly consolidated cube that holds consolidated values from the last
consolidation in IBM Cognos Controller on group level only (named <Data
mart name>ConsolidatedGroups).
3. A weekly actualities cube that holds leaf level data for all companies as they
appear in IBM Cognos Controller (<Data mart name>WeeklyCompanyDetails).
Note: Only applicable to installations with weekly actualities.
Figure 7. Data can be moved into different FAP cubes or customized cubes
FAP cubes should not be modified because they are created or re-created in each
initial publish. But you can automate the movement of the data into additional,
customized cubes. The customized cubes might be compressed with regard to
dimensions, or might contain additional rules for financial logic that meet your
requirements.
The extension points [B in the figure], provide the means to automate the
customization of the FAP cubes through standard TM1 functionality. The FAP
service looks for and executes Turbo Integrator scripts that follow a specified
naming convention. For more information, see Appendix A, “FAP extension
points,” on page 41.
Transformation rules
A number of transformation rules are applied when data is moved from the IBM
Cognos Controller relational data source to the cube target.
The transformation rules are applied for the following reasons:
v There are differences in the way that a relational database and a cube handle
data For example, the IBM Cognos Controller relational database stores values
on an aggregated level whereas the cube only stores values on a leaf level.
v IBM Cognos Controller works with time-dependent dimensions (the company
dimension).
When data is changed in IBM Cognos Controller (the source), the service moves
the changes to the cube automatically.While moving the data, the service
transforms it into pre-defined cube models according to a set of pre-defined rules.
This transformation is handled by the FAP Service that is leveraging its own
temporary database to complete its job. For a detailed description of the
transformation principles, see “Dimension transformation principles” on page 25.
Dimension naming conventions

There are naming conventions used in the transformation.
In the following table, the target is the FAP cubes, and the source is the IBM
Cognos Controller relational database.
Table 1. Dimension naming conventions
Cube dimension Relational Consolidated
(target) counterpart (source) Monthly cube cube Weekly cube
Account Account X X X
Company Company X X
CompanyGroup Company X
<Ext Dim 1> <Ext Dim 1> X X X
ActualityMonthly PerAct X X
ActualityWeekly PerAct X
PeriodMonthly PerAct X X
PeriodWeekly PerAct X
Currency Currency Code X X X
Transaction Currency Transaction Currency X X X
Code
Consolidation Consolidation Type X X X
Perspective
Closing Version Manual Journal X X X
Type/Closing
Version
Contribution Version Automatic Journal X X X
Type/Contribution
Version
Origin Company Original Company X X X
Counter Company Counter Company X X X
Journal Number Journal Number X X X
Counter Dimension Counter Dimension X X X
18 User Guide
Table 1. Dimension naming conventions (continued)
Cube dimension Relational Consolidated
(target) counterpart (source) Monthly cube cube Weekly cube
Measures: Amount
v YTD
Amount in
v Transaction YTD Transaction Currency
v Monthly Note:
v Weekly v Monthly and
v Comment Weekly measures
are calculated
v Transaction
through rules. The
Comment
weekly value is
v Comment Count only applicable for
the weekly cube.
v The comment
count is calculated
as the summary
count of all
comments in the
leafs in the
hierarchy.
v Transaction
comment is for IC.
The Account and Company dimensions both have a number of attributes. For more
information, see Appendix B, “Dimension attributes,” on page 43.
Examples of target cubes

The following examples illustrate the possible target cubes.
Please note that the way the naming of the extended dimensions is set up in the
source affects the cubes (in the examples these are Prod, Mark, and Customer).
The monthly detailed cube:
The monthly detailed cube is the most frequently used cube.
It holds facts and data and comments for all leafs defined in the IBM Cognos
Controller hierarchy. In addition, summation nodes are automatically calculated by
TM1.
During the consolidation process, when a consolidation is run in IBM Cognos

Controller, the result is consolidated values on all groups in the source. In the
target cube, the same values can be seen as a result of TM1 aggregating all leaf
values into the summation nodes. The consolidated values as such (in the source)
are not transferred to the target. However, as soon as a leaf value is updated in the
source (IBM Cognos Controller), there is a difference on the group level when
comparing the source and the target. This is because each leaf change is
propagated to the target and then aggregated according to the aggregation logic in
the TM1 OLAP environment. In other words, the summation nodes contain the
recent changes in the source. This is different from the source, in which the
consolidation values from the last consolidation stay the same, even if a leaf value
has been updated.
The next time a consolidation is run in IBM Cognos Controller, the source and the
target will look the same again.
Figure 8. Tree structure view of the monthly detailed cube
The monthly consolidated cube:
The monthly consolidated cube holds the consolidated values for companies
defined as groups (or sub-groups) in IBM Cognos Controller.
This type of cube is not affected by leaf-level changes in IBM Cognos Controller.
This cube will be updated only when a consolidation is run in IBM Cognos
Controller.
20 User Guide
Figure 9. Tree structure view of the monthly consolidated cube
The consolidated cube leverages a variant of the company dimension,

CompanyGroup. This is a flat hierarchy containing only the groups and without
the period stamp.
By combining data from the detailed and the consolidated cubes (by customizing),
it is possible to show the result of the last consolidation on group levels
(summation nodes) and latest updates on company level (leaf nodes).
The weekly cube:
The weekly cube is only applicable to IBM Cognos Controller installations where
weekly actualities have been configured.
This cube is similar to the monthly cube but with two main differences:
v It uses the ActualityWeekly (instead of the ActualityMonthly) dimension.
v It uses the PeriodWeekly (instead of the PeriodMonthly) dimension.
Please note that the hierarchy for the PeriodWeekly dimension is Year->Week; that
is, month is not part of the hierarchy. This is because IBM Cognos Controller does
not handle the relationship between months and weeks, that is, determining what
weeks, or parts of weeks, go into a certain month.
Figure 10. Tree structure view of the weekly cube
Additional considerations
The sections that follow discuss some additional considerations to keep in mind
when working with IBM Cognos Controller Financial Analytics Publisher.
Near real time FAP versus published target:
IBM Cognos Controller Financial Analytics Publisher automatically and in near real
time moves changes from the relational source to the target cube.
The speed of data movement enables in-process reporting and data validation
based on data in the cube.
You can give report consumers access to the final data, without giving them access
to near real-time cubes. This is useful for users who only require a snapshot of the
data for both statutory and management reporting after the closing. You can
restrict access to near real-time cubes by using the following methods:
v Turn off the trickle publish function. However, this will completely eliminate the
possibility for close to real time analysis for all users.
v Make a copy of the near real time cube within the same TM1 server and use the
copy for these users.
v Copy the TM1 server.
For additional descriptions on how to customize FAP for various reporting

scenarios, go to the IBM Cognos Proven Practices documentation web site:
http://www.ibm.com/developerworks/data/library/cognos/
cognosprovenpractices.html
22 User Guide
FAP and security:
Users and authorization groups in IBM Cognos Controller are published to TM1,
and the authorization groups get prefixes to avoid naming conflicts.
The following security modes are available for IBM Cognos Controller and FAP in
TM1:
Basic security mode
For TM1 9.4.1 and TM1 9.5.x, IBM Cognos Controller users and authorization
groups are published and can be leveraged if CAM authentication is not used to
access the IBM Cognos Controller Financial Analytics Publisher cube (for example
from the TM1 Excel plug-in, but not from BI).
Note: IBM Cognos Controller users and authorization groups present in IBM
Cognos Controller are deleted in TM1 during the initial publish operation.
CAM security mode
For TM1 9.4.1, all CAM users in IBM Cognos Controller are published, but they are
published without the integrated security from IBM Cognos Controller that is
present in the TM1 cube.
For TM1 9.5 and later, security is integrated between IBM Cognos Controller and
TM1. Users and authorization groups in IBM Cognos Controller are published to
TM1. Then for all CAM users present in TM1, the CAM user ID is connected to the
IBM Cognos Controller user ID and gets the appropriate authorization groups
(provided the CAM information has been maintained in IBM Cognos Controller).
Attempted use of TM1 security mode settings that are not supported by IBM
Cognos Controller results in the termination of the initial publish process and the
data mart being set to Error. The following TM1 API security modes are not
supported:
v Distributed
Implies that the TM1 server is a distributed server that accepts connections
without specifying any credentials.
v Mixed
Implies that the TM1 server accepts user authenticating either using Basic
authentication or Windows Integrated Authentication.
v WIA
Implies that the TM1 server accepts connections that can authenticate based on
Windows Integrated Authentication.
Aggregations (statistical accounts):
When working with statistical accounts, you need to be aware of the

numerator-denominator behavior as described in the example.
Imagine a simple product hierarchy with Vehicles as the top node (0) and with
Bikes and Cars as the next level (1). In this example, a certain calculation (KPI) is
defined as C = A / B, where A is the numerator and B the denominator. C is to be
calculated on both Level 0 and Level 1.
Figure 11. Aggregating statistical accounts
Calculating C with the support of the advanced formula calculation accounts could
be done in two different ways:
v C is set up as an advanced formula calculation account at Level 1, and the
division is part of the formula. A and B could be normal accounts or
AFC/statistical accounts.
v C is calculated in the report. A and/or B are set up as advanced formula
calculation/statistical accounts at level 1.
From a calculation point of view:
Formula Results
CBikes = ABikes / BBikes CBikes = 1/1 = 1
CCars = ACars / BCars CCars = 1/10 = 0.1
If C is set up as an advanced formula calculation account, the FAP cube would

automatically aggregate C to the next dimension level (Level 0). However,
CVehicles is not defined as CBikes + CCars, but rather as CVehicles = AVehicles /
BVehicles = (ABikes + ACars) / (BBikes + BCars.
Default aggregation for C on Level 0:

v CVehicles = CBikes + CCars = 1 + 0.1 = 1.1
Expected result for C on Level 0:

v CVehicles = AVehicles / BVehicles = (ABikes + ACars) / (BBikes + BCars = (1+1)
/ (1+10) = 2/11 = 0.1818
When defining these types of calculations you must be aware of this behavior.
However, there are at least two possible alternative ways of handling this:
v Scenario 1: If you want the calculation of C to be set up as an advanced formula
calculation account, then different advanced formula calculation accounts should
be created by dimension level. For example, C dimension level 0 and C
dimension level 1. You then need to use the appropriate advanced formula
calculation account in your reports; that is, you need to be aware of that C on
level 1 will be aggregated to Level 0, and not be meaningful on this level.
v Scenario 2: If the calculation of C is done in the report for all levels, no such
aggregation would occur. A and/or B can be set up as advanced formula
calculation accounts, use the built-in formulas and period logic, and be re-used
in multiple KPI calculations in various reports.
24 User Guide
Note: Please note that an advanced formula calculation performed on the top level
only would work without the numerator-denominator consideration.
Dimension transformation principles

To understand the FAP cubes and how to author reports based on data in the
cubes, it is important to understand the underlying transformation principles.
The Account dimension

The account structure in IBM Cognos Controller's relational source allows a base
account to logically sum-up several times to the same summation account, as
illustrated in the example.
Figure 12. Account summation structure in the source (Controller) database
From a hierarchical point of view, S1 would be evaluated as: S1 = S2 + S3 =

(A1+A2) + (A2+A3) = A1 + 2*A2 + A3.
However, the correct interpretation is that a single account should not be summed
multiple times, hence: S1 = A1 + A2 + A3.
To avoid flattening the account structure and losing the ability to drill down in the
target, a compensating transformation, such as the following is used:
Figure 13. Account summation structure in the target database
In this compensating transformation, the summation structure in the source is

rebuilt in the target and includes relations that are weighted to compensate where
needed, for example 2* A2 - A2 = A2.
Note: In the account structure there is no need for additional aggregation nodes
because summation accounts do not relate to any physical transactions.
The Company dimension

The company structure is period dependent in the source, one structure version
per month. IBM Cognos Controller Financial Analytics Publisher can handle
multiple company structures for different consolidation types and periods. This
allows you to drill down through the group and company tree for other periods.
The transformation principle is illustrated in the following example. When the

Legal (LE) company structure is transformed in the target, there is a leaf level of
companies and group entities (G1, G2, and G3) that relate to the transactions
(elimination companies). In the figure, the Group Adjustment Company (GAC) in
the source is treated like any other company in the hierarchy.
Figure 14. The company dimension transformed from source to target
Summary of the transformation principle:

v The names (identifiers) of the leaf nodes are invariant over different periods and
the names in the target cube correspond to the codes in the source.
v Each published period (that is, the period that the user chooses) has its own
aggregation hierarchy. The naming convention contains both the corresponding
source group code and the period.
v The company dimension in the target is the sum of the period specific
hierarchies illustrated and the leaf nodes (corresponding to entities in the
source). This means that, in the target, the company dimension will have one top
node per period.
v The naming convention is <consolidation type>.<period>.<company>, for
example, LE.2009-09.G2
The principle is similar to the one used for extended dimensions. Each "transaction
carrying member" becomes a leaf node in the target. Each leaf node has the same
name as the code in the source, which simplifies updates. The aggregating nodes
in the target are added and follow a naming convention.
Example of the time dependent company dimension

The company dimension is time dependent.
That is, it can vary over time, or more specifically, it varies with the period. A new
company might be added (acquired), another might be removed (sold), and a third
might be moved in the structure (ownership change).
The following example describes the transformation of a legal company structure

as it looks in the 2009-01 period.
26 User Guide
Figure 15. Company dimension transformation example for 2009-01 period
In the next period, the company structure is modified and company C3 is now
owned by G2 and C2 by G3. The new transformation would look like this.
Figure 16. Company dimension transformation example for 2009-02 period
Each published period (that is, each period that the user chooses when setting up
the trickle-publish) has its own aggregation hierarchy. The naming convention
contains both the consolidation type, the group code, and the period from the
source.
The company dimension in the target is the sum of the period specific hierarchies
illustrated and the leaf nodes. This means that the target company dimension will
have one top node per period.
In the current solution, it is possible to drill down through the company hierarchy
one period at a time. However, if you drill down through the 2009-01 company
hierarchy after having selected the 2009-03 period dimension, the result will be
inconsistent. Time-dependent dimension aggregation is not currently supported.
The trial balance function

The following example illustrates the trial balance function in IBM Cognos
Controller Financial Analytics Publisher.
Source
Figure 17. Trial balance function example, view of source
In the trial balance report for the 0901 period, actuality AC, and the company
structure 0901LE, the eliminations (AJT) will appear as separate columns for each
company when you select the option in the report (this option is the default in
each company and drillable). On the subgroup, these eliminations from the
subsidiaries will be aggregated and kept as such (except if you select the option
Consolidated Automatic journals type as BASE). When you drill by automatic
journal type, you see eliminations that are directly on the subgroup level.
Target
Figure 18. Trial balance function example, view of target
When the cube is generated for the company structure version 0901LE, period
0901, and actuality AC; the Elim I/C, Elim I/P and Elim Acq transactions go to the
elimination company 1000, assuming they were booked on subgroups 2000 and
5000. Eliminations in the source that are stored in companies that are not
cross-owned, remain on the company in the target. Review related information
about the server preference ETYP_EXCLUDE. For more information, see
“Contribution versions” on page 35.
Publishing to a Data Mart

The following example illustrates the Publish to Data Mart function in IBM Cognos
Controller.
If you want to use the Publish to Data Mart function in IBM Cognos Controller
instead, the transformation will look like the following diagram. Note that the
Publish to Data Mart function does not support the time dependent dimension
concept of IBM Cognos Controller Financial Analytics Publisher, and that the
elimination company naming convention is slightly different.
28 User Guide
Figure 19. Publish to Data Mart function
The CompanyGroup dimension

The CompanyGroup dimension contains all groups in a flat hierarchy and without
period stamps. This dimension is used in the consolidated cube only.
Figure 20. Consolidated cube, CompanyGroup dimension example
Extended dimensions 1-4

Extended dimensions are dimensions that are defined by users. When IBM Cognos
Financial Analysis Publisher transforms extended dimensions 1-4, the dimension
names that are used in the source relational database are also used in the cube.
In the source, values are stored on aggregated levels in the hierarchies. It is not
possible to store values in the same way in the target. Therefore, in the target cube,
when the data is transformed, aggregation nodes are added.
In the target, an extended dimension is built according to the following

conventions:
v All members in the source become leaf members in the target, and use the same
code.
v All members that are aggregation members in the source are also created as
separate aggregation nodes in the target.
Figure 21. Transformation of extended members from source to target
Example of slowly moving dimensions

Slowly moving dimensions are dimensions that are not frequently updated.
Slowly moving dimensions are updated in two phases:

v The first phase handles transactions in the source with members that are
unknown to the target. For example, this is typically the result of an added
product, company, or period in the source.
v The second phase updates one or many dimensions in the target.
For the system-created aggregation nodes, the naming convention @Aggr can be
changed in the FAP client.
This example shows the changes in the source database and target cube during the
different phases of an update.
In the following figure, A1, A2, B1, and B2 are different products that belong to
different product groups.
Figure 22. Example of dimensions in source and cube
In the source, if product group C and product C1 are added, and product B2 is
moved, this change is initially not reflected in the target. After transactions that
correspond to the new product members (C and C1) are detected, the new
members are added to the target.
These new members are not connected in the hierarchy, but are collected under a
"not connected" node. The only dimensional operation that occurs during this stage
is to add the new leaf members. The IBM Cognos Controller Financial Analytics
Publisher server tracks all valid leaf members in all dimensions to detect the new
ones. A new leaf node is added before the corresponding transaction is imported
into the target.
In the following figure, the new source product groups and products that are
detected in the source, are added as new, but unconnected leaf members in the
30 User Guide
target.
Figure 23. Transformation of slowly moving dimensions, phase 1
The second phase of the slowly moving dimension transformation addresses the
inconsistency between the source and the target. In the IBM Cognos Controller
Financial Analytics Publisher client, when you detect that there are pending source
dimension changes, you can choose to update the TM1 dimension. This updating
process is manually triggered for the following reasons:
v It is not specified how an automated detection of a dimension update in the
target should be updated from the source.
v There is a disadvantage with automatic updating because every small change in
the source results in a costly operation in the target. For example, it is best to
not trigger an update after each change if you make significant changes to the
product hierarchy.
v Even if performance is not a concern, the user might not want the update to be
triggered automatically. A dimensional update can invalidate reports and it
might be best to wait until a certain time, for example, after the closing process
is finished.
After you manually trigger dimensional updating, the target is updated to contain
new members, a restructured aggregation hierarchy, and changed names (aliases on
the target side). The following figure shows this second phase of transformation.
Figure 24. Transformation of slowly moving dimensions, phase 2
The ActualityMonthly dimension

The actualitymonthly dimension is a list of the used actualities without any
hierarchical logic. The actuality is transformed as it is logically used in the
relational source.
In the source fact table, actuality is not a column of its own, that is, the PerAct
dimension is split into two dimensions in the target: actuality and period.
Furthermore, the period and actuality dimensions are sometimes treated as one
dimension in the source, and in other cases as two different dimensions.
Linked actualities
Linked actualities are also moved to the ActualityMonthly dimension.
Note: A linked actuality increases the size of the cube, because it is a copy and not
a reference.
The ActualityWeekly dimension

The ActualityWeekly dimension is, in the same way as the ActualityMonthly
dimension, a list of actualities without any hierarchical logic. The actuality is
transformed as it is logically used in the relational source. However, only source
actualities defined as weekly are included in this dimension, and they are used in
the weekly cube only.
The PeriodMonthly dimension

Similar to actualitymonthly dimension, periodmonthly is a separate dimension and
is aggregated from months into quarters and then into years. The periodmonthly
dimension's year and quarter levels are not explicitly present in the source. The
period hierarchy is not meant for aggregation; its purpose is to support relative
period logic and to support relative periods in the year following the financial
year, and not the calendar year.
Example of closing period in December

Note that the node All is not explicitly present in the period monthly hierarchy, but
is used in this example to make it easier to understand.
Figure 25. Period monthly aggregation in target, example with December closing period.
32 User Guide
Example of closing period in April
April is used as the closing month in this example.
Figure 26. Period monthly aggregation in target, example with April closing period.
Comments:
v The months that belong to the same year are calculated based on a closing
period.
v The naming convention used most often for broken financial years is the “year
of the closing month”. In the data mart, the year always relates to the financial
year and not to the calendar year.
v The naming convention for the quarter level in the period dimension follows
from the years. For example, the financial year 2009 will have four (financial)
quarters named 2009-Q1 to 2009-Q4. The quarters must be uniquely named, so
you cannot use just Q1 for all years.
One important objective of the period dimension is to support the notion of

relative periods.
Example of relative periods

A typical report will list the profit and loss statement for one company but for
different periods. For example, a table report might have accounts as rows and
different periods as columns. The period columns are all based on one current
period which the report consumer will be prompted for. For example, the columns
could be "current period", "previous period", "last year's closing period" and "last
year's corresponding period". In the Report Generator in IBM Cognos Controller,
the three periods would be expressed as "-1", "-N112" and "-12"; all relative to the
prompted period ([currentperiod]).
In the target, these relative period functions are not supported, but the report
author can instead use the query functions available in Report Studio and other
reporting products.
Table 2. Source expressions and Report Studio query functions
Source expression Report Studio query function (MDX)
-1 lag([currentperiod],1)
-12 lag([currentperiod],12)
+1 lead([currentperiod],1)
+12 lead([currentperiod],12)
P001 firstSibling([currentperiod])
Table 2. Source expressions and Report Studio query functions (continued)
Source expression Report Studio query function (MDX)
P012 lastSibling([currentperiod])
N101 firstChild (lag(parent([currentperiod]),1))
N112 lastChild (lag(parent([currentperiod]),1))
Note: Note that the BI syntax uses navigation in the period hierarchy.
The PeriodWeekly dimension

The PeriodWeekly dimension is similar to PeriodMonthly, however, it is aggregated
from weeks into years. It is used in the weekly cube.
The Currency dimension

The currency dimension is transformed in a straightforward 1:1 fashion, that is, the
target looks the same as the source.
The Transaction currency dimension

The transaction currency dimension is transformed in a straightforward 1:1 fashion,
that is, the target looks the same as the source.
Consolidation perspective
The transformation principle for the consolidation perspective is straightforward.
Reported values and manual journals (ktypkonc is blank) get no consolidation
perspective. Other records, that is, automatic journals get the consolidation
perspective as the consolidation type, for example, LE and CT_LE are an
aggregated node.
Figure 27. The transformation principle for the consolidation perspective, example with LE
and CT_LE aggregated.
Automatic Journals can be booked on companies or on groups, which means that

the consolidation perspective filter affects values on both levels.
Please note that automatic journals may or may not include a company reference,
depending on whether there is cross-ownership involved (a company reference) or
not (no company reference). For more information, see “Contribution versions” on
page 35.
Closing versions
The manual journal types with the closing version aggregation level in the source
are called closing versions in the target, and have a 1:1 transformation rule.
34 User Guide
The closing versions in the target are prefixed with CL. Manual journal types have
the same code as in the source with one exception; the reported value journal type,
which is displayed as REPOBT because ' ' is not a valid name in the target.
Example of closing version

The code for a reported value (blank in the source) is named REPOBT in the target.
This is to avoid blank names and guarantee unique names.
Figure 28. Example of closing version in the target
Contribution versions
The contribution versions in the target are prefixed with CO. Automatic journal
types have the same code as in the source with one exception; the base value
automatic journal type which is displayed as BASEET because ' ' is not a valid
name in the target. You can configure the naming convention in the FAP client.
The transformation of automatic journals introduces complexity due to support for

cross-ownership in IBM Cognos Controller. The challenge is to store values in a
summation node in a cube while accommodating the way in which IBM Cognos
Controller handles cross-owned companies.
For this transformation the concept of elimination company (EC) is used, which is
similar to the Publish to Data Mart function. In Financial Analytics Publisher, the
naming convention is to give the same name for the EC company as for the group.
For example, for the group named Grp1, the elimination company is also called
Grp1. For more information, see “The Company dimension” on page 25. In the
Publish to Data Mart function in IBM Cognos Controller the name would have
been EC_Grp1.
On a high level, all automatic journals 30 (rebooking of subsidiaries change in

equity) and automatic journal 37 (allocations) are by default kept on the company
level in the target. Other automatic journals are moved to the elimination company
in the target. A server preference (ETYPE_EXCLUDE) is available to modify this
default behavior. By using ETYPE_EXCLUDE you state which automatic journal
types should remain on the company in the target, instead of being transferred to
the elimination company. Note that this does not affect eliminations on groups or
cross-owned companies; those journals will always be transferred to the
elimination company.
Note: Any modification of the server preference should be done with caution,
especially if cross-ownership exists in the company structure.
It is followed by these rules:

v When company type = K (that is, the sub-group) and VerificationType = K then
exclude the row completely from the transformation. This is because these
journals are also in a company below (and we do not want them to be stored
twice).
Followed by this set of rules:
1. Transactions (automatic journals) with specific KtypKonc (cross-ownership)
move to the EC company.
For example, in the case of cross-ownership, the ktypkonc would be LEGrp1,
and not LE. In situations without cross-ownership, the ktypkonc would be LE
or OP.
2. Transactions with KtypKonc <> " " on sub-groups (that is, automatic journals
booked directly on sub-groups) move to the EC company belonging to the
group above.
3. Transactions with KtypKonc = " " - stay on the company (BASE values), unless
the server preference says differently.
4. Automatic journal types 30 and 37 stay on the company, unless the server
preference is set and excluding these two.
Server preference addition:
If the server preference is set, automatic journal types in the server preference
stay on the company, all other automatic journal types go to the EC company:
v For example, if you want journal types 30, 35, 37 and 38 to stay at the
company, the server preference should look like this: ETYPE_EXCLUDE=30, 35,
37, 38 (that is, you need to mention 30 and 37 despite the default behaviour
of storing at company level).
Example of contribution version

The following table provides an example of a transaction in the source:
Table 3. Transaction in the source
Comp Automatic Journal kTypCons Period
A 90 LEGrp2 2007-01
This will be transformed into:

Table 4. Transformed company
Comp Automatic Journal origComp period
Grp2 90 A 2007-01
In this example, Grp2 is the elimination company of the target group.
Examples of contribution version - trial balance

This example shows company codes in both the source and the target and how
data is transferred following the different contribution version rules.
Figure 29. Contribution version - trial balance example of source company codes
36 User Guide
Figure 30. Contribution version - trial balance example of data transferred to target
The following example illustrates the IBM Cognos Controller trial balance for
period 0812, actuality AC, and company structure 0812LE, and the transformation
to the target cube for period 0812, actuality AC, and company structure 0812LE.
Figure 31. Trial balance example of transformation from source to target
The Origin company dimension

The origin company dimension (source company) contains all companies in the
source as members in a simple structure.
The Counter company dimension

The counter company dimension (source company) contains all companies in the
source as members in a simple structure.
The Journal number dimension

The journal number dimension is transformed 1:1, that is, the target looks the same
as the source.
The Counter dimension
The counter dimension is a duplicate of the external dimension 1, and uses the
same transformation principle.
The Measurement dimension

In the cube there is a measurement dimension, which corresponds to the two value
columns in the fact table; amount and transamount. In the target this dimension
will have three members, with the option to add more in the future.
The members are as follows:

v YTD - corresponds to the amount column in the XDBxx table. This is a year to
date (YTD) value in the source.
v Transaction YTD - corresponds to the transamount column.
v Monthly - this is a computed period value. For the first period in a year: the
period value = the YTD value. For all other periods: period value (period) =
YTD (period) - (YTD (period-1). This calculation is implemented as a cube rule.
v Weekly - similar to monthly, this is also a computed value.
v Comment - for accounts (not journals).
v Transaction Comment - for IC transactions (likely always empty).
v Comment Count - this is a computed value created as the summary of all
comments on leafs below. If there is a comment or transaction comment on a
leaf, the comment count gets the value of 1.
The Impact of contribution version BASE value in IBM Cognos

Controller, versions 8.x
In IBM Cognos Controller, versions 8.x, the AJT is aggregated to BASE at subgroup
levels, which causes a difference between the source and the target cube. From
IBM Cognos Controller, version 10.1 and later, this is not the case as AJT is not
aggregated to BASE at subgroup levels anymore.) For subgroups, the target will
show aggregated data from all subsidiary companies for the contribution version
BASE. In the source, a report on subgroups will show BASE values for all
subsidiary companies including eliminations that are also summarized in Base.
The following figure shows a simple structure for consolidation type LE in the
source.
Figure 32. Structure for consolidation type LE in the source
In the source, the resulting trial balance report on the highest group level (G1), for
contribution version BASE, will appear as shown in the following table:
38 User Guide
Table 5. The resulting trial balance report on the highest group level (G1)
Consolidated
Co1 Co2 G2 Tot Value
Account 1 10 10 8 28 21
Explanation 10-2 10+10+8 28-3-4
Consolidated Consolidated
BASE value BASE value
on G2 on G1
In the source, the resulting trial balance report on the subgroup level (G2), for
contribution version BASE, will appear as shown in the following table:
Table 6. The resulting trial balance report on the subgroup level (G2)
Co3 Tot Consolidated Value
Account 1 10 10 8
Explanation 10-2
Consolidated BASE
value on G2
In the target cube, for contribution version BASE, it will appear as shown in the
following table:
Table 7. The target cube, for contribution version BASE
G1 Co1 Co2 G2 Co3
Account 1 30 10 10 10 10
Explanation
Aggregated Aggregated
BASE value BASE value
from Co1, from Co3.
Co2 and Co3.
In the source, the trial balance report on the total level (including eliminations, for
example BASE + automatic journal type 1), will appear as:
Table 8. The trial balance report on the total level
Consolidated
Co1 Co2 G2 Tot Value
Account 1 6 7 8 21 21
Explanation 10-4 10-3 10-2 10-4+10-3+8 6+7+8
Consolidated Consolidated
value on G2 value on G1
In the target cube on the total level (including eliminations, for example BASE +
automatic journal type 1), it will appear as:
Table 9. The target cube on the total level
G1 Co1 Co2 G2 Co3
Account 1 21 6 7 8 8
Table 9. The target cube on the total level (continued)
G1 Co1 Co2 G2 Co3
Explanation
Aggregated Aggregated
value from value from
Co1, Co2 and Co3.
Co3
40 User Guide
Appendix A. FAP extension points
TM1 as a platform opens up endless possibilities when it comes to customizing the
default FAP cubes, that is, to incorporate specific customer requirements into the
reporting solution.
One available TM1 mechanism is the TI scripts (Turbo Integrator). For more
information, see the TM1 user documentation.
FAP provides several script place holders, that is, distinct places in the code where
the FAP Service will look for Turbo Integrator scripts on the TM1 server and if
they follow a certain naming convention execute them. Available place holders are:
Table 10. FAP extension points
Extension point Description
ccr_ip_before_[a-zAZ0-9] Before initial publish.
ccr_ip_middle_[ a-zAZ0-9] In the middle of initial publish (after
dimensions/structures, before data).
ccr_ip_after_[a-zAZ0-9] After initial publish.
ccr_pc_before_[a-zAZ0-9] Before publish children. Step 1 for slowly
moving dimensions (move dimensions to
TM1 for data trickle to work).
ccr_pc_after_[a-zAZ0-9] After publish children.
ccr_us_before_[a-zAZ0-9] Before update structures. Step 2 for slowly
moving dimensions (re-generate the TM1
dimensions).
ccr_us_after_[a-zAZ0-9] After update structures.
ccr_dt_before_[a-zAZ0-9] Before data trickle.
ccr_dt_after_[a-zAZ0-9] After data trickle.
Several scripts can be executed at each step. They are then run in alphanumeric
order, for example, A1 runs before A2. Although this document is not intended to
cover possible TI scripts a couple of examples are provided.
This script would add an "All" node to the company hierarchy.

While (j <= Dimsiz(’Company’));
Element = DIMNM(’Company’, j);
If (DTYPE(’Company’, Element) @= ’C’);
# All should not be included into itself.
If (Element @<> ’All’);
# Consolidation types should not be included. They are always
of size 2.
If (Long(Element) <> 2);
# Consolidation type + period should not be included. They
are always of size 2+1+7=10.
If (Long(Element) <> 10);
DimensionElementComponentAdd(’Company’, ’All’, Element,
0);
EndIf;
EndIf;
Else;
allIindex=j;

EndIf;
EndIf;
j = j + 1;
End;
This example describes how an attribute can be added to the Company dimension,
with just the code from Controller.
# Add one extra attribute: ’Company Code’ containing
the controller code,
# except QAR companies, which gets their prefix.
AttrInsert(’Company’, ’Local Currency’, ’Company Code’, ’S’);
i = 1;
While (i <= Dimsiz(’Company’));
Element = DIMNM(’Company’, i);
If (DTYPE(’Company’, Element) @= ’C’);
# Consolidated nodes
CodeLength = Long(Element);
If (CodeLength > 10);
CodeName = SUBST(Element, 12, CodeLength - 10);
AttrPutS(CodeName , ’Company’, Element, ’Company Code’);
# Copy attributes from leaf to consolidated node.
EN_longName = ATTRS(’Company’, CodeName, ’EN_long’);
AttrPutS(EN_longName, ’Company’, Element, ’EN_long’);
EN_shortName = ATTRS(’Company’, CodeName, ’EN_short’);
AttrPutS(EN_shortName, ’Company’, Element, ’EN_short’);
SV_longName = ATTRS(’Company’, CodeName, ’SV_long’);
AttrPutS(SV_longName, ’Company’, Element, ’SV_long’);
SV_shortName = ATTRS(’Company’, CodeName, ’SV_short’);
AttrPutS(SV_shortName, ’Company’, Element, ’SV_short’);
EndIf;
ElseIf (DTYPE(’Company’, Element) @<> ’C’);
AttrPutS(Element, ’Company’, Element, ’Company Code’);
EndIf;
i = i + 1;
End;
42 User Guide
Appendix B. Dimension attributes
This appendix contains additional information about some of the dimensions and
their attributes. An OLAP database does not work in the same way as a relational
database, for example, there is no schema or referential integrity.
However, some FAP dimensions have quite a few TM1 attributes. These attributes
can be useful in various reporting scenarios as well as in TM1 scripts.
Table 11. Dimension attributes
Company Description
<language>_short Short name in group language, <language>
subject to set-up, for example, EN.
<language>_long Long name in group language.
< language>_short Short name in an additional language. Could
be more than one additional (local)
language.
< language>_long Long name in an additional languages.
Structure Version Period for the structure version, for example,
200911. Only on groups (aggregation nodes).
Consolidation Type Consolidation type for the hierarchy, for
example, CT LE. Only on groups
(aggregation nodes).
Company Type Company type as defined for the company
in Controller.
Country Code Country code as defined in IBM Cognos
Controller.
Local Currency Local currency as defined in IBM Cognos
Controller.
Info 1 - Info 20 Info fields as defined in IBM Cognos
Controller (additional company information)
Account Description
<language>_short Short name in group language, <language>
subject to set-up, for example, EN.
<language>_long Long name in group language.
< language>_short Short name in an additional language. Could
be more than one additional (local)
language.
< language>_long Long name in an additional language.
Account Type Account type as defined for the account in
IBM Cognos Controller.

44 User Guide
Notices
This information was developed for products and services offered worldwide.
This material may be available from IBM in other languages. However, you may be
required to own a copy of the product or product version in that language in order
to access it.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service. This document may
describe products, services, or features that are not included in the Program or
license entitlement that you have purchased.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Software Group

Attention: Licensing
3755 Riverside Dr.
Ottawa, ON
K1V 1B7
Canada
Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled

environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
46 User Guide
This Software Offering does not use cookies or other technologies to collect
personally identifiable information.
Trademarks
IBM, the IBM logo and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “ Copyright and
trademark information ” at www.ibm.com/legal/copytrade.shtml.
The following terms are trademarks or registered trademarks of other companies:

v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Notices 47
48 User Guide
Index
A FAP (continued)
dimensions 17
account 25 overview 11
add security 23
data marts 7 FAP data
new source 6 verify 11
FAP database
select 5
C FAP performance and stability 2
CAM security 23 Financial Analytics Publisher
company 26 configure 5
companygroup dimension 29
components 12
concepts 12 I
configure impact
Financial Analytics Publisher 5 contribution version base values 38
consolidation perspective 34 inital publish 13
contribution version base values 38
D L
log information
data view 8
trickling 14
data mart 28
publish 28
database O
purging 16 overview 11
define
service settings 6
dimension naming conventions 18 P
dimension transformation principles 25 permission levels for a FAP user 1
account 25 purging
actualitymonthly 31 database 16
closing version 35
company 26
contribution version 35
counter company 37 S
counter dimension 38 select
currency 34 FAP database 5
extended dimensions 1-4 29 service settings
journal number 38 define 6
linked actualities 32 source definition 2
measures 38 structure updates 14
origin company 37
period 32
slowly moving dimensions 30 T
transaction currency 34 time dependent dimension 26
transformation of data 11
dimension transformation principles 25
E reporting format 11
extended dimensions 1-4 29 transformation rules 18
trial balance comparison 28
trickle 6
F trickling 14
fact
trickling 14
FAP U
components 12 user groups 1
concepts 12
cubes 17

V view
log information 8
verify
FAP data 11
50 User Guide

User Guide: IBM Cognos Controller Financial Analytics Publisher

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

User Guide: IBM Cognos Controller Financial Analytics Publisher

Загружено:

Авторское право:

Доступные форматы

IBM Cognos Controller

Financial Analytics Publisher

Chapter 1. What's new? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2. Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

© Copyright IBM Corp. 2004, 2015 iii

Appendix B. Dimension attributes . . . . . . . . . . . . . . . . . . . . . . . . 43

To find product documentation on the web, including all translated

This documentation describes the current functionality of the product. References

© Copyright IBM Corp. 2004, 2015 v

For changes to previous versions, see:

Note: To review an up-to-date list of environments supported by IBM Cognos

New features in IBM Cognos Controller Financial Analytics Publisher

FAP user groups

If an Initial Publish was performed in a previous Cognos ControllerCognos

The IBM Cognos ControllerIBM Cognos Controller on Cloud User

Note: If a user is assigned only to the IBM Cognos ControllerIBM Cognos

© Copyright IBM Corp. 2004, 2015 1

IBM Cognos TM1 User group members can use TM1.

The User Group Administrator group

One source definition for each Controller database

Greater FAP performance and stability

New log files

For more information, see “Defining sources” on page 6.

Enhanced naming convention for dimensions

For more information, see “Adding a data mart” on page 7.

Chapter 1. What's new? 3

Selecting a database type

Defining service settings

© Copyright IBM Corp. 2004, 2015 5

Trickling fact data from the source

Before you begin

Adding a data mart

Before you begin

Chapter 2. Getting started 7

Viewing log information

This allows you to keep track of every task that is performed.

Chapter 2. Getting started 9

Users want access to consolidated data to perform analytic-style reporting and

Figure 1. FAP overview

FAP combines two different technologies: a relational database technology

© Copyright IBM Corp. 2004, 2015 11

The initial publish process:

The fact trickling process:

As it is possible to store measures on aggregation nodes in IBM Cognos Controller,

The structure updates process consists of two parts:

Workflow for the first part of the structure updates:

Figure 4. Structure update process, structural changes transferred

Workflow for the second part of the structure updates:

Purging the FAP database

Figure 6. Purging the FAP database

Note: Only applicable to installations with weekly actualities.

Dimension naming conventions

Examples of target cubes

The monthly detailed cube:

The monthly detailed cube is the most frequently used cube.

During the consolidation process, when a consolidation is run in IBM Cognos

Figure 8. Tree structure view of the monthly detailed cube

The monthly consolidated cube:

The consolidated cube leverages a variant of the company dimension,

The weekly cube:

Near real time FAP versus published target:

For additional descriptions on how to customize FAP for various reporting

Basic security mode