2 Maintaining Configuration

There are many files and preferences that affect the Oracle Communications MetaSolv Solution (MSS) environment. This chapter describes them in the following sections, providing information about:

  • Configuration files

  • File relationships

  • Configuration parameters that may affect product performance

  • API server process controls

  • Changing configuration files

  • Setting system preferences

  • Copying encrypted passwords to the gateway.ini file

  • Gateway events through integration server

Configuration of Oracle WebLogic Server also affects your MetaSolv Solution environment. See "Delivering File Changes" for additional details and refer to the WebLogic Server documentation for instructions on modifying Oracle WebLogic Server settings.

Understanding Configuration Files

MetaSolv Solution is installed with INI and XML configuration files that set the environment for the product, its software options, and the accessory products. Configuration files that you manage can be installed in various locations on the Oracle WebLogic server or the client. You also manage database configuration files that are installed on the database server.

MetaSolv Solution installer setup places the MetaSolv Solution files on the Oracle WebLogic server, on the client, or on the database server. When configuration files are required on the client, a master copy is stored on the Oracle WebLogic server. When the software is updated with a maintenance release or patch, the master copy is automatically updated. When this happens, master copies must be copied to the client machines manually. This process is detailed in MetaSolv Solution Installation Guide.

In addition, the MetaSolv Solution configuration files work only when the Oracle Init.ora is correctly configured. Table 2-1 describes the configuration files.

Table 2-1 Configuration File Functions

Configuration File Name Function Location

FOP.xconf.xml

This configuration file is used to generate PDF reports in the MSS application. During the MSS installation, the installer copies the FOP.xconf.xml file to the server home directory.

Oracle WebLogic server

gateway.ini

Manages many MetaSolv Solution functions and API access to the database. The gateway.ini file is a server-side configuration file and is used by several server processes, including the APIs.

Oracle WebLogic server

init.ora

This Oracle initialization file is described in the Oracle documentation.

Oracle Database server

jmaster.ini

Access to the jmanager.exe executable provides administrator access to the Background Processor job queue. Access to the job queue permits cancelling jobs, pausing, and clearing the queue.

client

lerg.ini

The lerg.exe file runs the Location and Routing Gateway, which loads data from the iconectiv® LERGTM Routing Gateway.

client

loggingconfig.xml

This configuration file produces the Appserver.log, Appserverlog_misc.log, and Appserver_audit.log log files.

Oracle WebLogic server

mslvloggingconfig.xml

This configuration file is used to configure the JDBC tracing and row limits. Oracle WebLogic server

npasplit.ini

The executable, npasplit.exe, runs the NPA Split Utility. Every user running the split utility must have a copy of npasplit.ini in the product folder to designate database connections. The file also contains some user preference information that is specific to the NPA split utility. This file is installed with the split utility.

client

pmat.ini

This configuration file designates the database to be used with the Pre-Migration Analysis Tool (PMAT).

client

tbs.ini

This configuration file is used by the MetaSolv Solution executable, tbs.exe.

This file is installed on the client when MetaSolv Solution is installed.

client

tbs_util.ini

This configuration file is used by the MetaSolv Solution Utilities executable, tbs_util.exe. This file is installed on the client.

client

tnsnames.ora

The MetaSolv Solution installer does not copy or update the tnsnames.ora file. You must manually update the tnsnames.ora file after you install the Oracle client.

tnsnames.ora is an Oracle configuration file that contains network addresses mapped to databases. Each client has at least one of these files in an Oracle folder. The client cannot access a database unless it is listed in this file. See the Oracle documentation for details.

tnsnames.ora resides on the client machine only when one of the accessory products is also installed. It is not required for MetaSolv Solution.

client

MetaSolv Solution Application Components

MetaSolv Solution application components are divided into two groups:

  • Components that communicate only with Oracle WebLogic Server (n-tier)

  • Components that communicate directly with the database (2-tier)

The gateway.ini file is a server-side configuration file that is used by several server processes, including the MetaSolv Solution APIs. See "Parameters for gateway.ini File" for details about this file.

Communicating with the Oracle WebLogic Server

Application components that communicate only with the Oracle WebLogic server depend on the Oracle WebLogic Server to communicate directly with the database. Table 2-2 describes system applications that communicate with the Oracle WebLogic server.

Table 2-2 Applications That Communicate With the Oracle WebLogic Server

Application Server Connection INI Files Executable Name Product Name

tbs.ini

tbs.exe

MetaSolv Solution

jmaster.ini

jmaster.exe

jmanager.exe

Background Processor

