1. System Administrator's Guide
  2. Configuring OSM with oms-config.xml

5 Configuring OSM with oms-config.xml

This chapter explains how to configure Oracle Communications Order and Service Management (OSM) using the oms-config.xml file and provides a detailed reference of available parameters.

Working with oms-config.xml

You can configure various OSM runtime parameters in the oms-config.xml file. The working copy of the oms-config.xml file is automatically saved in the domain_home directory, or you can define the directory using a start-up configuration parameter.

When you start OSM, the system checks for the OSM WebLogic domain start-up configuration parameter -Dmslv.oms.config, which it uses to find a valid oms-config.xml file. If the start-up parameter is not present, OSM searches the current OSM WebLogic domain directory, and uses the parameters from that file, if it exists.

If there is no oms-config.xml file in the current domain directory, OSM server automatically extracts it from the oms.ear file and saves it to the domain_home directory. OSM server then loads all parameters from that file.

Note:

When you modify oms-config.xml parameters, you must ensure that you are using the working copy of the oms-config.xml file so that OSM server loads and applies the modified values. The working copy is defined as the following:

  • If the -Dmslv.oms.config start-up parameter is set, the working copy is the file name location defined in -Dmslv.oms.config=file name location.

  • If no -Dmslv.oms.config start-up parameter is defined, the working copy is the oms-config.xml file that is saved in the domain_home directory.

To modify the working copy of the oms-config.xml file:

  1. Open the oms-config.xml file from the directory where the file is saved, for example, domain_home.

    Note:

    Oracle recommends that you back up your oms-config.xml file before making any changes to it.

  2. Do any of the following. For a list of parameters and their descriptions, see "oms-config.xml Parameters."

    • If the parameter you would like to set is already present in your oms-config.xml file, modify the value of the parameter.

    • If the parameter you would like to set is in Table 5-1 but is not already present in your oms-config.xml file, add an <oms-parameter> element for the parameter under the <oms-configuration> element. It does not matter what order the <oms-parameter> elements are in in the file.

  3. Save the oms-config.xml file.

oms-config.xml Parameters

Table 5-1 describes the parameters that can be configured in the oms-config.xml file.

Table 5-1 Description of oms-config.xml Parameters

Name Description Type Min Max Default

DefaultUserAction

The default action to perform on orders and tasks in the Worklist and Query screens for all users who have not set the default action in the Options page of the Task web client

Valid values (actions) for the global default action parameter that OSM administrators can specify are:

  • NoGlobalDefault (This is the default if no action is set.)

  • AcceptEditTask

  • AddRemark

  • RaiseException

  • ViewOrderData

  • ViewOrderProcessHistory

  • ViewNotificationHistory

  • CopyOrder

String

NA

NA

NoGlobalDefault

node_removal_allowed_on_redeploy

Enables removal of nodes on redeploy.

boolean

NA

NA

false

excel_export_row_limit

Maximum number of records (Worklist data and Query results) that can be exported to a CSV file.

integer

1

100000

50000

excel_export_memory_size

Memory cap for the export function in the Worklist and Query pages. Any export operation that consumes memory more than the specified value is not carried out. The value of the memory cap should be specified in MB.

integer

500

2000

800

excel_export_cluster_limit

Maximum number or limit of total number of concurrent export requests that can be received on the database

integer

1

100

NA

max_worklist_rows

Maximum number of rows shown in the worklist.

Changing this parameter can affect system performance.

Oracle recommends that you not change this parameter to a value significantly larger than the default.

integer

1

10000

200

max_query_rows

Maximum number of rows returned in the Query Results page in the Task web client.

Changing this parameter can affect system performance.

Oracle recommends that you not change this parameter to a value significantly larger than the default.

integer

1

10000

200

max_notification_rows

Maximum number notifications returned in one request in the Task web client.

Changing this parameter can affect system performance.

Oracle recommends that you not change this parameter to a value significantly larger than the default.

integer

1

10000

200

worklist_page_size

Maximum number of rows shown on each Worklist page in the Task web client.

integer

5

100

20

userlist_page_size

Maximum number of rows shown on each User List page in the Task web client.

integer

5

100

20

query_results_page_size

Maximum number of lines shown on one page in the Query Results page in the Task web client.

integer

5

100

20

notifications_page_size

Maximum number of lines shown on the Notifications page in the Task web client.

integer

5

100

20

jdbc_fetch_size

JDBC fetch size.

integer

1

10000

100

max_read_only_field_length

Maximum length of a read-only field in the Order editor.

integer

1

512

30

remark_change_timeout_hours

Time in hours after the date and time a remark is added to an order that changes are no longer allowed to the remark.

integer

-1

1000

1

attachment_file_system_name

Name of the T3 file service configured in WebLogic that manages order attachments for OSM.

string

NA

NA

NA

max_attachment_size

Maximum size in MB of documents attached to orders in the Task web client.

Changing this parameter impacts OSM WebLogic host machine file system usage.

integer

1

100

3

database_timezone_offset

Offset in seconds of the database server's time zone. The database time zone offset is used to calculate the time zone of the database, which may be different from the time zone of the application. The maximum offset is 14 hours. The default value is ignored: this parameter is defaulted to the database server's time zone offset.

