Control-M for SAP Installation

Control-M for SAP is installed on an Agent, on a Windows or UNIX operating system.

Before you upgrade to Control-M for SAP to version 9.0.21, you must first do the following:

  • Verify that Control-M/Agent 9.0.20 or higher is installed.

  • Stop the Extractor process, as described in Starting and Stopping the Extractor Process.

Control-M for SAP Additional Requirements

The following table describes the additional requirements for Control-M for SAP.

Requirement

Details

JCo Library

The sapjco3.jar and sapjco3 C library files are not delivered with Control-M for SAP. They must be installed separately.

SAP Basis Release: 6.10, 6.20, 6.40

(NetWeaver), 7.x

If you are working with SAP Basis 7.0, you must install SAPKB70012 (Support Package 12) as a minimum requirement.

Kernel Version

Ensure that the latest kernel version is running.

XBP interface

It is recommended that your SAP system includes at least the XBP 2.0 interface. Some of the features are available without XBP 2.0 if you are using Control-M Function Modules. For more information, see Differences Between XBP BAPIs and Control-M Function Modules.

According to the SAP documentation, the XBP 2.0 interface is included in the following SAP Basis Support Packages:

  • 6.10 - SAPKB61028: Support Package 28.

  • 6.20 - SAPKB62017: Support Package 17.

  • 6.40: No support package needed.

  • 7.0 - SAPKB70012: Support Package 12.

SAP Business Information Warehouse

Releases: 3.0B, 3.1 Content, 3.1 Content with BI CONT 3.20, 3.5, 7.x.

If you plan to use the Control-M for SAP-BW functionality, you must install the following BW Support Packages:

  • BW 3.0B - SAPKW30B27: Release details in SAP Note 723258.

  • BW 3.1 - SAPKW31021: Release details in SAP Note 723263.

  • BW 3.5 - SAPKW35012: Release details in SAP Note 986892.

  • BW 7.0 - SAPKW70014: Release details in SAP Note 991094.

If you plan to use the Control-M for SAP Interrupt feature for BW support packages 3.0 and 3.5, then you must manually install SAP Note 786748.

SAP Event Based Scheduling

SAP Basis Release: 7.0 and later.

Open Ports

The following gateway port in the SAP host must always be open, even if you are using a firewall:

33<SYSNR>

where SYSNR represents the System Number of the computer where the SAP Gateway Server runs.

Gateway port 3335 refers to the port number, 33, and the System Number, 35.

If you are using Log in Groups, ensure that the Message Server port you are using is open and configured in the OS Services file in one of the following locations:

  • UNIX: /etc/services

  • Windows: C:\Windows\System32\drivers\etc\services

Add an entry with the following format:

sapms<SAP SID> 36<System_Number>/tcp

For more information, see 000267030.

You can use the transport user role, BMCCTRLM_CM_USER, which includes all the authorizations (with the exception of S_RS_PC) needed to work with Control-M for SAP. Use this role as the Control-M user. For more information on how to install the Transport, see Transport Sub-folder Contents.

You might need to add additional authorizations. The authorization checks if the job is completed in SAP using the Run as User of the job step. However, if you do not set a Run as User for the job step, the Run as User is set in the connection profile and must have the require authorizations.

The User Type, as defined in the SAP User maintenance transaction (SU01), can be either System or Dialog. Different user types might cause errors in connection.

Installing Control-M for SAP on Control-M/Agent on UNIX

This procedure describes how to install Control-M for SAP on Control-M/Agent on UNIX in a Control-M/Server self-hosted environment.

  • To install multiple instances of Control-M for SAP on several Agents with the same configuration, use Automatic Install, as described below.

  • To use the Default Interactive Install, configure XServer using the DISPLAY environment variable, as described in Setting Environment Variables in UNIX. If you do not have XServer, either use the console or do an automatic install.

Before You Begin

  • Stop all jobs on the Agent.

    If you are using a Linux x86_64 platform that runs a 32-bit version of Control-M/Agent, install the following 32-bit libraries:

    • libXtst.so.6

    • libXi.so.6