These components are managed by configuration files that have identical, or almost identical, content. Each INI file provides the following types of information for the associated EXE:

  • An Oracle WebLogic Server profile name

    For example:

    [Application Servers]
    J2EEProfiles= 'MSS63'
  • An Oracle WebLogic Server port ID

    For example:

    [J2EEProfile MSS63]
    url=https://server.us.example.com:8630

Using a tbs_db.ini File

Table 2-3 describes system applications that communicate with the database.

Table 2-3 Applications That Communicate With the Database

Database Connect INI Files Executable Name Product Name

lerg.ini

lerg.exe

Location and Routing Gateway

npasplit.ini

npasplit.exe

NPA Split Utility

tbs_util.ini

tbs_util.exe

MetaSolv Solution Utilities

You can create a tbs_db.ini file to enable the tbs_util.exe and npasplit.exe files to communicate with the database through one file, using a shared INI parameter. Doing so allows you to make changes to only the tbs_db.ini file, which is shared by the other three files. Following is an example of a tbs_db.ini file:

[DBMS_Profiles]
Profiles= 'MSSPROD'

[Profile MSSPROD] 
DBMS=ORA 
Database=Oracle 
UserId= 
DatabasePassword= 
LogPassword= 
ServerName=M63PROD
LogId= 
Lock= 
DbParm=DisableBind=0,DelimitIdentifier='No',CommitOnDisconnect='No' 
PRomPt=1 
AutoCommit=0 
url=http://192.0.2.62:9638

lerg.ini, tbs_util.ini, and npasplit.ini include any changes that are in the tbs_db.ini file when a Sharedini= parameter is added to them, because the parameter indicates that the tbs_db.ini file should be referenced. Following is a model npasplit.ini file:

[DBMS_Profiles]
SharedIni=\\path\TBS_db.ini

Where path represents the path to the tbs_db.ini file.

Following is a sample tbs_util.ini file that uses the shared reference:

[DBMS_Profiles]
SharedIni=\\srvpldevsrvc1\testing\6.3.x_ini\tbs_db.ini

Changing INI Files

When changes are made to the location of the database or the Oracle WebLogic server, changes must be made in the MetaSolv Solution INI files. The INI files provide information about the names you want to appear in the log on database list.

Template copies of these files are copied to the /appserver/config directory on the Oracle WebLogic server by the installer. The installer edits these files to include specifications for each specific Oracle WebLogic server.

Pre-Migration Analysis Tool Configuration

Oracle provides a Pre-Migration Analysis Tool (PMAT) that should be used against a pre-M/6 MetaSolv Solution database. This tool provides a detailed analysis of what data may be affected by the Next Generation Migration. The PMAT is a separate executable found on the Oracle software delivery Web site and uses its own .ini file, Pmat.ini. To log on and use the PMAT, you must update the Pmat.ini file.

Contact Oracle Communications Consulting for guidance on how to obtain the Pmat.ini file.

The following is a sample of the file you must update:

[DBMS_Profiles]
Profiles='DatabaseProfileName'

[Profile DatabaseProfileName]
DBMS=ORA
Database=Oracle
UserId=
DatabasePassword=
LogPassword= 
ServerName=DatabaseName
LogId=
Lock=
PRomPt=1
DbParm=DisableBind=0,DelimitIdentifier='No',CommitOnDisconnect='No'
AutoCommit=0

To configure the Pmat.ini file, set the DatabaseProfileName to name the database profile parameter and set the DatabaseName to the name of the database where the migration analysis will be performed.

Setting Oracle WebLogic Server Performance Parameters

Parameters can be set that affect performance of the Oracle WebLogic Server and the database.

For proper performance of the Oracle WebLogic Server, specific MetaSolv Solution configuration settings are recommended. Those settings are discussed in the following sections.

For more information on Oracle WebLogic Server performance and MetaSolv Solution, see MetaSolv Solution Installation Guide. For information about Oracle WebLogic Server performance, see the Oracle WebLogic Server documentation.

Database performance also has a strong impact on product performance. To manage database performance, see "Managing Database Performance".

Setting gateway.ini Oracle WebLogic Server Performance Settings

Several gateway.ini parameters can have a significant negative impact on Oracle WebLogic server performance. They are:

  • CacheRefreshMode [CA]

  • DBPollingInterval [Event2]

  • DBPollingInterval [Events]

  • PrintExportObjects [Gateway]

See "Parameters for gateway.ini File" for details.

Copying Encrypted Passwords to gateway.ini

When you install the application server, the session_password and jndi_password are encrypted in the [Session] and [JNDI] sections respectively in the gateway.ini file. The encrypted passwords are prefixed with {AES}.

