24
SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product has been renamed as SAP Conversion Agent by Itemfield. Future editions of this manual will reflect the new name, which replaces the name ContentMaster .

SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

  • Upload
    others

  • View
    35

  • Download
    0

Embed Size (px)

Citation preview

Page 1: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

SAP Conversion Agent byItemfield (ContentMaster)

ContentMasterAdministrator's Guide

Version 4.0 for Microsoft Windows

This product has been renamed as SAP Conversion Agent by Itemfield. Future editions ofthis manual will reflect the new name, which replaces the name ContentMaster.

Page 2: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

Legal Notice

ContentMasterAdministrator's Guide

Copyright © 2004-2006 Itemfield Inc. All rights reserved.

Itemfield may have patents, patent applications, trademarks, copyrights, or other intellectual propertyrights covering subject matter in this document. Except as expressly provided in any written licenseagreement from Itemfield, the furnishing of this document does not give you any license to thesepatents, trademarks, copyrights, or other intellectual property.

The information in this document is subject to change without notice. Complying with all applicablecopyright laws is the responsibility of the user. No part of this document may be reproduced ortransmitted in any form or by any means, electronic or mechanical, for any purpose, without theexpress written permission of Itemfield Inc.

SAP AGhttp://www.sap.com

Publication Information:

Version: 4.0 for Microsoft WindowsDate: January 2006

Page 3: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide Contents

i

Contents

1. Overview ...........................................................................................1Additional Administration Information ....................................................................................................1

2. Installation ........................................................................................2System Requirements ........................................................................................................................... 2

Platform ...........................................................................................................................................2Java Runtime Environment ............................................................................................................. 2Third-Party Applications ..................................................................................................................3

If You are Upgrading from a Previous Version ......................................................................................4Installation Instructions .......................................................................................................................... 4

Setup Options.................................................................................................................................. 5Registration and Licensing .............................................................................................................. 6

Uninstalling ............................................................................................................................................ 8User Privileges ...................................................................................................................................... 9Testing the Installation........................................................................................................................... 9Troubleshooting................................................................................................................................... 10

Java Heap Size .............................................................................................................................11Log Files........................................................................................................................................11

3. Upgrading ContentMaster Projects...............................................12When Is Upgrading Necessary?.......................................................................................................... 12Upgrading an Individual Project...........................................................................................................12Upgrading ContentMaster Services.....................................................................................................13

Upgrading an Individual Service....................................................................................................13Batch Utility for Upgrading All Deployed Services.........................................................................13Modified Components ...................................................................................................................14Features that Are Not Upgraded Correctly ....................................................................................14

XSD Schemas .....................................................................................................................................15Customized Component List ...............................................................................................................15Additional Upgrade Issues...................................................................................................................15

Page 4: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide Contents

ii

4. Configuration Editor.......................................................................16Backing Up the Configuration File ....................................................................................................... 16Using the Configuration Editor.............................................................................................................16Configuration Settings .........................................................................................................................17

Index....................................................................................................19

Page 5: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 1. Overview

1

Overview

This book explains how to administer ContentMaster on Microsoft Windowsplatforms. It covers subjects such as:

Installing the ContentMaster software

Upgrading ContentMaster projects from previous versions

Configuring ContentMaster

Additional Administration Information

Some of the information in this book, such as how to use the Configuration Editor,is also applicable to ContentMaster versions for Unix-based operating systems. Fordetailed information about the Unix versions, see the book ContentMaster for Unix.

1

Page 6: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

2

Installation

This chapter explains how to install and register ContentMaster on a MicrosoftWindows platform.

System Requirements

To install the ContentMaster software, your computer should meet the followingminimum requirements.

Platform

Microsoft Windows 2000, XP Professional, or 2003 Server (32-bit edition).

Microsoft Internet Explorer, version 6.0 or higher.

(For ContentMaster Studio) Microsoft .NET Framework, version 1.1 or higher.If you do not already have this, the ContentMaster setup installs it.

At least 128 MB of RAM.

For a ContentMaster Engine installation running production ContentMasterservices, we recommend at least 512 MB of RAM and a CPU speed of at least 1GHz.

