GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
							<?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="Configure Cognos UI and Error String Customization Toolkit" />
<meta name="abstract" content="You must configure IBM Cognos User Interface and Error String Customization Toolkit before you start using it." />
<meta name="Description" content="You must configure IBM Cognos User Interface and Error String Customization Toolkit before you start using it." />
<meta name="DC.subject" content="configuring, synchronization directory, source directory, reference directory, target directory, locales, variables, .properties, updating configuration in UNIX, source locale, target locale, package file, log files, VAR information, content locale, product locale, supported locales" />
<meta name="keywords" content="configuring, synchronization directory, source directory, reference directory, target directory, locales, variables, .properties, updating configuration in UNIX, source locale, target locale, package file, log files, VAR information, content locale, product locale, supported locales" />
<meta name="DC.Relation" scheme="URI" content="ug_ldk_t_id_configurelocalizationkit_148stepsforunixorlinux.html#id_ConfigureLocalizationKit_148StepsforUNIXorLinux" />
<meta name="DC.Relation" scheme="URI" content="ug_ldk_t_id_configurelocalizationkit_168stepsforwindows.html#id_ConfigureLocalizationKit_168StepsforWindows" />
<meta name="DC.Date" scheme="iso8601" content="2014-08-19" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="ConfigureLocalizationKit" />
<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>Configure 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_c_localizationkit.html#c_localizationkit";parent.header.nextNavPage = "ug_ldk_t_id_configurelocalizationkit_148stepsforunixorlinux.html#t_id_configurelocalizationkit_148stepsforunixorlinux"; 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_configurelocalizationkit"></a><a name="configurelocalizationkit"></a><h1 class="title topictitle1">Configure Cognos UI
and Error String Customization Toolkit</h1>
<div class="body conbody"><div class="abstract">  <span class="shortdesc">You must configure IBM® Cognos® User Interface and Error
String Customization Toolkit before you start using it. </span>
 </div>
