Installing the Adapter

Overview

This chapter explains how to use the IBM webMethods Installer wizard to install, upgrade, and uninstall webMethods SOPERA Adapter 8.0. For complete information about other installation methods or installing other webMethods products, see the Installing IBM webMethods Products On Premises for your release.

This IBM webMethods Adapter for SOPERA Installation and User’s Guide refers to the main installation directory as IBMwebMethods_directory.

Requirements

For a list of the operating systems and products supported by SOPERA Adapter, see IBM webMethods Adapters System Requirements, available in the webMethods area of the webMethods.io Documentation Website.

Installing the Adapter

About this task

The instructions in this section are meant to be used with the more complete instructions in the Installing IBM webMethods Products On Premises for your release.

Important: You must install the SOPERA ESB infrastructure before you install SOPERA Adapter.

To install SOPERA Adapter 8.0

Procedure

Download the IBM webMethods Installer .
If you are installing the adapter on an existing Integration Server, shut down Integration Server.
Start the IBM webMethods Installer wizard.

Choose the webMethods release that includes the Integration Server on which to install the adapter. For example, if you want to install the adapter on Integration Server 9.5, choose the 9.5 release.

If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server. If you are installing both the host Integration Server and the adapter, specify the installation directory to use. The Installer will install the adapter in the Integration Server_directory\packages directory.
In the product selection list, select Adapters > webMethods SOPERA Adapter 8.0.
To install documentation for webMethods SOPERA Adapter , on the Documentation panel in Installer, select Adapter Readmes and Documentation.
After the Installer completes the adapter installation, close the Installer.
Copy the following files from the SOPERA SBB_directory\lib directory into the Integration Server_directory\packages\ WmSoperaAdapter \code\jars directory:
- jax-qname-namespace.jar
- sbb-factory-impl.jar
- sbb-papi.jar
Copy the following files from the SOPERA infrastructure into the Integration Server_directory\packages\ WmSoperaAdapter \code\jars\static directory:
- login.jar
- sbb-se-core.jar
Copy the following files from the SOPERA AdminTool_directory\lib directory into the Integration Server_directory\packages\ WmSoperaAdapter \code\jars directory:
- jaxmeapi-0.5.1.jar
- jaxmexs-0.5.1.jar
- jaxme2-0.5.1.jar
- jaxme2-rt-0.5.1.jar
- privilegemanagement-jaxb.jar
- privilegemanagement-proxy.jar
- sbb-admin-tool.jar
- sbb-configrepos-scopepath.jar
- sbb-instance-proxy-plugin.jar
- sbb-proxy-util.jar
- sbb-toolsuite-service-utilities.jar
- sbb-toolsuite-common.jar
- userAccountManagement-proxy.jar
- userAccountManagement-jaxb.jar
Complete the installation as described in Completing the Installation.
Start the host Integration Server.

Completing the Installation

To complete the installation, you must perform the following tasks before start up.

Set SOPERA Specific Properties in the SOPERA Adapter Configuration File

About this task

To set the properties in the sopera.config file

Procedure

Navigate to the Integration Server_directory\packages\ WmSoperaAdapter \config directory.
Open the sopera.config file in a text editor.

Specify the properties as described in the following table:

Property	Description/Action
org.sopware.sbb.home	Required. Set to the home directory of the SOPERA SBB Library installation on the local system. For example, `C:\SOPERA\ServiceBackbone`
org.sopware.admintool.home	Set to the home directory of the SOPERA Admin Tool location on the local system. This parameter is required. For example, `C:\SOPERA\AdminTool`
org.sopware.transport.http.enable	Optional. Set the HTTP inbound transport for the SOPERA SBB Library. Valid values are: `true` Enables HTTP. This is the default value. `false` Disables HTTP.
org.sopware.transport.http.port	Optional. Set the HTTP inbound port for the SBB Library running on the Java VM. If you do not specify a value, the adapter will throw an error when you attempt to enable the adapter notification.
org.sopware.transport.https.enable	Optional. Set the HTTPS inbound transport for the SOPERA SBB Library. Valid values are: `true` Enables HTTPS. `false` Disables HTTPS. This is the default value.
org.sopware.transport.https.port	Optional. Set the HTTPS inbound port for the SOPERA SBB Library running on the Java VM.
org.sopware.transport.https.keystore	Optional. Set the file name of the keystore used by the SOPERA SBB Library for enabling the HTTPS transport.
org.sopware.transport.https.password	Optional. The password for accessing the keystore used by the SBB Library for enabling the HTTPS transport.
org.sopware.transport.https.clientauth	Optional. Set client authentication for the HTTP or HTTPS inbound transport. Valid values are: `true` Enables client authentication. `false` Disables client authentication. This is the default value.

