This chapter describes how to verify that Oracle Communications Order and Service Management (OSM) is installed correctly.
You can verify that OSM is installed by checking the state of all installed components in the OSM WebLogic server Administrator console.
To check the state of all installed components:
Log in to the Oracle WebLogic Server console.
In the left pane of the console, expand the Environment node and select Servers.
In the right pane of the console, click the managed server on which OSM is installed.
In the tabs, select Deployments and expand oms to verify that all EJBs and modules have been deployed.
Verify that both oms and cartridge_management_ws applications are active.
Repeat 2 steps 5 to for all other managed servers in the cluster.
You can verify that OSM is installed by logging into the Order Management web client and the Task web client using the OSM administrator user account. The OSM WebLogic server instance must be running before attempting these procedures.
Some functions and screens provided by these clients are not accessible until you have created and deployed a valid OSM cartridge that includes a role configured with permissions to use these functions and screens. After doing this, you must then assign the role to a workgroup using the OSM Order Management web client. For more information, see OSM Order Management Web Client User's Guide.
You can use the product cartridges that come with the OSM installer and you can also use the following sample OSM cartridges included with Oracle Communications Design Studio:
Provisioning Broadband and Order Change Demo contained in the bb_ocm_demo cartridge file.
Provisioning View Framework Demo contained in the view_framework_demo cartridge file.
For more information about installing these sample cartridges, configuring roles, setting permissions, and deploying cartridges, see the Design Studio Help.
To log in to the Task web client:
Access the following URL in your web browser:
http://host:port/OrderManagement
Where host is the machine where OSM is installed, and port is the server's HTTP port number.
If the server has been set up for secure connection, enter https in the URL. Typically, the System Administrator would have the login information.
In the User Name field, enter the OSM administrator user name you selected when you installed OSM.
In the Password field, enter the OSM administrator password you selected when you installed OSM.
Click Login.
Note:
The New Order, Worklist, and Query tabs are not accessible for the OSM administrator. The OSM administrator user can also access the Reporting, Notification, and Options tabs.To log in to the Order Management web client:
Access the following URL in your web browser:
http://host:port/OrderManagement/orchestration
Where host is the machine where OSM is installed, and port is the server's HTTP port number.
If the server has been set up for secure connection, enter HTTPS in the URL. Typically, the System Administrator would have the login information.
In the User Name field, enter the OSM administrator user name you selected when you installed OSM.
In the Password field, enter the OSM administrator password you selected when you installed OSM.
Click Login.
Note:
You can log into the Order Management web client, but the administrator user cannot use any functions.To configure and verify HTTPS connectivity for OSM client browsers:
Ensure that you have completed the steps described in "Preparing WebLogic Server for an OSM Cluster Installation."
Access one of the following URLs in your web browser:
https://host:sslport/OrderManagement https://host:sslport/OrderManagement/orchestration
where host is the machine in which OSM is installed and sslport is the server's HTTPS port number. host and sslport can also be the host name and SSL secure port of a hardware or software load balancer, for example, if you have set up and configured the Oracle HTTP Server software load balancer.
Click Continue to this website (not recommended).
Click Certificate Error.
Click View Certificates.
Select the root certificate authority.
Click Install Certificate.
Click Next.
Select Place all certificates in the following store.
Choose Trusted Root Certification Authorities.
Click OK.
Click Yes.
Select the intermediate certificate authority.
Click Install Certificate.
Import the intermediate certificate into Intermediate Certification Authorities.
Click OK.
Click Yes.
Close the web browser.
Open the web browser. No certificate errors should appear.
The OSM installation includes an OSM compliance tool. Running this tool evaluates your system's compliance against established rules to ensure that the system is optimally configured for the environment.
This section includes the post-installation tasks required for OSM to interact with the compliance tool.
OSM provides a set of python (*.py) scripts that extend the WebLogic Scripting Tool (WLST) command vocabulary, which allows you to use WLST to run the compliance tool. For more information about WLST, see Oracle WebLogic Scripting Tool documentation. For information about using WLST over a secure connection, see the OSM System Administrator's Guide.
The compliance tool relies on WLST extensions in the WebLogic_home/common/wlst directory. When you start the OSM server for the first time, the WLST extension files are automatically installed in the correct directory. If this directory is not accessible to the OSM server, the files must be installed manually, using the procedure in this section.
To manually install compliance files:
Start an OSM WebLogic managed server.
Go to the domain_home/osm_compliance/scripts directory.
Do one of the following:
As a UNIX or Linux user with write permission to the WLST directory, run the following script:
copyComplianceWLSTScripts.sh
As a Windows user with write permission to the WLST directory, run the following script:
copyComplianceWLSTScripts.bat
The following WLST extension files are copied to the WebLogic_home/common/wlst directory: compliance.py, evaluate.py, and snapshot.py.
You can run the compliance tool on a single instance of OSM or in a clustered environment. If you are running OSM in a clustered environment, you must configure coherence remote management, which allows you to specify one node as the MBean server that manages all other nodes.
You configure coherence remote management by adding and setting system properties for OSM managed servers after you start the Java virtual machine.
To configure coherence remote management:
Log on to the WebLogic Server Administration Console.
Click Lock & Edit.
In the Domain Structure tree, expand Environment and then click Servers.
The Summary of Servers page is displayed.
Click the name of the WebLogic server where you want to designate as the MBean server that manages all other nodes.
The configuration parameters for the server are displayed on a tabbed page.
Click the Server Start tab.
In the Arguments field, enter the following:
-Dtangosol.coherence.management.remote=true -Dtangosol.coherence.management=all
Click Save.
In the Domain Structure tree, expand Environment and then click Servers.
The Summary of Servers page is displayed.
Click the name of a WebLogic server where you want to designate as the MBean clients of the MBean server.
The configuration parameters for the server are displayed on a tabbed page.
Click the Server Start tab.
In the Arguments field, enter the following:
-Dtangosol.coherence.management.remote=true -Dtangosol.coherence.management=none
Repeat steps 8 and 11 for all other managed servers in your system.
Restart the managed servers.
The OSM compliance tool captures a snapshot of your system's configuration and evaluates this configuration against established rules, which are based on best practices and guidelines. Using these rules, the compliance tool analyzes the system and produces an evaluation result that allows you to verify that your system is optimally configured for your environment.
Several default compliance tool parameters are specified in the oms-config.xml file. Use these parameters to change the directory path where the system stores the following: the compliance snapshot output, the evaluation results, the snapshot files that will be evaluated, and the evaluation rules. For more information, see OSM System Administrator's Guide.
The compliance tool is based on JMX technology and captures the configuration snapshot from target environments, such as JMX MBeans for the WebLogic domain, OSM system and database parameters, and coherence cluster for OSM.
For more information about the rules that are provided and adding new rules, see the compliance tool documentation, provided in the SDK at the following location:
OSM_home/SDK/Compliance/doc/index.html
Run the compliance tool using WebLogic Scripting Tool (WLST) scripts. For more information about WLST, see WebLogic Scripting Tool documentation.
Note:
If you are running the compliance tool in a cluster, there are additional factors to consider. For more information, see "Cluster Considerations."To run the compliance tool:
Enter WLST interactive mode and connect to an OSM managed server.
Do one of the following:
If you want to create the snapshot then evaluate it do the following:
Run the following command, which creates a snapshot of the system configuration:
osmSnapshot("snapshot_directory")
where snapshot_directory is the directory in which you want to put the snapshot of the system configuration. If you leave this blank, the system puts the snapshot in the default directory specified by the oms-config.xml file.
Run the following command, which verifies configuration compliance by evaluating the snapshot:
osmEvaluate("evaluate_directory")
where evaluate_directory is the directory in which you want to put the evaluation of the snapshot against the compliance rules. If you leave this blank, the system puts the evaluation in the default directory specified by the oms-config.xml file.
If you want to take a snapshot and immediately evaluate the snapshot do the following:
Run the following command, which creates the compliance results file:
osmCompliance("compliance_directory")
where compliance_directory is the directory in which you want to put the compliance results. If you leave this blank, the system puts the compliance results in the default directory specified by the oms-config.xml file.
You can run the compliance tool in a clustered environment. Keep in mind that the osmSnapshot command collects the following types of configuration:
common: The same on every managed server.
coherence: Available only on the managed server that has the coherence MBean server.
server: Specific to the managed server that is collecting the snapshot.
It is typical to run the compliance tool on the managed server that has the coherence MBean server because doing so will evaluate the broadest set of configuration (common, coherence, and a server). To fully check compliance, you must also run the tool on each of the other managed servers.
The compliance tool saves the evaluation results in the directory specified in the WLST command or in the oms-config.xml parameter. The evaluation results are saved in two formats: HTML and XML.
Note:
The names of the evaluation result files are in the following formats: yyyymmdd-hhmmss.xml and yyyymmdd-hhmmss.html.The evaluation results report displays information about the software versions in your environment, and then lists the results. These results are divided into the following tables:
Non-Compliant Rules: The rules with which your environment is not compliant.
Compliant Rules: The rules with which your environment is compliant.
Table 10-1 lists the columns in the HTML evaluation results file and provides a description for the information contained in each column.
Table 10-1 Compliance Tool Evaluation Results File: HTML
| Column Name | Description |
|---|---|
|
Index |
Specifies rule index in the table. |
|
Rule Name |
Displays the name of the compliance rule. |
|
Severity |
Defines the severity of this rule. Possible values are:
|
|
Description |
Specifies a general description of the rule. |
|
Message |
If the rule passes, it displays the compliant message. If the rule fails, it displays a non-compliant message and a list of non-compliant objects. |
|
Rationale |
Displays the rationale behind a compliance rule. |
|
Reference |
Specifies a link to a document that describes the compliance rule in more detail. |
|
Keywords |
Displays keywords related to targeted configurations. |
Table 10-2 lists the elements in the XML evaluation results file and provides a description for the information stored in each element.
Table 10-2 Compliance Tool Evaluation Results File: XML
| Column Name | Description |
|---|---|
|
compliantResult |
Contains the evaluation result of a compliance rule. Each compliant result element stores evaluation the result for one rule. |
|
compliantMessage |
Appears if a compliance rule passes. The message is not displayed when the rule fails. This message is copied directly from the rule file. |
|
description |
Specifies a general description of the rule. |
|
keywordlist |
Displays keywords related to targeted configurations. |
|
nonCompliantMessage |
Appears if a compliance rule fails. The message is not displayed when the rule passes. This message is copied directly from the rule file. |
|
nonCompliantObjects |
Contains a list of objects that failed the compliance rule. Non-compliant objects are not displayed when the rule passes. |
|
nonCompliantObject |
Contains an object that failed the compliance rule. |
|
rationale |
Displays the rationale behind a compliance rule. |
|
referenceUrl |
Specifies the link to a document that describes the compliance rule in more detail. |
|
ruleName |
Displays the name of the compliance rule. |
|
severity |
Defines the severity of this rule. Possible values are:
|