Defining Build-and-Deploy Modes for Automation Plug-ins

Note:

The information in this topic applies as of release OSM 7.0.3. Design Studio uses only the Legacy build-and-deploy mode for earlier releases.

When you deploy cartridges with automation plug-ins to your OSM run-time environment (automation plug-ins for automation tasks as well as for activation tasks), you can define a configuration to have Design Studio build and deploy automation plug-ins in a particular way. Prior to OSM 7.0.3, when you built and deployed a cartridge that included automation plug-ins, OSM ran each automation plug-in in that cartridge in its own separate EAR file; this method of building and deploying automation plug-ins is now referred to as the Legacy build-and-deploy mode. Legacy mode simply refers to the manner in which automation plug-ins were deployed and executed prior to OSM 7.0.3. As of release OSM 7.0.3, you can build and deploy a cartridge in Design Studio using the Optimized build-and-deploy mode, the default mode; this mode improves the performance of processing of automated or activation tasks and improves the performance of build and deployment of cartridges with such tasks.

Note:

The Legacy build-and-deploy mode is deprecated, but it is supported for backward compatibility.

Note:

XML Catalog support is required to be enabled for all cartridges as of release OSM 7.0.3.

About Build-and-Deploy Modes for Automation Plug-ins

Build-and-deploy modes for automation plug-ins affect how the plug-ins are processed at run time. See Defining Build-and-Deploy Modes for Automation Plug-ins for introductory information on build-and-deploy modes. A dispatch mode setting on the OSM server controls the automation plug-in dispatch mode of the OSM system, which is directly related to the build-and-deploy mode you configure in Design Studio. The build-and-deploy mode configured in Design Studio controls building and deploying the automation components required for Legacy mode or Optimized mode; it can also be configured to build and deploy the automation components required for both modes.

The Optimized mode enables the automation plug-ins to be deployed and executed more efficiently (automation plug-ins can run in a common EAR file).
The Legacy mode deploys and executes the automation plug-in in a manner consistent with previous OSM releases (each automation plug-in runs in its own EAR file).
The mode entitled Both (Allow server preference to decide) indicates the automation plug-in can run in either Optimized or Legacy mode (Design Studio builds the cartridge with the automation components required for either mode).

If you build and deploy the automation components required for both modes, OSM executes the automation plug-in at run time in the mode specified by the dispatch mode setting on the OSM server. See the discussion on automation plug-in dispatch modes in OSM Developer's Guide for information on how to define the dispatch mode setting on the OSM server.

The following table summarizes the effective mode OSM uses at run time based on how the automation plug-in build-and-deploy mode and the server dispatch mode are set as of OSM 7.0.3:

Automation Plug-in Build-and-Deploy Mode (set in Design Studio)	OSM Server Dispatch Mode	Effective Mode Used at Run Time
Optimized	Legacy	Optimized
Optimized	Internal	Optimized
Legacy	Legacy	Legacy
Legacy	Internal	Legacy
Both	Legacy	Legacy
Both	Internal	Optimized

You can set the automation plug-in build-and-deploy mode in two levels:

Global preference: Set the mode for all cartridges in the same workspace by setting a global preference. To specify a build-and-deploy mode for all cartridges in the same workspace, see "Setting Automation Plug-in Build-and-Deploy Modes for All Cartridges"
Cartridge-level preference: Set the mode for individual cartridges by setting a cartridge management variable. To specify a build-and-deploy mode for individual cartridges, see "Setting Automation Plug-in Build-and-Deploy Modes for Individual Cartridges".

Note:
The cartridge-level preference overrides the global preference.

Design Studio uses the following build-and-deploy modes when a cartridge is deployed:

If the Target Version field is set to an OSM release of OSM 7.0.3 or later; for example, set to 7.0.3, Design Studio uses the build-and-deploy mode that you set for the individual cartridge (the default mode is Optimized) or the mode you set as the global preference.
If the Target Version field is set to 7.0.1 or below, the Design Studio build-and-deploy mode is set to Legacy and cannot be changed.

Note:
Optimized mode is not available when using releases OSM 7.0.2 or earlier.

Setting Automation Plug-in Build-and-Deploy Modes for All Cartridges

You can set the build-and-deploy mode of automation plug-ins for all cartridges in the same workspace as a global preference.

To set the automation plug-in build-and-deploy mode for all cartridges:

From the Window menu, select Preferences, then select Oracle Design Studio, and then select Order and Service Management Preferences.
In the Build and Deploy Mode field, do one of the following:
- To build and deploy cartridges so that automation plug-ins are run in a common EAR file (deploys and executes automation plug-ins more efficiently), select Optimized.
- To build and deploy cartridges so that each automation plug-in is run in its own EAR file (deploys and executes the automation plug-in in a manner consistent with previous OSM releases), select Legacy.
- To build and deploy the automation components for both Optimized and Legacy modes, select Both (Allow server preference to decide).
  
  If you set this option, the automation plug-in can execute at run time in either Optimized mode or Legacy mode because the automation components required for both are built and deployed. In this case, OSM uses the automation plug-in dispatch mode defined on the OSM server at run time.
Design Studio builds and deploys all cartridges with the mode you specify as a global preference.

Note:
Cartridges for which you have a set a different build-and-deploy mode at the cartridge level will build and deploy in that mode.

Note:
Oracle recommends using Optimized mode because this mode improves the performance of building and deploying cartridges that include automation plug-ins. See OSM Developer's Guide for information on how performance is improved.
Click OK.

Design Studio saves your deployment preferences and closes the Preferences dialog box.

Setting Automation Plug-in Build-and-Deploy Modes for Individual Cartridges

You can set the build-and-deploy mode of automation plug-ins for each cartridge in your workspace. Setting the build-and-deploy mode for an individual cartridge overrides the build-and-deploy mode set as a global preference; that is, OSM uses the mode you set at the cartridge level at run time.

To set automation plug-in build-and-deploy mode preferences for a specific cartridge in your workspace:

From the Studio menu, select Show Design Perspective.
In the Studio Projects view, double-click the Project entity for which you want to set the build-and-deploy mode preference.

The project opens in the Project editor.
Click the Cartridge Management Variables tab.
In the Name column, click the BUILD_DEPLOY_MODE variable.
In the Default Value column, do one of the following:
- To build and deploy this cartridge so that automation plug-ins are run in a common EAR file (deploys and executes automation plug-ins more efficiently), enter optimized.
- To build and deploy this cartridge so that each automation plug-in is run in its own EAR file (deploys and executes the automation plug-in in a manner consistent with previous OSM releases), enter legacy.
- To build and deploy the automation components for both Optimized and Legacy modes, enter both.
  
  If you set this option, OSM uses the automation plug-in dispatch mode defined on the OSM server at run time.
Click Save.