Sybase Technical Library - Product Manuals Home
[Search Forms] [Previous Section with Hits] [Next Section with Hits] [Clear Search] Expand Search

About This Book [Table of Contents] Chapter 2 Installing Adapter for
SAP R/3

Installation Guide New Era of Networks Adapter for SAP R/3 3.9

[-] Chapter 1 Migrating to Adapter for SAP R/3 Version 3.9

Chapter 1

Migrating to Adapter for SAP R/3 Version 3.9

Process Overview

For Windows, Solaris, AIX, and HP-UX, the following procedures comprise the migration process:

Preparing for Upgrade

Existing database refers to the database you are currently using.

Target database refers to the database you will use with Adapter for SAP R/3 version 3.9.

Before migrating formats and rules from an existing database to your target database, verify the following:

Upgrading from Version 3.0.3 to Version 3.9

Upgrading from Adapter for SAP R/3 version 3.0.3 to version 3.9 consists of the following steps:

Upgrading from Version 3.8 to Version 3.9

Upgrading from Adapter for SAP R/3 version 3.8 to version 3.9 consists of the following steps:

Changes to Configuration Keys

If you use the GUI to import your pre-3.9 configuration files, some of the keys will be automatically mapped to the keys required by 3.9. You will have to make some manual changes to the configuration file before you use it. Alternatively, you can make all changes manually.

Appendix A of the Adapter for SAP R/3 User's Guide contains a list of all currently valid configuration keys.

The following keys and values must be changed in your configuration files. You can use the sample configuration files that are provided with the new installation. Manually transfer existing values for keys from your existing configuration files into the new configuration files based on the sample files provided.

This list contains keys that are typically used in configuration files but may not be all of the keys you have used. See the Adapter for SAP R/3 User's Guide for a specific version for a complete list of configuration keys for that version.

Product Upgrade Keys and Mapping

Version 3.0.3

Version 3.8

Version 3.9

queue.mgr.name

NNMQS_SES_OPEN_QMGR

same as 3.8

queue.in.name=TO_SAP

NNOT_TIL_OPEN_TSI=TO_SAP

same as 3.8

queue.out.name=FROM_SAP

NNOT_TIL_OPEN_TSI=FROM_SAP

same as 3.8

failurequeue.name=FAILURE

NNOT_TIL_OPEN_TSI=FAILURE

same as 3.8

queue.empty_queue_wait_time_milli

transport.wait_time_milli

not used

queue.empty_queue_wait_time

transport.wait_time

same as 3.8

queue.exit_it_empty

transport.exit_if_empty

same as 3.8

error.logfile

no equivalent key

Default error log is NNSYMessageLog.nml

same as 3.8

no.special.char

no equivalent key

same as 3.8

sap.reconnectAttempts

sap.retry.count and

sap.retry interval

same as 3.8

sap.rfc.destination

same as 3.0.3

sap.destination

sap.client

same as 3.0.3

same as 3.0.3

sap.user

same as 3.0.3

same as 3.0.3

sap.password

same as 3.0.3

same as 3.0.3

sap.language

same as 3.0.3

same as 3.0.3

sap.rfc.trace

same as 3.0.3

sap.trace

sap.logLevel

same as 3.0.3

same as 3.0.3

sap.logFile

same as 3.0.3

same as 3.0.3

Adapter.adapter

same key but value has changed

same as 3.8

NN.LinkMode

same as 3.0.3

sap.linkMode

NN.InboundMethod

same as 3.0.3

sap.inboundMethod

NN.IDocBatchSize

same as 3.0.3

Adapter.batch.size

NN.CreateIDocReport

same as 3.0.3

sap.createIDocReport

NN.IDocTrace

same as 3.0.3

not used

NNLogFileName

same as 3.0.3

sap.logFile

NN.VerboseLog

same as 3.0.3

sap.verboseLog

MQS.QueueManagerName

NNMQS_SES_OPEN_QMGR

same as 3.8

MQS.GetQueueName

NNOT_TIL_OPEN_TSI

same as 3.8

MQS.PutQueueName

NNOT_TIL_OPEN_TSI

same as 3.8

MQS.ErrorQueueName

NNOT_TIL_OPEN_TSI

same as 3.8

RFC.Destination

same as 3.0.3