Note: You can remove or comment the optional properties in the sopera.config file. For details about these system properties, see the SOPERA configuration reference guide.

Save and close the file.

Configure the IS Login Module

About this task

You use the IS Login Module to authenticate a SOPERA user against a SOPERA infrastructure.

The IS Login Module is a JAAS login module that is automatically installed as part of the SOPERA Adapter installation. By default, the IS Login Module is not enabled. For more information about SOPERA user authentication, see User Authentication.

To configure the IS Login Module

Procedure

Configure central user management as described in the IBM webMethods Integration Server Administrator’s Guide for your release.

Central user management is required to store and manage information about SOPERA users.
Navigate to the Integration Server_directory\config directory.
Open the is_jaas.cnf file in a text editor.
Edit the file as follows:
1. Add the following code in the IS_Transport section to include the WmLoginModuleIS login module. Set the authenticationTSPEndpoint parameter to point to your token service:
```
IS_Transport  
{  
        com.softwareag.security.login.webmethods.WmLoginModuleIS 
sufficient  
   create_user_principal=true  
          auth-type=auth-id-password  
          authenticationTSPEndpoint=     
              "http://SOPERAInfrastructureServer:18080/TokenService/services/Trust"  
          soapRequestTemplateFile="config/sts-request.template";  
  
        com.wm.app.b2b.server.auth.jaas.X509LoginModule requisite;  
        com.wm.app.b2b.server.auth.jaas.BasicLoginModule requisite;  
};
```
  where SOPERAInfrastructure Server is the hostname of your actual SOPERA infrastructure server, for example: "http://localhost:18080/TokenService/services/Trust"
2. Configure incoming SOPERA call authentication. SOPERA Adapter verifies the authentication information it receives from an incoming SOPERA call and creates an Integration Server session for it. This configuration is required only when SOPERA Adapter invokes an Integration Server service that does not have the anonymous ACL for execution. To enable incoming call authentication, add the following section:
  
  Note: The values for verificationKeystore and verificationKeystorePwd parameters will depend on your environment.
```
sopware.auth-token-checking {  
    org.sopware.security.login.webmethods.WMLoginModule REQUIRED  
    auth-type=auth-token-checking  
    expiryClearance="525600"  
    verificationKeystore="/Users/root/keystore.jks"  
    verificationKeystorePwd="atleast8"  
    verificationCertAlias="client"  
    verifyTrustChain="false"  
    cacheCleanupInterval="5"  
    samlAttributeForPrincipalName="pxpUid";  
};
```
Save and close the is_jaas.cnf file.
Copy the sts-request.template file from the Integration Server_directory\packages\ WmSoperaAdapter \config directory into the Integration Server_directory\config directory.
Restart Integration Server for the changes to take effect.
Log on to Integration Server Administrator as Administrator and go to Security > Access Control Lists.
Add the group of SOPERA users named SOPUsers to the ACL that you require.
For example, if you want to log on as Administrator in Integration Server Administrator with a SOPERA user, you can add the SOPUsers group to the Allowed ACL list as described in the IBM webMethods Integration Server Administrator’s Guide for your release.

Configure the MWS Login Module

About this task

When you use IBM My webMethods Server and you want to log on to IBM My webMethods Server using a SOPERA user, you must configure the MWS Login Module. The IBM My webMethods Server portlets that you must deploy are packaged with SOPERA Adapter and are located in the Integration Server_directory\packages\WmSoperaAdapter\portlets directory.