The ContentMaster Engine and Studio software require approximately 200 MB ofdisk space.

If you plan to install the optional ContentMaster libraries (such as those for HL7,EDI-X12, EDIFACT, HIPAA, AL3, and SWIFT), you should reserve additionalspace. Each library may require up to a few hundred megabytes.

Java Runtime Environment

A Sun Java 2 Runtime Environment, version 1.4.2_9, must be installed on thecomputer. You can use the JRE that is installed with ContentMaster, or you candownload a JRE from http://www.sun.com.

2

Page 7: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

3

If You Have Multiple JRE Versions

The setup prompts you to select a JRE version to use when you run ContentMaster.If you have multiple JRE versions, you should select a single version that you willuse with ContentMaster.

The selected JRE does not need to be defined in the PATH. (In rare instances, theContentMaster Java document processors may require that the JRE be defined inthe PATH for proper operation.)

If necessary, you can use the Configuration Editor to change the selected JREfollowing the installation.

If You Plan to Use the ContentMaster Java API

If you use the ContentMaster Java API to activate a ContentMaster service, anyJava components of the service run on the JRE that is used by the external Javaapplication.

For consistency of operation, we recommend that this be the same JRE as the onethat you configured within ContentMaster. In any event, it must be a JRE versionthat ContentMaster supports.

Third-Party Applications

You can use ContentMaster with documents that are generated by a large numberof third-party applications. The following applications are among those that arecurrently supported.

Please contact SAP support for information about other applications, file formats,or versions.

Microsoft Office ApplicationsTo help you parse Microsoft Office documents (Word, Excel, or PowerPoint),ContentMaster offers several document processors, which convert the documentsto a format such as text, HTML, RTF, or XML. Office versions 97 and higher aresupported.

The text, HTML, and RTF processors require that the Office application be installedon the ContentMaster computer. The XML processors do not require the Officeapplication.

For detailed information, see the Parsers chapter in the ContentMaster Studio User'sGuide.

Acrobat and COBOL Support

ContentMaster contains built-in support for the Adobe Acrobat (PDF) format andfor COBOL data formats. You do not need to install any Acrobat or COBOLsoftware to process these file types.

Page 8: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

4

If You are Upgrading from a Previous Version

From Version 4.0.2 or EarlierIf you are upgrading from ContentMaster version 4.0.2 or earlier, you mustuninstall your existing version before installing the new version.

From Version 4.0.3 or Higher

If you are upgrading from ContentMaster version 4.0.3 or higher, or if you areinstalling a ContentMaster service pack, you do not need to uninstall beforeinstalling the new version.

Before starting the upgrade, you must shut down all applications that useContentMaster. Otherwise, the setup cannot replace certain files, and the upgrademay fail.

Upgrading Multiple Components and ComputersThe setup requires that you upgrade all the ContentMaster components together tothe same release number. This includes:

ContentMaster Engine and Studio

Any other optional ContentMaster components

We recommend that you upgrade all ContentMaster computers in yourorganization at the same time. This avoids any possible version conflicts betweenprojects that you develop on one computer and run on another computer.

Upgrading Projects

To upgrade your existing ContentMaster projects and run them in the new version,see Chapter 3, Upgrading ContentMaster Projects.

Installation Instructions

To install the ContentMaster software:

1. If your organization has a site license for ContentMaster, make sure that youhave the license key. The setup wizard will prompt you to enter the key.

2. Log on as a user with administrative privileges for the local computer.

3. Execute the ContentMaster4.exe file.

The installer opens an InstallShield wizard. Please be patient; it may take ashort time to open the wizard.

4. You are prompted to select the language of the setup displays.

This sets the language for the setup wizard and the default language for theContentMaster user interface. Following installation, you can change the user-interface language in the ContentMaster Configuration Editor.

Page 9: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

5

5. Follow the on-screen instructions to complete the setup. For an explanation ofthe options, see Setup Options below.

6. Depending on your ContentMaster version, the setup may prompt you toregister the software and install a license file. Follow the on-screen instructionsto complete the registration. For further information, see the section onRegistration and Licensing below.

