Tip or Technique

External Repository Control

Product(s): IBM Cognos 8 Framework Manager Area of Interest: Modeling

External Repository Control

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 cscogpp@ca.ibm.com .

IBM Cognos Proprietary Information

External Repository Control

Contents
1 2 3 4 5 INTRODUCTION ............................................................................................ 4 FRAMEWORK MANAGER PROJECT FILES AND AN EXTERNAL REPOSITORY 4 STEPS ............................................................................................................ 5 MODEL SYNCHRONIZATION ......................................................................... 5 SEGMENTED PROJECTS................................................................................. 5

IBM Cognos Proprietary Information

External Repository Control

1 Introduction
This document explains how to use Framework Manager with an external source control system (e.g. Perforce), without using the repository features provided by Framework Manager. This is necessary if your repository system is not supported by Framework Manager.

2 Framework Manager Project Files and an External Repository

Framework Manager Projects consist of three essential files, plus a log file directory. These files are: File Name [Project name].cpf model.xml customdata.xml preferences.xml repository.xml Optional/Required Description Required This project file tracks segments and links. Required This is the model data. Required This saves user interface information such as diagram layout. Optional This file is not used. 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.

IBM Cognos Proprietary Information

External Repository Control

3 Steps
1. After your Framework Manager project is created, make sure it is closed, and then, Check In the project file.cpf, model.xml, and customdata.xml into your repository of choice. 2. Before opening the Framework Manager project to begin modeling again, you will be required to Check Out those three files out from your repository. NOTE: 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. SOLUTION: 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. 3. When your Framework Manager session is complete, close the project, and then Check In these three files to your repository.

4 Model Synchronization
If you do 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 project log files. NOTE: It is not necessary to Check Out the log files, as they are never updated after they are first created.

5 Segmented Projects
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. 1. The segments can be individually opened as stand-alone projects, in which case repository handling is the same as for any other project. 2. 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 intend to modify, which are located, as sub-directories under the main project. NOTE: The repository should maintain the same hierarchy as the project directory.

IBM Cognos Proprietary Information

External Repository Control

IBM Cognos Proprietary Information