Oracle recommends that you do not change this parameter from the installation setting.

integer

-50400

50400

NA

admin_email_address

Default email address to which to send notifications. The default value set by oms-parameter-default is ignored.

Oracle recommends that you not change this parameter from the installation setting.

string

NA

NA

NA

email_server

IP address or server name of the email server used to send OSM notifications.

Oracle recommends that you not change this parameter from the installation setting.

string

NA

NA

127.0.0.1

email_server_port

Port number of the email server used to send OSM notifications.

Oracle recommends that you not change this parameter from the installation setting.

string

NA

NA

993

email_server_authentication

Enables use of SSL authentication when connecting to the email server when set to true.

boolean

NA

NA

true

email_server_ssl

Enables SSL connection to the email server when set to true.

boolean

NA

NA

true

url_root

The base URL for the OSM web applications.

string

NA

NA

oms

create_order_show_namespace

If set to false, no list is displayed in the Task web client to select a namespace when creating an order.

boolean

NA

NA

true

load_users_from_database

In the XML API, you can call ListUsers. This tells the handler to either load the users from the database or from the J2EE security server (WebLogic).

boolean

NA

NA

false

workstream_refresh_interval

In the Task web client, the number of milliseconds to wait before attempting to retrieve the next available task in a workstream.

Changing this parameter can affect system performance.

Oracle recommends that you do not change this parameter from the installation setting.

integer

500

60000

1000

max_workstream_retry

In the Task web client, the number of retries to attempt to retrieve the next available task in a workstream before redirecting the user back to the Worklist screen.

Changing this parameter can affect system performance.

Oracle recommends that you do not change this parameter from the installation setting.

integer

1

1000

30

workstream_predefined_status_display_fixed

Controls how task completion status buttons are displayed in the workstream order editor.

If set to true, predefined task statuses are displayed on a separate line in their predefined order. User-defined statuses are displayed on the next line. The display order of user-defined statuses is controlled by the model designer.

If set to false, all task completion statuses are displayed in a single line. The display order of all task completion statuses is controlled by the model designer.

boolean

NA

NA

true

hide_dirty_order

Normally, after a task is completed and you return to the worklist, the task is displayed in bold italics to indicate it has been completed. If set to true, the completed task will not be displayed in the worklist.

boolean

NA

NA

false

disable_edit_on_server_refresh

If set to true, if a server refresh occurs while an order is being edited, the edit function becomes disabled.

boolean

NA

NA

true

login_screen

Initial screen displayed when the Task web client is started. Valid values include:

  • about

  • default

  • home

  • query

  • worklist

string

NA

NA

worklist

auto_logout_warning_offset_minutes

Number of minutes prior to session timeout (auto-logout) to display a warning message to the user. A value of -1 indicates no warning is issued.

Oracle recommends that you do not change this parameter from the installation setting.

integer

1

1440

5

com.mslv.oms.util.xml.XMLHelper.DocumentBuilderFactory

Do not use unless instructed to do so by Oracle.

string

NA

NA

oracle.xml.jaxp.JXDocumentBuilderFactory

custommenuaction_model_location

Name of the configuration file containing metadata definitions for a custom menu action.

string

NA

NA

NA

event_poller_interval

Time in milliseconds OSM waits before polling for new events.

integer

100

60000

5000

event_poller_mutex_timeout

Do not use unless instructed to do so by Oracle.

integer

0

60000

10000

enable_log_stacktraces

Enables and disables logging stack traces.

If set to true, stack trace printing in the log is enabled. If set to false, it is disabled.

boolean

NA

NA

true

com.mslv.oms.handler.order.cache.OrderCacheManager

Cache manager.

string

NA

NA

com.mslv.oms.handler.order.cache.jboss.JBossOrderCacheManager

com.mslv.oms.security.HandlerFactoryRegistry.HandlerFactory

Name of the process that manages the handling of high activity orders in clustered systems.

string

NA

NA

com.mslv.oms.security.HandlerFactory

com.mslv.oms.handler.cluster.ClusteredHandlerFactory.HighActivityOrder.CollectionCycle.Enabled

Enables high-activity order collection cycles.

boolean

NA

NA

true

com.mslv.oms.handler.cluster.ClusteredHandlerFactory.HighActivityOrder.CollectionCycle.InitialDelay

The amount of time in milliseconds to wait before the first collection cycle. This wait period allows servers to start and the system to stabilize before statistics used to determine high activity orders are collected.

integer

1000

3600000

10000

com.mslv.oms.handler.cluster.ClusteredHandlerFactory.HighActivityOrder.CollectionCycle.Duration

Time in milliseconds to spend collecting high-activity order statistics per collection cycle.

integer

1000

60000

10000

com.mslv.oms.handler.cluster.ClusteredHandlerFactory.HighActivityOrder.CollectionCycle.Interval

The interval in milliseconds between consecutive of the collection cycle.

integer

1000

3600000

60000

com.mslv.oms.handler.cluster.ClusteredHandlerFactory.HighActivityOrder.RequestPerSecondThreshold

