Installing the Agent for SAP

This topic guides you through the installation of an SAP agent in an AE system without using authentication. If you want to use one of the authentications methods available you need to follow additional installation steps. For more information, see Agent Authentication.

Tip! This page refers only to the manual installation process. If you want instructions on how to install a containerized Java agent, see Installing Containerized Java Agents.

Notes:

• It is best to install the agent in a separate directory (such as C:\AUTOMIC\AGENT\SAP).
• It is not required to install the agent on the same computer as the SAP system.

This Agent supports sending emails using SMTP and SMTPS. For more information, see Setting Up Email Connections.

Requirements

• The following SAP support packages are required for using the job options No printing, Report send status and Report status by mail for spool-list receivers:

  • For 4.6C: SAPKB46C52

  • For 6.20: SAPKB62059

  • For 6.40: SAPKB64017

  • For 7.00: SAPKB70008

  For more information, see SAP ABAP, Java and PI

• No minimum support package is needed for higher SAP releases.

• For the SAP Solution Manager 7.2 integration:
  Implement the fixes referred to in the SAP notes 3067559 and 3050832

Make sure you have the following information before starting the installation:

• Access to the SAP Service Marketplace (http://service.sap.com): Name and Password

• SAP user administrator:Name and Password

• (Optional) SAP Transport-system administrator:

  • when using the AE interface, Name and Password of the SAP System administrator

  • when operating the system with SAP GUI, Name and Password of the SAP Transport -system administrator

• Parameter for RFC access to the particular SAP system:

  • Name of the SAP System

  • Host name of an SAP instance or SAP Router String - host

  • SAP system number sysnr

  • (Optional) Computer name or SAP Router String of the Message Server lb_host

  • (Optional) Logon group Ib_group

• Access to the operating system.

• TCP/IP access to the Automation Engine.

• Agent name.

• AE Installation directory.

• Access to the AE system client 0: Name and Password

Connecting to the Automation Engine

The Automation Engine and the Windows, UNIX, and Java Agents communicate using TLS/SSL. These agents establish a connection with the Java communication process (JCP), which uses trusted certificates to prove their identity to other communication partners.

Important! Make sure you are familiar with the TLS/SSL and certificate implementation before installing and/or upgrading the respective component. For more information, see:

• TLS/SSL Considerations for Automic Automation

• Securing Connections to the AE (TLS/SSL)

When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default; that is the Java trust store for Java components and Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. In this case, you only have to check that the root certificates already are in the respective store.

If the relevant certificates are not there and you want to import them, you can use OS or Java specific tools for that purpose, such as Keytool, cert-manager, OpenSSL and such. For more information on how to use those tools, please refer to the respective product documentation.

If you do not want to use the default locations for the components and Agents listed above, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

Important! TLS/SSL Agents (in containers and on-premises) as well as the TLS Gateway, when used for the Automic Automation Kubernetes Edition, establish a connection to an ingress / HTTPS load balancer, which requires a certificate for authentication.

Make sure that address of the load balancer is defined on both sides: the Automation Engine and the Agent / TLS Gateway and that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to AWI, the JCP and REST Processes Using an Ingress.

Installing the Agent for SAP

1. Install the Microsoft Visual C++ 2017 Redistributable Package (Windows).

   As of JCo 3.0.0, JCo running on Windows the Visual Studio 2005 C/C++ runtime libraries are required. For more information, see SAP note 684106.

   You can skip this step when the required version of the package is already installed. You can access the installed programs through the computer's Control Panel to check if the package is available, and if so, which version.

2. On the admin and/or user computer where the Agent is installed, install the Java Runtime Environment (JRE).

   If you have JRE installed, you can ignore this step. For a list of compatible java versions, see compatibility matrix

   Use the following command to check the version of the current Java virtual machine (VM):

   java -version

   If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the directories is correct in the %PATH% or $PATH settings since the first JRE that is found in the list of directories is used.

   SAP note 684106 describes what JREs are supported.

3. On the host, install the Agent

   UNIX

   1. Log in using the AE user.

   2. Transfer the file UCXJR3X.tar.gz to a directory (i.e. sap).

   3. Switch to the sap directory: cd sap.

   4. Unpack the .tar file:

      gzip -d UCXJR3X.tar.gz

      tar xvfo UCXJR3X.tar

      Make sure all files have been unpacked correctly and to note all .tar messages, which can come from various owners. After that you can delete the .tar file if you like.

   5. Make sure all files have the correct owner and group entries.

   6. Rename the supplied INI file ucxjr3x.ori.ini to ucxjr3x.ini.

   7. Adjust the INI file to your system environment.

      When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates already are in the respective store.

      If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

      For more information, see Securing Connections to the AE (TLS/SSL).

   WINDOWS

   1. Switch to the subdirectory: IMAGE:AGENTS\SAP\WINDOWS.

   2. Run SETUP.EXE to start the program.

   3. Adjust the INI file of the SAP agent to your system environment. For more information, see Agent SAP.

      When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates already are in the respective store.

      If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

      For more information, see Securing Connections to the AE (TLS/SSL).

   4. Adjust the HEADER.SAP, TRAILER.SAP, RESTART.SAP or HEADER.SAPBW, TRAILER.SAPBW and RESTART.SAPBW as necessary. For more information, see Executing Jobs.

      The SAP agent is an AE background program and it is generally started as a service in the ServiceManager. For more information, see ServiceManager.

4. On the hosts computer, install the SAP Java Connector.

   Note: The archive of the SAP Java Connector (<sapjco-install-path>/docs/jco/intro.html) comprises a detailed configuration and installation guide. Make sure you read it carefully to make sure that everything works correctly.

   1. Check the SAP agent requirements to see which Java Connector version is supported.

      Install the 32bit SAP Java Connector if you use 32bit Java. 64bit Java requires the 64bit SAP Java Connector.

   2. Download the SAP Java Connector from the SAP Service Marketplace and install it (Support Portal > Downloads > SAP Connectors > SAP Java Connector > Tools & Services).

   3. Copy the SAP Java Connector files to the BIN directory of the Agent.

      The SAP note 636912 includes information that can be used to verify that the Java Connector has correctly been installed.

   4. Test the installation using the following command: java -jar {path-to-sapjco.jar}/sapjco.jar –stdout.

      On Windows you can double click on sapjco.jar. No error messages should be displayed.

5. On the host computer, import the AE Interface.

   This installation step is only required if you intend to use the AE interface.

   1. Copy the transport files.

   2. Import the transport.

      For more information, see Transporting the CA Automic Extension

6. Create a System User in SAP.

   1. Log in to the SAP system using the SAP user administrator.

   2. Create an authorization profile either directly or with a role. For more information, see SAP Security Objects.

      Create a user and assign the authorization profile or role.

      The SAP System user must be created with the same password in each SAP client in which you want to run jobs.

7. Create Connection Objects The SAP agent requires login data to log on to the various SAP areas.

   1. Open AWI and log into Client 0.

   2. Create an extra Connection object for the SAP areas to be used with the SAP agent.

      You require at least one Connection object for the ABAP Basis in which you specify the SAP System user. All other Connection objects are optional. For more information, see Connection (CONN).

   3. In the Connection object, select the type and enter your login data:

      • SAP: ABAP Basis, see Executing Jobs in ABAP Stack (CCMS)

        Connection type: Remote Function Call

      • SAP: Java Basis, see Executing Jobs in Java Stack (JXBP)

        Connection type: Internet

      • SAP: Process Integration, see Best Practices for the Automic Automation / SAP Integrstion

        Connection type: Internet

      • SAP: System Landscape Directory, see Registering to System Landscape Directory (SLD)

        Connection type: Internet

8. Set Up the Agent object.

   1. Switch to the folder HOST.

   2. Create an Agent object.

   3. As agent name, use the same name as specified in the name= parameter of the INI file of the SAP agent.

   4. Open the Agent object and switch to the Agent page and select Connection objects for each connection type you will use in the SAP Connections section.

   5. Save and close the Agent object.

9. Start the Agent.

   1. Make sure that the AE system is running on the server computer. For more information, see Multi-Server Operations.

   2. On the host, start the Agent with the following commands:

      • Windows: <path to java> -Xrs -Xmx1G -jar ucxjr3x.jar

        If java is installed in a folder which contains spaces the command needs to be placed in quotes.

        Example

        "C:\Program Files (x86)\Java\jre7\bin\java" -jar -Xrs -Xmx1G ucxjr3x.jar

      • UNIX: <path to java> -Xmx1G -jar ucxjr3x.jar

        Example

        /usr/bin/java -jar -Xmx1G ucxjr3x.jar

        If the SAP Java Connector cannot load its native library the parameter -Djava.library.path can be used to point to a directory which contains the libsapjco3.so.

      Use the ServiceManager to start or end the Agent as a service. For more information, see ServiceManager.

   3. In AWI, client 0, verify that the Agent is logged on to the Automation Engine.

      Newly logged on Agents are not assigned to a client automatically and can only be viewed in Client 0. Once you have logged in to Client 0, access the Administration perspective and select Agents & Groups.

      Assign the new Agent to clients with the required rights using the Agent object definition. For more information, see Authorizations Page.

10. Run a functional test.

    1. Start a test job.

       Create a LOGIN object and an SAP_ABAPJob. Use the syntax <sap client>,<user> for the user info in the LOGIN object Make sure that the checkbox for the Agent log report is selected in the Job object.

       Example script for the test job:

       R3_ACTIVATE_REPORT REP=RSM04000_ALV,COVERPAGE=YES

       The current ABAP creates a list of actual users.

    2. Monitor the process in Process Monitoring.

       It can take a couple of seconds for the system to register that the job is done. The agent checks at an increasing interval whether the job is still running. This is done in order to capture short running Jobs early. The status check interval increases the longer the Job runs. The maximum value can be specified in the UC_HOSTCHAR_DEFAULT variable. For more information, see UC_HOSTCHAR_DEFAULT - Host Characteristics.

    3. Check the job report (PLOG and REP)

    4. Check the agent logins in the log file.

    5. On the SAP system:

       • Check the log entries from the current period with the transaction RZ15 (only when using the standard interface).

       • Shut down the agent.

See also:

• Installing the Agents
• Agent SAP INI file