...

IBM Cognos 8 Framework Manager - How to Successfully

by user

on
Category: Documents
2

views

Report

Comments

Transcript

IBM Cognos 8 Framework Manager - How to Successfully
Guideline
IBM Cognos 8 Framework
Manager - How to Successfully
work with Projects and an
External Repository
Product(s): IBM Cognos 8 BI - Framework Manager
Area of Interest: Modeling
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
2
Copyright
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC
is an IBM Company. While every attempt has been made to ensure that the
information in this document is accurate and complete, some typographical
errors or technical inaccuracies may exist. Cognos does not accept
responsibility for any kind of loss resulting from the use of information
contained in this document. This document shows the publication date. The
information contained in this document is subject to change without notice.
Any improvements or changes to the information contained in this document
will be documented in subsequent editions. This document contains
proprietary information of Cognos. All rights are reserved. No part of this
document may be copied, photocopied, reproduced, stored in a retrieval
system, transmitted in any form or by any means, or translated into another
language without the prior written consent of Cognos. Cognos and the
Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated)
in the United States and/or other countries. IBM and the IBM logo are
trademarks of International Business Machines Corporation in the United
States, or other countries, or both. All other names are trademarks or
registered trademarks of their respective companies. Information about
Cognos products can be found at www.cognos.com
This document is maintained by the Best Practices, Product and Technology
team. You can send comments, suggestions, and additions to
[email protected] .
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
3
Contents
1
INTRODUCTION ............................................................................................ 4
2
PROVEN PRACTICES FOR USING THE BUILT-IN REPOSITORY FEATURE
WITH SEGMENTED PROJECTS ...................................................................... 5
3
PROVEN PRACTICES FOR SEGMENTING AND LINKING PROJECTS.............. 8
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
4
1
Introduction
This document explains how to use Framework Manager with an external
source control system (eg. Perforce), without using the repository features
provided by Framework Manager. This is necessary if your repository system
is not supported by Framework Manager.
Framework Manager projects consist of three essential files, plus a log file
directory. These files are:
• [project name].cpf – Required. This project file tracks segments and
links.
• model.xml – Required. This is the model data.
• customdata.xml – Required. This saves user interface information such
as diagram layout.
• preferences.xml – Optional.
• repository.xml – This file must not be present if you are handling your
own repository. If this file is in your project, you must delete it.
Log files are found in the “logs” subdirectory. A new log file is created each
for each Framework Manager session. These logs are required only if you
intend to use the Model Synchronization feature. External repository handling
is simpler if you ignore the log files.
After your Framework Manager project is created, make sure it is closed, then
check in the project file, model.xml and customdata.xml into your repository.
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
5
Before opening the Framework Manager project, check those three files out
from your repository. If you fail to do so (and your repository system marks
checked in files as read-only), Framework Manager will open in read-only
mode. The text “[Read Only]” will appear on the application title. If this
happens, close the project, and check out the files. If you have done a lot of
work in a read-only project, then you may save the project, and you must
then ensure those files get checked in properly.
When your Framework Manager session is complete, close the project, then
check in the three files.
If you require the Model Synchronization feature, you must check in any new
log files that are created. When you are ready to synchronize, you will need
to get a copy of all the log files. It is not necessary to check them out, as
they are never updated after they are first created.
For segmented projects, the segments are simply project directories stored
under the parent project directory. There are two ways to work with a
segmented project. The segments can be individually opened as stand-alone
projects, in which case repository handling is the same as for any other
project. Or segments can be opened as part of the main project. In this
case you have to check out the projects for each segment you are going to
modify, which are located a sub-directories under the main project. The
repository should maintain the same hierarchy as the project directory.
2
Proven Practices for using the Built-in Repository
feature with Segmented Projects
There are two basic rules:
1. Add the project to a repository before creating segments in it.
2. Do not use the Revision History dialog to synchronize previous
versions. It may not work properly for segmented projects.
A repository for a segmented project should be created in the following order:
• Use the”New Project” dialog to create a new project and add it to the
repository.
• Set up the desired folder structure.
• Add the project to the repository now, if this has not already been
done.
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
6
•
Use the “Create Segment” dialog to create segments on the desired
namespaces and folders. If the segments are to be nested, always
start from the lowest level. Check the “Add to Repository” checkbox,
and do not change the default “Connection” and “Location in
Repository” text strings.
If you want to add a project that is already segmented to a repository, you
must do the following:
1. Select the root project, invoke the “Add Project to Repository” dialog to
add it to the repository.
2. Browse to the repository you just created in your repository client
application. You will see all the segments have been checked in. Remove
all these segments from the repository. Do not remove the “logs”
directory from the main project.
3. Using Windows Explorer, browse to the project, then to each segment
folder. From the View menu, select Choose Details… and check the
Attributes box. Observe the project files in each segment folder are readonly (The Attribute is “RA”). Select these files, right-click on them and
select Properties. Uncheck the Read-only checkbox, and press OK. The
attributes should no longer have an “R”. Do this for each segment.
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
7
4. In Framework Manager, select each segment and from the Repository
menu invoke the “Add Project to Repository” dialog.
Make sure the “Location in repository” value is the root project. If it is not, then
press the browse button to the right, and select the root project.
Segments that are created as part of a master project can be opened directly as a
standalone project. Repository information is maintained correctly when this is done.
IBM Cognos Proprietary Information
IBM Cognos 8 Framework Manager - How to Successfully work with
Projects and an External Repository
8
3
Proven Practices for Segmenting and Linking Projects
Again, there are two basic rules:
1. Segments should always be created in a sub-directory below the main
project. Always accept the default project name and path on the Create
Segment dialog. Linked projects should never be in a sub-directory below
the main project.
2. The order of segmented and linked folders and namespaces in a project
must never change if that project is linked from another project.
This second rule imposes a significant limitation on how you can work with
linked projects. This is further complicated by the fact that when you convert
a folder or namespace into a segment, its position changes. If a project is
going to be linked by another project, you must ensure that you set up its
segments before you link to it.
IBM Cognos Proprietary Information
Fly UP