The number of requests per second per order that must be processed for an order to be considered a high-activity order and eligible for special load balancing.

integer

1

1000

50

com.mslv.oms.security.HandlerCallbackFactoryRegistry.HandlerCallbackFactory

Do not use unless instructed to do so by Oracle.

string

NA

NA

com.mslv.oms.security.HandlerCallbackFactory

com.mslv.oms.security.OrderViewAccessProvider

Registers a security callback for the OrderViewAccessException exception.

string

NA

NA

NA

com.mslv.oms.cartridgemgmt.DeployCartridgeMDB.CartridgeDeploymentTransactionTimeout

Default transaction timeout interval in seconds for Oracle Communications Design Studio cartridge deployment. Design Studio can override the default value through the environment property.

integer

120

3600

3600

com.mslv.oms.cartridgemgmt.cache.DeployCartridgeCache.DeployCartridgeRequestTimeToLiveMinutes

Default eviction timeout interval in minutes for Design Studio cartridge deployment requests to be cleaned up from the cache. Design Studio can override the default value through the environment property.

integer

5

360

30

com.mslv.oms.cartridgemgmt.cache.DeployCartridgeCache.DeployCartridgeLocalCacheSize

Do not use unless instructed to do so by Oracle.

integer

10

10000

1000

com.mslv.oms.logging.ThreadLogAppenderMaxBufferSize

Do not use unless instructed to do so by Oracle.

integer

1000

20000

10000

com.mslv.oms.model.transform.OrderTransformer.ModelURL

Do not use unless instructed to do so by Oracle.

string

NA

NA

NA

oracle.communications.ordermanagement.cluster.BusinessRequestBalancer.OrderRelease.Timeout

The time in seconds to wait for a non-exclusive lock to be placed on an order.

A non-exclusive lock is required prior to OSM attempting to process an order. Exclusive locks are acquired by OSM when an order is about to be ejected from the order cache or when an order is being transferred from one node in an OSM cluster to a different node. Exclusive locks prevent non-exclusive locks from being acquired.

integer

200

500

200

oracle.communications.ordermanagement.cluster.BusinessRequestBalancer.OrderOwnershipLock.Timeout

Timeout interval, in seconds, for acquiring an exclusive cluster-wide lock on an order.

integer

30

60

30

oracle.communications.ordermanagement.cluster.BusinessRequestBalancer.ServerState.Scanning.Interval

Time in milliseconds to wait between scanning server states. This value is used to determine how frequently the WebLogic server is checked to see if it is in a RUNNING state prior to enabling application services such as intracluster communication or the JMS server. These services cannot be safely enabled until after the WebLogic server is in a RUNNING state.

integer

1000

10000

5000

oracle.communications.ordermanagement.orchestration.generation.ControlDataLocation

Specifies the node in an orchestration order's order template that contains control data for order items. The data at this location is automatically populated by OSM when the orchestration plan is generated.

string

NA

NA

ControlData/OrderItem

oracle.communications.ordermanagement.orchestration.generation.TransformedOrderItemLocation

Specifies the node in an orchestration order's order template that contains control data for transformed order items. The data at this location is automatically populated by OSM when the orchestration plan is generated.

string

NA

NA

ControlData/TransformedOrderItem

oracle.communications.ordermanagement.util.net.CatalogUriResolver.DefaultXmlCatalogsUris

List of URIs specifying the XML Catalogs that are used system-wide. On all OS platforms, entries are separated by a semicolon (;).

string

NA

NA

NA

oracle.communications.ordermanagement.config.ModelResourceClasspath

List of URIs specifying either JAR files or directories containing class files that will be made available to the OSM class loader. On all OS platforms, entries are separated by a semicolon (;).

string

NA

NA

NA

order_editor_submit_mode_threshold

The response time of the Order Editor page increases with the number of nodes in an order. To avoid slow response times, the order_editor_submit_mode_threshold parameter is configured to a threshold value for node instances saved in the system. If the number of saved instances increases this threshold value, the system automatically switches from AJAX to form-submit mode when edited orders are saved or submitted for processing.

integer

1

9999999

9999999

is_tablelayout_height_fixed

If set to true, the table height equals the value of height_of_tablelayout. If set to false, the table height adjusts according to the number of rows in the table.

boolean

NA

NA

true

height_of_tablelayout

Height in pixels of the table layout.

string

NA

NA

400px

no_of_rows_in_textarea_without_scroll

Maximum number of rows that a text field can accommodate without a scroll bar.

integer

3

1000

3

max_no_of_rows_in_textarea_with_scroll

Maximum number of rows that a text field can accommodate with a scroll bar.

integer

3

1000

3

normalize_space_for_lookup_rule

Determines whether spaces are normalized within XML values that are used in the results of a Lookup behavior. If set to true, the results are normalized by trimming leading and trailing spaces and replacing repeating spaces with a single space, in accordance with the normalize-space XPath function as defined on the World Wide Web Consortium (W3C) website here: http://www.w3.org/TR/xpath/#function-normalize-space.

boolean

NA

NA

true

com.mslv.oms.handler.completeorder.CompleteOrderHandlerEJB.OrchPlanLock.Timeout