Note: Configuring the MWS Login Module is required only when you want to use My webMethods interfaces to access Integration Server. If you are using only Integration Server Administrator, configure only the IS Login Module as described on Configure the IS Login Module.

To configure the MWS Login Module

Procedure

Configure central user management as described in the IBM webMethods Integration Server Administrator’s Guide for your release.

Central user management is required to store and manage information about SOPERA users.
Copy the is_jaas.cnf file from the Integration Server_directory\config directory into the My webMethods Server_directory\default\config directory, and then rename the file to sopera_login.properties.

Important: If you want to use only MWS Login Module and you have not configured IS Login Module, you must edit the is_jaas.cnf file as described in step 4a in Configure the IS Login Module.
Copy the sts-request.template file from the Integration Server_directory\packages\ WmSoperaAdapter \config directory into the My webMethods Server_directory\default\config directory.
Install both portlets, wm_sopera_auth.pdp and wm_sopera_login.pdp, using My webMethods:
1. Log on toIBM My webMethods Server as system administrator.
2. Navigate to Administration > Configuration > Install Administration.
3. Click Install New Component.
4. Specify the Integration Server_directory\packages\ WmSoperaAdapter \portlets directory as the location for the portlets.
5. Click Next.
6. Click Install.
If the portlets are installed successfully, you will get a confirmation message verifying that the install succeeded. If the installation fails, check your log files to troubleshoot the installation failure. For more information about how to install portlets, see the Administering IBM My webMethods Server for your release.
Copy the login.jar file and the login-webmethods.jar file from the Integration Server_directory\packages\ WmSoperaAdapter \code\jars\static directory into the following location in the wm_sopera_auth portlet installation: My webMethods Server_directory\server\default\system\wm_sopera_auth\lib
Create a custom login page as follows. With this custom login page, you can log on as both a SOPERA user and a normal IBM My webMethods Server user. For detailed instructions for each of these steps, see the Administering IBM My webMethods Server for your release.
1. Log on to IBM My webMethods Server as system administrator.
2. Go to the Public Folders and add a new page from the Tools menu.
3. Add the SOPERA login portlet from Portlets > System to the new page.
4. Ensure that the authentication scheme for your custom login page and the SOPERA login portlet is Anonymous.
5. Create a new login rule that invokes the new custom login page. Ensure that this rule is the first to be executed.

Upgrading from SOPERA Adapter 7.1

About this task

To upgrade and migrate from SOPERA Adapter 7.1 to SOPERA Adapter 8.0

Procedure

Back up your existing SOPERA Adapter 7.1 installation and all custom packages.
In Integration Server Administrator, go to Packages > Management and locate the WmSoperaAdapter package.
To uninstall SOPERA Adapter 7.1, select Safe Delete. The existing installation is deleted and preserved for reference.
Install SOPERA Adapter 8.0 as described in Installing the Adapter.
Complete the installation as described in Completing the Installation.

Uninstalling the Adapter

About this task

The instructions in this section are meant to be used with the uninstallation instructions in the Installing IBM webMethods Products On Premises for your release.

To uninstall SOPERA Adapter 8.0

Procedure

Shut down the host Integration Server. You do not need to shut down any other webMethods products or applications that are running on your machine.
Start the IBM webMethods Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > webMethods SOPERA Adapter 8.0.
After the Uninstaller completes, restart the host Integration Server.
The Uninstaller removes all SOPERA Adapter 8.0-related files that were installed. However, it does not delete files created after you installed the adapter (for example, jar files copied into Integration Server_directory\packages\ WmSoperaAdapter \ code\jars\static\ or configuration files, nor does it delete the adapter directory structure. You can go to the Integration Server_directory\packages directory and delete the WmSoperaAdapter directory.
The Uninstaller does not delete any user-defined SOPERA Adapter 8.0 components such as connections, adapter services, or adapter notifications. Because these components will not work without the adapter, delete them manually, either at the file system level or using Designer. For instructions, see the IBM webMethods Service Development Help.