<p class="p">Configuration involves specifying directories where the XML resource
files can be obtained, processed, and placed after they are customized.
It also involves specifying locale codes that define the source and
target languages.</p>
<p class="p">When you specify locale variables, such as Source_Locale and Target_Locale_List,
ensure that the locale string always contains a valid ISO language
code. It can also contain an optional ISO country code. The ISO language
code is a lowercase, two-letter code defined by ISO-639. The ISO country
code is a lowercase, two-letter code defined by ISO-3166. For example,
ja (Japanese), it (Italian), ru (Russian), zh-cn (Simplified Chinese
- China), and zh-tw (Traditional Chinese - Taiwan).</p>
<p class="p">You specify the configuration variables in the LocalizationConfig.properties
file located in the product installation directory named <span class="ph filepath"><var class="keyword varname">installation_location</var>\bin</span>. </p>
<p class="p">You can customize either product locale files, content locale files,
or both, by using the Localization_Filter variable.  IBM Cognos Business
Intelligence uses the product locale files to provide Web-based user
interfaces, such as Event Studio, Report Studio, Analysis Studio,
and Query Studio. Product locale files are already translated for
all the product locales supported.  You can translate the product
locale files for a data locale supported but not translated by the IBM Cognos software,
to allow users to use the studios in their locale.</p>
<p class="p"> Cognos BI uses the content
locale to display data in reports and to provide the user interfaces
associated with report consumption, such as IBM Cognos Connection
and Report Viewer. Translated content locale files for most of the
data locales supported are provided. You can translate the content
locale files for a data locale that is supported but not translated
by the IBM Cognos software, to allow users to view and
run reports in their locale.</p>
<p class="p">We recommend that you use the locales supported by your IBM Cognos product.
Although you can use other locales, we cannot guarantee that the product
will work properly with those locales. </p>
<p class="p">To review an up-to-date list of data locales supported by IBM Cognos products
and a list of product and content translations, visit the <a class="xref" href="http://www.ibm.com/software/data/cognos/customercenter" target="_blank" title="(Opens in a new tab or window)">IBM Cognos Customer Center</a> (http://www.ibm.com/software/data/cognos/customercenter).</p>
<p class="p">You enter values for the following variables. You must use a forward
slash / when entering a directory location. </p>
<dl class="dl"><dt class="dt dlterm">Source_Directory</dt>
<dd class="dd">Location of the directory in your workspace that will contain
copies of the original resource files, such as <span class="ph filepath">C:/Translation/Src</span>.</dd>
<dt class="dt dlterm">Source_Locale</dt>
<dd class="dd">Language code of the original resource files from which the text
is customized.</dd>
<dt class="dt dlterm">Synchronization_Directory</dt>
<dd class="dd">Location of the directory in your workspace that will contain
the resource files that you customize, such as <span class="ph filepath">C:/Translation/Sync</span>.</dd>
<dt class="dt dlterm">Reference_Directory</dt>
<dd class="dd"><p class="p">Location of the directory in your workspace that will contain
unchanged copies of the original resource files used in a given customization
project. In a subsequent customization project, these files are used
to determine which text was added, deleted, or updated.</p>
<p class="p">You
can create this directory as a subdirectory of the synchronization
directory, such as <span class="ph filepath">C:/Translation/Sync/Ref</span>.</p>
</dd>
<dt class="dt dlterm">Target_Directory</dt>
<dd class="dd">Location of the directory in your workspace that will contain
the target resource files, such as <span class="ph filepath">C:/Translation/Target</span>.</dd>
<dt class="dt dlterm">Target_Locale_List</dt>
<dd class="dd">One or more language codes, separated by a comma, into which the
text will be translated, such as ru or pl.</dd>
<dt class="dt dlterm">ackage_File</dt>
<dd class="dd">Name and location of the compressed file (.zip) that will contain
the packaged target resource files, such as <span class="ph filepath">C:/Translation/LocalizationOut.zip</span>.</dd>
<dt class="dt dlterm">Log_File</dt>
<dd class="dd"><p class="p">Name and location of the log file that will contain processing
information, such as <span class="ph filepath">C:/Translation/Localization.log</span>.</p>
 <p class="p">Default:
No log file</p>
</dd>
<dt class="dt dlterm">Component_Name_List </dt>
<dd class="dd"><p class="p">Names of the product components, separated by a comma, that
represent the component element in the input resource files for which
the messages are customized.</p>
 <p class="p">Default: All</p>
</dd>
<dt class="dt dlterm">VAR_Information</dt>
<dd class="dd">Text that VARs can embed in the customized files, such as <var class="keyword varname">Generated
by company X</var>. The default text is <var class="keyword varname">Generated by
the IBM Cognos software</var>.</dd>
<dt class="dt dlterm">Localization_Filter</dt>
<dd class="dd"><p class="p">Specifies whether to process files tagged for product locale,
content locale, or both.</p>
 <p class="p">Possible values are:</p>
 <ul class="ul"><li class="li">Product Locale<p class="p">This is the Default. Only files tagged with the
customization attribute <span class="ph uicontrol">Product Locale</span> or without
a customization attribute will be processed.</p>
 </li>
<li class="li">Content Locale<p class="p">Only files tagged with the customization attribute <span class="ph uicontrol">Content
Locale</span> will be processed. </p>
 </li>
<li class="li">none<p class="p">All message files regardless of the customization attribute
will be processed.</p>
 </li>
</ul>
</dd>
<dt class="dt dlterm">Allow_Untranslated_Strings</dt>
<dd class="dd"><p class="p">Allows you to generate the target resource files while there
are still some strings that are not translated. The translate attributes,
which identify the strings to translate, remain in the file so that
you can translate them later. This is useful for testing purposes.</p>
 <p class="p">Possible
values are Yes or No. The default value is No.</p>
</dd>
</dl>
<p class="p">You must have write permissions for the following directories and
files:</p>
<ul class="ul"><li class="li"><span class="ph filepath"><var class="keyword varname">Synchronization_Directory</var></span></li>
<li class="li"><span class="ph filepath"><var class="keyword varname">Reference_Directory</var></span></li>
<li class="li"><span class="ph filepath"><var class="keyword varname">Target_Directory</var></span></li>
<li class="li"><span class="ph filepath"><var class="keyword varname">Package_File</var></span></li>
<li class="li"><span class="ph filepath"><var class="keyword varname">Log_File</var></span></li>
</ul>
<p class="p">On a UNIX computer, ensure
that you have an environment variable named JAVA_HOME that points
to the location of your Java<sup class="ph sup">TM</sup> Runtime Environment. An
example of the installation location of a Java Runtime Environment
is <em class="ph i">java_directory/java/java_version/</em>jre.</p>
</div>
<div class="related-links">
<ul class="ullinks">
<li class="link ulchildlink"><span class="ulchildlinktext"><a href="ug_ldk_t_id_configurelocalizationkit_148stepsforunixorlinux.html#id_ConfigureLocalizationKit_148StepsforUNIXorLinux">Configuring the localization configuration properties file for UNIX or Linux operating systems</a></span><br />
Follow this procedure to configure the IBM Cognos User
Interface and Error String Customization Toolkit for UNIX or Linux operating
systems.</li>
<li class="link ulchildlink"><span class="ulchildlinktext"><a href="ug_ldk_t_id_configurelocalizationkit_168stepsforwindows.html#id_ConfigureLocalizationKit_168StepsforWindows">Configuring the localization configuration properties file for Windows operating systems</a></span><br />
Follow this procedure to configure the IBM Cognos User
Interface and Error String Customization Toolkit for Windows operating systems.</li>
</ul>
</div>
<style type="text/css">.highlight { background: #DEEEFF; }</style><script src="common/highlight.js"></script><script><!-- highlight(); //--></script>
</div>
</body>
</html>