Begin

  1. Run the following command to stop the Agent:

    $CONTROLM/scripts/shut-ag -u <agentUser> -p all

  2. Extract the files from the temporary directory that you created when you obtained the installation files.

    • If the Agent was installed with a root user, log in as a root user every time you start or shut down the Agent throughout this procedure.

    • (AIX only) Type the following command as a root user to remove unused libraries:

      /usr/sbin/slibclean

  3. Use one of the following modes:

    • Display: If you install using GUI or XServer, set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.

    • Console: It is not necessary to set DISPLAY.

  4. Run the following command to activate the installation script:

    <source_path>/setup.sh

  5. Do one of the following:

    • Interactive Install: Follow the on-screen instructions until the installation is complete.

    • Automatic Install: Do the following:

      1. Follow the on-screen instructions until the Summary window appears.

      2. Click Generate, select a location to create the XML parameter file, and click Yes.

      3. Copy the XML parameter file to a network location that is accessible to all computers where you want to perform an automatic installation.

      4. Type the following command to run the installation script:

        <source_path>/setup.sh -silent <filename.xml>

        To start working with Control-M for SAP, you must download the required SAP Java Connector files. For more information, see Downloading the sapjco3.jar and sapjco3 C Library Files.

  6. End the session.

  7. Start a new session and run the following command to restart the Agent:

    $CONTROLM/scripts/start-ag -u <agentUser> -p all

The installation log is saved to the following location:

$HOME/BMCINSTALL/log/cmsap/BMC_Control-M_For_For_SAP_Install_<date-time>.log

Installing Control-M for SAP on Control-M/Agent on Windows

This procedure describes how to install Control-M for SAP on Control-M/Agent on Windows in a Control-M/Server self-hosted environment.

To install multiple instances of Control-M for SAP on several computers using the same configuration, use automatic install as described below.

Before You Begin

  • Stop all jobs on the Agent.

Begin

  1. Log in to Control-M/Agent as an Administrator.

  2. From the Services application, right click on Control-M Agent and click Stop.

  3. From the directory that contains the installation files that you obtained, double-click setup.exe.

  4. Do one of the following:

    • Interactive install: Follow the on-screen instructions until the installation is complete.

    • Automatic install: Do the following:

      1. Follow the on-screen instructions until the Summary window.

      2. Click Generate, select the location to create the XML file, and click Yes.

        The XML file is only relevant for computers with the same Agent instance name. For Agents that have a different instance name, create a separate XML file for each Agent.

      3. Copy the XML file to a network location that is accessible to all computers where you want to perform an automatic installation.

      4. Run the following installation script:

        <source_path>\setup.exe -silent <silent.xml>

        To start working with Control-M for SAP, you must download the required SAP Java Connector files. For more information, see Downloading the sapjco3.jar and sapjco3 C Library Files.

  5. From the Services application, right click on Control-M Agent and click Start.

    After you have installed Control-M for SAP on a Control-M/Agent, you must install Control-M for SAP on the Control-M client if you do not have the latest version of Control-M client, as described in Installing Control-M for SAP on the Control-M Client on Windows.

  • The installation log is saved to the following location:

    BMCINSTALL\log\cmsap\BMC_Control-M_For_SAP_Install_<timestamp>.log

  • If the installation failed, the log file is saved to the following location:

    %temp%\BMC_Control-M_For_SAP_Install_<timestamp>.log

Installing the Secure Network Communications (SNC) on Control-M for SAP

This procedure describes how to install the SNC protocol on Control-M for SAP, which enables the encryption of data between Control-M for SAP and the SAP system, in a Control-M/Server self-hosted environment.

Begin

  1. Follow the download and installation procedures, as described in KA 000111305.

  2. After the SNC protocol setup is complete, stop the Agent.

  3. Run the following command to stop Control-M for SAP:

    • UNIX: sapcmbe.sh stop

    • Windows: sapcmbe.cmd stop

  4. (UNIX only) Run the following command to start Control-M for SAP:

    sapcmbe.sh start &

  5. Start the Agent.

Installing Control-M for SAP on the Control-M Client on Windows

This procedure describes how to install Control-M for SAP on the Control-M Client on Windows in a Control-M/Server self-hosted environment.

Before You Begin

  • Close Control-M client and CCM.

Begin

  1. Log in as an Administrator.

  2. Navigate to the EM directory and double-click setup.exe.

  3. Do one of the following:

    • Interactive Install: Follow the on-screen instructions until the installation is complete.

    • Automatic Install: Do the following:

      1. Follow the on-screen instructions until the Summary window appears.

      2. Click Generate, select a location to create the XML file, and click Yes.

        The XML file is only relevant only for computers with the same Control-M/EM version. For computers with different Control-M/EM versions, a separate file must be created for each computer.

      3. Copy the XML file to a network location that is accessible to all computers where you want to perform an automatic installation.

      4. Run the following installation script command:

        <source_path>\EM\setup.exe -silent <silent.xml>

    The installation log is saved to the following location or under the directory that contains the %temp% directory:

    %temp%\BMC_Control-M-CM_EM_Install_<date-time>.log

Control-M for SAP XBP Interface and Control-M Function Modules

Control-M for SAP works integrally with the XBP interface and supports the following versions:

  • XBP 1.0

  • XBP 2.0

  • XBP 3.0