Time in seconds that OSM will wait while trying to acquire an exclusive lock on an orchestration plan.

This lock is required only when OSM detects that all order components within the orchestration plan have completed and the order can complete.

integer

1

3600

30

oracle.communications.ordermanagement.orchestration.generation.DumpOrchestrationPlan

If set to true, OSM saves a copy of every generated orchestration plan in XML format to the file orderId_orderType_orchestrationSequence_orchestrationPlanOutput.xml.

Note: This parameter should be set to true only at the request of Oracle Support for diagnostic purposes.

boolean

NA

NA

false

webui_order_info_pane_order_item_sort_ascending

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

webui_order_info_pane_order_component_sort_ascending

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

time_out_override_for_jms_adapter

The amount of time to wait before throwing the JMS response timeout.

integer

15000

300000

15000

oracle.communications.ordermanagement.cache.UserPerferenceCache

Specifies the name of the Coherence cache configuration to use for user preference information. By default, a local cache is used for non-clustered environments. For clustered environments a "near cache" is used to ensure changes to user preference information is automatically synchronized between cluster nodes.

string

NA

NA

near

oracle.communications.ordermanagement.RuleDelayTaskPoller.StartupDelay

Do not use unless instructed to do so by Oracle.

integer

1000

600000

900000

oracle.communications.ordermanagement.RuleDelayTaskPoller.Interval

Specifies the pause time in milliseconds between consecutive times that the rule is run and delay task processors.

integer

1000

60000

5000

oracle.communications.ordermanagement.RuleDelayTaskPoller.MaxRuleTaskProcessors

Specifies the maximum number of rule task processors.

integer

1

50

1

oracle.communications.ordermanagement.RuleDelayTaskPoller.MaxDelayTaskProcessors

Specifies the maximum number of delay task processors.

integer

0

50

1

allow_undeploy_component_cartridge_in_solution

By default, component cartridges that are used by composite cartridges in the run-time environment cannot be undeployed. During the development of a composite cartridge, however, you may need to undeploy a component cartridge used by the composite cartridge. To enable the undeployment of one or more component cartridges used by a composite cartridge, set this value to true.

boolean

NA

NA

false

oracle.communications.ordermanagement.security.GlobalQueryRoles

Contains the names of the applicable OSM workgroups (known as roles in Design Studio) separated by a semicolon, a comma, and a colon (;,:).

Note: Including a workgroup name in this parameter makes OSM behave (for that for that workgroup) the way it did prior to OSM 7.0.3.1. It should only be used for backward compatibility.

If a workgroup is not included in this parameter, a user can query an order type/source only if the user is a member of a workgroup with one of the following permissions for the order type/source:

  • Permission to create the order (creation task)

  • Permission on at least one task

  • Permission on at least one flex header where the flex header node is in that order's order template

  • At least one query view assigned.

In addition to the conditions above, the workgroup which provides the user with the permission above must also have the Search View permission assigned.

If a workgroup is included in this parameter, the permissions will operate as they did prior to OSM 7.0.3.1: users can query all order types/sources, without meeting any of the conditions above. Having the workgroup included in this parameter also overrides filters defined for the workgroup. So, a user who is a member of a workgroup defined in this parameter is able to query all order types and order sources, regardless of any filters configured.

Note: Users can always see default and defaultOrchestration cartridges, regardless of any other conditions, and regardless of whether their workgroup is included in this parameter.

string

NA

NA

NA

oracle.communications.ordermanagement.order.UseUnionOfFiltersAcrossRoles

Filters are OR'ed across roles and the results are a union of data across all the results. If a user is a member of a workgroup with privileges on an order within a cartridge and that workgroup has no filters, the user can see all orders in that cartridge. To see all the results AND'ed so that an intersection of the results is obtained, the names of the specific workgroup should be given in the configuration file separated by a semicolon, a comma, and a colon (;,:).

This parameter has been added for backward compatibility with older versions of OSM.

string

NA

NA

NA

oracle.communications.ordermanagement.ws.CreateOrder.UseTinyTree

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

oracle.communications.ordermanagement.orchestration.generation.UseTinyTree

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

oracle.communications.ordermanagement.amendment.DataEnrichmentAware

Determines whether OSM is aware of changes to order data from Task web client users assigned to manual tasks or from automation plug-ins. If set to true, OSM compares revision order data to the current order including any changes from manual tasks or automation plug-ins. If set to false, OSM compares revision orders to the last submitted order data excluding changes from manual tasks or automation plug-ins.

boolean

NA

NA

true

oracle.communications.ordermanagement.transaction.order.lock

If set to true, OSM will attempt to lock the order while executing order fulfillment state updates during an update order request. This is to prevent a race condition between two threads trying to execute fulfillment state updates.

boolean

NA

NA

true

oracle.communications.ordermanagement.transaction.order.lock.waittime

Wait time in milliseconds for the OSM order lock for oracle.communications.ordermanagement.transaction.order.lock.

integer

1000

30000

3000

oracle.communications.ordermanagement.orchestration.generation.CompressOrchestrationPlan

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

oracle.communications.ordermanagement.order.CompressXMLValues

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

true

soap_adapter_preemptive_authentication