For example:

[Gateway]
APPJMSUser=app_jms
APPJMSPwd=
[Session]
User=app_api
Password=
[JNDI]
User=administrator
Password=
Factory=weblogic.jndi.WLInitialContextFactory
URL=t3://srvsunpluto:7001

After the application server is installed, you may opt to change the passwords for different users of the application server. If you change the user passwords for the application server, you must encrypt your new passwords, and then copy the encrypted passwords in the [Session], [Gateway], and [JNDI] sections of /appserver/gateway/gateway.ini file. See "Sample installed gateway.ini File" for more information.

To encrypt the new password using MetaSolv Solution Utilities:

  1. Start the MetaSolv Solution Utilities application. See "Using the MetaSolv Solution Utilities" for more information.

  2. From the File menu, select Security, and then select Encrypt Passwords.

    The Encrypt Passwords dialog box appears.

  3. In the Password in Text field, enter your new password.

  4. Click Encrypt.

    The encrypted password appears in the Encrypted Word field.

  5. Copy the encrypted password and paste it in the appropriate section of gateway.ini file.

  6. Restart the application server.

Setting loggingconfig.xml Oracle WebLogic Server Performance Settings

Set all logging levels to error in the loggingconfig.xml for normal use. Change the severity only during troubleshooting. For information about the loggingconfig.xml file parameters, see "Annotated Logging Configuration Files".

Setting Up API Servers

All of the API servers named in the [Servers] and [ThreadProcs] sections of the gateway.ini file are started automatically unless disabled. To disable a server, place a semicolon (;) at the beginning of the line that names the server or during installation, the servers can be disabled. By default, only the Integration server is enabled.

Some MetaSolv Solution API servers poll the MetaSolv Solution database at designated intervals to determine whether there is any work that the server should perform. These servers have their own unique set of configuration parameters. The servers are:

  • The Gateway Event server

  • Event2 server for PSR End User Billing

  • The System Task server

  • Integration Server

The Gateway Event server is the engine that handles all aspects of:

  • Dispatching internally originating events to the ORB for transmission to third-party applications

  • Recording some gateway event reported state changes in the MetaSolv Solution database

Figure 2-1 provides a view of the lifecycle of event statuses from the point of view of the MetaSolv Solution, and illustrates the function of the Gateway Event server.

Figure 2-1 State Transition Diagram for Gateway Events

Description of Figure 2-1 follows
Description of "Figure 2-1 State Transition Diagram for Gateway Events"

See "Parameters for gateway.ini File" for descriptions of these parameters. Table 2-4 lists the server processes.

Table 2-4 gateway.ini Server Processes

Server Process Description

Gateway Event server

The Gateway Event server handles dispatching internal events to the ORB and recording some gateway event state changes in the MetaSolv Solution database

Event2 server for PSR End User Billing

This server performs the same function as the Gateway Event function except for billing gateway events.

System Task server

The System Task server allows system tasks to be automatically completed by MetaSolv Solution.

Integration server

The Integration server enables the interaction of the Oracle WebLogic server, other Oracle products, and third party products.

Signal server proc

Reserved for internal processing.

For more information about the API server processes, see "Servers Parameters".

Updating Configuration Files

Under some conditions, changes must be made to parameters in configuration files. You will make changes when your environment changes, when instructed to make changes by Oracle Global Customer Support, or when using the logging files to track problems.

For details about configuration and deployment at your site, see your site's deployment diagram.

To edit the INI or XML configuration files:

  1. Backup the configuration file.

  2. Open and edit the file by using any common editor, such as Notepad.

  3. Shut down and restart the Oracle WebLogic server unless changing the loggingconfig.xml file.

For Oracle WebLogic Server-related changes, check the upper left corner in the WebLogic Server Administration Console where a message is displayed that informs you whether you need to restart the server or not.

Changing Configuration Files When the Environment Changes

Configuration files include specific information about the environment, such as machine names, database IDs, and so on. Use Table 2-5 as a guide to changing your configuration files if environment changes are made.

Table 2-5 Environment Changes Affecting Configuration Files

Situation Change These Files Location

Changing a database name

Only 2-tier application INI files

Oracle WebLogic server and client

Adding an API

gateway.ini

Oracle WebLogic server

Adding an Oracle WebLogic server

All INI files

client and server

Creating a cluster (Oracle WebLogic task)

See the Oracle Administration Console

Oracle WebLogic server

Creating a new domain (Oracle WebLogic server task)

See the Oracle Administration Console

Oracle WebLogic server