XBP versions 2.0 and higher are designed to work with external scheduling applications and function best with Control-M Function Modules, also known as Control-M FMs.

Control-M FMs are Control-M for SAP specific APIs which perform tasks that are not provided by the SAP standard BAPIs.

Control-M for SAP comes with a set of predefined Control-M FMs.

By default, Control-M prefers to use XBP BAPIs over Control-M FMs. For example, if you want to copy a variant on an SAP system with XBP 1.0, install Control-M FMs. However, if you install SAP system XBP 2.0 or higher and configure the account with the XBP version, the variant is copied using the XBP BAPIs.

Installing the Control-M Function Modules in a Non-Unicode SAP System

This procedure describes how to install the Control-M FMs in a non-Unicode SAP system in a Control-M/Server self-hosted environment.

If you do not want to install Control-M FMs, ensure that the Use Extended option is set to No. See Advanced Option Parameters.

Begin

  1. Navigate to the SAP Transports directory:

    • UNIX: <source_path>/Tools/Transports

    • Windows: <source_path>\Tools\Transports

  2. Copy the transport files into the SAP system transport directory.

  3. Remove the read-only attribute from the transport files to prevent import issues to your SAP system.

    For more information about the contents of the sub-folders of the Transports folder, see Transport Sub-folder Contents.

  4. Use the SAP Transport Management System (transaction STMS) or the operating system executable program to import the required transport files.

Installing the Control-M Function Modules in a Unicode SAP System

This procedure describes how to install Control-M FMs in a Unicode SAP system in a Control-M/Server self-hosted environment.

If you do not want to install Control-M FMs, ensure that the Use Extended option is set to No. For more information, see Advanced Option Parameters.

Begin

  1. Navigate to the SAP Transports directory:

    • UNIX: <source_path>/Tools/Transports

    • Windows: <source_path>\Tools\Transports

  2. Do one of the following:

    • If you want to set the Unicode flag manually, do the following:

      1. Follow the import procedure in SAP Note 330267 in the section Transports from 4.6 to 6.10/6.20/6.30.

      2. Copy the transport files into the transport directory of your SAP system.

      3. Remove the read-only attribute from the transport files to prevent import issues to your SAP system.

        For more information about the contents of the sub-folders of the Transports folder, see Transport Sub-folder Contents.

      4. Use the SAP Transport Management System (STMS) or the operating system executable program to import the required transport.

        Before calling the transaction, set the SAP parameter SETUNICODEFLAG to TRUE in the SAP transport system.

    • If you do not want to set the Unicode flag manually do the following:

      1. Copy the transport files into the transport directory of your SAP system.

      2. Remove the read-only attribute from the transport files to prevent import issues to your SAP system.

        For more information about the contents of the sub-folders of the Transports folder, see Transport Sub-folder Contents.

      3. Use the SAP Transport Management System (STMS) or the operating system executable program to import the required transport.
        Ignore the warnings.

      4. Extract the uc_support.zip file located under directory transports on the Control-M for SAP root directory to a temporary directory.

      5. Import the transport QW1K900062 from the extracted files.

      6. Open transaction SE38 and execute the following program:

        /BMCCTRLM/RUN_CHANGE_TO_UNICOD

        The program updates the Control-M FMs to run SAP Unicode systems.

Differences Between XBP BAPIs and Control-M Function Modules

The following table describes the differences between XBP BAPIs and Control-M FMs.

Y indicates that the BAPI has the action.

Action

XBP 1.0 BAPI

XBP 2.0 BAPI

XBP 3.0 BAPI

Control-M Function Modules

Parent/Child (Mass Parallel) Functionality

 

Y

Y

 

Intercept Functionality

 

Y

Y

 

Enhanced Extract Functionality

 

Y

Y

 

Basic Extract Functionality(ctmextract)

 

 

 

Y

(Works partially without Control-M FMs)

Raise SAP Events

 

Y

Y

Y

Submit an Event-Based Job

 

Y

Y

 

Batch Input Functionality

 

 

 

Y

Submitting Data Archiving Jobs

 

Y

Y

Y

Detecting and Releasing Data Archiving jobs

 

Y

(Using the Parent/Child and the Interception functions)

Y

(Using the Parent/Child and the Interception functions)

Y

Job Class (A, B) in Create Mode

 

Y

Y

Y

Preventing Duplication in Extracting jobs from SAP

 

Y

Y

Y

Support for External Command

 

Y

Y

 

Spool List Recipient in Create job Mode

 

Y

Y

 

Additional Print and Archiving Job Step Parameters

 

Y

Y

Y

Improved Faster Mechanism for Tracking Jobs in SAP

 

Y

Y

 

Configure Job log Retrieval

Y

Y

Y

 

