GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
							<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xml:lang="en-us" lang="en-us">
<head xmlns="">
<!--
Licensed Materials - Property of IBM
IBM Cognos Products: DOCS
© Copyright IBM Corp. 2005, 2014
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<meta name="Copyright" content="© Copyright IBM Corp. 2005, 2014."></meta>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<meta name="copyright" content="© Copyright IBM Corporation 2014" />
<meta name="DC.Rights.Owner" content="© Copyright IBM Corporation 2014" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="Cognos UI and Error String Customization Toolkit" />
<meta name="abstract" content="IBM Cognos User Interface and Error String Customization Toolkit automates the process of customizing the messages and user interface text in IBM Cognos Business Intelligence products." />
<meta name="Description" content="IBM Cognos User Interface and Error String Customization Toolkit automates the process of customizing the messages and user interface text in IBM Cognos Business Intelligence products." />
<meta name="DC.subject" content="branding, names, logos, trademarks, re-branding, directories, flowchart" />
<meta name="keywords" content="branding, names, logos, trademarks, re-branding, directories, flowchart" />
<meta name="DC.Date" scheme="iso8601" content="2014-08-19" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="LocalizationKit" />
<meta name="DC.Language" content="en-us" />
<meta name="IBM.Country" content="ZZ" />
<!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./common/ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./common/idsvhlp.css" />
<title>Cognos UI and Error String Customization Toolkit</title>
<script language="javascript"><!--
  function openTopic( openTopicLoc, tour ) { var helpWin = ''; var tempHelpWindowName = ''; var helpWindowName = ''; var winWidth = 680; var winHeight = 500; var charPos = openTopicLoc.indexOf("?", 0); if(tour == "tour") { winWidth = 800; winHeight = 600; } if( charPos > 0 ) tempHelpWindowName = openTopicLoc.substring(0, charPos ) || ''; else tempHelpWindowName = openTopicLoc || ''; if( tempHelpWindowName ) { helpWindowName = tempHelpWindowName.replace(/#/ig, "_"); helpWindowName = helpWindowName.replace(/\./g, "_"); helpWindowName = helpWindowName.replace(/\//g, "_"); } if( helpWindowName ) { helpWin=window.open( openTopicLoc, helpWindowName, "toolbar=no,location=no,directories=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width="+winWidth+",height="+winHeight, true); helpWin.focus(); } }
  function doNav() {parent.header.previousNavPage = "ug_ldk_t_id_uninstallingcognosldk.html#t_id_uninstallingcognosldk";parent.header.nextNavPage = "ug_ldk_c_configurelocalizationkit.html#c_configurelocalizationkit"; parent.header.updateNav(); 
    if(parent.tabcontent) {document.getElementById("collapsableVbar").className="bux-collapsableContentPane-resize-vbar-right-invisible-false"; document.getElementById("collapsableVbarButton").className="bux-collapsableContentPane-border-openClose-button-left"; document.getElementById("collapsableVbarButton").title="Hide the navigation pane"; } 
    else {document.getElementById("collapsableVbar").className="bux-collapsableContentPane-resize-vbar-left-invisible-false"; document.getElementById("collapsableVbarButton").className="bux-collapsableContentPane-border-openClose-button-right"; document.getElementById("collapsableVbarButton").title="Show the navigation pane"; }  }
  function dC() { if(parent.tabcontent){ parent.tab.fHlp('ug_ldk.html'); } else {parent.tab.fHlp('ug_ldk_a.html'); }	} 
--></script><!--[if IE 6]><style type="text/css">.contentDIV {width:100%;overflow:auto;} .bux-collapsableContentPane-resize-vbar-left-invisible-false {visibility:visible;position:absolute;} .bux-collapsableContentPane-resize-vbar-right-invisible-false {visibility:visible;position:absolute;}</style><![endif]-->
<!--[if gte IE 7]><style type="text/css">.contentDIV {overflow:visible;}</style><![endif]-->
</head>
<body onLoad="doNav();highlight();jumpHL();">
<!--ZOOMSTOP-->
<noscript>To use IBM Cognos product documentation, you must enable JavaScript in your browser.</noscript>
<noscript>Internet Explorer Users: If the Information Bar displays a message informing you that active content has been restricted, click the Information Bar for an option to allow blocked content for the current help session. For more information on changing security settings, search Internet Explorer help for <q>active content advanced options</q>. All other browsers: Please make sure JavaScript is enabled.</noscript>
<!--ZOOMRESTART-->
<div class="bux-collapsableContentPane-resize-vbar-right-invisible-false" id="collapsableVbar" role="region" aria-label="navigation bar container"><div tabindex="0" class="bux-collapsableContentPane-border-openClose-button-left" id="collapsableVbarButton" role="region" aria-label="collapse and expand navigation bar"><a href="JavaScript:dC();"><img style="text-decoration: none" src="common/spacer.gif" height="1px" width="1px" border="0" alt="Open and Close navigation pane" /></a></div></div><div class="contentDIV" role="main">
<a name="c_localizationkit"></a><a name="localizationkit"></a><h1 class="title topictitle1"> Cognos UI
and Error String Customization Toolkit </h1>
<div class="body conbody"><div class="abstract">  <span class="shortdesc">IBM® Cognos® User Interface and Error
String Customization Toolkit automates the process of customizing
the messages and user interface text in IBM Cognos Business Intelligence
products. </span>
 </div>
<p class="p">You can use it when you translate the text strings into another
language or when you modify the existing language version of the text. </p>
<div class="note note"><span class="notetitle">Note:</span> Not all Cognos Business
Intelligence products can be localized using the Cognos User Interface and Error String Customization
Toolkit. In particular, you cannot customize the IBM Cognos Cube
Designer or the IBM Cognos Dynamic Query Analyzer.</div>
<p class="p">You cannot use Cognos UI
and Error String Customization Toolkit to change the branding of a
product, such as names, logos, tag lines, or trademarks. Please refer
to the product documentation to find out how to deal with branding.</p>
<p class="p">The text strings that you customize are located in the XML resource
files (<a class="xref" href="ug_ldk_c_inputresourcefiles.html#InputResourceFiles" title="Input resource files are XML files that contain message strings, such as error messages and warnings, as well as menu text and user interface text.">Input Resource Files</a>)
in the <span class="ph filepath"><var class="keyword varname"> installation_location</var>/msgsdk</span> directory.
The structure of the resource files is defined by the schema file
named CCLMessageFile.xsd, located in the same directory. For more
information about the names of files to customize and their descriptions,
see <a class="xref" href="ug_ldk_c_filestolocalizeincognosreportnet.html#FilestoLocalizeinCognosReportNet" title="The following is a list of files in IBM Cognos Business Intelligence that you must customize and their descriptions. These files are located in installation_location/msgsdk. You may only have a subset of the following files depending on which Cognos Business Intelligence components you have installed.">Files to Customize in Cognos Business Intelligence</a>.</p>
<p class="p">The customization process may have to be performed for each release
of the product (<a class="xref" href="ug_ldk_t_localizingsubsequentversionsofaproduct.html#LocalizingSubsequentVersionsofaProduct" title="If a new version or a patch for a IBM Cognos product contains changes to the messages or user interface text, you must customize the resource files again. IBM Cognos User Interface and Error String Customization Toolkit simplifies this task.">Customizing Subsequent Versions of a Product</a>). Cognos UI and Error String Customization
Toolkit keeps track of changes made to the text strings in different
releases of the product and identifies the strings that are new or
changed. For the next release, you can easily find and customize only
those strings. This helps to reduce your customization costs.</p>
<p class="p"> Cognos UI and Error String
Customization Toolkit uses a set of directories to manage the customization
process over several iterations. You specify names and locations for
these directories when you configure Cognos UI
and Error String Customization Toolkit. </p>
<p class="p">The following flowchart illustrates the customization process and
shows the directories involved.</p>
<div class="fig fignone"><img class="image" src="images/ug_ldk_ug_crn_lockt_schematic.jpg" alt="Illustrates the flow between the product location and toolkit directories." /><ol class="ol"><li class="li">A user copies all input resource files for the product from the <span class="ph filepath"><var class="keyword varname">installation_location</var>/msgsdk</span> directory
and its subdirectories to the source directory.</li>
<li class="li"> Cognos UI and Error
String Customization Toolkit copies the input resource files from
the source directory to the reference and synchronization directories.
All the directories are synchronized. The source and target locale
codes are inserted in the file names, and the text for customization
is identified.</li>
<li class="li">A user customizes the text strings in the synchronization directory.</li>
<li class="li"> Cognos UI and Error
String Customization Toolkit validates the files in the synchronization
directory.</li>
<li class="li"> Cognos UI and Error
String Customization Toolkit generates the final output in the target
directory.</li>
<li class="li">A user copies the generated output to a computer where the product
is installed.</li>
</ol>
</div>
<div class="section"><h2 class="title sectiontitle">Source Directory</h2>  <p class="p">This directory contains
the original input resource files that were copied from the msgsdk
directory. The source language, which is either English, French, German,
or Japanese, is specified in the name of the files. You must copy
all input resource files for the product from the <span class="ph filepath"><var class="keyword varname">installation_location</var>/msgsdk</span> directory
and its subdirectories to the source directory.</p>
 <p class="p">You create
the source directory manually. </p>
 </div>
<div class="section"><h2 class="title sectiontitle">Reference Directory </h2>  <p class="p">This directory contains
copies of the latest input resource files. They will be used during
the next customization project to determine which messages were added
or updated. The target language is specified in the name of the files.</p>
 <p class="p">This
directory is created automatically.</p>
 </div>
<div class="section"><h2 class="title sectiontitle">Synchronization Directory </h2>  <p class="p">This directory
contains the resource files that you use to customize the text. The
target language is specified in the name of the files. Initially,
these files are copies of the original input resource files. In subsequent
versions of the product, new messages are added, obsolete messages
are deleted, and updated messages are flagged for your attention.</p>
 <p class="p">This
directory is created automatically.</p>
 </div>
<div class="section"><h2 class="title sectiontitle">Target Directory </h2>  <p class="p">This directory contains
the generated output in a format required by the product. You can
later copy the output files to your product environment.</p>
 <p class="p">This
directory is created automatically.</p>
 </div>
</div>
<div class="related-links"></div>
<style type="text/css">.highlight { background: #DEEEFF; }</style><script src="common/highlight.js"></script><script><!-- highlight(); //--></script>
</div>
</body>
</html>