Setting deployment properties and generating the service

To generate the module, which is the artifact that is deployed on IBM® Business Process Manager or WebSphere® Enterprise Service Bus, you create the module, associate the adapter with the module, and specify an alias used to authenticate the caller to the SAP server.

1. Optionally select Edit Operations if you want to change the default operation name. Then, in the Edit Operation Names window, type a new name and optional description, and click OK.
2. Indicate whether you will use an authentication alias (instead of typing a user ID and password) to establish a connection to the SAP server:
   • To specify an authentication alias, leave Specify a Java Authentication and Authorization Services (JAAS) alias security credential selected. Then, in the J2C Authentication Data Entry field, enter the name you specified in the Security section of the administrative console.

     If you are not going to use an authentication alias, clear Specify a Java Authentication and Authorization Services (JAAS) alias security credential.

   • To use a user ID and password, select Using security properties from the managed connection factory. Type in the user name and password to specify your security credentials.
   • To use other security mechanisms native to the enterprise system or if security is not required, select Other
3. Select With module for use by single application to embed the adapter files in a module that is deployed to the application server, or select On server for use by multiple applications to install the adapter files as a stand-alone adapter.
   Figure 1. Connection properties

   
   • With module for use by single application: With the adapter files embedded in the module, you can deploy the module to any application server. Use an embedded adapter when you have a single module using the adapter or if multiple modules need to run different versions of the adapter. Using an embedded adapter enables you to upgrade the adapter in a single module without the risk of destabilizing other modules by changing their adapter version.
   • On server for use by multiple applications: If you do not include the adapter files in a module, you must install them as a stand-alone adapter on each application server where you want to run the module. Use a stand-alone adapter when multiple modules can use the same version of the adapter and you want to administer the adapter in a central location. A stand-alone adapter can also reduce the resources required by running a single adapter instance for multiple modules.
4. If you selected On server for use by multiple applications in the previous step, the Connection properties list becomes active. Make one of the following selections:
   • Select Specify connection properties if you want to provide configuration information now. Then continue with step 5.
   • Select Use predefined connection properties if you want to use a connection factory configuration that already exists.

     If you decide to use predefined connection properties, you must ensure that your resource adapter name matches the name of the installed adapter, because this is how the adapter instance is associated with these properties. If you want to change the resource adapter name in the import or export, use the assembly editor in IBM Integration Designer to change the value in the import or export.

     When you select Use predefined connection properties, the JNDI Lookup Name field is displayed in place of the properties.

     1. Type a value for JNDI Lookup Name.
     2. Click Next.
     3. Go to step 8.
5. In the Connection properties section, set or change any connection properties that apply to your configuration.

   Notice that some of the values are already filled in. For example, the values that you used in the Specify the Discovery Properties window (such as the Host name) are filled in.

   Select the Use load balancing check box to use load balancing to connect to the SAP system. Load balancing properties which are Message server host, Logon group name and SAP system ID have to be specified in the Additional connection configuration panel under the Advanced tab.

   See Managed connection factory properties for more information about these properties.

   Properties marked with an asterisk (*) are required.

6. To set additional properties, click Advanced.
   1. Expand Processing methods for illegal XML characters
      1. From the Illegal XML character processing drop-down list, select one of the options that correspond to your requirement:
         • Do not validate illegal XML characters, if you want to work with the default adapter behavior.
         • Throw exception if contents in the BO contains illegal XML characters, if you want to proceed after you get an exception message, and log the illegal XML characters in the trace file, at runtime.
         • Discard all illegal XML characters and related logs, if you want the adapter to discard the illegal XML characters, and log the characters in the trace file, at runtime.
      Figure 2. Processing methods for illegal XML characters
   2. Optionally expand Additional connection configuration and provide values (or change the default values) for the fields in this section of the window. For example, if your SAP configuration uses load balancing, provide values for the Message server host field, Logon group name and SAP system ID. Select the Reset the JCO client after closing connection handle check box if during an outbound transaction, you want the adapter to make sure changes on the SAP EIS are reflected in the client. For Query interface transactions, the property does not have a functionality impact. It is recommended that you do not select the check box.
   3. Optionally, expand Advanced Security Configuration to specify your security mechanism. You can enable both Secure Network Connection (SNC) andSingle Sign On (SSO).
      • If you are using Secure Network Connection, select Enable Secure Network Connection. Enter information in the associated fields (name, partner, security level, and library path). If you select X509 certificate based authentication, the X509 certificate name has to be entered. Secure Network Connection has to be enabled to use X509 certiicate based authentication.
      • If you are using Single Sign On authentication, select Enable Single Sign On (SSO). Enter the SSO Logon Ticket in the field.
   4. Optionally to set RFC and JCo tracing properties, perform the following steps:
      1. Expand SAP RFC trace configuration and select RFC trace on.
      2. Select the Write JCo traces into adapter logs checkbox to enable JCo API traces to be generated in the broker trace file. These traces will then be interleaved with the adapter traces. Each JCo API trace logged into the broker trace file will have the string [JCoAPI]. All JCo API traces are logged at the INFO message log level.
      3. Select a tracing level from the RFC trace level list.
      4. Click Browse and select a location to which the RFC trace files will be saved.
   5. Optionally expand Logging and tracing and specify the following information:
      • If you have multiple instances of the adapter, set ,Adapter ID to a value that is unique for this instance.
      • If you want to mask sensitive information in log and trace files (for example, if you want to avoid making customer information visible in these files), select Disguise user data as "XXX" in log and trace files.

   See Managed connection factory properties for information about these optional properties.

7. Click Next. The Service Location Properties window opens.
8. Create a module.
   1. In the Specify the Location Properties window, click New in the Module field.
   2. In the Integration Project window, click Create a module project or Create a mediation module project and click Next.
9. In the New Module window, perform the following tasks:
   1. Type a name for the module.

      As you type the name, it is added to the workplace specified in the Location field.

      This is the default location. If you want to specify a different location, remove the check from Use default location and type a new location or click Browse and select the location.

   2. Specify whether you want to open the module in the assembly diagram (for module projects) or whether you want to create a mediation flow component (for mediation module projects). By default, these choices are selected.
   3. Click Finish.
10. In the Specify the Location Properties window, perform the following steps:
    1. If you want to change the default namespace, clear the Use default namespace check box and type a new path in the Namespace field.
    2. Specify the folder within the module where the service description should be saved by typing a name in the Folder field or browsing for a folder. This is an optional step.
    3. Optionally change the name of the interface.

       The default name is SAPOutboundInterface. You can change it to a more descriptive title if you prefer.

    4. If you want to save the business objects so that they can be used by another application, click Save business objects to a library and then select a library from the list or click New to create a new library.
    5. Optionally type a description of the module.
11. Click Finish.