Opersys Cover Page Parameter

 

Y

Y

 

CP and NP Options in Variant Selection

 

Y

Y

 

Parameters for Time of Printing (Print Immediate, Print Later, or Send to SAP Spooler)

 

Y

Y

 

Use Logon Groups

Y

Y

Y

 

Application Logs and Status Support

 

 

Y

 

Load and Action Requests

ABAP Programs List

 

Y

Y

Y

Variants List

Y

Y

Y

 

Show Variant

 

Y

Y

Y

Variant Copy

 

Y

Y

Y

Variant Change

 

Y

Y

Y

Output Devices (Printers) List

 

Y

Y

 

Layouts (Print Formats)

 

Y

Y

 

Load Job Server Groups

 

Y

Y

 

Load External Command

 

Y

Y

 

Load for Distribution List

 

Y

Y

 

Load Owner

 

Y

(Supported when working with SAP 6.20 or above)

Y

(Supported when working with SAP 6.20 or above)

 

Load Event

 

 

Y

Y

View Job Steps

Y

Y

Y

 

Manage Event History Profiles

 

 

Y

 

Manage Interception Profiles

 

 

Y

 

Differences Between SAP Business Warehouse and Control-M Function Modules

Some actions are performed by Control-M FMs instead of the standard SAP BAPIs with SAP-BW.

The following table describes the major differences in actions performed by BW 2.x BAPIs, BW 3.x or higher BAPIs, and Control-M FMs:

Action

BW 2.x BAPI

BW 3.x or above BAPI

Control-M Function Modules

Start I/P

Y

Y

 

Monitor I/P

Y

Y

  

I/P Output

 

Y

Y

Get Background Job

Name/Count

 

 

Y

Set Background Job Name

 

Y

Y

Display the Number of Records Transferred and Requested of an I/P Run

    

Y

Start P/C

 N/A

Y

  

Monitor P/C

 N/A

Y

  

Restart P/C

N/A

Y

 

P/C Output

 N/A

Y

  

Process Chains (P/C) capabilities are only available in SAP-BW 3.x systems or higher.

Importing Transport Sub-Folders

This procedure describes how to import the transport sub-folder that is needed to authorize Control-M users.

Begin

  1. Import the required transport into Client 000. For more information, see Control-M for SAP Installation.

  2. Create a local transport and import it to the target client.

  3. Define the SAP System User Type to Control-M for SAP.

Transport Sub-folder Contents

The following table lists the contents of the sub-folders in the Transports folder.

Transport Name

Description

SAP_R3

Enables you to use any of the Control-M FMs.

Install this transport before installing any other transports.

BW

Enables you to use the BW-related FMs.

Install this transport only after installing the SAP_R3 transport.

DA

Enables you to use the Control-M Data Archiving functionality.

Install this transport only after installing the SAP_R3 transport.

Do NOT install this transport on SAP release 4.5B.

AUTH

Enables you to use the Control-M authorization role.

Uninstalling Control-M for SAP from UNIX

This procedure describes how to uninstall Control-M for SAP from UNIX.

Before You Begin

  • Stop all jobs on the Agent.

Begin

  1. Log in to the Agent and run the following command to shut it down:

    $CONTROLM/scripts/shut-ag -u <agentUser> -p all

    If the Agent has a root user, log in as the root user.

  2. Set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.

  3. Navigate to the $HOME directory and run the following command:

    • Interactive Uninstall: ./BMCINSTALL/uninstall/DRRMC.9.0.00/uninstall.sh

    • Automatic Uninstall: ./BMCINSTALL/uninstall/DRRMC.9.0.00/uninstall.sh -silent

  4. Run the following command to restart the Agent:

    $CONTROLM/scripts/start-ag -u <agentUser> -p all

Control-M for SAP is now uninstalled from your UNIX Agent.

Uninstalling Control-M for SAP from Windows

This procedure describes how to uninstall Control-M for SAP from Windows.

Before You Begin

  • Stop all jobs on the Agent.

Begin

  1. Log in to the Agent as an Administrator.

  2. Open a command prompt window as an Administrator, and run the following command using the full path:

    <Agent Install Path>\BMCINSTALL\uninstall\DRRMC.9.0.00\uninstall.exe -silent

Control-M for SAP is now uninstalled from your Windows Agent.

To review the installation log, navigate to the %TEMP% directory.

Uninstalling the Control-M Option for SAP R/3 Jobs Conversion Utility

This procedure describes how to uninstall the Control-M Option for SAP R/3 jobs conversion utility.

Begin

  1. Navigate to the following directory:

    %TEMP%

  2. Delete the directory and all its contents.

The Control-M option for SAP R/3 jobs conversion utility is now uninstalled from your Agent.