sap.destination

RFC.ClientCode

same as 3.0.3

sap.client

RFC.UserName

same as 3.0.3

sap.user

RFC.Password

same as 3.0.3

sap.password

RFC.Language

same as 3.0.3

sap.language

RFC.Trace

same as 3.0.3

sap.trace

no equivalent key

RFC.ReqWait

sap.reqWait

no equivalent key

RFC.ConnectRetries

sap.connectRetries

no equivalent key

NN.retry.count

sap.retry.count

no equivalent key

NN.retry.interval

sap.retry.interval

no equivalent key

SAP.reqWait

sap.reqWait

no equivalent key

SAP.Destination.Out

sap.destination.out

no equivalent key

SAP.Destination.In

sap.destination.in

no equivalent key

SAP.retry.count

sap.retry.count

no equivalent key

SAP.retry.interval

sap.retry.interval

Converting IDoc Formats

You must convert the formats for both IDocs and BAPIs when you move between versions of Adapter for SAP R/3. Custom formats can continue to use names that begin with unique prefixes to differentiate them from standard formats.

You need to migrate your IDoc formats to accommodate the following situations:

The format conversion tool that ships with Adapter for SAP R/3 is a valuable resource for you to more easily migrate IDoc formats. Formats are dependent on the field mapping that you have done so you must also migrate those mappings. The purpose of the conversion tool is to preserve the field mappings used for output formats and transfer those current field mapping to the newly loaded format. The tool does this using two format export files as input to produce a new format export file; the new format export file combines the information from the two formats. This is intended to save you time because, after you use the tool to transfer you old field mappings, you need map only the new fields. Formats can be converted without doing rules at the same time, but rules cannot be converted without also converting the associated formats.

To use the IDoc conversion tool, export your old IDoc output format and the new unmapped output format loaded using the version 3.9 adapter. Then edit the conversion tool configuration file to specify the names of the format export files and run the tool. IDoc formats required by version 3.9 into the IDoc conversion tool. The tool then creates one usable format based on the mapping of the two formats.

After you have transferred the field mapping, you may validate the converted format by reformatting previously used messages and confirming that the output message fields contain the expected data. The New Era of Networks utility programs msgtest.exe and ruletest.exe can be used to validate your converted messages and rules.

The IDoc conversion tool for Adapter for SAP R/3 provides the tools to do the following:

The following procedures must be applied individually to each IDoc format that is being migrated. The conversion tool is able to handle only one IDoc type at a time.

To migrate IDoc formats from a 4.x Formatter database

Output formats used by the Broker for IDocs sent into SAP changed between version 3.03 and version 3.8 of the SAP adapter. The segment names used to begin with E2 or Z2 and terminate with a three-digit version number. Segment names now begin with E1 or Z1 to reflect that the IDoc is inbound into SAP. Three-digit version numbers have been dropped.

New input formats can be used as loaded. No information from the old input format needs to be migrated.

  1. Do one or both of the following:

    1. Export only the outbound format from the 4.x Formatter database using the NNFie utility provided with Formatter 4.x.

      Example:

       C:\MQI\bin>nnfie -e absen1.oc.4x.exp -m SAP.OC.ABSEN1 -s nnfie

    2. Export the Rules associated with the format using the NNRie utility., if you are converting rules.

      Example:

      C:\MQI\bin.nnrie -e absen1.4x.rules.exp -m SAP.OC.ABSEN1 -s nnfie

      When exporting extended IDoc formats from an 4.x Formatter database, the format name must be in quotation marks because names contain special characters. For example:

      nnfie -e format.exp -m "SAP.OC.MATMAS03^1" -s import

  2. Load the outbound format for the same IDoc into a temporary 5.6 database using version 3.9 of Adapter for SAP R/3.

  3. Export only the outbound format of the IDoc loaded in the previous step using the NNFie utility provided with Formatter 5.x.

    Example:

    C:\sybase\bin>nnfie -e absen1.oc.5x.exp -m SAP.OC.ABSEN1 -s nnfie

  4. Edit the configuration file for the conversion tool to indicate:

  5. To run the conversion tool, type the command using the following as an example:

    sap39idoccnvtool -file=<name of configuration file>

    The format export files and the configuration file used to load the 3.9 schema should be placed in the SAP-3_9/bin folder. The command must be run from this same folder.

  6. Inspect the log file produced by the conversion utility for errors.

  7. Do one of the following:

    1. Import the format created by the conversion utility into the target database using the NNFie utility provided with Formatter 5.x.

      Example:

      C:\ConversionTests\>nnfie -i absen1.oc.conv.exp -g -s nnfie

    2. Import the Rules file created by the conversion utility using the NNRie utility provided with Formatter 5.x. This step is required only if step 1b was used.

  8. Review the formats to be sure the converted format has the correct mapping.

    If any formats have not been converted, you must change them manually.

  9. Test the format by using it as the target format for reformatting a test message.