Setup Options

The setup options vary, depending on the components in your installationpackage. The following paragraphs describe the options when you install the mainContentMaster components.

Site License

If you have a site license, enter the license key at the prompt.

Folder and File Locations

The setup prompts for the following folder or file locations.

You may accept the default locations, or you may browse to locations that youprefer. Following the installation, you can change the locations (except for theinstallation location) by using the Configuration Editor (see Chapter 4,Configuration Editor).

ContentMaster PathThe ContentMaster installation folder. The default is c:\Program Files\SAP\ContentMaster.

JRE LocationThe location of the Java Runtime Environment that you will use withContentMaster. The default is a JRE that the setup installs in theContentMaster folder. Optionally, you can browse to another JRE, which isalready installed on your computer (see Java Runtime Environment above).

ContentMaster Repository PathThis is the folder where you will deploy ContentMaster services for executionby ContentMaster Engine. The default location is c:\Program Files\SAP\ContentMaster\ServiceDB.

ContentMaster Log PathThe location where ContentMaster Engine stores its log files. The default is:

c:\Documents and Settings\<USER>\Application Data\SAP\ContentMaster\4.0\CMReports

Component Selection and Setup Types

At the prompt, choose which components to install, and if you would like to do atypical or custom installation. Depending on the components in your setuppackage, there may be options for components such as:

Page 10: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

6

Engine(Required) Installs ContentMaster Engine, which is the runtime componentthat executes ContentMaster services.

Eclipse Development EnvironmentInstalls ContentMaster Studio for Eclipse. This is a design and configurationenvironment where you can create ContentMaster projects.

Later in the setup, you are prompted to use ContentMaster Studio either withan existing IBM Eclipse installation, or to install a new, standalone copy ofEclipse. The option to use the existing copy of Eclipse is appropriate if Eclipseversion 2.1.2 or 2.1.3 is already installed on the computer, and you wish to useContentMaster Studio in it. Otherwise, you should select the standaloneoption.

Document ProcessorsInstalls a set of document processors, which you can use in datatransformations.

LibrariesInstalls the ContentMaster project libraries. The libraries contain predefinedparsers, serializers, and XSD schemas, which you can use with protocols suchas HL7, X12 EDI, EDIFACT, HIPAA, AL3, and SWIFT.

Registration and Licensing

Depending on your ContentMaster version, you may be prompted to register thesoftware or to provide licensing information. You can open ContentMaster Studioand create projects without a license, but you cannot run data transformations untilyou install a license.

If for any reason you did not register during the setup, you can register later. Onthe Start menu, choose SAP ContentMaster > Registration. You can also use theRegistration option to renew a license or to expand the licensing terms.

Some vendors may provide other registration options or instructions. Please follow anyspecial registration instructions that you received with your copy of ContentMaster.

Site License

A site license is a single license, which is valid for all computers in theorganization.

To obtain a site license, please contact your ContentMaster vendor. You will needto provide information such as maximum number of CPUs per computer.

The site license includes a license key and a License.cfg file. During the setup, youare prompted to enter the license key.

Following the setup, you must install a copy of the License.cfg file. See Installing aLicense.cfg File below.

Page 11: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

7

Standalone License

A standalone license is a license to use ContentMaster on a single computer.

If you plan to use a standalone license, the setup prompts you to register thesoftware. You must register separately on each computer where you installContentMaster. Following the setup, you must install a License.cfg file, which isspecific for the computer.

At the prompt, select one of the following options:

Add license fileSelect this option if you already have a license file for your computer(License.cfg), and you want to use it.

Register nowSelect this option to obtain a standalone license file, which lets you runContentMaster on a single computer.

Register laterRegister (and run ContentMaster) later.

The registration procedure is as follows:

1. In the registration form, enter the following information:

Product TypeChoose CM Studio to register ContentMaster Studio alone.

Choose CM Engine to register both ContentMaster Studio and Engine.

Depending on the optional features that you installed, there may beadditional product-type options.

Number of CPUsThe number of processors in the computer.

Company NameYour company's name.

E-mailThe email address where SAP should send the license file.

Phone No.Your telephone number.

