Oracle Communications Services Gatekeeper - Core Core Guide Edition 1.0 July 2016
Copyright 2016, Oracle and/or its affiliates. All rights reserved. Disclaimer This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way. Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display, perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization of Oracle. The information contained in this document is subject to change without notice. This document is not warranted to be error-free. Restricted Rights Notice If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS The U.S. Government s rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted by the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract. Trademark Notice Oracle and Java are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
Table of Contents Practices: BASIC...1-1 Practices Overview...1-3 BASIC-1: Downloading the Services Gatekeeper Software...1-4 BASIC-2: Installing Services Gatekeeper...1-5 BASIC-3: Configuring the Services Gatekeeper Domain...1-7 BASIC-4: Starting the Services Gatekeeper Servers...1-12 BASIC-5: Creating Desktop Shortcuts...1-16 BASIC-6: Changing Networking (Reference)...1-18 Practices: DOCS...2-1 Practices Overview...2-3 DOCS-1: Exploring the Services Gatekeeper Documentation...2-4 Answers to the Questions in This Practice...2-7 Practices: ADMIN...3-1 Practices Overview...3-3 ADMIN-1: Examining Log Files and Using the Administration Console...3-4 ADMIN-2: Using WebLogic Scripting Tool...3-6
Practices: BASIC Chapter 1 Practices: BASIC Chapter 1 - Page 1
Practices: BASIC Chapter 1 - Page 2
Practices Overview Practices Overview In these practices, you will download and install and configure Services Gatekeeper. Product Versions The following practices have been tested on Oracle Linux 6 using Oracle Database Express Edition (XE) version 11g R2 and Oracle Communications Services Gatekeeper version 6.0. Prerequisites You should already have an installation of: Oracle Linux Oracle Database Express Edition (XE) Environment Your environment will be different depending on which network topology you use, for example Bridged, NAT, Host-Only. When the instructions contain the text <IP>, you need to replace this with an IP-address. To find out the IP address of your machine, use the following command: $ ifconfig eth0 Link encap:ethernet HWaddr... inet addr:10.0.2.15 Bcast:10.0...... Note: The IP address in the example above is 10.0.2.15. Practices: BASIC Chapter 1 - Page 3
BASIC-1: Downloading the Services Gatekeeper Software Overview In this practice, you will download the Oracle Communications Services Gatekeeper software. You will download the generic JAR file for doing a multi-tier installation. Accessing the Oracle Software Delivery Cloud Since websites are often changed, the instructions below might differ slightly from the way the site looks at the moment. But the process should be very similar. 1. In your laptop, open a browser and go to http://edelivery.oracle.com. The Oracle Software Delivery Cloud screen appears. 2. Click Sign In and provide your credentials. The Export Restrictions screen appears. Note: if you do not have an Oracle Account, click New User? Register Here. 3. Study the Export Restrictions and decide if you are ready to comply. If you accept the export restrictions, the screen for searching for products appears. 4. In the Product field, enter Gatekeeper. A list of matching products appears. 5. Click the latest available release of Oracle Communications Services Gatekeeper. 6. Click Select Platform. A list of platforms appears. 7. Select Linux x86-64. 8. Click Select. In the list of selected items, Release: Oracle Communications Services Gatekeeper for Linux x86-64 appears. 9. Click Continue. The most recent update of Oracle Communications Services Gatekeeper appears. 10. Click Continue. The License Agreement window appears. 11. Study the License Agreement and decide if you are ready to comply. If you accept the license agreement, the File Download screen appears. Downloading Services Gatekeeper 12. Click the link for Oracle Communications Services Gatekeeper 6.0 Multi-tier Software. 13. Save the file to your computer. The file is named V73996-01.zip. 14. Unpack the ZIP file and copy or move the file ocsg_multitier_generic.jar to the shared directory on your host computer, which should be C:\VMs\Shared. Summary You have now downloaded the Oracle Communications Services Gatekeeper software. Practices: BASIC Chapter 1 - Page 4
BASIC-2: Installing Services Gatekeeper Overview In this practice, you will install Oracle Communications Services Gatekeeper. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Checking the Java Installation Services Gatekeeper is certified to be used with Java 7, but it is forward compatible with Java 8. The environment has both versions available, but you will be using Java 8. 3. Check the Java version: $./javacheck.sh 4. If you need to change to Java 8, run the following script: $./java8set.sh Installing Services Gatekeeper 5. Create a directory for the installation: $ cd /opt $ sudo mkdir ocsg600multi 6. Set the user oracle as the owner of the new directory: $ sudo chown oracle:oinstall ocsg600multi 7. Start the installer: $ java -jar /mnt/shared/ocsg_multitier_generic.jar The Installation Inventory Setup screen appears. 8. In the Operating System Group, select oinstall. 9. Click OK. The Welcome screen appears. 10. Click Next. The Installation Location screen appears. 11. In the Oracle Home field, enter /opt/ocsg600multi. 12. Click Next. The Installation Type screen appears. 13. Click Next. The Prerequisite Checks screen appears. 14. Click Next. The Installation Summary screen appears. 15. Click Install. Practices: BASIC Chapter 1 - Page 5
The Installation Progress screen appears and after a while all the installation tasks are done. 16. Click Next. The Installation Complete screen appears. 17. Deselect Automatically Launch the Configuration Wizard. 18. Click Finish. Installing a Fix for Third Party Call Unfortunately there is a bug in the third party call service that you need to install a fix for. The following instructions will only work if this is done before starting the servers the first time. 19. Change to the applications directory of your Services Gatekeeper installation and backup the original third party call ear: $ cd /opt/ocsg600multi/ocsg/applications $ cp wlng_nt_third_party_call_px21.ear wlng_nt_third_party_call_px21.ear.backup 20. Copy the fixed ear file: $ cp ~/ocsgcourse/labs/3rdpartycall/wlng_nt_third_party_call_px21.ear. Summary You have now installed Services Gatekeeper. Practices: BASIC Chapter 1 - Page 6
BASIC-3: Configuring the Services Gatekeeper Domain Overview Before you can use Oracle Communications Services Gatekeeper, you need to create a domain. In this practice you will create a basic high available domain with one administration server and two managed servers. These managed servers will both have the Access Tier and Network Tier functionality co-located and will participate in the same cluster. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Starting the Domain Configuration Wizard 3. Create the domains directory: $ cd ocsgcourse $ mkdir domains 4. Start the Domain Configuration wizard: $ /opt/ocsg600multi/wlserver/common/bin/config.sh The Configuration Type screen appears. Creating and Configuring the Domain 5. Verify that Create a new domain is selected. 6. In the Domain Location field, enter /home/oracle/ocsgcourse/domains/ocsgdomain. 7. Click Next. Practices: BASIC Chapter 1 - Page 7
The Templates screen appears. 8. Select OCSG Basic HA Configuration and click Next. The Administrator Account screen appears. 9. In the Password and Confirm Password fields, enter p4ssword. 10. Click Next. The Domain Mode and JDK screen appears. 11. Verify that Domain Mode is set to Development. 12. Verify that JDK is set to Oracle HotSpot. 13. Click Next. The JDBC Data Sources screen appears. 14. Select both wlng.datasource and wlng.localtx.datasource. 15. In the DBMS/Service field, enter XE. 16. In both the Username and Password fields, enter ocsg_lab. 17. Select only wlng.datasource and verify that the Driver is set to Oracle s Driver (Thin XA) for instance connections. 18. Select only wlng.localtx.datasource and verify that the Driver is set to Oracle s Driver (Thin) for instance connections. 19. Click Next. The JDBC Data Sources Test screen appears and the database connections are tested. Note: If any of the connection tests fails, you need to go back and correct the settings in the previous screen. 20. Click Next. The Advanced Configuration screen appears. 21. Select Administration Server, Managed Servers, Clusters and Coherence and Deployments and Services. 22. Click Next. The Administration Server screen appears. 23. In the Listen Address field, select All Local Addresses. 24. Click Next. The Managed Servers screen appears. 25. For both servers, in the Listen Address field, select <IP>. Note: Whenever the instructions contain the text <IP>, you need to replace this with the IPaddress of your virtual machine. 26. For Server1, set Listen Port to 7011 and SSL Listen Port to 7012. 27. For Server2, set Listen Port to 7021 and SSL Listen Port to 7022. 28. Click Next. The Clusters screen appears. Note: The configuration wizard has now saved the SSL Listen Ports. 29. Click Back. 30. For both servers, deselect Enable SSL. Note: Even though we are disabling SSL, we set the port to the appropriate values to make sure this works if SSL is enabled later. 31. Click Next. Practices: BASIC Chapter 1 - Page 8
The Clusters screen appears, again. 32. In the Cluster Address enter <IP>:7011, <IP>:7021. For example: 10.0.2.15:7011, 10.0.2.15:7021. 33. Click Next. The Assign Servers to Clusters screen appears. 34. Click Next. The Machines screen appears. 35. Select ServerMachine2 and click Delete. 36. Change name of ServerMachine1 to ServerMachine. 37. Click Next. The Assign Servers to Machines screen appears. 38. In the left panel, select Server2 and in the right panel select ServerMachine, then click the right arrow icon. Server2 is moved to the right panel and is configured to be deployed on the ServerMachine. 39. Click Next. The Deployments Targeting screen appears. 40. By default, all the application services are deployed, which is unnecessary for the practices. Select items in the right panel and click the left arrow icon to remove the services from your deployment until only the following items remains: Application daf-multitier-at daf-multitier-nt interceptors wlng_at_multimedia_messaging_parlay_rest wlng_at_multimedia_messaging_px21 wlng_at_oauth wlng_at_payment_parlay_rest wlng_at_payment_px30 wlng_at_portal_service wlng_at_qos_px40 wlng_at_qos_rest wlng_at_rest_portal_service wlng_at_session wlng_at_sms_parlay_rest wlng_at_sms_px21 wlng_at_terminal_location_px21 wlng_at_terminallocation_parlay_rest wlng_at_third_party_call_px21 wlng_nt_multimedia_messaging_px21 wlng_nt_oauth wlng_nt_payment_px30 wlng_nt_portal wlng_nt_qos Practices: BASIC Chapter 1 - Page 9
wlng_nt_session wlng_nt_sms_px21 wlng_nt_terminal_location_px21 wlng_nt_third_party_call_px21 wlng_prm xparam_interceptors Library DafExternalActions pubsub rest-core 41. Click Next. The Services Targeting screen appears. 42. Remove the following item from the AdminServer in the Targets panel: jsr309driveroam 43. Click Next. The Configuration Summary screen appears. 44. Click Create. The Configuration Progress screen appears. 45. Click Next. The Configuration Success screen appears. 46. Click Finish. Configuring Randomization To minimize the impact of low entropy in your practice environment, you will configure the domain environment script to use the non-blocking device urandom instead of the blocking device random. However, in a production system, where secure keys are generated, this workaround should not be used. Notice that the path to urandom needs to be obfuscated as /dev/./urandom since Java, for unknown reasons, automatically replaces /dev/urandom with /dev/random. 47. Open the domain environment script for editing: $ cd $ cd ocsgcourse/domains/ocsgdomain/bin $ gedit setdomainenv.sh 48. When the last possible change of MEM_ARGS has been done, as shown in the first part of the code below, add the code for using urandom: if [ "${USER_MEM_ARGS}"!= "" ] ; then MEM_ARGS="${USER_MEM_ARGS}" export MEM_ARGS fi # Use /dev/urandom instead of /dev/random for entropy MEM_ARGS="${MEM_ARGS} -Djava.security.egd=file:/dev/./urandom" export MEM_ARGS Practices: BASIC Chapter 1 - Page 10
Note: The code above should be added near line 270 in the file. Summary You have now created a Services Gatekeeper domain to be used in the practices of this course. Practices: BASIC Chapter 1 - Page 11
BASIC-4: Starting the Services Gatekeeper Servers Overview After creating the Services Gatekeeper domain you have a configuration with an administration server and a cluster with two managed server. In this practice you will start these servers and examine the configuration through the administration console. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Starting the Services Gatekeeper Administration Server 3. Start the administration server in your Services Gatekeeper domain: $ cd ocsgcourse/domains/ocsgdomain $./startweblogic.sh The administration server is fully started when you see the message The server started in RUNNING mode. 4. From the Terminal menu, select Set Title. The Set Title dialog appears. 5. In the Title field, enter Admin and click OK. The title of the terminal window changes to Admin. Logging in to the Administration Console 6. Start Firefox and go to: http://127.0.0.1:7001/console. 7. Enter the user name weblogic and the password p4ssword. 8. Click Login. The Administration Console appears. Setting the Listen Address for the Administration Server 9. In the Domain Structure panel, expand Environment and click Servers. The list of servers appears. 10. Click AdminServer. 11. In the Listen Address field, enter <IP>. 12. Click Save. 13. In the Admin terminal window, press Ctrl-C to stop the server. 14. Press up-arrow to recall the last command and then press Enter to restart the server. Logging in to the Administration Console Again When you log into the administration console the next time, you need to use the IP-address instead of the localhost (127.0.0.1) address. Practices: BASIC Chapter 1 - Page 12
15. In Firefox, go to: http://<ip>:7001/console. 16. Enter the user name weblogic and the password p4ssword. 17. Click Login. The Administration Console appears. Starting the Managed Servers 18. Open a new terminal window and set the window title to Server1. 19. Start the first managed server in your domain: $ cd ocsgcourse/domains/ocsgdomain/bin $./startmanagedweblogic.sh Server1 http://<ip>:7001 20. At the prompt Enter username to boot WebLogic server, enter weblogic. 21. At the prompt Enter password to boot WebLogic server, enter p4ssword. The managed server is fully started when you see the message The server started in RUNNING mode. 22. In the Server1 terminal window, from the File menu, select Open Terminal. A new terminal window appears with the prompt already in the correct directory. 23. Set the window title to Server2. 24. Start the second managed server in your domain: $./startmanagedweblogic.sh Server2 http://<ip>:7001 25. At the prompt Enter username to boot WebLogic server, enter weblogic. 26. At the prompt Enter password to boot WebLogic server, enter p4ssword. The managed server is fully started when you see the message The server started in RUNNING mode. Creating Boot Identity Files for Easier Server Start Up By default you have to supply the username and password at every startup of the managed servers. To make this process a little bit easier you will store this information in properties files instead. You will store the username and password in clear text, but after the first startup of the servers, you will see that this information is encrypted. 27. Open a new terminal window and change to the directory for Server2: $ cd ocsgcourse/domains/ocsgdomain/servers/server2 28. Create a directory for the security settings of the Server2 server: $ mkdir security 29. Create a boot properties file in the security directory: $ cd security $ gedit boot.properties 30. Enter the following two lines: username=weblogic password=p4ssword 31. Save the file and exit the editor. 32. Copy the file to Server1: $ cd../../server1 $ cp -r../server2/security. Practices: BASIC Chapter 1 - Page 13
Creating Start Scripts for the Servers 33. Change to the course directory: $ cd $ cd ocsgcourse 34. Create a start script for Admin: $ gedit start_basic_admin.sh 35. Enter the following two lines: #!/bin/sh cd /home/oracle/ocsgcourse/domains/ocsgdomain./startweblogic.sh 36. Save the file and exit the editor. 37. Make the file executable: $ chmod +x start_basic_admin.sh 38. Create a start script for Server1: $ gedit start_basic_server1.sh 39. Enter the following two lines: #!/bin/sh cd /home/oracle/ocsgcourse/domains/ocsgdomain/bin./startmanagedweblogic.sh Server1 http://<ip>:7001 40. Save the file and exit the editor. 41. Make the file executable: $ chmod +x start_basic_server1.sh 42. Copy the file to create a start script for Server2: $ cp start_basic_server1.sh start_basic_server2.sh 43. Edit the start script for Server2: $ gedit start_basic_server2.sh 44. Replace Server1 with Server2. 45. Save the file and exit the editor. Restarting the Servers 46. In the Admin terminal window, press Ctrl-C to stop the server. 47. Use the new script to restart the server: $ cd $ cd ocsgcourse $./start_basic_admin.sh 48. In the Server1 terminal window, press Ctrl-C to stop the server. 49. Use the new script to restart the server: $ cd $ cd ocsgcourse $./start_basic_server1.sh 50. Open a new terminal window and check the boot property file to make sure that the username and password are now encrypted: $ cd Practices: BASIC Chapter 1 - Page 14
$ cd ocsgcourse/domains/ocsgdomain/servers/server1/security $ more boot.properties #Tue Jul 11... password={aes}h9uwxgafhh7jf0xwaes45nnz4he7t2rkufsical6owe\= username={aes}oeluaolcsil0t3mxbp7kyhidmhtkc5usykbq62ytjve\= 51. In the Server2 terminal window, press Ctrl-C to stop the server. 52. Use the new script to restart the server: $ cd $ cd ocsgcourse $./start_basic_server2.sh Shutting Down the Services Gatekeeper Servers 53. In the Server2 terminal window, press Ctrl-C to stop the server. 54. In the Server1 terminal window, press Ctrl-C to stop the server. 55. In the Admin terminal window, press Ctrl-C to stop the server. Summary You have now configured, started and shut down all the servers in your domain. Practices: BASIC Chapter 1 - Page 15
BASIC-5: Creating Desktop Shortcuts Overview In this practice, you will create desktop shortcuts for starting both the administration and the managed server for your domain. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Creating a Shortcut for Starting the Administration Server 3. Right click in an empty space on the desktop, and select Create Launcher. The Create Launcher dialog box appears. 4. In the Name field, enter Admin Basic. 5. In the Command field, enter gnome-terminal --title "Admin Basic" -e /home/oracle/ocsgcourse/start_basic_admin.sh. 6. Click the default icon, which looks like a spring with a small platform. The Choose an icon dialog box appears. 7. Click pixmaps in the Places panel, select the wls_start.png file, and click Open. The Create Launcher dialog box appears again. 8. Click OK. Creating a Shortcut for Starting the Managed Servers 9. Right click in an empty space on the desktop, and select Create Launcher. The Create Launcher dialog box appears. 10. In the Name field, enter Server1 Basic. 11. In the Command field, enter gnome-terminal --title "Server1 Basic" -e /home/oracle/ocsgcourse/start_basic_server1.sh. 12. Click the default icon, which looks like a spring with a small platform. The Choose an icon dialog box appears. 13. Click pixmaps in the Places panel, select the wls_start.png file, and click Open. The Create Launcher dialog box appears again. 14. Click OK. 15. Right click in an empty space on the desktop, and select Create Launcher. The Create Launcher dialog box appears. 16. In the Name field, enter Server2 Basic. 17. In the Command field, enter gnome-terminal --title "Server2 Basic" -e /home/oracle/ocsgcourse/start_basic_server2.sh. 18. Click the default icon, which looks like a spring with a small platform. The Choose an icon dialog box appears. Practices: BASIC Chapter 1 - Page 16
19. Click pixmaps in the Places panel, select the wls_start.png file, and click Open. The Create Launcher dialog box appears again. 20. Click OK. Starting the Services Gatekeeper Servers 21. Double-click the new Admin Basic icon. The administration server is starting. 22. Double-click the new Server1 Basic icon. The managed server is starting. 23. Double-click the new Server2 Basic icon. The managed server is starting. Shutting Down the Services Gatekeeper Servers 24. In the Server2 terminal window, press Ctrl-C to stop the server. 25. In the Server1 terminal window, press Ctrl-C to stop the server. 26. In the Admin Basic terminal window, press Ctrl-C to stop the server. Summary You have now created desktop shortcuts for starting both the administration and the managed servers for your domain. Practices: BASIC Chapter 1 - Page 17
BASIC-6: Changing Networking (Reference) Overview The following instructions will help you change the type of networking in your running VM and properly use the new IP address. Only use these instructions if your VM needs to: Change from wired to wireless networking, or vice versa. Change from NAT networking to bridged or host-only networking. One important reason to change to host-only networking is if your laptop is not networked. This can lead to problems when starting some servers since the operating system is configured to use the network to create unique identifiers. Tasks Changing the Type of Networking for the VM 1. Make sure that the Converged Application Server is not running. 2. From the Virtual Box menu Devices, select Network Adapters. 3. For the Attached To field, select the type of networking you want to use. 4. For the Name field, select the network card you want to use. 5. Click OK. Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 6. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. Restarting the Network in Linux 7. Open a terminal window. 8. Restart the network: $ sudo /etc/init.d/network restart 9. Find out the new IP address: $ ifconfig Changing the IP Address for the Converged Application Server 10. Change to the config directory of the domain and open the configuration file for editing: $ cd $ cd ocsgcourse/domains/ocsgdomain/config $ gedit config.xml 11. Find all occurrences of the old IP-address and change it to the new one, for example: <listen-address>10.0.2.15</listen-address> Note: You need to change the listen address for the administration server and for the two managed servers. You also need to change the IP addresses of the cluster. 12. Save the file and close the editor. 13. Change to the JDBC configuration directory and open the two configuration files for JDBC: $ cd jdbc Practices: BASIC Chapter 1 - Page 18
$ gedit wlng-jdbc.xml wlng-localtx-jdbc.xml 14. Find all occurrences of the old IP-address, in both files, and change it to the new one. 15. Save the files and close the editor. Summary You have now changed the networking of the VM and made sure that the new networking settings are used. Practices: BASIC Chapter 1 - Page 19
Practices: BASIC Chapter 1 - Page 20
Practices: DOCS Chapter 2 Practices: DOCS Chapter 2 - Page 1
Practices: DOCS Chapter 2 - Page 2
Practices Overview Practices Overview In this practice, you will explore the documentation for Oracle Communications Services Gatekeeper, Oracle WebLogic Server, and Oracle Communications Converged Application Server. Practices: DOCS Chapter 2 - Page 3
DOCS-1: Exploring the Services Gatekeeper Documentation Overview Oracle Communications Services Gatekeeper is built on top of Oracle WebLogic Server. The procedures for how to configure JDBC and JMS, and how to deploy and undeploy J2EE applications, are described in the WebLogic Server guides. Services Gatekeeper includes communication services that integrate with networks through Session Initiation Protocol (SIP). Because of this, the SIP container from Oracle Communications Converged Application Server is included in the Services Gatekeeper installation. Information about configuring and managing the SIP container is in the Converged Application Server guides. In this practice, you will explore some of the documentation that you might need when working with Services Gatekeeper. This documentation includes: Oracle Communications Services Gatekeeper Oracle Communications Converged Application Server Oracle WebLogic Server You will also answer some quiz questions related to certain content in these guides. Note: Answers to the quiz questions are supplied at the end of this practice. Tasks Exploring the Services Gatekeeper Documentation In this task, you will locate and read about Services Gatekeeper container services. 1. Start a web browser and go to http://www.oracle.com. 2. Place your cursor over the Support tab and select Product Documentation in the list of options. 3. In the list of product categories, click Industries. 4. In the list of product groups, click Oracle Communications documentation. 5. In the list of products, find the Network Applications group and click Services Gatekeeper. The home page for Services Gatekeeper Documentation appears. 6. In the list of releases, click Release 6.0. The home page for Oracle Communications Services Gatekeeper Release 6.0, Documentation appears. 7. Click System Administrator s Guide. 8. Click Deploying and Administering Communication Services. 9. Browse the documentation for the Finding Container services section. Tip: Use Ctrl-F to search for a specific text in the web page. 10. Read about the available container services. Container Services Documentation and Quiz In the System Administrator s Guide, open the Managing and Configuring EDRs, CDRs and Alarms chapter, browse the text and follow links to answer the following question: What type of J2EE component is an external EDR listener? Practices: DOCS Chapter 2 - Page 4
Communication Services Documentation and Quiz The Services Gatekeeper documentation set includes a Communication Service Reference Guide, which describes all communication services included in Services Gatekeeper. Use this guide, and follow any links or references to answer the following questions: Which network protocols does the Native SMPP Communication Service support? At which points are CDRs generated for the Parlay X 2.1 Short Messaging/SMPP Communication Service? Release Notes Documentation and Quiz When a new version of Services Gatekeeper is released, the best place to get an overview of the new features is in the release notes. Use the Release Notes chapter to answer the following question: On which version of WebLogic Server does Services Gatekeeper 6.0 run? Exploring the Converged Application Server Documentation The SIP container is included in the Services Gatekeeper installation. Administration of the SIP container is separate from administration of Services Gatekeeper. The Administration Console includes a separate section for configuring and monitoring the SIP container, as shown in the screenshot below. You find the documentation for the SIP container in the Converged Application Server guides. In this task, you will read the documentation for the SipServer part of the Administration Console. 11. In your web browser, go to http://www.oracle.com. 12. Place your cursor over the Support tab and select Product Documentation in the list of options. 13. In the list of product categories, click Industries. 14. In the list of product groups, click Oracle Communications documentation. 15. In the list of products, find the Network Applications group and click Converged Application Server. The home page for Converged Application Server Documentation appears. 16. In the list of releases, click Release 7.0. The home page for Oracle Communications Converged Application Server Release 7.0, Documentation appears. Practices: DOCS Chapter 2 - Page 5
17. Click Administrator s Guide. 18. Expand Converged Application Server Configuration Overview. 19. Click Overview of Configuration and Administration Tools. 20. Read the Administration Console section, which refers to the SipServer part of the console. 21. Click the Accessing the Administration Console link, and read about each of the tabs for the SipServer part of the Administration Console. Exploring the WebLogic Server Documentation Services Gatekeeper runs on top of Oracle WebLogic Server. Thus, much of the information you need to manage Services Gatekeeper is in the WebLogic Server documentation. In this task you will read the documentation for how to install a Java Enterprise Archive (an EAR file) by using the Administration Console. All the Services Gatekeeper communication services are packaged as EAR files. 22. In your web browser, go to http://www.oracle.com. 23. Place your cursor over the Support tab and click Product Documentation in the list of alternatives. 24. In the list of product categories, click Middleware. 25. In the list of Middleware products, click Oracle WebLogic Server. The Oracle WebLogic Server, Get Started page appears. 26. In the left-hand menu, click Administer. 27. In the Manage the Environment section, click Administer with Administration Console. 28. Browse the list of topics to find the Deploy and configure resources section. 29. Click the Install an enterprise application link and read about how to use the Administration Console to deploy an EAR file. Summary You have now explored the documentation for Services Gatekeeper, Converged Application Server, and WebLogic Server. Practices: DOCS Chapter 2 - Page 6
Answers to the Questions in This Practice Answers What type of J2EE component is an external EDR listener? Answer: A JMS topic subscriber Which network protocols does the Native SMPP Communication Service support? Answer: SMPP v 3.4 and SMPP v 5.1. At which points are CDRs generated for the Parlay X 2.1 Short Messaging/SMPP Communication Service? There are three Short Messaging/SMPP-specific CDRs. A CDR is generated when one of the following criteria are met: After Services Gatekeeper has successfully received and processed an applicationoriginated message, and successfully sent all segments of the message to the network. After Services Gatekeeper receives and processes a delivery report sent from the network. After Services Gatekeeper successfully receives and processes a mobile-originated message sent from the network. On which version of WebLogic Server does Services Gatekeeper 5.1 run? Answer: WebLogic Server 12c (12.1.3). Practices: DOCS Chapter 2 - Page 7
Practices: DOCS Chapter 2 - Page 8
Practices: ADMIN Chapter 3 Practices: ADMIN Chapter 3 - Page 1
Practices: ADMIN Chapter 3 - Page 2
Practices Overview Practices Overview In these practices, you will start your Services Gatekeeper administration server, examine log and trace files, and use the Administration Console. Product Version The following practices have been tested on Oracle Linux 6 using Oracle Database Express Edition (XE) version 11g R2 and Oracle Communications Services Gatekeeper version 6.0. Prerequisites You should already have: An installation of Oracle Linux An installation of Oracle Database Express Edition (XE) An installation of Oracle Communication Services Gatekeeper A basic Services Gatekeeper domain Environment Your environment will be different depending on: which network topology you use, for example Bridged, NAT, Host-Only which type of installation you have done, for example single-tier or multi-tier When the instructions contain the text <IP>, you need to replace this with an IP-address. When the instructions contain the text <PORT>, you need to replace this with the Port number for the managed server. When the instructions contain the text <DOMAIN>, you need to replace this with the path for your domain. To find out the IP address of your machine, use the following command: $ ifconfig eth0 Link encap:ethernet HWaddr... inet addr:10.0.2.15 Bcast:10.0...... Note: The IP address in the example above is 10.0.2.15. Practices: ADMIN Chapter 3 - Page 3
ADMIN-1: Examining Log Files and Using the Administration Console Overview In these practices, you will start your Services Gatekeeper administration server, examine log and trace files, and use the Administration Console. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Starting the Servers You only need the administration server and one managed server for the practices in this section. 3. Double-click on the desktop icon called Admin Basic. The server is fully started when you see the message The server started in RUNNING mode. 4. Double-click on the desktop icon called Server1 Basic. The managed server is fully started when you see the message The server started in RUNNING mode. Examining the Log Files You may encounter problems in the practices for this course. When you encounter a problem, it is a good idea to examine the log and trace files for errors. You can find the following log files in the directory <DOMAIN>/servers/AdminServer/logs: access.log, which is the HTTP access log AdminServer.log, which is the log for the administration server nnndomain.log, which is the domain log that consists of the collated server logs of all servers in the domain. You can set up filter rules for which information is stored in this log file. By default, the filter is configured to log events of notice level or higher. You can find the following log files in the directory <DOMAIN>/servers/Server1/logs: access.log, which is the HTTP access log Server1.log, which is the log for the managed server 5. Open a new terminal window and look for errors in the Server1.log file: $ cd ocsgcourse/domains/ocsgdomain/servers $ cat Server1/logs/Server1.log grep Error 6. Look for warnings: $ cat Server1/logs/Server1.log grep Warning 7. If you saw any errors or warnings, you are likely to discover the exact same in the domain log. Please check the timestamp to make sure: $ cat AdminServer/logs/ocsgDomain.log grep Error Practices: ADMIN Chapter 3 - Page 4
$ cat AdminServer/logs/ocsgDomain.log grep Warning Examining the Trace File You can find the trace file in <DOMAIN>/servers/Server1/trace. By default, there is only one trace file, default.log, which is where the Services Gatekeeper trace service writes all trace information. 8. Examine the trace file: $ more Server1/trace/default.log Configuring Buffering and Caching for Tracing (Optional) If you use the tail -f command on the default.log trace file, and send traffic through you will notice Services Gatekeeper buffers the output to minimize the performance impact that write operations have on a high-performance system. This is good in a production environment, where traffic is constantly flowing through the system. But in a lab environment, you probably want to see the trace information immediately. In the following instructions you will use the Administration Console to turn off tracing buffering in one of the managed servers. This change is dynamic and is in effect only until you restart the server. 9. Start Firefox and go to: http://<ip>:7001/console. 10. Enter the user name weblogic and the password p4ssword, then click Login. 11. In the Domain Structure panel, expand OCSG and click Server1. The Oracle Communications Services Gatekeeper panel appears. 12. Expand Log4j, and click log4j:appender=default, Location=Server1. The Attributes and Operations panel appears. 13. Select bufferedio and change the value to false. 14. Select immediateflush and change the value to true. 15. Click Update Attributes. You have now stopped the tracing service from doing any buffering until the next restart of Server1. Summary You have now started your Services Gatekeeper servers, examined the log and trace files, and used the Administration Console. Practices: ADMIN Chapter 3 - Page 5
ADMIN-2: Using WebLogic Scripting Tool Overview In this practice, you will use the WebLogic Scripting Tool (WLST) to change an MBean attribute and to invoke an MBean operation. You will also run a prepared WLST script. Tasks Starting Your Virtual Machine When you start your virtual machine, it is good practice to also mount the shared directory. 1. If your virtual machine is not running, start the virtual machine and log in as the user oracle, with the password oracle. 2. Open a new terminal window and mount the shared directory: $./mount_shared.sh Starting the Servers You only need the administration server and one managed server for the practices in this section. 3. Double-click on the desktop icon called Admin Basic. 4. Double-click on the desktop icon called Server1 Basic. Using WebLogic Scripting Tool to Explore MBeans 5. Open a new terminal window and set the window title to WLST. 6. Set the domain environment variables by running the setdomainenv.sh script: $ cd ocsgcourse/domains/ocsgdomain $../bin/setdomainenv.sh 7. Start WLST: $ java weblogic.wlst 8. Connect to the Services Gatekeeper domain: > connect('weblogic', 'p4ssword', 't3://<ip>:7011') 9. Navigate to the root of the custom MBeans that are registered in the server: > custom() 10. Navigate to the Services Gatekeeper part of the custom MBean tree: > cd('com.bea.wlcp.wlng') 11. Navigate to the Trace Service MBean: > cd('com.bea.wlcp.wlng:name=wlng,instancename=traceservice, Type=com.bea.wlcp.wlng.log.management.TraceServiceMBean') Important: Make sure there are no spaces in the string above. 12. List the available MBean attributes: > ls('a') You should see that TracingEnabled attribute is set to true. 13. Set the attribute TracingEnabled to false: > set ('TracingEnabled', Boolean("false")) 14. List the available attributes and make sure the TracingEnabled attribute has been changed: Practices: ADMIN Chapter 3 - Page 6
> ls('a') Tip: Use up arrow to recall previous commands. 15. Set the attribute TracingEnabled back to true: > set ('TracingEnabled', Boolean("true")) 16. List the available operations: > ls('o') 17. Execute the rollover operation: > objs=jarray.array([], Object) > strs=jarray.array([], String) > invoke('rollover', objs, strs) Note: Even though the rollover operation doesn t have any parameters, the invoke command always requires two arrays as parameters. 18. Exit WLST: > exit() 19. Check that the rollover operation created a new trace file: $ date $ ls la servers/server1/trace/default.* You should see that the default.log file has very recently been created and that there is an older version named default.log.1, which was saved when you executed the rollover operation. Running WebLogic Scripting Tool Scripts You can create WSLT scripts to perform various tasks and use WSLT to run them. In this task, you will examine and run a WLST script. The following figure shows the relationship between the WLST script and the shell scripts that has been provided for these practices: The WLST script is in a file with a.py extension. This script has no hardcoded values. The parameters needed to run the WLST script are set in the shell-script.sh file. Because there will be many shell script files, they all get the general connection information from the setconnenv.sh file. To change the host name or the password for the administration server, you only need to edit the information in the setconnenv.sh file. The setdomainenv.sh file is used to set global variables for the domain, such as the class path, so that the shell script can run WLST. 20. Change to the WLST script directory: $ cd $ cd ocsgcourse/wlst 21. Open the script that controls the server connection: $ gedit setconnenv.sh Practices: ADMIN Chapter 3 - Page 7
22. Set the general domain environment execute path to: ~/ocsgcourse/domains/ocsgdomain/bin/setdomainenv.sh 23. Set the HOSTNAME to the current IP-address of your virtual machine. 24. Set the PORT to 7011. 25. Save the file and exit the editor. 26. Change to the directory that contains the Server WLST scripts: $ cd Server 27. Examine the scripts for rolling over the trace file: $ cat rollover_trace.py $ cat rollover_trace.sh 28. Run the script: $./rollover_trace.sh 29. Check that the rollover operation created a new trace file: $ cd $ cd ocsgcourse/domains/ocsgdomain/servers/server1/trace $ date $ ls la Summary You have now used WLST to change an MBean attribute and to invoke an MBean operation. You also ran a prepared WLST script. Practices: ADMIN Chapter 3 - Page 8