5. DITA 1.4 Upgrade for Windows
Foreword
Use this document to upgrade your Contenta DITA Windows workstations,
server, web system, and your database to Contenta DITA v1.4 as noted below.
Before you install the Contenta DITA Web software on your Contenta systems
verify that the system is installed and operational at Contenta version 3.2C.3
and Contenta DITA 1.3 with Hot Fix 1. To check the installed version, look in
the system’s registry under:
My Computer > HKEY_LOCAL_MACHINE > SOFTWARE >
XyEnterprise > Content@ > Products
Under the products folder is a key (Name), Product_Hotfix, such as
Content@Client_Hotfix or Content@Server_Hotfix, with the version number.
System/Type Description Refer to
Contenta Client Contenta Explorer Client
(workstation) 3.2C.3 with
Contenta DITA 1.3
Typical or Custom install
Chapter 2, ʺContenta Explorer
Upgradeʺ
Contenta Server Contenta Server 3.2C.3 with
Contenta DITA 1.3
Chapter 1, ʺContenta Server
Upgradeʺ
Contenta Web Contenta Web Chapter 3, ʺContenta Web Upgradeʺ
Database Oracle database; Contenta
database/user
Chapter 4, ʺDatabase Upgradeʺ
6. 1-2 DITA 1.4 Upgrade for Windows
For example:
Note:You must install Hot Fix 1 for Contenta DITA 1.4 before installing Contenta
DITA 1.4. If you have not installed Hot Fix 1, do so before continuing with this
installation. If you did not receive the Hot Fix 1 software CD, contact your Customer
Support representative to request one.
To interpret the version numbering in the registry note:
The Contenta DITA 1.4 upgrade/installation software program automatically detects
the type of Contenta system on which you are installing and installs the appropriate
Contenta DITA files. For example, if you place the Contenta DITA 1.4 installation CD
on a Contenta client system that has the Contenta client administration software
installed, the installation program detects that the system is a Contenta client with
administration software and begins an installation of the Contenta DITA files needed
for this type of system.
If the system does not have the required version of software, or if no Contenta software
is found on the system, the installation program exits with a message that the installer
cannot continue with the configuration it detected is installed.
If Contenta is not installed or not at the required 3.2C.3 version with Hot Fix 1, refer to
the appropriate Contenta installation or upgrade document to meet the prerequisites
before continuing. If you do not have the documentation or the installation software
that is required, contact your XyEnterprise Customer Support representative to request
the software and documentation.
3.2.3.3.0.1
3.2C.3.
Patch Set 0
Hot Fix 1
8. 1-2 Contenta DITA 1.4 Upgrade for Windows
Procedure
1. Login to the Contenta server as the Administrator user.
2. Place the Contenta DITA 1.4 installation CD in the CD drive of your Contenta
server.
The installer automatically executes and displays an InstallAnywhere is
preparing to install... window. Then the installer displays information about
the Contenta Product Configuration (software) that was detected on the system.
For example:
3. Click the Continue button to continue the installation.
The installer displays the Introduction window.
4. Click the Next button to continue.
The installer displays the License Agreement window.
5. Click in the I accept the terms of the License Agreement radio button.
The Next button is activated.
6. Click the Next button to continue the installation.
The installer displays the pre‐installation summary screen.
7. Verify that the information in the pre‐installation screen is accurate.
If the information is not accurate, click the Previous button until you find the screen
where you can correct the inaccuracy.
9. Contenta DITA 1.4 Upgrade for Windows 1-3
8. After verifying that the information is accurate, click the Install button.
The installation program begins and displays an Installing Contenta DITA
screen.
When complete, the installer displays an Install Complete window.
Information about the location of the log file is reported.
9. Click the Done button to exit the installer.
IMPORTANT NOTE: Clicking the Done button creates the log file. If you
click the X in the upper right of the window to exit, the log file is not created.
10. Check the log file to determine what errors occurred and if necessary, correct
them.
Note:The log file is only accessible after you click the Done button in the Install
Complete window. If you do not see the log file in the logs directory, make certain that
the Install Complete window is not open; if it is still open, click the Done button to
exit the installer and create the log file. If you clicked the X in the upper right of the
Install Complete window to exit the installer, there is no log file.
11. To complete the upgrade, refer to:
• Chapter 2, ”Contenta Explorer Upgrade” to upgrade the Contenta client/
workstations.
• Chapter 3, ”Contenta Web Upgrade” to upgrade your Contenta Web
Server.
• Chapter 4, ”Database Upgrade” to upgrade your Contenta DITA
database.
12. 2-2 Contenta DITA 1.4 Upgrade for Windows
Procedure
1. Login to the workstation as the Administrator user.
2. Place the Contenta DITA1.4 installation CD in the CD drive of your Contenta
client (workstation). This is the system where you have previously installed the
Contenta 3.2C.3 client software using the typical or custom option.
The installer automatically executes and displays an InstallAnywhere is preparing
to install... window. Then the installer displays information about the Contenta
Product Configuration (software) that was detected on the system.
For example:
The following example is of a system that has Contenta Client with Administration
software and three editor applications, Epic, FrameMaker and XMetaL, installed. The
installer program upgrades the DITA software that it detects is already installed on the
system.
3. Click the Continue button to continue.
The installer displays the Introduction window.
4. Click the Next button to continue.
The installer displays the License Agreement window.
5. Click in the I accept the terms of the License Agreement radio button.
The Next button is activated.
13. Contenta DITA 1.4 Upgrade for Windows 2-3
6. Click the Next button to continue.
The installer displays the Web Server/Port Number window.
7. Enter the Web Server Name and the Port Number— refer to the table on page 2‐1
for this information.
Note:If you do not enter a Port Number, the default is 80.
For this release, leave the Web Server Port Number field blank. Do not enter
any data in this field—issue 37945.
8. Click the Next button to continue.
The installer displays the pre‐installation summary screen. The screen contains
information about the software the installer identified for upgrading.
9. Verify that the information in the pre‐installation screen is accurate.
10. After verifying that the information is accurate, click the Install button.
If the information is not accurate, click the Previous button until you find the screen
where you can correct the inaccuracy.
The installation program begins and displays the Installing Contenta DITA screen.
When complete, the installer displays an Install Complete window. Information
about the location of the log file is reported.
11. Click the Done button to exit the installer.
IMPORTANT NOTE: Clicking the Done button creates the log file. If you click
the X in the upper right of the window to exit, the log file is not created.
14. 2-4 Contenta DITA 1.4 Upgrade for Windows
12. Check the log file to determine what errors occurred and if necessary, correct
them. Refer to ”Configuring for Dynamic Import” on page 2‐5.
Note:The log file is only accessible after you click the Done button in the Install Complete
window. If you do not see the log file in the logs directory, make certain that the Install
Complete window is not open; if it is still open, click the Done button to exit the installer
and create the log file. If you clicked the X in the upper right of the Install Complete
window to exit the installer, there is no log file.
13. To complete the upgrade, refer to Post Upgrade on page 2‐5.
15. Contenta DITA 1.4 Upgrade for Windows 2-5
Post Upgrade
Post Upgrade
Configuring for Dynamic Import
When you install Contenta DITA, a Dynamic Import configuration distribution file
named config.dist is copied to the Contenta_home > encaps > di directory. If the
Contenta DITA installation coincides with a new Contenta installation, the config.dist
file is automatically copied to digui.cfg and used when you execute Dynamic Import the
first time.
If you installed Contenta DITA after installing Contenta and using the Dynamic Import
tool, the next execution of Dynamic Import warns you that a config.dist file was found.
The DITA config.dist file contains:
• a topictree keyword that defines how to import the hierarchy of DITA directories
and files.
• the following keywords for the resolve references feature:
pretreeopts
preprocmodule
postprocmodule
If you have not customized the digui.cfg file, copy the config.dist file to digui.cfg
then define the keywords noted above for your site‐specific requirements.
Do not copy the config.dist file to digui.cfg if you have made additional customizations
to the digui.cfg file, however note that you must add the new arguments to the file to
enable the resolve references feature.
Refer to the Contenta DITA Administration User Guide for information about how to
define the arguments and keywords.
16. Post Upgrade
2-6 Contenta DITA 1.4 Upgrade for Windows
Log File
Note that a log file is created during the upgrade process. Check the log file to ensure
that the upgrade was successful and that no errors were logged. The log file resides
under the Contenta home > logs > install directory and is named dita1.4installdate.log
where date is the date of the installation/upgrade using the format yymmdd.
The log file should contain the following entries:
• products installed summary
• CWDitaPublish.pl backup file
• TranslationImport.pl and TranslationExport.pl backup files
• information about the editor setup; XMetaL and/or FrameMaker and/or Epic
• files that were installed
• files that were removed
Check the Summary for errors that may need attention.
The following example summary reports that there were no (0) fatal errors but that
there were four (4) non‐fatal errors.
To determine what errors occurred, search under the Install Log Detail section for
Status: ERROR.
For example:
Summary
‐‐‐‐‐‐‐
Installation: Successful with errors.
135 Successes
0 Warnings
4 NonFatalErrors
0 FatalErrors
Action Notes:
None
Install File: E:Program
FilesXyEnterpriseContent@binUpgrade_DITAupgrade_dita.pl
Status: ERROR
Additional Notes: ERROR ‐ ZeroGpf: Target file was read only
or did not have write permissions and was not overwritten
17. Contenta DITA 1.4 Upgrade for Windows 2-7
Post Upgrade
Troubleshooting
After upgrading the client if you encounter problems with a feature as noted below,
check the files and/or configuration as described.
Contenta DITA Search, Publish, or Translation
Epic
FrameMaker
???
Search
Open the Contenta_home > encaps > Verity > CWDITASearchTool.pl file
Check that the Webserver/Port Number was updated with values as specified step 7 on
page 2‐3 or as specified in the table on page 2‐1.
Publish
Open the Contenta_home > encaps > DITA > Publish > CWDITASearchTool.pl file
Check that the Webserver/Port Number was updated with values as specified step 7 on
page 2‐3 or as specified in the table on page 2‐1.
Translation
Open the Contenta_home > encaps > DITA > Translation > TranslationImport.pl and the
TranslationExport.pl files
Check that the Webserver/Port Number was updated with values as specified step 7 on
page 2‐3 or as specified in the table on page 2‐1.
???
Open the Epic_install > lib > init.acl file.
Verify that the Epic Plugin Entries, XyEnterprise EpicEdit Client Entries are commented
and following lines were added.
#XyEnterprise EpicEdit Plugin Entries.
if(!defined($ENV[ʺXY_EPIC_EXTENSIONS_OFFʺ]) ||
$ENV[ʺXY_EPIC_EXTENSIONS_OFFʺ]==0){
source C:PROGRA~1XYENTE~1Content@encapsditaeditEpicEditPlugin.cmd
#XyEnterprise EpicEdit Plugin Entries.
???
Open the FrameMaker_install > maker.ini file.
Verify that the FrameMakerPlugin Entries, XyEnterprise FrameMaker Client Entries are
commented and following lines were added.
ʺ;‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ API Clients ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ʺ
;XyEnterprise FrameMaker Plugin Entries.
XyFrameMakerPlugin=Standard,XML Application,<contenta install
dir>SystemXYFrameMakerPlugin.DLL,structured
;XyEnterprise FrameMaker Plugin Entries
18. Post Upgrade
2-8 Contenta DITA 1.4 Upgrade for Windows
Dynamic Import
Refer to ”Configuring for Dynamic Import” on page 2‐5.
???
Make certain that: the digui.cfg file contains:
• the topictree keyword and that you have defined it properly for your DITA data
• the pretreeopts, preprocmodule, and postprocmodule keywords and that you have
defined them properly for your DITA data
• DitaCustomCallbacks in the arguments for the split and import processes
20. 3-2 Contenta DITA 1.4 Upgrade for Windows
Procedure
Note: This installation process stops and restarts the Tomcat service.
1. Login to the Contenta server as the administrator user.
2. Place the Contenta DITA1.4 installation CD in the CD drive of your Contenta
Web Server. This is the system where you have previously installed the
Contenta Web Server 1.4C.3 software.
The installer automatically executes and displays an InstallAnywhere is
preparing to install... window. Then the installer displays information about
the Contenta Product Configuration (software) that was detected on the system.
For example:
3. Click the Continue button to continue the installation.
The installer displays the Introduction window.
4. Click the Next button to continue.
The installer displays the License Agreement window.
5. Click in the I accept the terms of the License Agreement radio button.
The Next button is activated.
6. Click the Next button to continue the installation.
The installer displays the Web Configuration Options screen.
21. Contenta DITA 1.4 Upgrade for Windows 3-3
7. Enter the Tomcat Service Name—refer to the information you recorded in the
table on page 3‐1 for this information.
Note: DOT_HOME is the DITA Open Toolkit home directory path and
Contenta_home is the home or installation directory path of the Contenta software.
8. Click the Next button to continue.
Note:If you specify an invalid Tomcat Service Name in step 7, the installer displays
an error message. Click the OK button in the error dialog box to return to the Web
Configuration Options screen and re‐enter the (correct) Service Name.
Option If selected
Install XML Style Sheet. Select this option if you use the Xy‐delivered style sheet,
default.xsl for Content View.
Do not select this option if you have customized the style
sheet that you use for Content View and do not want it
overwritten.
NOTE, if selected: If this option is selected, the style sheet, default.xsl is copied
to default.xsl.backup and a new default.xsl stylesheet is
installed—that is, the delivered file named rawdata.xsl is
copied to default.xsl.
Configure DITA Open
Toolkit.
Select this option if you have not configured the DITA Open
Toolkit. When selected, the DITA Open Toolkit Options screen
is the next step; refer to the graphic on page 3‐4 and step 9
on page 3‐4.
Do not select if the DITA Open Toolkit has already been
configured. If not selected, the Pre‐Installation Summary
screen is the next step; refer to step .
If this option is selected:
The xy.xml file:
Is copied to:
Contenta_homeencapsDITApublishsamplesxy.xml
<DOT_HOME>xy.xml
The test.ditaval file:
Is copied to:
Contenta_homeencapsDITApublishsamples
test.ditaval
<DOT_HOME>test.ditaval
The catalog.xml file is modified as follows:
This line:
is modified to read:
<system systemId=ʺant.batʺ uri=ʺ../util/runNOANT.batʺ/>
<system systemId=ʺant.batʺ uri=ʺ../util/runANT.batʺ/>
And this line:
is modified to read:
<system systemId=ʺxy.xmlʺ uri=ʺ../samples/xy.xmlʺ/>
<system systemId=ʺxy.xmlʺ uri=ʺfile:///<DOT_HOME>/
xy.xmlʺ/>
22. 3-4 Contenta DITA 1.4 Upgrade for Windows
• If the Configure DITA Open Toolkit option was selected in step 7, the installer
displays the DITA Open Toolkit Options screen. Continue with step 9 below.
• If the Configure DITA Open Toolkit option was not selected in step 7, the
installer displays the Pre‐Installation Summary screen. Skip step 9 and
continue with step .
9. Note the following for the DITA Open Toolkit Options:
Note:You must select Configure Environment Manually or Use Environment Setup
Script but you cannot select both.
10. Click the Next button to continue.
The installer displays the pre‐installation summary screen.
11. Verify that the information in the pre‐installation screen is accurate.
Note:The Web Server Name/Port Number field does not contain any information.
This does not affect the upgrade; continue with the installation.
DITA Open Toolkit
Location
Click the Choose button to select the correct path to the DITA
Open Toolkit home location.
Configure Environment
Manually
Select this option if the runANT.bat file has already been
modified to execute an environment setup script, or if you
want to manually modify the runANT.bat file to specify an
environment setup script to be executed.
If you do not select this option you must select Use
Environment Setup Script.
Use Environment Setup
Script
Select this option to add the environment setup script to the
runANT.bat file as noted below.
Specify the path and name of the Environment Setup Script
and the installer automatically adds the following lines to
the Contenta_home > encaps > DITA > publish> util >
runANT.bat file:
REM ***start DITA Open Toolkit env setup
call ENV_SETUP_SCRIPT
REM ***start DITA Open Toolkit env setup
Where ENV_SETUP_SCRIPT is the value (path and
filename) you specify in the Environment Setup Script field.
If you do not select this option you must select Manual
Configuration.
23. Contenta DITA 1.4 Upgrade for Windows 3-5
12. After verifying that the information is accurate, click the Install button.
The installation program begins and displays an Installing Contenta DITA
screen.
When complete, the installer displays an Install Complete window. If there
were any errors, information about the log file containing error information
is reported.
13. Click the Done button to exit the installer.
14. Check the log file to ensure that the upgrade was successful and that no
errors were logged.
The log file is named dita1.4installdate.log where date is the date of the
installation/upgrade using the format yymmdd. Refer to page 3‐7 for a
description of the contents of the log file.
15. Upgrade your database; refer to Chapter 4, ”Database Upgrade”.
24. Post Upgrade
3-6 Contenta DITA 1.4 Upgrade for Windows
Post Upgrade
Publish Tool
The upgrade program copies the following files to the Contenta_home > distr
directory:
• Publish‐tool.properties
• Catalog.xml
If you have modified either file with site‐specific information, compare the files for
any updates in this release.
Note: To make the directory paths in the publish‐tool.properties file consistent with
the system’s registry, modify the publish‐tool.properties file as noted.
Follow the procedure on the Contenta Web Server (only).
1. Access the registry on the Contenta Web Server.
2. Open the following path and make note of the paths for the checkout and temp
directories.
HKEY_LOCAL_MACHINE > SOFTWARE > XyEnterprise > Content@ >
Settings > Directories
Example: Registry settings for Checkout and Temp
3. Edit the publish‐tools.properties file:
Contenta_home > encaps > DITA > publish > config > publish‐tool.properties
25. Contenta DITA 1.4 Upgrade for Windows 3-7
Post Upgrade
4. Specify the path for files.checkout.path with the Checkout path in the registry
and the files.temp.path with the temp path in the registry.
Example: publish‐tools.properties file, checkout and temp variables
files.checkout.path=C:XyEnterpriseContent@checkout
files.temp.path=C:XyEnterpriseContent@temp
Tomcat Service
Verify that the following edit was made to the server.xml in tomcat_home > conf:
<DefaultContext cookies="false"/>
Log File
Note the following entries made in the log file:
• Information from Contenta Product Configuration screen.
• Information from Pre‐Install summary screen.
• Log entry for registry entries.
• Log entry for the files that are being installed
• Log entry for the files that are being removed.
28. 4-2 Contenta DITA 1.4 Upgrade for Windows
Procedure
To upgrade your Contenta DITA database, enter the following upgrade command
(on a single line) at a command prompt from a Contenta client/administration
system that has been upgraded to Contenta DITA 1.4.
From the Contenta_home/bin/Upgrade_DITA directory:
upgrade_dita.pl -dbase DITAdbname@sid -S socket
-h Contenta_server -u sysadmin -pw sysadmin_password
where:
For example:
Note:The ‐h switch is required only if the system from which the command is being
issued is not the Contenta server.
A log file named upgrade_dita.log is created in the Upgrade_DITA directory. Open
the log file to ensure that it does not contain any errors indicating that the upgrade
was not successful.
Note:If you do not have a custom password for the sysadmin user, the upgrade
program may report INFO: Canʹt open password file. You can ignore this message.
The changes made by the upgrade_dita.pl utility are described in Appendix A,
”Contenta DITA Database Upgrade Program”.
Contenta_home The top-level, installation path of the Contenta software.
DITAdbname@sid The name of the Contenta DITA database/DITA Oracle user
with the Oracle sid (identifier).
socket The PcmPortal number.
Contenta_server The Contenta server name.
sysadmin_password The password for the Contenta sysadmin user.
cd XyEnterprise/Contenta/bin/Upgrade_DITA
upgrade_dita.pl -dbase ditadb@cielo -S 6050 -h rosie -u sysadmin
-pw manager
29. Appendix A
Contenta DITA Database
Upgrade Program
The Contenta DITA upgrade program (upgrade_dita.pl utility) adds or
modifies the following in your Contenta DITA database.
New ditalinks Table
The upgrade program adds the following ditalinks table in Oracle for the
Contenta DITA user (Contenta database) specified in the upgrade command
with the ‐dbase switch.
Name Type
PDM_BLOBID NUMBER(38) indexed
PDM_CONFIG NUMBER(38) indexed
PDM_REVID NUMBER(38)
NAME VARCHAR2(100)
OBJECT_TYPE CHAR(75)
SYSTEM_BASENAME CHAR(75) indexed
NAME_PATH VARCHAR2(1024)
SYSTEM_FULLPATH VARCHAR2(1024) indexed
30. A-2 Contenta DITA 1.4 Upgrade for Windows
New Property Sheet Fields
The upgrade_dita.pl utility adds new property sheet fields to the Contenta objects as
noted.
New Objects
The upgrade_dita.pl utility adds the following new objects to your Contenta DITA
database.
Object Name: PPC_2BP
Class Type = Graphic
Property Sheet Name = ppc_2bp
Icon Name = Graphic
Can be created by = Project, Group, DITA_Audience, DITA_Language, DITA_Product,
DITA_Component
Mimetype property sheet field set to image/2bp
Object (Type) New property sheet field With the default value
topic objects xrefset (integer) 1
conref xrefset (integer) 1
DITA_Map Map Title Number (character string)
Map Titles Identifier (character string) Default
Use Source Naming (character string)
PDF Graphic Format (character string) TIF
DITA_TopicHead Map Title Number (character string)
Map Titles Identifier (character string) Default
DITA_RelTable xml lang (character string) en‐us
DITA_TopicRef xml lang (character string) en‐us
Project SDL Job Number (character string)
32. A-4 Contenta DITA 1.4 Upgrade for Windows
Bookmap object types, toolboxes
Object Name Tool box should have the following tool
DITA_AbbrevList new DITA_Topic
DITA_Amendments new DITA_Topic
DITA_Appendix ‐‐no new tools‐‐
DITA_BackMatter new DITA_BookLists,
new DITA_Notices,
new DITA_Dedication, new DITA_Colophon,
new DITA_Amendments
DITA_BiblioList new DITA_Topic
DITA_BookAbstract new DITA_Topic
DITA_BookList new DITA_Topic
DITA_BookLists new DITA_ToC,
new DITA_FigureList,
new DITA_AbbrevList,
new DITA_TrademarkList, new DITA_BiblioList,
new DITA_GlossaryList,
new DITA_IndexList,
new DITA_BookList
DITA_BookMap new DITA_BookMeta,
new DITA_FrontMatter,
new DITA_Chapter,
new DITA_Part,
new DITA_Appendix,
new DITA_BackMatter
DITA_BookMeta ‐‐no new tools‐‐
DITA_Chapter ‐‐no new tools‐‐
DITA_Colophon new DITA_Topic
DITA_Dedication new DITA_Topic
DITA_DraftIntro ‐‐no new tools‐‐
DITA_FigureList new DITA_Topic
DITA_FrontMatter new DITA_BookLists,
new DITA_Notices,
new DITA_Dedication,
new DITA_Colophon,
new DITA_BookAbstract, new DITA_DraftIntro,
new DITA_Preface
DITA_GlossaryList ‐‐no new tools‐‐
DITA_IndexList new DITA_Topic
34. A-6 Contenta DITA 1.4 Upgrade for Windows
New tools and/or Updates to Existing Tools
The upgrade_dita.pl utility adds the following new tools and/or updates existing tools
as noted.
New Tool
Tool Name: Check References
Description: DITA Check References Tool
Commandline: interp noflash perl DITA/ResolveReferences/
CWDITACheckReferences.pl
Tool type: client
Toolboxes: Sysadmin, Projman
Object Types: Desktop, Configuration
Client Tools
DITA_TableList map/topicref bookmap/tablelist tablelist
DITA_ToC map/topicref bookmap/toc toc
DITA_TrademarkList map/topicref bookmap/
trademarklist
trademarklist
Tool Name Description Commandline/Syntax Tool for Object(s)
Translation Export SDL Translation Exp
SDL Client AI
interp noflash perl DITA/
Translation/TranslationExport.pl
–tn “Translation Export SDL” #
Project
Translation Import SDL Translation Imp
SDL Client AI
interp noflash perl DITA/
Translation/TranslationImport.pl
–tn “Translation Import SDL” #
Project
XMetaL Reviewer Send To XMetaL
Reviewer
interp noflash perl Reviewer/
CWReviewer.pl
Project
SDL Status Checker SDL Status
Checker Client AI
interp noflash perl DITA/
Translation/
TranslationStatusSDL.pl #
Project
Epic Map and Topic Edit DITA Map and
Topics, checkout‐
checkin
interp noflash perl DitaEdit/
EditDitaMap.pl ‐editor Epic ‐lock
any
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
35. Contenta DITA 1.4 Upgrade for Windows A-7
Epic Map Edit DITA Map only ,
checkout‐checkin
interp noflash perl DitaEdit/
EditDitaMap.pl ‐editor Epic ‐lock
MapOnly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map and Topic
Check Out
DITA Map and
Topics Check Out
interp noflash perl DitaEdit/
CheckOutDitaMap.pl ‐editor
Epic –lock any
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map and Topic
Check In
DITA Map and
Topics Check In
interp noflash perl DitaEdit/
CheckInDitaMap.pl ‐editor Epic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map Check Out DITA Map only
Check Out
interp noflash perl DitaEdit/
CheckOutDitaMap.pl ‐editor
Epic –lock MapOnly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map Check In DITA Map only
Check In
interp noflash perl DitaEdit/
CheckInDitaMap.pl ‐editor Epic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Topic Edit DITA Topic Edit interp noflash perl DitaEdit/
EditDitaTopic.pl –editor
FrameMaker
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Topic Check
Out
DITA Topic Check
Out
interp noflash perl DitaEdit/
CheckOutDitaTopic.pl ‐editor
FrameMaker
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Tool Name Description Commandline/Syntax Tool for Object(s)
36. A-8 Contenta DITA 1.4 Upgrade for Windows
FrameMaker Topic Check
In
DITA Topic Check
In
interp noflash perl DitaEdit/
CheckInDitaTopic.pl ‐editor
FrameMaker
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map and
Topic Edit
DITA Map and
Topics, checkout‐
checkin
interp noflash perl DitaEdit/
EditDitaMap.pl ‐editor
FrameMaker ‐lock any
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map Edit DITA Map only,
checkout‐checkin
interp noflash perl DitaEdit/
EditDitaMap.pl ‐editor
FrameMaker ‐lock MapOnly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map and
Topic Check Out
DITA Map and
Topics Check Out
interp noflash perl DitaEdit/
CheckOutDitaMap.pl ‐editor
FrameMaker ‐lock any
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map and
Topic Check In
DITA Map and
Topics Check In
interp noflash perl DitaEdit/
CheckInDitaMap.pl ‐editor
FrameMaker
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map Check
Out
DITA Map only
Check Out
interp noflash perl DitaEdit/
CheckOutDitaMap.pl ‐editor
FrameMaker ‐lock MapOnly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map Check
In
DITA Map only
Check In
interp noflash perl DitaEdit/
CheckInDitaMap.pl ‐editor
FrameMaker
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Tool Name Description Commandline/Syntax Tool for Object(s)
37. Contenta DITA 1.4 Upgrade for Windows A-9
Changes in the Command Line of Existing Tools
The upgrade_dita.pl utility makes the following changes to the commands of existing
tools as noted in the Tool Name column.
Note:The following are all client tool types.
Tool Name New Command Line
Translation Export interp noflash perl DITA/Translation/TranslationExport.pl
–tn “Translation Export” #
Translation Import interp noflash perl DITA/Translation/TranslationImport.pl
–tn “Translation Import” #
DITA Search for TopicRef interp noflash perl verity/CWDITASearchTool.pl ‐editor
xmetaldita ‐dita 0 ‐ditaview topicref
DITA Search for Project interp noflash perl verity/CWDITASearchTool.pl ‐editor
xmetaldita ‐dita 0 ‐ditaview project
XMetaL Topic Edit interp noflash perl DitaEdit/EditDitaTopic.pl ‐editor
XMetaL
XMetaL Topic Check Out interp noflash perl DitaEdit/CheckOutDitaTopic.pl ‐editor
XMetaL
XMetaL Topic Check In interp noflash perl DitaEdit/CheckInDitaTopic.pl ‐editor
XMetaL
XMetaL Map and Topic Edit interp noflash perl DitaEdit/EditDitaMap.pl ‐editor XMetaL
‐lock any
XMetaL Map Edit interp noflash perl DitaEdit/EditDitaMap.pl ‐editor XMetaL
‐lock MapOnly
XMetaL Map and Topic Check
Out
interp noflash perl DitaEdit/CheckOutDitaMap.pl ‐editor
XMetaL ‐lock any
XMetaL Map and Topic Check
In
interp noflash perl DitaEdit/CheckInDitaMap.pl ‐editor
XMetaL
XMetaL Map Check Out interp noflash perl DitaEdit/CheckOutDitaMap.pl ‐editor
XMetaL ‐lock MapOnly
XMetaL Map Check In interp noflash perl DitaEdit/CheckInDitaMap.pl ‐editor
XMetaL
38. A-10 Contenta DITA 1.4 Upgrade for Windows
New appdata Settings
The upgrade_dita.pl utility adds the following appdata settings.
Tools > Options > Tool Preferences > (refer to Path in the table below)
Path Key Name Value
Global/Settings Publish PDF Graphic Format TIF
Global/Settings Translation UseZips Yes (or No)
Global/Settings Translation OnlineOutputGraphicTypes JPG
Global/Settings Translation PrintOutputGraphicTypes TIF
Global/
DocumentTypes/
topic
Translation
Export
TransExport DitaTranslationExportDefault
Global/
DocumentTypes/
topic
Translation
Import
TransImport DitaTranslationImportDefault
Global/
DocumentTypes/
topic
Translation
Export SDL
TransExport DitaTranslationExportSDL
Global/
DocumentTypes/
topic
Translation
Import SDL
TransImport DitaTranslationImportSDL
Global/Settings/
Translation
SDL SDL Client ID
SDL Server URL
SDL Proxy Port
None
None
None
Global/
content@web/
Settings/
DitaTranslationTimeOutSecs 300
Global/
Document Types
bookmap Header <?xml version=ʺ1.0ʺ?>
<!DOCTYPE bookmap
PUBLIC ʺ‐//OASIS//DTD
DITA BookMap//ENʺ
ʺbookmap.dtdʺ>
39. Contenta DITA 1.4 Upgrade for Windows A-11
Web Tools
The following new tools are (Selected) added to the ProjMan and sysadmin toolboxes for the
objects noted in the Tool Assigned for Objects column.
The tools are Available for other toolboxes but not Selected. If you want other users to
access the tools, you must select and add them to the user/role toolbox.
Name Description Commandline Tool Assigned
for Objects
Translation Export Translation Export
SDL Client AI
prog cw_common/custom/
DITA_TranslationExport/
mainTranslationEx.jsp?request=connect
&tool=Translation Export
Project
Translation Import Translation
Import Client AI
prog cw_common/custom/
DITA_TranslationImport/
mainTranslationImp.jsp?request=conne
ct&tool=Translation Import
Project
Translation Export SDL Translation Export
SDL Client AI
prog cw_common/custom/
DITA_TranslationExport/
mainTranslationEx.jsprequest=connect
&tool=Translation Export SDL
Project
Translation Import SDL Translation
Import SDL Client
AI
prog cw_common/custom/
DITA_TranslationImport/
mainTranslationImp.jsp?request=conne
ct&tool=Translation Import SDL
Project
SDL Status Checker SDL Status
Checker
prog cw_common/custom/
DITA_TranslationStatusSDL/
mainTranslationStatusSDL.jsp
Project
XMetaL Topic Fetch DITA Topic Fetch prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic&re
adonly=true
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetaLTopic Check Out DITA Topic Check
Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
40. A-12 Contenta DITA 1.4 Upgrade for Windows
XMetaL Topic Check In DITA Topic Check
In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetaL Map Check Out DITA Map only
Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetaL Map Check In DITA Map only
Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetaL Map and Topic
Check Out
DITA Map and
Topics Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetaL Map and Topic
Check In
DITA Map and
Topics Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
XMetal Map Fetch DITA Map Fetch prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamap&rea
donly=true
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Topic Fetch DITA Topic Fetch prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic&re
adonly=true
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
41. Contenta DITA 1.4 Upgrade for Windows A-13
Epic Topic Check Out DITA Topic Check
Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Topic Check In DITA Topic Check
In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map Check Out DITA Map only
Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map Check In DITA Map only
Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map and Topic
Check Out
DITA Map and
Topics Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map and Topic
Check In
DITA Map and
Topics Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
Epic Map Fetch DITA Map Fetch prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamap&rea
donly=true
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
42. A-14 Contenta DITA 1.4 Upgrade for Windows
FrameMaker Topic
Fetch
DITA Topic Fetch prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic&re
adonly=true
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Topic
Check Out
DITA Topic Check
Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Topic
Check In
DITA Topic Check
In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditatopic
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map
Check Out
DITA Map only
Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map
Check In
DITA Map only
Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamaponly
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map and
Topic Check Out
DITA Map and
Topics Check Out
prog cw_xml_co/standard/code/
mainXmlCo.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
FrameMaker Map and
Topic Check In
DITA Map and
Topics Check In
prog cw_xml_ci/standard/code/
mainXmlCi.jsp?editor=cwditamap
DITA_ConRef
DITA_Concept
DITA_Maptitles
DITA_Reference
DITA_Task
DITA_Topic
46. Contenta DITA 1.4 File List
A-18 Contenta DITA 1.4 Upgrade for Windows
Admin and Server
distrdatabasebasedita.dmp
Admin
binUpgrade_DITAupgrade_dita.pl
binUpgrade_DITAupgrade_dita_app.pl
Admin Windows
binUpgrade_DITAupgrade_dita_init.exe
Admin Solaris
binUpgrade_DITAupgrade_dita_init
Server
encapsDitaTranslationExport.pl
encapsDitaTranslationExport.pm
encapsDitaTranslationImport.pl
encapsDitaTranslationImport.pm
encapsDITASDLSDLReceive.class
encapsDITASDLSDLSend.class
encapscustomDitaTranslationExportDefault.pm
encapscustomDitaTranslationExportSDL.pm
encapscustomDitaTranslationImportDefault.pm
encapscustomDitaTranslationImportSDL.pm
distrencapsDITASDLLangCodes.txt
Server Windows
encaps7za.exe