ContactYour name.

2. Click the Register button, and submit the registration to the indicated location.

3. When you receive the License.cfg file, install it as described below.

Installing a License.cfg FileTo install a License.cfg file on the computer:

1. Log on as a user with administrative privileges.

Page 12: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

8

2. Open ContentMaster Studio. A registration prompt is displayed.

3. Click the Add License File button, browse to the License.cfg file, and clickOpen. You can then use ContentMaster.

Alternatively (for example, on a computer where ContentMaster Studio is not installed),you can install License.cfg by copying it to the ContentMaster installation folder.

After a Major Computer Upgrade

A standalone License.cfg file is specific to a particular computer.

After a major computer upgrade, such as installing a new Windows version, thesystem may no longer recognize your License.cfg file. If that occurs, you shouldrepeat the registration procedure and install a new License.cfg file.

Changing the License Type

To switch from a site license to a stand-alone license, or vice versa, you shoulduninstall ContentMaster and install it again.

License StatusTo determine whether you have a valid ContentMaster license, open a commandprompt and enter the command

CM_console aaa

where aaa is a placeholder for a ContentMaster service name (the service aaadoesn't need to actually exist). If you do not have a valid license, the commanddisplays an error message such as license file has been corrupted or doesn't exist. Inthat case, you should follow the steps described above to obtain a license.

If you receive an error message such as invalid service 'aaa', you can ignore it. Thereason for the message is that the aaa service doesn't exist.

License RenewalTo renew a license, please contact SAP.

Uninstalling

To uninstall ContentMaster, open the Add or Remove Programs option of theWindows Control Panel. Select the option to remove ContentMaster 4.0.

Page 13: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

9

User Privileges

In the Windows Control Panel, you should register the users who will useContentMaster, and grant the appropriate privileges.

AdministratorsWindows users who have administrative privileges can perform all ContentMasteroperations.

Limited Users

Typically, limited users do not have write permission for the ContentMasterprogram folder. Therefore, they are subject to the following restrictions:

They cannot install or uninstall the ContentMaster software.

They can generate a registration file (registration.txt), but they cannotinstall a license file (License.cfg).

They cannot deploy services to the default ContentMaster repository. You canrelax this restriction by moving the ContentMaster repository to anotherfolder, where the users have write permission (see Chapter 4, ConfigurationEditor).

They cannot add custom components such as document processors ortransformers.

They can view the settings in the ContentMaster Configuration Editor, butthey cannot change the setting values.

Testing the Installation

To verify that ContentMaster is installed correctly, you can perform the followingtest:

1. Open a command prompt.

2. Enter the CM_console command, without any parameters.

3. CM_console should display a usage message such as the following:

Usage:CM_console Service name [Additional options]...

4. In the folder ContentMaster4\setupTests, there is a sample ContentMasterproject called TestCME. Copy the entire TestCME directory to the ContentMasterrepository, which you defined during the setup (by default,ContentMaster4\ServiceDB). This makes TestCME available as a ContentMasterservice.

5. Enter the following command, which executes TestCME.

Page 14: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

10

CM_console TestCME

The service performs a simple data transformation on an HL7 sourcedocument. The following result should be displayed:

<Result>Test Succeeded</Result>

6. If you installed the document processors, you can test the installation byrunning an additional service called TestCMDP. The service converts an Excelspreadsheet file to XML. It uses the ExcelToXml document processor toperform an initial conversion stage.

Note: This test requires a version 1.4 or higher JRE.

To run the test, copy the folder

ContentMaster4\setupTests\TestCMDP

to the ContentMaster repository. Then run the command:

CM_console TestCMDP

The output should be:

<Report><Name>John Doe</Name><Age>29</Age><Sex>Male</Sex><Report><Q Year="2000" Q="1">5</Q><Q Year="2000" Q="2">6</Q><Q Year="2000" Q="3">7</Q><Q Year="2000" Q="4">3</Q><Q Year="2001" Q="1">5</Q><Q Year="2001" Q="2">8</Q><Q Year="2001" Q="3">3</Q><Q Year="2001" Q="4">3</Q><Q Year="2002" Q="1">3</Q><Q Year="2002" Q="2">4</Q><Q Year="2002" Q="3">2</Q><Q Year="2002" Q="4">8</Q></Report></Report>

Troubleshooting

If you experience difficulty installing or running ContentMaster, please check thefollowing points.

Page 15: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 2. Installation

11

Java Heap Size

If a Java component of ContentMaster, such as a document processor that usesJava, fails to process very large documents, the problem may be an inadequate Javaheap size. You can control the heap size by this procedure:

1. Open the ContentMaster Configuration Editor (see Chapter 4, ConfigurationEditor).

2. In the left pane, expand the tree to display:

CM Configuration/CM Engine

3. Right-click the CM Engine node and add JVM init parameters.

4. Assign a value of JVM init parameters such as Xmx512M, where 512 is the heapsize in megabytes.

You should define the JVM init parameters only if needed. Setting a large Javaheap size increases the ContentMaster memory requirement.

Log Files

ContentMaster generates several log files, which are useful for troubleshootingpurposes.

Installation Logs

The setup creates a set of logs in the ContentMaster4\Inst_logs folder. You canexamine the logs for any error messages.

ContentMaster Studio LogBy default, ContentMaster Studio keeps a log of its operations. To enable or disablethe log, and to determine the log location, open the Preferences window ofContentMaster Studio.

ContentMaster Studio Event LogsWhen ContentMaster Studio runs a data transformation, it saves an event logcalled Events.cme in the Results folder of the project. The log is displayed in theEvents view. For information, see the chapter on Running and Testing Projects in theContentMaster Studio User's Guide.

ContentMaster Engine Event LogsIf a failure occurs in a ContentMaster service, ContentMaster Engine creates anevents log. You can view the log in the Event Viewer tool. For more information,see the chapter on Event Logs in the ContentMaster Engine Developer's Guide.

Page 16: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 3. Upgrading ContentMaster Projects

12

Upgrading ContentMaster Projects

If you are upgrading from a previous ContentMaster release, you may need toupgrade your existing projects and your deployed ContentMaster services to thecurrent release.

The upgrade from ContentMaster version 3.1 or higher is fully automatic. You canupgrade an individual project by opening or importing it in ContentMaster Studio,or you can run a batch utility, which upgrades all the deployed services.

When Is Upgrading Necessary?

Upgrading is necessary when the ContentMaster Engine syntax version haschanged.

To determine the syntax version, open a command prompt and run the followingcommand:

CM_console -v

Upgrading an Individual Project

To upgrade an individual project, open or import it in ContentMaster Studio.

In ContentMaster Studio for Eclipse, you can do this by running the File > Importcommand. In the Import window, select the option to import an ExistingContentMaster Project into Workspace.

3

Page 17: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 3. Upgrading ContentMaster Projects

13

ContentMaster Studio prompts you to upgrade the project if necessary. Theupgrade is fully automatic.

Following the upgrade, you should test the project and confirm that it runscorrectly.

Upgrading ContentMaster Services

To upgrade your deployed ContentMaster services, you should use one of thefollowing procedures.

Upgrading an Individual Service

You can upgrade the development copy of a project and re-deploy it as aContentMaster service.

To do this, open or import the development copy in ContentMaster Studio. Testthe project, and re-deploy it as a service.

Batch Utility for Upgrading All Deployed Services

You can upgrade all your deployed ContentMaster services in a single operation.

To do this, run the CM_DBConverter.bat utility, which is located in theContentMaster installation folder. The procedure is as follows:

1. Open a command prompt.

2. Type the CM_DBConverter command with the following switches:

Switch Description

-s (Required) Path of the existing ContentMaster repository (or of another folderthat contains services).

-l (Optional) Path of the upgrade log file. The default isSyntaxConversionLog.txt , in theDocuments and Settings\<UserName> folder.

-b (Optional) Path of the backup folder. The default is the ContentMasterrepository location, concatenated with the suffix _Backup.

-d (Optional) Path of the new ContentMaster repository.If you omit this switch, the utility upgrades the services in their existinglocation.If you specify this switch, the utility copies the service projects to the newlocation and upgrades the copy. You must change the ContentMasterrepository location to the new path (see Chapter 4, Configuration Editor).

Page 18: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 3. Upgrading ContentMaster Projects

14

Following each switch, leave a space and type the path. If the path containsspaces, you must enclose it in quotation marks.

3. The utility notifies you when the upgrade is complete. If there were errors, itprompts you to examine the log file. If the utility could not upgrade a service,it stores a copy of the project in a folder whose path is the ContentMasterrepository location concatenated with the suffix _Error.

Example 1

c:\>CM_DBConverter -s "c:\Program Files\SAP\ContentMaster\ServiceDB"

The utility upgrades the services in their existing location, which is the ServiceDBfolder.

The utility backs up the original projects in the ServiceDB_Backup folder. If itcannot convert a service, it stores a copy of the project in ServiceDB_Error.

The utility generates a log file in the Documents and Settings\<User Name> folder.

Example 2c:\>CM_DBConverter -s "c:\Program Files\SAP\ContentMaster\ServiceDB" -d "c:\Program Files\SAP\ContentMaster\ServiceDB_New"

The utility copies the existing service projects to a new folder called ServiceDB_New.It upgrades the copied projects.

Using the Configuration Editor, you must change the ContentMaster repositorylocation to the ServiceDB_New folder.

The backup folder, error folder, and log file are as in the preceding example.

Modified Components

In version 4.0, some of the ContentMaster components that you can use in datatransformations have been revised, renamed, or replaced by new components.When you upgrade a project, ContentMaster inserts the new componentsautomatically.

For a list of components that have been modified, see the document What's New inContentMaster 4.0.

Features that Are Not Upgraded Correctly

The automatic upgrade tools successfully upgrade nearly all the ContentMasterfeatures that existed in previous ContentMaster versions.

Nonetheless, it is important that you test the data transformation following theupgrade. For example, you may find that an upgraded project containing theLocator component behaves slightly differently from the original version 3.2

Page 19: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 3. Upgrading ContentMaster Projects

15

project, where the Locator component did not exist, and the analogousfunctionality was implemented in a different way.

If you find that an upgraded project does not operate correctly, you can edit itsconfiguration in ContentMaster Studio.

XSD Schemas

In ContentMaster 3.1, the XML schema was defined in the TGP files of the project.Starting in ContentMaster 3.2, the XML schema is an XSD file.

When you upgrade a version 3.1 project to version 4.0, ContentMaster Studiocreates an external XSD schema automatically. You should review the schema andconfirm that it meets your needs. You can edit the schema or create your ownschema, as required.

For information, see the Data Holders chapter of the ContentMaster Studio User'sGuide.

Customized Component List

If you customized the component list of a previous version by adding TGP files tothe AutoInclude folder, you should upgrade the TGP files. One way to do this is asfollows:

1. In your previous ContentMaster version, create a project and add the TGP fileto it.

2. Open or import the project in ContentMaster Studio 4.0. You are prompted toupgrade the project to the new version.

3. Copy the upgraded TGP file to the AutoInclude\User folder of version 4.0.

You must install the TGP file on computers where you run either ContentMasterStudio or ContentMaster Engine. For a detailed discussion of this subject, see thesection Customizing the ContentMaster Component List in the book ContentMasterStudio in Eclipse.

Additional Upgrade Issues

If you have any additional questions about upgrading ContentMaster projects,please contact SAP support.

Page 20: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 4. Configuration Editor

16

Configuration Editor

ContentMaster has a Configuration Editor, which lets you edit the basicparameters of a ContentMaster installation.

Usually, you need to use the Configuration Editor only in the followingcircumstances:

If you need to change one of the folder locations that you configured duringthe setup, such as the JRE location or the ContentMaster repository location.

If instructed in the ContentMaster documentation or by SAP support.

Backing Up the Configuration File

The Configuration Editor saves the configuration in a file called CMConfig.xml,which is located in the ContentMaster installation folder.

Before you edit the configuration, we recommend that you save a backup copy ofCMConfig.xml. In the event of a problem, you can restore the backup.

The file CMConfig.bak is a backup of the original CMConfig.xml, which the setupprogram created when you installed ContentMaster. Restoring CMConfig.bakreturns ContentMaster to its original configuration.

Using the Configuration Editor

To open the Configuration Editor, on the Start menu, open SAP ContentMaster >Configuration.

Some of the Configuration Editor settings are available in all ContentMasterinstallations. Some additional settings may vary depending on the ContentMasterversion and on the optional components that you have installed.

4

Page 21: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 4. Configuration Editor

17

Assigning the SettingsThe editor has an Explorer type window. In the left pane, expand the tree andselect the desired setting. In the right pane, double-click to assign a setting value.

Some settings require that you type a value, whereas others offer a drop-down listor a browse option. If a setting has a gray background, it has a read-only value thatcannot be edited.

Some settings accept a table of values. For such settings, you can right-click to addor remove table rows.

Saving the Configuration FileClick the Save icon to save the edited settings. If you forget to save, theConfiguration Editor displays a reminder when you exit.

Configuration Settings

The following are the most common configuration settings that you may need toedit. You can assign these settings when you run the ContentMaster setup. Ifnecessary, you can change the settings afterwards in the Configuration Editor.

CM Configuration/Directory services/File system/Base PathThe ContentMaster repository location, where you store ContentMasterservices that you deploy. The default location is:

c:\Program Files\SAP\ContentMaster\ServiceDB

CM Configuration/CM Engine/JVM LocationThe location of the Java 2 Runtime Environment. The default is:

c:\Program Files\SAP\ContentMaster\jre1.4\bin\client

You can change this setting if you want to use a different, supported JRE, or ifyou upgrade the JRE and you want ContentMaster to use the new version. Fora list of the supported JREs, see Java Runtime Environment in Chapter 2,Installation.

Page 22: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide 4. Configuration Editor

18

You should not uninstall the previous JRE until you have assigned and testedthe new setting, because the Configuration Editor itself requires a JRE.

CM Configuration/General/Reports directoryThe location where ContentMaster saves event logs and certain other types ofreports. The default is:

c:\Documents and Settings\<USER>\Application Data\SAP\ContentMaster\4.0\CMReports

There are many additional settings, which are described in the relevant locationsthroughout the ContentMaster documentation.

Page 23: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide Index

19

Index

C

CM_DBConverterservice upgrade utility, 13

CMReportssetting log location, 18

component listupgrading customized, 15

Configuration EditorContentMaster, 16using, 16

configuration filebacking up, 16

ContentMaster Engineinstalling, 6

ContentMaster repositorysetting location, 17

ContentMaster servicesupgrading, 13

ContentMaster Studioinstalling, 6

D

document processorsinstalling, 6

E

Eclipseinstalling, 6

event logssetting location, 18

Excelsystem requirements, 3

H

heap sizeJava, 11

I

installationContentMaster, 2

J

Javaheap size, 11

JRE locationchanging, 17

L

librariesinstalling, 6

licenseconfirming validity, 8site, 6standalone, 7

licensingContentMaster, 5

limited usersrestrictions, 9

log fileslocation of, 11

logssetting location, 18

M

Microsoft Officesystem requirements, 3

P

PowerPointsystem requirements, 3

projectsupgrading from previous version, 12

R

registrationContentMaster, 7renewing, 8

reportssetting location, 18

Page 24: SAP Conversion Agent by Itemfield (ContentMaster) · SAP Conversion Agent by Itemfield (ContentMaster) ContentMaster Administrator's Guide Version 4.0 for Microsoft Windows This product

ContentMaster Administrator's Guide Index

20

S

schemasupgrading, 15

servicesupgrading, 13

site license, 6standalone license, 7syntax version

ContentMaster Engine, 12system requirements

ContentMaster, 2

T

testingContentMaster on Windows, 9

troubleshootingContentMaster installation, 10

U

uninstallingContentMaster, 8

upgradingContentMaster services, 13ContentMaster versions, 4modified components, 14projects, 12selecting components for, 4

usersprivileges, 9

V

versionContentMaster Engine syntax, 12

W

Wordsystem requirements, 3