Skip Headers
Oracle® Communications Order and Service Management System Administrator's Guide
Release 7.2.2

E35414-02
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

6 Configuring OSM with oms-config.xml

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

Working with oms-config.xml

Various OSM parameters can be configured in oms-config.xml. The file can be stored in oms.ear, or it can be located externally.

By default, OSM uses oms-config.xml packed in oms.ear for configuration parameters. To alter the stored oms-config.xml file, unpack oms.ear, edit oms-config.xml, save your changes, and repack oms.ear. Redeploy the updated oms.ear for changes to take effect.

Oracle recommends the using an external oms-config.xml file:

Using an External oms-config.xml File

To use an external oms-config.xml file:

  1. If you have not already done so, unpack oms.ear as described in "Using an oms-config.xml File Stored in oms.ear".

  2. Make a copy of the oms-config.xml file and store it in a location of your choosing.

  3. Edit domain_home/bin/startWebLogic.sh (startWebLogic.bat on Windows) and locate the line that starts WebLogic. It will appear similar to the following:

    ${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} -Dweblogic.Name=${SERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy ${JAVA_OPTIONS} ${PROXY_SETTINGS} ${SERVER_CLASS}
    
  4. Add the following parameter:

    -Dmslv.oms.config=omsconfigxml_path/oms-config.xml
    

    where omsconfigxml_path is the path to your customized oms-config.xml file.

    The updated line will appear similar to the following:

    ${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} -Dweblogic.Name=${SERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy -Dmslv.oms.config=/Users/wls/oms-config.xml ${JAVA_OPTIONS} ${PROXY_SETTINGS} ${SERVER_CLASS}
    
  5. Save and close the file.

Using an oms-config.xml File Stored in oms.ear

OSM run-time parameters are configured in oms-config.xml.

To alter oms-config.xml, unpack oms.ear, edit oms-config.xml, and repack oms.ear.

To unpack and repack oms.ear, use the following batch files and scripts:

  • UNIX:

    unpackOSM.sh and packOSM.sh. The files are in OSM_Home/SDK/Customization

  • Windows:

    unpackOMS.bat and packOMS.bat. The files are in OSM_Home\SDK\Customization

The SDK directory exists only if you installed the SDK during a Custom installation.

Important:

You can install only the SDK on a Windows or UNIX machine by running the OSM installer again, and selecting Custom installation.

To configure OSM by editing the oms-config.xml file:

  1. Copy the oms.ear file from the production system to the system containing the pack and unpack scripts or batch files.

    Note:

    Oracle recommends that you make a backup copy of your original oms.ear file, in case you need to restore the default settings.
  2. Go to OSM_Home/SDK/Customization.

  3. Do one of the following:

    • UNIX:

      Edit unpackOMS.sh and packOMS.sh and set JAVA_HOME variable to the path to the JDK on your UNIX machine.

    • Windows:

      Edit unpackOMS.bat and packOMS.bat and set JAVA_HOME variable to the path to the JDK on your Windows machine.

    Note:

    If the path in JAVA_HOME contains a space, enclose the path in quotation marks. For example:
    set JAVA_HOME="C:\oracle\middleware test\jdk160_11"
    
  4. Do one of the following:

    • UNIX:

      Run unpackOMS.sh, which unpacks oms.ear.

      New sub-directories are created in OSM_Home/SDK/Customization, including: osm-ear, osm-ejb, osm-war, osmwebui, and resources.

    • Windows:

      Run unpackOMS.bat, which unpacks oms.ear.

      New sub-directories are created in OSM_Home\SDK\Customization, including: osm-ear, osm-ejb, osm-war, osmwebui, and resources.

  5. Edit osm-ejb\security\META-INF\oms-config.xml to customize the parameters you want to modify. See Table 6-1 for a list of parameters in oms-config.xml.

    Important:

    Oracle recommends that you make a backup copy of oms-config.xml before making any changes to it.
  6. Save your changes.

  7. Do one of the following:

    • UNIX:

      Run packOMS.sh, which repacks oms.ear.

    • Windows:

      Run packOMS.bat, which repacks oms.ear.

    This creates a new oms.ear file.

  8. Copy the updated oms.ear to a directory on the host running the OSM server, for example, OSM_home/bin.

  9. Log in to the WebLogic Administration Console.

  10. In the Domain Structure pane, click Deployments.

  11. In the Deployments window, select the box next to oms.ear, click Stop, and select the option appropriate for your situation.

  12. With the box next to oms.ear selected, click Delete.

  13. Click Activate Changes.

  14. Click Install.

  15. In the Install Application Assistant window, browse to the location of the updated oms.ear file and click Finish.

  16. Select the box next to oms.ear and click Start and Servicing all Requests.

oms-config.xml Parameters

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

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

Name Description Type Min Max Default

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

64000

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

64000

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

64000

200

worklist_page_size

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

integer

1

64000

15

userlist_page_size

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

integer

1

64000

15

notifications_page_size

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

integer

1

64000

15

query_results_page_size

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

integer

1

64000

15

jdbc_fetch_size

JDBC fetch size

integer

1

64000

200

url_root

The base URL for the OSM Web applications

string

N/A

N/A

oms

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

N/A

N/A

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

N/A

N/A

25

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

N/A

N/A

N/A

email_server_ssl

Enables SSL connection to the email server when set to True

boolean

N/A

N/A

True

email_server_authentication

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

boolean

N/A

N/A

True

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

120

attachment_file_system_name

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

string

N/A

N/A

N/A

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

256

10

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.

It is not recommended to change this parameter from the installation setting.

integer

-50400

50400

N/A

max_read_only_field_length

Maximum length of a read-only field in the Order Editor

integer

1

512

30

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

N/A

N/A

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

N/A

N/A

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

It is not recommended to change this parameter from the installation setting.

Changing this parameter can affect system performance.

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

It is not recommended to change this parameter from the installation setting.

Changing this parameter can affect system performance.

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

N/A

N/A

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

N/A

N/A

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

N/A

N/A

True

login_screen

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

  • about

  • default

  • home

  • query

  • worklist

string

N/A

N/A

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. The maximum value is 1440 minutes (24 hours).

It is not recommended to change this parameter from the installation setting.

integer

-1

1440

5

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

Cache manager

string

N/A

N/A

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

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

 

string

N/A

N/A

oracle.xml.jaxp.JXDocumentBuilderFactory

custommenuaction_model_location

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

string

N/A

N/A

N/A

event_poller_interval

Time in seconds OSM waits before polling for new events

integer

100

60000

1000

event_poller_mutex_timeout

 

integer

0

60000

10000

com.mslv.oms.security.HandlerFactoryRegistry.HandlerFactory

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

string

N/A

N/A

com.mslv.oms.security.HandlerFactory

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

Enables high-activity order collection cycles

boolean

N/A

N/A

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 executions 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

 

string

N/A

N/A

com.mslv.oms.security.HandlerCallbackFactory

com.mslv.oms.security.OrderViewAccessProvider

Registers a security callback for the OrderViewAccessException exception

string

N/A

N/A

N/A

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

100

3600

600

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.model.transform.OrderTransformer.ModelURL

 

string

N/A

N/A

N/A

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.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.CreateOrder

Default Orchestration plan XQuery to create an order update. This parameter is not intended to be end-user adjustable.

Oracle recommends not changing this parameter.

string

N/A

N/A

oracle/communications/ordermanagement/orchestration/generation/CreateOrder.xquery

oracle.communications.ordermanagement.orchestration.generation.ControlDataLocation

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

string

N/A

N/A

ControlData/OrderItem

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

N/A

N/A

N/A

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

N/A

N/A

N/A

com.mslv.oms.automation.AutomationDispatcher.DefaultAutomationPluginDispatchMode

The dispatch mode to use by default for all automation plug-ins

LEGACY: run in external EAR file

INTERNAL: run in oms.ear

string

N/A

N/A

INTERNAL

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

N/A

N/A

True

height_of_tablelayout

Height in pixels of the table layout

string

N/A

N/A

400px

no_of_rows_in_textarea_without_scroll

 

integer

3

1000

3

max_no_of_rows_in_textarea_with_scroll

 

integer

3

1000

3

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

1

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 used only at the request of Oracle Support for diagnostic purposes.

boolean

N/A

N/A

False

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 here: http://www.w3.org/TR/xpath/#function-normalize-space.

boolean

N/A

N/A

True

webui_order_info_pane_order_item_sort_ascending

 

boolean

N/A

N/A

True

webui_order_info_pane_order_component_sort_ascending

 

boolean

N/A

N/A

True

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

N/A

N/A

near

oracle.communications.ordermanagement.RuleDelayTaskPoller.MaxRuleTaskProcessors

Specifies the maximum number of rule task processors

integer

1

50

1

oracle.communications.ordermanagement.RuleDelayTaskPoller.MaxRuleTaskProcessors

Specifies the maximum number of delay task processors

integer

0

50

1

oracle.communications.ordermanagement.RuleDelayTaskPoller.Interval

Specifies the pause time in milliseconds between consecutive executions of the rule and delay task processors.

integer

1000

60000

5000

oracle.communications.ordermanagement.security.GlobalQueryRoles

An order type/source can be queried if the user has one of the following permissions on 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.

The workgroups where one of the previous permissions is set must all have the Search View permission assigned. Users can always see default and defaultOrchestration cartridges. For backwards compatibility, this configuration option can be used to force this function to return all order type/source in the system. The workgroup names should be separated by a semicolon, a comma, and a colon (;,:).

This parameter makes the OSM consistent with pre 7.0.3.1 behavior.

string

N/A

N/A

N/A

oracle.communications.ordermanagement.order.UseUnionOfFiltersAcrossRoles

Filters are OR'ed across roles and the results are a union of data across all the results so that 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

N/A

N/A

N/A

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

15

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.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

N/A

N/A

True

oracle.communications.ordermanagement.table-layout.size

The number of rows displayed in the table in a single view (i.e. 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.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

N/A

N/A

50

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

N/A

N/A

* (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

N/A

N/A

* (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

N/A

N/A

* (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

N/A

N/A

* (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

N/A

N/A

* (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

N/A

N/A

* (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

N/A

N/A

* (meaning all workgroups)