About OSM Cartridge Management Variables

Design Studio for OSM provides the following default cartridge management variables:

Note:

Use the same default value for variables that are defined in multiple cartridges in a workspace. If different values are used, a warning appears in the Problems view.

Default Variable	Use
FAST_CARTRIDGE_UNDEPLOY	Enter true to undeploy a cartridge from OSM without purging cartridge metadata or order data, or enter false to purge cartridge metadata and order data during the undeploy operation.
PURGE_CARTRIDGE_BEFORE_DEPLOY	Enter true to undeploy the previous version of a cartridge before deploying the new version, or enter false to update the previous version of the cartridge with the changes in the new version. If both PURGE_CARTRIDGE_BEFORE_DEPLOY and FAST_CARTRIDGE_UNDEPLOY are set to true, the cartridge is undeployed using the fast undeploy option before it is redeployed. This is referred to as a fast redeploy. Note: If your cartridge has pending or completed orders that you do not want to purge, do not undeploy the cartridge, but deploy the new version with PURGE_CARTRIDGE_BEFORE_DEPLOY set to false.
ENTITY_CONFLICT_ACTION_ON_DEPLOY	Enter replace to replace the old entities with the new (default); enter ignore to add the new entities and retain the old; or enter abort to stop the process. This variable applies only if PURGE_CARTRIDGE_BEFORE_DEPLOY is set to false.
PURGE_ORDER_ON_UNDEPLOY	Enter true to purge all existing orders associated with the cartridge, or enter false if you do not want the system to undeploy the cartridge if it has pending orders. If both PURGE_ORDER_ON_UNDEPLOY and FAST_CARTRIDGE_UNDEPLOY are set to true, the operation is a forced fast undeploy, which aborts open orders; neither the cartridge nor associated orders are purged. If PURGE_ORDER_ON_UNDEPLOY is set to true and FAST_CARTRIDGE_UNDEPLOY is set to false, the operation is a forced undeploy, which purges the cartridge and associated orders. Caution: Undeploying a cartridge using the forced undeploy option purges all existing orders for that cartridge.

Note:

Oracle recommends that you do not remove any of the default cartridge management variables.

You can define and use the following optional cartridge management variables:

Optional Variable	Use
BUILD_DEPLOY_MODE	Enter optimized if you want to build the automation components for automation plug-ins to be able to run within a common (oms.ear) EAR file at run time. Enter legacy if you want to build the automation components for each automation plug-in to run in its own EAR file at run time. Enter both if you want to build the automation components for automation plug-ins to run in Optimized and Legacy modes. If you select both, OSM processes the automation plug-ins according to the automation plug-in dispatch mode that is set on the OSM server. See "Defining Build-and-Deploy Modes for Automation Plug-ins" for information on automation plug-in build-and-deploy modes. Tip: How you build and deploy automation plug-ins (the build-and-deploy mode) indicates whether you want the plug-ins to be able to run within the oms.ear file or not. The automation plug-in dispatch mode set on the OSM server indicates the ability for OSM to invoke an automation plug-in that is running within the bounds of the oms.ear file.
XML_CATALOG_SUPPORT	Enter enable if you want to enable XML Catalog support for this cartridge. Enter disable if you want to disable XML Catalog support for this cartridge. Note: XML Catalog support is enabled by default and is required to be enabled. When you deploy to some target run-time software versions, you can disable XML Catalog support. See "Working with XML Catalogs" for more information on using XML Catalogs.
UNDEPLOY_SHARED_CARTRIDGE	(Applies to composite cartridges only.) Enter true to force the undeployment of shared component cartridges within a composite cartridge. By default, the variable is set to false to prevent the undeployment of cartridges that are shared. See "Undeploying Composite Cartridges with Shared Component Cartridges" for more information.

Optional Variable

Use

BUILD_DEPLOY_MODE

Enter optimized if you want to build the automation components for automation plug-ins to be able to run within a common (oms.ear) EAR file at run time. Enter legacy if you want to build the automation components for each automation plug-in to run in its own EAR file at run time. Enter both if you want to build the automation components for automation plug-ins to run in Optimized and Legacy modes. If you select both, OSM processes the automation plug-ins according to the automation plug-in dispatch mode that is set on the OSM server.

See "Defining Build-and-Deploy Modes for Automation Plug-ins" for information on automation plug-in build-and-deploy modes.

Tip: How you build and deploy automation plug-ins (the build-and-deploy mode) indicates whether you want the plug-ins to be able to run within the oms.ear file or not. The automation plug-in dispatch mode set on the OSM server indicates the ability for OSM to invoke an automation plug-in that is running within the bounds of the oms.ear file.

XML_CATALOG_SUPPORT

Enter enable if you want to enable XML Catalog support for this cartridge. Enter disable if you want to disable XML Catalog support for this cartridge.

Note: XML Catalog support is enabled by default and is required to be enabled. When you deploy to some target run-time software versions, you can disable XML Catalog support. See "Working with XML Catalogs" for more information on using XML Catalogs.

UNDEPLOY_SHARED_CARTRIDGE

(Applies to composite cartridges only.) Enter true to force the undeployment of shared component cartridges within a composite cartridge.

By default, the variable is set to false to prevent the undeployment of cartridges that are shared. See "Undeploying Composite Cartridges with Shared Component Cartridges" for more information.