IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > SAP Software > Configure the module for deployment > Configure the module for inbound processing > Configure a module for ALE pass-through IDoc inbound processing

Setting deployment properties and generating the service

To generate the module, which is the artifact that is deployed on IBM BPM or WebSphere Enterprise Service Bus, you create the module, include the adapter in the module, and specify an alias used to authenticate the caller to the SAP server.

Make sure you have all the information needed to complete the Specify the Service Generation and Deployment Properties window and that you have performed any prerequisite tasks.

For example, a program ID must be registered on the SAP server.

If you want to assure once-only delivery of inbound events by persisting events to an event recovery table, make sure a data source has been created to hold the table.

Generate the module, which includes the adapter and configured business object. The module is the artifact you deploy on the server.

To generate the module, use the following procedure.

Procedure

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 or type in 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 activation specification. 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. Specify the Service Generation and Deployment Properties window

   

   • 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, 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 an activation specification 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 9.

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.

   1. 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.
   2. Change the Host name field if you are planning to send events from a different SAP server than the one you are using to create the adapter module.

   3. In the RFC Program ID field, type the name of the program ID you registered with the SAP server.

   4. The Gateway host is filled in, by default, with the value from the Host name field.

   5. A default value of sapgw00 is filled in for Gateway service. If you have more than one gateway server in your SAP configuration, change sapgw00 to the correct value.

   6. The remaining values in the SAP system connection information section are filled in with the values you entered in the Specify the Discovery Properties window. Change these values, if necessary.

      See Activation specification properties for ALE inbound processing for more information about these properties.

      Properties marked with an asterisk (*) are required.

6. In the Event persistence configuration section, select the properties to retain events in memory. Selecting event persistence options ensures a once-only delivery of inbound events. If you do not select the options, performance increases, but there is a risk of losing events in transit if there is an unexpected shut down.

   1. The Ensure assured-once event delivery field is selected by default to get a once-only delivery of the inbound events. This may reduce performance.

   2. Select Auto create event table if you want the adapter to create an event table. This field is selected by default.

   3. Enter a name in the Event recovery table name field

   4. Enter the JNDI name in the Event recovery data source (JNDI) name field

   5. Enter the user name in the User name used to connect to event data source field

   6. Enter the password in the Password used to connect to event data source field

   7. Enter the database schema name in the Database schema name field

7. 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.

   3. You can expand Event polling configuration and specify values indicating how events should be polled on the SAP server.

      For example, you can enter a list of event types in the Event types to process field if you want to limit the events that the adapter should process. You can select Retry EIS connection on startup if you want the adapter to retry a failed connection when starting. See Retry EIS connection on startup.

   4. Optionally expand ALE event status configuration and select Ignore IDoc packet errors if you want to continue to processing an IDoc packet if any errors occur during IDoc processing. If you want to provide update status for ALE processing, select ALE update status and fill in the associated fields. Properties marked with an (*) are required. Select Send ALEAUD per packet if you want to send one ALEAUD per IDoc packet which will contain confirmations for all IDocs in the packet.

   5. If you are using Secure Network Connection, expand Secure Network Connection (SNC) Configuration and select Enable secure network connection. Then enter information in the associated fields (name, partner, security level, and library path). Optionally type the name of an X509 certificate.

   6. Optionally set a comma-separated list of Interceptor classes in the List of Interceptors field. These Interceptor classes act as User Exits and must implement the com.ibm.j2ca.extension.monitoring.interceptors.Interceptor Java™ interface. Refer to User Exits through Interceptors for more details on Interceptors.
      

   7. Optionally to set RFC and JCo tracing properties...
      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.

   8. 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 Activation specification properties for ALE inbound processing for more information about these properties.

8. Click Next.

9. 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.

10. 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.

11. In the Specify the Location Properties window, perform the following tasks:

    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 SAPInboundInterface. 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.

12. Click Finish.

Results

The new module is added to the Business Integration perspective.

What to do next

Export the module as an EAR file for deployment.

Configure a module for ALE pass-through IDoc inbound processing