Moving an Oracle WebLogic server to another machine

All INI files

client and server

Changing ports (HTTP and log ports)

All INI files

client and server

Changing the administrative password for a domain

See the Oracle WebLogic Server documentation.

Oracle WebLogic server

Changing the Oracle database administrator password

Change the User parameter in the gateway.ini file

Oracle WebLogic server

Activating or deactivating an API

gateway.ini

Oracle WebLogic server

Changing System Preferences

System administrators manage the system and global preferences, which affect every user connected to the same MetaSolv Solution database. Users cannot alter system preferences unless given specific security permission. New preferences may be changed or added with service packs or patches.

System and global preferences affect users on one database. The System preferences affect all users of the application. Global preferences affect all users of all applications in the MetaSolv Solution product family. They are represented in the Preferences window by a globe icon. the icon for a system preference is two small heads.

To change a system preference:

  1. Log in to MetaSolv Solution.

  2. Click Application Set Up.

  3. Select Preferences.

  4. Follow instructions in the online Help to make changes.

The ability to change system preferences is a privilege that must be granted through the MetaSolv Solution Security module.

Delivering File Changes

Different configuration files are located on different components and therefore require different delivery methods when settings change.

The gateway.ini file is on the Oracle WebLogic server. Changes to it have different follow-up requirements than changes to settings on the UI or in configuration files that reside on a client machine.

Changes to product files, such as those made using service packs or patches, have other requirements.

Note:

You can dynamically change the loggingconfig.xml file in your production system. Ensure that you restrict access to this file to prevent unauthorized users from updating it.

Delivering Configuration Changes You Make

Some MetaSolv Solution configuration files reside on the client. They are:

  • jmaster.ini

  • lerg.ini

  • npasplit.ini

  • tbs.ini

  • tbs_util.ini

Other configuration files reside on the Oracle WebLogic server.

To change any configuration file:

  1. Locate the file on the Oracle WebLogic server.

  2. Open the file using Notepad or any text editor.

  3. Enter your changes and save the file.

  4. Deliver the file to the client machines manually.

  5. (Applicable only to the gateway.ini file) Restart the Oracle WebLogic server.

    Note:

    When you suspend and resume a MetaSolv Solution polling server process, that process does not re-read the gateway.ini settings that affect its operation. To put changes into effect, you must shut down and restart the Oracle WebLogic server.

Gateway Events Through Integration Server

Gateway Events through integration server continuously check the MSS database for events that are ready to be sent to an external application. The integration server also monitors the external application for updates to the status of a gateway event. When an external application sends a status update, the integration server records the new status in the MSS database.

In case of a cluster environment, Oracle recommends that you copy the integration.xml file (with added integration events) to any CORBA gateway event server (EVENTPROC) appserver to ensure that the CORBA gateway event server does not pick up the integration gateway events.

The following sections describe how to create a gateway event for communication between MSS and an external application.

Creating a Gateway Event

To create a gateway event:

  1. Create a new gateway event.

    For example: xxx_order_event.

    This is done in the Gateway window in MSS. MSS creates a gateway event and assigns an event ID.

  2. Query for the event ID associated with the gateway event, using the following SQL:

    select
    gateway_event_id, gateway_event_nm 
    from
    asap.gateway_event ge 
    where
    gateway_event_nm like = <APIGatewayName>

    In this case, APIGatewayName is the name associated with the event.

  3. Configure the event by make the following entries in the integration.xml file located at MSLV_Home/appserver:

    <handler enabled="true">
    <event-id><YourGatewayEventID></event-id> 
    <class>com.mslv.integration.handlers.DefaultEventHandler</class> 
    <destination>api</destination> 
    </handler>

    where YourGatewayEventID is the gateway eventID generated in step 2.

  4. Restart the MSS application server.

Outbound Events

All outbound events are published to a JMS queue, mss.external.event.queue, using the JMS Factory MSS.QueueConnectionFactory. The following list indicates how outbound events can be subscribed to:

  • Clients (both, third-party systems not on WebLogic and Oracle clients) can subscribe to the JMS queue externally and receive all events.

  • Products using SOA can subscribe to the queue through a channel and use event-name-based filtering to trigger appropriate workflows.

Locating Help Information On Gateway Events

  1. Open the Gateway Events window in MSS.

  2. On the navigation bar, select Application Setup, and then click Work Management Setup.

    The Work Management Setup window is displayed.

  3. Click Gateway Events.

    The Gateway Events window is displayed.

  4. Press F1 for Help.

    The Help window for the Gateway Events window is displayed. There are a number of links on this window that explain gateway events and how to create them.