To update a newly extended IDoc format in a 5.x Formatter database:
  1. Export only the original outbound format using the NNFie utility provided with Formatter 5.x.

    Example:

    C:\sybase\bin>nnfie -e absen1.oc.5x.exp -m SAP.OC.ABSEN1 -s nnfie

  2. Load the outbound format for the newly extended IDoc into a temporary 5.6 database using the 3.9 SAP adapter. (The example assumes an extended IDoc named ZABSEN1 was made from the base IDoc ABSEN1.)

  3. Export only the outbound format of the IDoc loaded in the previous step using the NNFie utility provided with Formatter 5.x.

    Example:

     C:\sybase\bin>nnfie -e zabsen1.oc.5x.exp -m SAP.OC.ZABSEN1 -s nnfie

  4. Edit the configuration file for the conversion tool to indicate:

  5. To run the conversion tool, type the command using the following as an example:

     sap39idoccnvtool -file=<name of config file>

    The format export files and the configuration file used to load the 3.9 schema should be placed in the SAP-3_9/bin folder. The command must be run from this same folder.

  6. Inspect the log file produced by the conversion utility for errors.

  7. Import the format created by the conversion utility into the target database using the NNFie utility provided with Formatter 5.x.

    Example:

    C:\ConversionTests\>nnfie -i zabsen1.oc.conv.exp -g -s nnfie

  8. Test the format by using it as the target format for reformatting a test message.

The way extended IDocs are treated is the major consideration for the conversion process between Adapter for SAP R/3 versions 3.8 and 3.9. Extended IDocs are no longer considered special situations.

To update a currently used IDoc format in a 5.x Formatter database:
  1. Export only the original outbound format using the NNFie utility provided with Formatter 5.x.

    Example:

    C:\sybase\bin>nnfie -e absen1.oc.5x.exp -m SAP.OC.ABSEN1 -s nnfie

  2. Load the outbound format for the new version of the IDoc into a temporary 5.6 database using the 3.9 SAP adapter (the example assumes a new version of ABSEN was released - ABSEN2).

  3. Export only the outbound format of the IDoc loaded in the previous step using the NNFie utility provided Formatter 5.x.

    Example:

    C:\sybase\bin>nnfie -e absen2.oc.5x.exp -m SAP.OC.ABSEN2 -s nnfie

  4. Edit the configuration file for the conversion tool to indicate:

  5. To run the conversion tool, type the command using the following:

    Example:

    sap39idoccnvtool -file=<name of config file>

    The format export files and the configuration file used to load the 3.9 schema should be placed in the SAP-3_9/bin folder. The command must be run from this same folder.

  6. Inspect the log file produced by the conversion utility for errors.

  7. Import the format created by the conversion utility into the target database using the NNFie utility provided with Formatter 5.x.

    Example:

    C:\ConversionTests\>nnfie -i absen2.oc.conv.exp -g -s nnfie

  8. Test the format by using it as the target format for reformatting a test message.

Example Log File

Source Control Record: SAP.OF.ABSEN1.CR
Destination Control Record: SAP.OF.ABSEN1.CR

Source Segment Name: SAP.OF.E2ABSE1
Destination Segment Name: SAP.OF.E2ABSE1
    Field: SAP.E2ABSE1.BDEGR    OutMap:     InMap: LEG.F1
    Field: SAP.E2ABSE1.MOABW    OutMap:     InMap: LEG.F2
    Field: SAP.E2ABSE1.ZEITY    OutMap:     InMap: LEG.F3
    Field: SAP.E2ABSE1.AGRUN    OutMap:     InMap: LEG.F4
    Field: SAP.E2ABSE1.BEGDA    OutMap:     InMap: LEG.F5
    Field: SAP.E2ABSE1.ENDDA    OutMap:     InMap: LEG.F6
    Field: SAP.E2ABSE1.ATEXT    OutMap:     InMap: LEG.F7