The SOAP Adapter does not support preemptive authentication by default. If preemptive authentication is used incorrectly, it can lead to significant security issues. You must evaluate the potential benefits versus the security risks of preemptive authentication in the context of your specific application environment. If you set this value to true, you can configure HttpClient to authenticate preemptively by prepopulating the authentication data cache.

boolean

NA

NA

false

oracle.communications.ordermanagement.security.access.summary

Grants access to the Summary tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Summary tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.data

Grants access to the Data tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Data tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.orchestration-plan

Grants access to the Orchestration Plan tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Orchestration Plan tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.dependencies

Grants access to the Dependencies tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Dependencies tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.amendments

Grants access to the Amendments tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Amendments tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.activity

Grants access to the Activity tab in the Order Management web client, by workgroup names. Only users of specific workgroups can view the Activity tab. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.security.access.data-tree

Controls how users see the Order Info region in the Order Management web client, by workgroup names. The Order Info region can be seen by all users, but only users of specific workgroups can expand the order item child items. Separate values with commas, semicolons, or colons. Values can contain the asterisk wildcard character, where the asterisk can match a string of characters (for example, a value of user* matches workgroup names user1, user2, user3, and so on).

string

NA

NA

* (meaning all workgroups)

oracle.communications.ordermanagement.table-layout.threshold

This feature introduced a threshold system parameter above which multi-instance group nodes will automatically be displayed as a table. The system parameter will be read from the existing oms-config.xml configuration file at application startup and metadata refresh, as with current system parameters. A non-integer value or a negative value disables this feature.

integer

-1

64000

50

oracle.communications.ordermanagement.table-layout.size

The number of rows displayed in the table in a single view (that is, without scrolling), can be configured.

integer

0

50

10

oracle.communications.ordermanagement.table-layout.fetch-size

The number of rows fetched at a time from the server is configurable; which means that not all the rows that are available for the component on the server are fetched and displayed on the client. The number of rows that are displayed on the client are just enough to fill the viewport. More rows are fetched as the user scrolls the component vertically.

integer

5

100

25

oracle.communications.ordermanagement.webui.text.cols.size

Do not use unless instructed to do so by Oracle.

integer

30

80

48

oracle.communications.ordermanagement.webui.xml.cols.size

Do not use unless instructed to do so by Oracle.

integer

72

144

80

oracle.communications.ordermanagement.webui.xml.rows.size

Do not use unless instructed to do so by Oracle.

integer

4

10

5

oracle.communications.ordermanagement.webui.max.xmlcomponents.per.row

Do not use unless instructed to do so by Oracle.

integer

1

4

2

oracle.communications.ordermanagement.webui.max.auto.expend.tree.levels

Do not use unless instructed to do so by Oracle.

integer

1

128

3

oracle.communications.ordermanagement.webui.max.components.per.row

Do not use unless instructed to do so by Oracle.

integer

1

4

3

oracle.communications.ordermanagement.webui.sort.component.type

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

false

oracle.communications.ordermanagement.resource.FullScopeAccess

The level of access to system resources. This parameter has one of the following values:

  • _strict_access_

    This value indicates that no cartridges will have full scope access to system resources.

  • *

    (asterisk) This value indicates that all cartridges will have full scope access to system resources.

  • catridgeMnemonic:version,cartridgeMnemonic:version, etc.

    This type of value indicates that only the listed cartridges will have full scope access. For example, if the value is:

    OSM_Cart1:1.0.0.0.0,OSM_Cart1:2.0.0.0.0

    it means that versions 1.0.0.0.0 and 2.0.0.0.0 of the OSM_Cart1 cartridge have full scope access to system resources, and no other cartridges have that access.

string

NA

NA

_strict_access_

show_all_data_history_logs_for_orderdetails

Controls which events the Order Management web client displays on the Activity tab of the Order Details page.

If set to false, the Activity tab displays only events that occur after the order is created. If set to true, the Activity tab displays all events, including those that occur before the order is created.

If this parameter is not present in the oms-config.xml file, the Activity tab behaves as though the property is set to false.

boolean

NA

NA

false

OrderCacheMaxEntries

Maximum number of orders that can be in the cache in a managed server at one time.

When there is an attempt to exceed the maximum cache size, the order with the longest period of inactivity is forcefully ejected from the cache to make room for orders being loaded into the cache.

A value of 0 means the cache size is unlimited. The only way that orders can be removed from the cache when the value of this parameter is 0 is when the value of the OrderCacheInactivityTimeout is reached.

integer

0

86400000

1000

OrderCacheInactivityTimeout

Maximum number of seconds that an order can be inactive (no attempt to access or update it) before being ejected from the cache.

A value of 0 means there is no inactivity timeout.

integer

0

86400000

3600

ClosedOrderCacheMaxEntries

Maximum number of orders that recently changed from an open state to a closed state that can exist in a managed server at any time.

When there is an attempt to exceed the closed order size, the recently closed order with the longest period of inactivity is forcefully ejected from the cache. A typical strategy for this value is to set it to a specific fraction of the OrderCacheMaxEntries value.

