3 Deploying and Running Web Services Manager

Learn how to deploy and start the Oracle Communications Billing and Revenue Management (BRM) Web Services Manager.

Topics in this document:

Running and Stopping Standalone Web Services Manager

When you are using the Web Services Manager in standalone mode, you do not need to deploy the software. You can start and stop it using scripts that are provided with the product.

To start standalone Web Services Manager, run the following command from the BRM_home/bin directory: 

start_brm_wsm

When started this way, the application takes into account the values in the BRM_home/apps/brm_wsm/config/infranet.properties file.

To stop standalone Web Services Manager, run the following command from the BRM_home/bin directory: 

stop_brm_wsm

Deploying and Running Web Services Manager on WebLogic Server

You can deploy Web Services Manager on WebLogic Server through the WebLogic Server Remote Console. Depending on the type of payload supported by web services, deploy one of the following files:

  • infranetwebsvc.war: Includes web services that support the payload as an XML string data type.

  • BrmWebServices.war: Includes web services that support the payload as an XML element data type.

If you customize web services, regenerate infranetwebsvc.war or BrmWebServices.war and use the generated version. Otherwise, you should use the default infranetwebsvc.war or BrmWebServices.war file. For more information about customizing web services, see "Customizing Web Services for WebLogic Server or Tomcat Deployments".

To deploy Web Services Manager on WebLogic Server:

  1. Create the WebLogic Server domain. See the discussion about creating a WebLogic domain in Fusion Middleware Creating Domains Using the Configuration Wizard for detailed instructions.

  2. If you deploy the BrmWebServices.war file, set the heap size required to start WebLogic Server:

    1. Open the WebLogic_home/user_projects/domains/domain_Name/setDomainEnv.sh file in a text editor.

      where WebLogic_home is the directory in which WebLogic Server is installed, and domain_name is the name of the domain you created in step 1.

    2. Add the following entry:

      USER_MEM_ARGS ="-Xms2048m -Xmx2048m"

    3. Save and close the file.

    4. Restart WebLogic Server.

  3. Do one of the following:

    • If you customized web services:

      1. Extract the BRM_home/deploy/web_services/infranetwebsvc.war or the BRM_home/deploy/web_services/BrmWebServices.war file to local_dir.

        where BRM_home is the directory in which BRM is installed, and local_dir is a directory on the machine on which you installed WebLogic Server.

      2. Copy the CustomFields.jar files to the local_dir/WEB-INF/lib directory. See "Setting Up Web Services Manager to Support Custom Opcodes" for more information.

        Note:

        The JRE version that was used to generate CustomFields.jar must be the same or lower than the version of the WebLogic Server JRE.

      3. Open the BRM_home/deploy/web_services/Infranet.properties file in a text editor.

      4. Modify the following entry:

        infranet.custom.field.package = package

        where package is the name of the package that contains the CustomOp.java file. For example: com.portal.classFiles.

      5. Add all the custom fields to the Infranet.properties file.

      6. Save and close the file.

      7. Copy the BRM_home/deploy/web_services/Infranet.properties file to local_dir/WEB-INF/classes or to the home directory on the machine on which WebLogic Server is installed.

      8. Regenerate the WAR file by running one of the following commands:

        To regenerate the infranetwebsvc.war file: 

        jar -cvf infranetwebsvc.war *

        To regenerate the BrmWebServices.war file: 

        jar -cvf BrmWebServices.war *

    • If you did not customize web services:

      1. Extract the BRM_home/deploy/web_services/infranetwebsvc.war or the BRM_home/deploy/web_services/BrmWebServices.war file to local_dir.

      2. Copy the BRM_home/deploy/web_services/Infranet.properties file to local_dir/WEB-INF/classes directory or to the home directory on the machine on which WebLogic Server is installed.

      3. Regenerate the WAR file by running one of the following commands:

        To regenerate the infranetwebsvc.war file: 

        jar -cvf infranetwebsvc.war *

        To regenerate the BrmWebServices.war file: 

        jar -cvf BrmWebServices.war *

  4. Log in to WebLogic Server Remote Console.

  5. Click Edit Tree, then Deployments, then App Deployments.

    The existing deployments are displayed in a table.

  6. Click New.

  7. Enter the name for the deployment in the Name field, move your administration server name in the Targets list to the Chosen area, and turn off Upload.

  8. Click Choose File next to the Source field and browse to the infranetwebsvc.war or BrmWebServices.war file.

  9. Click Create.

    The deployed application is added to the list.

  10. Click the name of your new deployment to view and configure any other deployment options.

To start Web Services Manager for web services:

  1. Click Monitoring Tree, then Deployments, then Application Management.

    A table containing the deployments is displayed.

  2. Select the box next to the deployments you created, such as infranetwebsvc or WSM, and click Start.

Deploying and Running Web Services Manager on Tomcat Server

You can deploy Web Services Manager on Apache Tomcat Server through the Tomcat Web Application Manager. See BRM Compatibility Matrix to ensure you are using the supported version of Apache Tomcat.

Depending on the type of payload supported by web services, deploy one of the following files:

If you customize web services, regenerate infranetwebsvc.war or BrmWebServices.war and use the generated version. Otherwise, you should use the default infranetwebsvc.war or BrmWebServices.war file. For more information about customizing web services, see "Customizing Web Services for WebLogic Server or Tomcat Deployments".

Deploying and Running infranetwebsvc.war

To deploy Web Services Manager for web services that support the payload as an XML string data type on Tomcat server:

  1. BRM Web Services Manager uses earlier versions of Java libraries that Tomcat no longer supports. To use BRM Web Services Manager with Tomcat, you must convert the libraries to work with Tomcat:

    1. Download version 1.0.0 of the Eclipse Transformer to the BRM_home/deploy/web_services directory.

    2. Extract the contents of the distribution JAR file using the following command:

      jar xf org.eclipse.transformer.cli-1.0.0-distribution.jar

    3. Convert the .war file to use Tomcat's version of the libraries using the following command:

      java -jar org.eclipse.transformer.cli-1.0.0.jar infranetwebsvc.war  infranetwebsvc-jakarta.war

  2. Create the Tomcat server domain.

    See the Tomcat documentation for detailed instructions.

  3. Download the JAX-WS Reference Implementation (RI) library, version 4.0.3, from.

  4. Extract the jaxws-ri-4.0.3.zip file and copy the following files to Tomcat_home/lib, where Tomcat_home is the directory in which the Tomcat server is installed:

    • gmbal-api-only.jar

    • ha-api.jar

    • jakarta.activation-api.jar

    • jakarta.xml.bind-api.jar

    • jakarta.xml.soap-api.jar

    • jakarta.xml.ws-api.jar

    • jaxb-core.jar

    • jaxb-impl.jar

    • jaxb-jxc.jar

    • jaxb-xjc.jar

    • jaxws-rt.jar

    • jaxws-tools.jar

    • management-api.jar

    • saaj-impl.jar

    • stax-ex.jar

    • streambuffer.jar

  5. Download xalan-2.7.0.jar file and copy it file to Tomcat_home/lib.

  6. In the infranetwebsvc-jakarta.war/WEB-INF/web.xml file, uncomment the servlet-to-URL mapping and save and close the file.

  7. Log in to the Tomcat Web Application Manager.

  8. In the War file to deploy section, click Browse.

  9. Select the infranetwebsvc-jakarta.war file and click Deploy.

    Tomcat Web Application Manager displays the deployed application in the Applications list.

For more information about the BRM web services included in Web Services Manager that take the payload as an XML string data type, see "Using Web Services".

Deploying and Running BrmWebServices.war

To deploy Web Services Manager for web services that support the payload as an XML element data type on Tomcat server:

  1. BRM Web Services Manager uses earlier versions of Java libraries that Tomcat no longer supports. To use BRM Web Services Manager with Tomcat, you must convert the libraries to work with Tomcat:

    1. Download version 1.0.0 of the Eclipse Transformer to the BRM_home/deploy/web_services directory.

    2. Extract the contents of the distribution JAR file using the following command:

      jar xf org.eclipse.transformer.cli-1.0.0-distribution.jar

    3. Convert the .war file to use Tomcat's version of the libraries using the following command: 

      java -jar org.eclipse.transformer.cli-1.0.0.jar BrmWebServices.war BrmWebServices-jakarta.war

  2. Create the Tomcat server domain.

    See the Tomcat documentation for detailed instructions.

  3. Download the JAX-WS Reference Implementation (RI) library, version 4.0.3.

  4. Extract the jaxws-ri-4.0.3.zip file and copy the following files to Tomcat_home/lib, where Tomcat_home is the directory in which the Tomcat server is installed:

    • gmbal-api-only.jar

    • ha-api.jar

    • jakarta.activation-api.jar

    • jakarta.xml.bind-api.jar

    • jakarta.xml.soap-api.jar

    • jakarta.xml.ws-api.jar

    • jaxb-core.jar

    • jaxb-impl.jar

    • jaxb-jxc.jar

    • jaxb-xjc.jar

    • jaxws-rt.jar

    • jaxws-tools.jar

    • management-api.jar

    • saaj-impl.jar

    • stax-ex.jar

    • streambuffer.jar

  5. Download xalan-2.7.0.jar file and copy it file to Tomcat_home/lib.

  6. In the BrmWebServices-jakarta.war/WEB-INF/web.xml file, uncomment the servlet-to-URL mapping and save and close the file.

  7. Log in to the Tomcat Web Application Manager.

  8. In the War file to deploy section, click Browse.

  9. Select the BrmWebServices-jakarta.war file and click Deploy.

    Tomcat Web Application Manager displays the deployed application in the Applications list.

  10. In the Applications list, click the /BrmWebServices link.

  11. The Tomcat Web Application Manager displays an HTTP and an HTTPS URL for the BRM web services.

    A sample URL for the BRMCUSTServices_v2 web service is as follows: 

    http://hostname:port/BrmWebServices/BRMCUSTServices_v2?wsdl

    where:

    • hostname is the domain IP address of the application server on which Web Services Manager is deployed.

    • port is the domain port number of the application server on which Web Services Manager is deployed.

      Web Services Manager displays the WSDL URLs for each available service.

For more information about the BRM web services included in Web Services Manager that take the payload as an XML element data type, see "Using Web Services".