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
DEFAULT_CARTRIDGE	This variable indicates whether the current version of the cartridge is the default version in the namespace. Cartridges that you deploy to OSM must have a default version. Specifying a default cartridge ensures that orders submitted by Task web client users who are not defined with permission to create versioned orders are handled correctly in the OSM run-time environment. At run time, if a user who does not have permission to create versioned orders enters an order, the OSM server submits the order to the default cartridge. See "Role Editor Role Tab" for more information about granting permissions to roles. Set this variable to one of the following values: Enter true to indicate that this version of the cartridge is the default version in the namespace. This is the default value. Enter false if there are multiple versions of this cartridge deployed to the OSM environment and one of the deployed versions has this set to true. Note: If you have multiple versions of a composite cartridge, for each composite cartridge you should set this variable to the same value for the composite cartridge and all of the component cartridges that it references. Only one of the composite cartridges should have this variable set to true.
ENTITY_CONFLICT_ACTION_ON_DEPLOY	This variable determines system behavior when cartridges are being updated with a new version and conflicting entities are found. It applies only if PURGE_CARTRIDGE_BEFORE_DEPLOY is set to false. Set this variable to one of the following values: Enter replace to replace the old entities with the new. This is the default value. Enter ignore to add the new entities and retain the old. Enter abort to stop the deployment process.
FAST_CARTRIDGE_UNDEPLOY	This variable determines system behavior when undeploying cartridges. Set this variable to one of the following: Enter true to undeploy a cartridge from OSM without purging cartridge metadata or order data. This is the default value. Enter false to purge cartridge metadata and order data during the undeploy operation.
NODE_REMOVAL_ALLOWED_ON_REDEPLOY	This variable determines whether to allow users to remove a node from an order template and redeploy cartridges. Set this variable to one of the following: Enter true to enable users to remove nodes from order template and redeploy cartridges. Enter false to prevent users from removing nodes from order template and redeploy cartridges. This is the default value.
PURGE_CARTRIDGE_BEFORE_DEPLOY	This variable determines system behavior when you are deploying a new version of a cartridge to an OSM environment where an older version of the cartridge is already deployed. Set this variable to one of the following values: Enter true to undeploy the previous version of a cartridge before deploying the new version. Do not use this value if your cartridge has pending or completed orders that you do not want to purge. Instead, do not undeploy the cartridge and set this value to false. 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. Enter false to update the previous version of the cartridge with the changes in the new version. This is the default value.
PURGE_ORDER_ON_UNDEPLOY	This variable determines system behavior when you try to undeploy cartridges that have pending orders. Set this variable to one of the following values: Enter true to purge all existing orders associated with the cartridge. This is the default value. If both PURGE_ORDER_ON_UNDEPLOY and FAST_CARTRIDGE_UNDEPLOY are set to true, the operation is a forced fast undeploy, which stops 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. Enter false if you do not want the system to undeploy the cartridge if it has pending orders. If you attempt to undeploy a cartridge that is not present in your workspace, and if the PURGE_ORDER_ON_UNDEPLOY option is defined as Inherit on the Cartridge Management Variables tab of the Studio Environment editor, then Design Studio defines the PURGE_ORDER_ON_UNDEPLOY option as false, even if the deployed cartridge includes a PURGE_ORDER_ON_UNDEPLOY option that is defined as true (on the Order and Service Management Project editor Cartridge Management Variables tab). To change this behavior, select the PURGE_ORDER_ON_UNDEPLOY option in the Cartridge Management Variables tab of the Studio Environment editor, then select Override, and then define the option as true. Caution: Undeploying a cartridge using the forced undeploy option purges all existing orders for that cartridge.
SUSPEND_DB_JOBS_TIMEOUT	This variable determines the amount of time the database jobs remain in a suspended state. Before importing a cartridge, the OSM server ensures that the OSM database jobs have stopped. If a variable is not specified, the default value of 0 is used, which indicates infinite time.
UNDEPLOY_SHARED_CARTRIDGE	(Composite cartridges only.) This variable determines system behavior when undeploying a composite cartridge. See "Undeploying Composite Cartridges with Shared Component Cartridges" for more information. Set this variable to one of the following values: Enter true to force the undeployment of shared component cartridges within a composite cartridge. Enter false to prevent the undeployment of cartridges that are shared. This is the default value.
OSM_RUNTIME_TYPE	This variable indicates whether the cartridge was configured with 7.5.0 features such as, TMF cartridge, System Interactions, Fallout and so on. By default, the variable is set to the value WLS. You can set the variable to one of the following values: For Non-TMF cartridges, you can use WLS. This means that cartridges can be deployed both in cloud native and WebLogic Server environments. For TMF cartridges, the value of the variable OSM_RUNTIME_TYPE is MultiService. This indicates that the cartridge configuration requires a cloud native environment. Here OSM would be running in an integrated environment with cloud native capabilities. WLS indicates OSM is running as a standalone application. Cloud native indicates that OSM is running in an integrated environment with cloud native capabilities.

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	This variable determines how the system will build and deploy cartridges targeted at versions of OSM prior to 7.3. Do not use this variable for OSM 7.3 or later OSM servers. Set the variable to one of the following values. Enter optimized if you want to build the automation components for automation plug-ins to be able to run within a common .ear file (oms.ear) at run time. This is the value that will be used if this variable is not set. 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 Order and Service Management General Preferences" for information about 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	This variable determines whether XML Catalog support is enabled. It 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. Enter enable if you want to enable XML Catalog support for this cartridge. This is the value that will be used if this variable is not set. Enter disable if you want to disable XML Catalog support for this cartridge.

Related Topics

Project Editor Cartridge Management Variables Tab