For example, the default is 50, which is 5% of the default of OrderCacheMaxEntries. This value along with the ClosedOrderCacheTimeout value is to set a number of seconds that represents the grace period that recently closed orders remain in cache, after which they are ejected.

integer

0

86400000

50

ClosedOrderCacheTimeout

Maximum number of seconds that recently closed orders remain in the cache after they have changed from an open state to a closed state.

This allows sufficient time for post-processing that might happen after an order is completed or aborted, but encourages closed orders to otherwise be ejected from cache more quickly than if they were ejected based on the OrderCacheInactivityTimeout parameter. Typically, this is set to a relatively low value, such as 60 seconds. To be effective, this value should be much smaller than the OrderCacheInactivityTimeout value.

integer

0

86400000

60

fast_cartridge_undeploy

If set to true, cartridges are undeployed from OSM but cartridge metadata and order data are not purged from the database.

After undeploying a cartridge, its status in the OSM database is set to UNDEPLOYED.

If set to false, when cartridges are undeployed, cartridge order data and metadata are removed from the database, which can take time if there are a large number of orders.

boolean

NA

NA

true

cartridge_operation_timeout

Timeout interval, in seconds, for completion of cartridge deployment. Deployment will be terminated when this time is reached.

integer

-1

3600

1800

oracle.communications.ordermanagement.xml.file.encoding

Specifies the standard text encoding OSM uses to parse XML attachments.

string

NA

NA

UTF-8

oracle.communications.ordermanagement.compliance.snapshot.output.directory

Specifies the directory that contains the system configuration snapshot files that are captured while you are running the compliance tool.

string

NA

NA

osm_compliance/snapshots

oracle.communications.ordermanagement.compliance.evaluator.output.directory

Specifies the directory that contains the evaluation results files after you run the compliance tool.

string

NA

NA

osm_compliance/results

oracle.communications.ordermanagement.compliance.evaluator.snapshot.directory

Specifies the directory that contains the generated snapshot files that need to be evaluated.

If this directory contains multiple sub-directories that contain snapshot files, the sub-directories are sorted alphabetically and the last one is used in the evaluation process. Each directory name is a timestamp of when the snapshot was captured, in the format: yyyymmdd-hhmmss.

string

NA

NA

osm_compliance/snapshots

oracle.communications.ordermanagement.compliance.evaluator.rule.directory

Specifies the directory that contains the rules that the snapshot is to be evaluated against. Directory rules run in addition to internal rules.

string

NA

NA

osm_compliance/rules

oracle.communications.ordermanagement.compliance.configuration.override.file

File to override the configuration file for the compliance tool.

string

NA

NA

NA

AutomationConcurrencyModels

You can specifies a delimited list of OACC policy xml files that the system can use to limit the concurrency of automation plug-ins. Each policy specifies which automation plug-ins are limited, the scope of the policy, and the maximum allowed concurrency level. All automation plug-ins not targeted by a policy have unlimited concurrency.

For example:

<oms-parameter>
  <oms-parameter-name>Automat ionConcurrencyModels</oms-parameter-name>
  <oms-parameter-value>file:/// Users/sample/automationConcurrencyModel.xml</oms-parameter-value>
</oms-parameter>

You can put the policy file in any reachable location and the policy file can have any name when being referenced from oms-config.xml. You can also include OACC policy files directly in the resource folder of OSM cartridges instead of referencing them from oms-config.xml. If both the referenced oms-config.xml OACC policy file and the local cartridge OACC policy file have the same name, then the oms-config.xml policy file overrides the local version.

For more information about OACC policy files, see OSM Developer's Guide.

List of files

NA

NA

NA

oracle.communications.ordermanagement.order.OperationalOverrideFileURLs

Location of operational jeopardy configuration override files. The format of this parameter is a comma-separated list of file names (including paths). Files should be located in the same file system as the oms-config.xml file. For example: 

/u01/settings/osm/operational-jeopardy-config1.xml,/u01/settings/osm/operational-jeopardy-config2.xml

By default this field is blank, which means that operational jeopardy configuration is not turned on.

List of files

NA

NA

NA

oracle.communications.ordermanagement.scheduler.MaxDelay.OrderJeopardyTimer

Maximum number of milliseconds for the generic timer to wait before triggering items on its list.

Changing this parameter can affect system performance.

integer

0

86400000

30000

oracle.communications.ordermanagement.scheduler.MaxEventCount.OrderJeopardyTimer

Maximum number of items processed in a single call to the generic timer.

Changing this parameter can affect system performance.

integer

1

10000

10

oracle.communications.ordermanagement.scheduler.MaxDelay.OrderJeopardyTimerCleanup

Do not use unless instructed to do so by Oracle.

integer

60000

86400000

3600000

oracle.communications.ordermanagement.scheduler.MaxPausedTime.OrderJeopardyTimerCleanup

Do not use unless instructed to do so by Oracle.

integer

1

2147483647

86400000

adaptivePolling.ceiling

Adaptive event polling determines how the om_jms_event table, which contains records of OSM-generated events, is polled. To increase performance, adaptive polling provides a mechanism for polling only the most active database partitions generally, with only periodic polling of all of the partitions.

