Deploying service modules

After you develop and test a service module in IBM Integration Designer and are satisfied that the module is working as designed, you can deploy it into the runtime environment. Use the information in this topic to prepare for and complete a successful deployment.

IBM® Business Process Manager enables you to deploy and run business integration components such as BPEL business processes, human tasks, business state machines, business rules, and other components. You can also run mediation flows that are contained in modules or mediation modules.
Restriction: The explanation and steps in this topic do not apply to Advanced Integration services, which are installed with the process applications that use them.
IBM Integration Designer extends the deployment capabilities of the Rational® Application Developer base on which it is built. You can deploy your modules in one or more of the following ways:
  • As EAR files for deployment on Process Server, using the administrative console or command-line tools.
  • As serviceDeploy files for deployment on Process Server, using the serviceDeploy command-line tool.
  • As project interchange files for import and project sharing in IBM Integration Designer.

Overview of the deployment process

When you are ready to deploy your module, follow these general steps.

  1. Verify a new or updated module in a test environment before deploying it to the runtime environment. For information, see the "Testing Modules" link at the end of this topic.
  2. Understand the dependency and packaging considerations for modules and libraries. In addition, be aware of the deployment implications when you change a library or module name. You can find links to information about dependencies and packaging at the end of this topic.
  3. If you plan to deploy on a cluster, make sure that you understand the specific requirements described in "Considerations for deploying modules on clusters."
  4. As necessary, set module deployment properties.
  5. Export the module from IBM Integration Designer. Note that exported modules can be shared.
  6. Deploy the module.
    Note: The process for deploying service modules in a production environment is similar to the process described in "Developing and deploying applications" in the WebSphere® Application Server Network Deployment information center. If you are unfamiliar with those topics, review them first.
Tip: When an enterprise archive (EAR) file is deployed and includes a mediation, a GovernanceData folder is generated with application details. The data is processed, but it is not used unless you configure the Endpoint Lookup mediation primitive or the Policy Resolution mediation primitive. See Governance in the IBM WebSphere Enterprise Service Bus information center. The processing of the governance data requires a UTF-8 file encoding. If your Java virtual machine (JVM) is using a different encoding, the characters that do not match with UTF-8 encoding cause a processing error. The JVM defaults to the operating system file encoding, but you can change it to UTF-8 with a file.encoding JVM property with a value of UTF-8. Create a property as described in Java virtual machine custom properties in the IBM WebSphere Application Server information center.