Adjusting for Customization

Make sure that the new format contains the correct default values for control records. (Default values in control records are optional.) The conversion tool transfers user-defined values and mappings, but it does not transfer default values.

If the original format specified default values for the partner profile fields of the control record, then you must manually set the values to those literals. This applies to the literals named SAP.<IDOC TYPE>.* where * is one of the following: RCVPOR, RCVPRN, RCVPRT, SNDPOR, SNDPRN, SNDPRT.

Suggestions for Converting IDocs

Example Conversion Tool Configuration File

#--------------------------------------------------# File Name:  ConvTool.cfg
# Sample configuration file for running the IDoc
# format conversion tool.
# The format of this file is important. Session names
# MUST begin at the beginning of the line, the
# associated keys MUST be below the session name
# and indented by spaces or tabs. Comments are
# preceded by #.

#--------------------------------------------------
NNConv
# name of original format as seen in formatter
# database
    FromFormat = SAP.OC.MATMAS03^1
# name of format (loaded using new version of SAP
# adapter) as seen in 5x formatter
    ToFormat = SAP.OC.MATMAS03.ZMATMAS_EXTENSION# must provide connection parameters used by 3.9 SAP
# adapter to connect to SAP use inbound idoc or Schema 
# mode configuration file to get needed params to 
# connect to SAP
    SAPInConfig = in.cfg
# 1=411 0=5x (they could go 5x to 5x)
    SourceFrom411 = 1
    
# release of user's SAP system
    SourceSAPRelease = 4.6B
# name of export file of format to convert (ONLY one
# format!)
    SourceExtract = matmas_ext.4x.mapped.exp
# name of export file of format freshly loaded in 5.x
# via GUI (ONLY one format!)
RawExtract = matmas_ext.39.raw.exp
# desired name of converted format export file
OutputExtract = matmas_ext.39.conv.exp
# conversion log file
    LogFile = format_conversion.log
#####################################################
# the following keys are for Rules related components
#####################################################
# name of rule export file (from 411) [Optional]
# RulesIn = matmas_ext.rules.4x.exp
# desired name of converted rule export file (into 5x)
# [Optional]
# RulesOut = matmas_ext.rules.conv
# User may specify a new name for Message Type within the 
# Application Group in 5x database (the name is no
# longer limited to 32 characters in length, but may be
# up to 128 characters in length).
# After the input format is imported into the 5x
# database, the user would need to manually rename the
# format to match the new expanded name created using
# this key.
# example:
# name in 4x database: LEG.I.ORIGINAL_LIMITED_SIZE_NAME
# renamed in 5x database to
# LEG.I.MODIFIED_FORMAT_NAME_OF_LARGER_SIZE
# ToRuleInputMessage=SAP.IC.MATMAS03.ZMATMAS_EXTENSION

# defaults to same name [Optional] or change rule name
# RuleNameOut =
# eof

Converting BAPI Formats

You must convert the formats for both IDocs and BAPIs when you move between versions of Adapter for SAP R/3. Custom formats can continue to use names that begin with user-defined prefixes to differentiate them from standard formats.

BAPI formats and rules that you used for version 3.8 of the adapter will work with Adapter for SAP R/3 version 3.9. BAPI formats from version 3.0.3 or earlier are not supported and should be reloaded using the version 3.9 adapter. New rules must be created for these formats.

The term New Formatter Database references any database created using MQSI version 2.0.2, WMQI version 2.1, or e-Biz Integrator versions 3.2x or 3.6x.

The term Old Formatter Database references a database built on earlier versions of these products.

To use BAPI formats used in pre-3.9 versions
  1. Reload all BAPIs into the New Formatter Database.

    New Rules must be created for all formats that are reloaded into a new database.

Upgrading Rules

Review the rules that you are currently using with Adapter for SAP R/3. If they need to be converted for use with version 3.9:


About This Book [Table of Contents] Chapter 2 Installing Adapter for
SAP R/3