This parameter specifies how many times to query only the most active partitions before performing the full query again. Set to 0 to turn of adaptive polling and run the full query every time.

integer

0

100

10

adaptivePolling.maxPartitions

Adaptive event polling determines how the om_jms_event table, which contains records of OSM-generated events, is polled. To increase performance, adaptive polling provides a mechanism for polling only the most active database partitions generally, with only periodic polling of all of the partitions.

This parameter specifies the number of partitions to include in the query of only the most active partitions.

integer

1

30

2

oracle.communications.ordermanagement.wm.ProcessRequest.Timeout

Do not use unless instructed to do so by Oracle.

integer

60000

300000

60000

oracle.communications.ordermanagement.monitoring.adml.dir

Do not use unless instructed to do so by Oracle.

string

NA

NA

${common.components.home}/modules/oracle.dms_12.2.1/adml

oracle.communications.ordermanagement.monitoring.date.displayformat

Do not use unless instructed to do so by Oracle.

string

NA

NA

yy-MM-dd HH:mm:ss

oracle.communications.ordermanagement.monitoring.movingaverage.windowsize

Do not use unless instructed to do so by Oracle.

integer

1

100000

1000

oracle.communications.ordermanagement.order.contingency

Amount of contingency buffer, measured in minutes, that is added to a calculated order duration to determine the projected delivery date of an order.

integer

0

525600

0

oracle.communications.ordermanagement.ws.FindOrderRequest.FindOrderMaxOrderThreshold

Maximum number of rows that are returned in the results of the FindOrder web service operation. For more information, see "FindOrder" in OSM Developer's Guide.

integer

1

64000

1000

oracle.communications.ordermanagement.ws.FindOrderOperationImpl.MaxFlexHeaderCountInOrderBy

The number of flexible headers that can be sent in an order by clause in a web service request. If the number of flexible headers is greater than this value, the web service request will be rejected.

integer

1

100

1

oracle.communications.ordermanagement.ui.compatibilityMode

Do not use unless instructed to do so by Oracle.

boolean

NA

NA

false

oracle.communications.ordermanagement.OrderPartitioningRealmConfigFileURLs

Location of order partitioning realm configuration files. The format of this parameter is a comma-separated list of file names (including paths). Files should be located in the same file system as the oms-config.xml file. For example: 

/u01/settings/osm/order_partitioning_realms_config1.xml,/u01/settings/osm/order_partitioning_realms_config2.xml

By default this field is blank, which means that no additional partitioning realms for orders are configured in the system beyond those installed by default.

See "Partitioning Realms" for more information about this configuration.

List of files

NA

NA

NA

communications.ordermanagement.webui.render_timeline_tab_for_orderdetails

Enables and disables the Timeline tab in the Order Management Web Client. For more information about the Order Lifecycle Management UI and the Timeline tab, see OSM Order Management Web Client User's Guide.

If set to true, the Timeline tab is displayed in the Order Management Web Client UI. If set to false, the tab is not displayed.

boolean

NA

NA

true

oracle.communications.ordermanagement.EventPoller.MaxProcessingTime

Time, in seconds, for requests from a single poll of table om_jms_event to process. Events that have not been processed before this time expires will be processed during the next poll.

integer

1000

600000

25000

oracle.communications.ordermanagement.EventPoller.MaxEventErrorCount

Number of attempts to retry processing an event when event processing has failed.

integer

1

1000

10

oracle.communications.ordermanagement.AutomationResponseMessageParkingEnabled

Determines whether OSM saves external responses for later delivery if the task receiver cannot process them when they are received (for example, because the order is being amended).

boolean

NA

NA

true

application_scope_id

For internal use only.

string

NA

NA

NA

Configuring Operational Order Jeopardies with Configuration Files

Operational order jeopardies are a method of configuring order jeopardies at runtime. You can configure operational order jeopardies with XML configuration files. These files are referenced in oms-config.xml using the oracle.communications.ordermanagement.order.OperationalOverrideFileURLs parameter.

A sample operational order jeopardy file is provided in the jeopardy configuration in Design Studio. An order jeopardy configuration file has two main elements.

  • orderJeopardy: This element contains a jeopardy configuration. The name attribute of this element contains the name of the order jeopardy. If it matches the name of an order jeopardy configured in Design Studio, the definition in this file will override the Design Studio configuration. If the name does not match any configured in Design studio, this jeopardy will be considered a new jeopardy.

  • extendedOrderDefinition: This element contains information about the jeopardies that should be assigned to a particular order.

Following is a sample orderJeopardy element, with an explanation of its contents. In this sample, the jeopardy will be raised if the order spends more than four minutes (80 percent of five minutes) getting from the specified fromState to one of the specified toState values (not counting any time spent in an excludedState). 

<model:orderJeopardy name="SampleOrderTimeout" namespace="ProvComponent">
   <model:description>Sample Order Timeout</model:description>
   <model:priority>2</model:priority>
   <model:enabled>true</model:enabled>
   <model:condition>
      <model:name>null_rule</model:name>
      <model:namespace>ProvComponent</model:namespace>
   </model:condition>
   <model:notifyRole>
      <model:name>ProvRole</model:name>
      <model:namespace>ProvComponent</model:namespace>
   </model:notifyRole>
   <model:notificationView>
      <model:name>ActivationOrderQueryTask</model:name>
      <model:namespace>ProvComponent</model:namespace>
   </model:notificationView>
   <model:policy>
      <model:stateConditions>
         <model:fromState>open.running.in_progress</model:fromState>
         <model:toState>open.not_running.canceled</model:toState>
         <model:toState>closed.completed</model:toState>
         <model:toState>closed.aborted</model:toState>
         <model:excludedState>open.not_running.suspended</model:excludedState>
         <model:excludedState>open.not_running.failed</model:excludedState>
      </model:stateConditions>
      <model:threshold xsi:type="model:OrderJeopardyFixedDurationThresholdType">
        <model:percent>80</model:percent>
        <model:duration>P0Y0M0DT0H5M0S</model:duration>
      </model:threshold>
   </model:policy>
</model:orderJeopardy>

  • description: This contains the description of the jeopardy.

  • priority: This is the priority of the notification. The notification with the highest priority is evaluated first.

  • enabled: This should be set to true if the jeopardy is enabled, or false if it is not enabled. Setting this value to false is a simple way of disabling a jeopardy with a matching name that was created in Design Studio.

  • condition: This contains the rule that defines when this jeopardy is active. If the rule returns true, the jeopardy is evaluated.

  • notifyRole: This contains the name of the role that should be notified if the jeopardy is met.

  • notification view: This contains the view that should contain any data that is used to determine order jeopardy duration or date/time.

  • policy: This specifies the actual jeopardy information.

  • stateConditions: This specifies the states involved in the jeopardy notification, including the state or states the order is transitioning from (fromState), the state or states that the order is transitioning to (toState), and the states during which the timer should pause (excludedState).

  • threshold: This contains information about duration for the jeopardy.

  • percent: This is the percentage of the duration to wait before raising the jeopardy.

  • duration: The duration to wait (taking into consideration the offset) before raising the jeopardy.

Following is another sample of the policy element inside the of the orderJeopardy element. In this sample, the jeopardy will be raised if the order does not reach one of the specified states by five minutes before the date/time specified in the /ControlData/CompleteDate data element on the order. 

<model:policy>
  <model:stateConditions>
    <model:toState>closed.completed</model:toState>
    <model:toState>closed.aborted</model:toState>
  </model:stateConditions>
  <model:threshold xsi:type="model:OrderJeopardyOrderExpressionThresholdType">
    <model:offset>-P0Y0M0DT0H5M0S</model:offset>
    <model:expression>
      <model:orderData>/ControlData/CompleteDate</model:orderData>
      <model:unit>seconds</model:unit>
      <model:default>P0Y0M0DT0H0M0S</model:default>
    </model:expression>
  </model:threshold>
</model:policy>

  • stateConditions: This specifies the states involved in the jeopardy notification. In this example, only the toState is included, indicating that the expression element should refer to a date/time value rather than a duration.

  • offset: This specifies the amount of time to raise the jeopardy before (because the value begins with a minus sign) the date/time specified in the orderData element.

  • orderData: This specifies an order data element that contains a date/time type value.

  • unit: Because the data element in this case is a date/time, the value of this parameter is ignored.

  • default: Because the data element in this case is a date/time, the value of this parameter is ignored.

Following is a sample extendedOrderDefinition element, with an explanation of its contents: 

<model:extendedOrderDefinition xsi:type="model:OrderJeopardyAssociationDefinitionType" name="SampleOrderTimeoutExtendedOrder" namespace="SystemConfig">
   <model:extends>
      <model:orderType>
         <model:name>ActivationSampleOrder</model:name>
         <model:namespace>ProvBase</model:namespace>
      </model:orderType>
      <model:orderSource>
         <model:name>ActivationSampleOrder</model:name>
         <model:namespace>ProvBase</model:namespace>
      </model:orderSource>
      <model:cartridge> 
        <oms:namespace>OsmCentralOMExample-Solution</oms:namespace> 
        <oms:version>4.0.0.0.0</oms:version> 
      </model:cartridge>
   </model:extends>
   <model:jeopardy xsi:type="model:OperationalOrderJeopardyReferenceType">
      <model:name>SampleOrderTimeout</model:name>
      <model:namespace>ProvComponent</model:namespace>
   </model:jeopardy>
</model:extendedOrderDefinition>

Note:

In this example, xmlns:model is equivalent to: http://xmlns.oracle.com/communications/ordermanagement/model; and xmlns:oms is equivalent to: http://www.metasolv.com/OMS/OrderModel/2002/06/25

  • extends: This element contains information about the order being extended.

  • orderType: This contains the name of the order.

  • orderSource: This contains the Order Source of the order. This value is set in the Order editor Details tab, in the Order Source field. If there is no value in this field for the order, the orderSource is the same as the orderType.

  • cartridge: This element contains the cartridge namespace and version, which are required when the operational order jeopardy is referenced in the oms-config.xml file instead of being defined in the model from Design Studio.

  • jeopardy: This element contains the name and namespace of the jeopardy that should be evaluated for the specified order. There should be one instance of this element for each jeopardy that applies to the order.