How Do I Add Additional OracleAS Portal Targets to Oracle Enterprise Manager Consoles

An Oracle Application Server Portal 10g (9.0.4) Technical Note March 2004 | Introduction | Defining an OracleAS Portal target | Adding new targets | Summary | More Information |

Introduction
This note describes how an administrator can add additional Oracle Application Server Portal 10g targets to the Oracle Enterprise Manager 10g Application Server Control Console and the Grid Control Console, for monitoring and administration purposes. During a default Oracle Application Server 10g installation, a target is created for OracleAS Portal automatically. However, if a new OracleAS Portal instance is configured using ptlasst for a given OracleAS middle tier, you need to add the target manually, as described in this document. Note that Oracle does not recomend using ptlasst to configure OracleAS Portal instances, ptlasst install opions are documented only for backward compatibility. You define Oracle Enterprise Manager targets within the configuration file targets.xml. Oracle Enterprise Manager uses the information in this file (e.g. target name, type, properties. etc.) to obtain target metrics and enable target configuration.The file is located at $ORACLE_HOME/sysman/emd/targets.xml, where ORACLE_HOME is either the:

Oracle Application Server Home (Application Server Control Console) Management Agent Home (Grid Control Console)

Note: If you are using the Grid Control Console to manage your Oracle Application Server 10g instance, you do need to update the Management Agent's targets.xml. However, if you have not yet installed the Oracle Enterprise Manager Grid Control Management Agent, first add the new target to targets.xml for the Oracle Application Server instance and then install the Oracle Enterprise Manager Grid Control Management Agent. This way, the Management Agent will discover the new OracleAS Portal target automatically. For more information on Oracle Enterprise Manager Grid Control, refer to documentation on the Oracle Technology Network at http://otn.oracle.com.
Back to Top

Defining an OracleAS Portal target in targets.xml

You must define each OracleAS Portal target using the XML format shown below. The different colors represent mandatory values and optional values and the editable values are all those shown in bold, for example, Display_Name. <Target TYPE="oracle_portal" NAME="Name" DISPLAY_NAME="Display_Name" VERSION="1.0"> <Property NAME="version" VALUE="9.0.4" /> <Property NAME="OracleHome" VALUE="OracleHome" /> <Property NAME="PortalListeningHostPort" VALUE="PortalListeningHostPort" /> <Property NAME="HTTPMachine" VALUE="HTTPMachine" /> <Property NAME="HTTPPort" VALUE="HTTPPort" /> <Property NAME='HTTPProtocol' VALUE='http' /> <Property NAME="portal_DAD" VALUE="portal_DAD" /> <Property NAME="OidRepSchemaName" VALUE="OidRepSchemaName" /> <Property NAME="startComponent" VALUE="startComponent" /> <Property NAME='PPESuccessfulResponsesCriticalThreshold' VALUE='80' /> <Property NAME='PPESuccessfulResponsesWarningThreshold' VALUE='90' /> <Property NAME='modplsqlSuccessfulResponsesCriticalThreshold' VALUE='80' /> <Property NAME='modplsqlSuccessfulResponsesWarningThreshold' VALUE='90' /> <Property NAME='portletResponseCriticalThreshold' VALUE='4500' /> <Property NAME='portletResponseWarningThreshold' VALUE='4000' /> <CompositeMembership> <MemberOf TYPE="oracle_ias" NAME="iASName.machine.domain" ASSOCIATION="null"/> </CompositeMembership> <Property NAME="useProxy" VALUE="useProxy" /> <Property NAME="ProxyHost" VALUE="proxyHost" /> <Property NAME="ProxyPort" VALUE="proxyPort" /> </Target> This table describes OracleAS Portal target properties and provides example values: Property Name NAME Property Description Example Values

The unique name with which the OracleAS Portal target is registered. mid904.myMachine.xyz.c The format for the name is: om_portal:myPortal <iasName>.<machine_name> _<display_name(see below)>

For more details on <iasName>.<machine_name> see oracle_ias CompositeMembership NAME property below. The name used to represent the OracleAS Portal target. This name is displayed in the Oracle Application portal:myPortal Server component list in the Application Server Control Console and the Grid Control Console. The version number of the OracleAS 9.0.4 Portal target. Solaris: / export/home/oracle/mid9 04 Windows: d:\oracle\mid904 PortalListeningHostPort The entry point to the OracleAS Portal target excluding the DAD myMachine.xyz.com:777 information, that is, <Listening 8 Host>:<Listening Port>. The machine and domain name for the HTTP Server. This is the middle myMachine.oracle.com tier node with which OracleAS Portal is associated. The HTTP port of the Oracle HTTP Server that is servicing OracleAS 7779 Portal. The HTTP protocol used by the HTTP Server. This is http by default. If Secure Sockets Layer (SSL) is configured, the value is https.

DISPLAY_NAME

version

OracleHome

The ORACLE_HOME of the Oracle Application Server whose middle tier is servicing the portal.

HTTPMachine

HTTPPort

HTTPProtocol

http

The name of the Database Access Descriptor (DAD) used to access OracleAS Portal via mod_plsql (excluding the pre-pended "/pls/" string). portal_DAD For example, if the OracleAS Portal myPortal access URL is: http://myMachine.oracle. com:7778/pls/myPortal The portal_DAD is myPortal. OidRepSchemaName The name of the OracleAS Portal Repository database schema. The target name of the OC4J instance (OC4J_Portal by default) that starts OracleAS Portal. The format for the name is: <iasName>.<machine_name> _OC4J_Portal A threshold value used by OracleAS Portal to determine whether the PPESuccessfulResponsesC status of the Parallel Page Engine riticalThreshold Services is reported to be critical, 80 that is, when the percentage of successful responses drops below the value set here. Parallel Page Engine Services are considered to be in a warning state if the percentage of successful PPESuccessfulResponses responses is higher than 90 WarningThreshold PPESuccessfulResponsesCriticalThr eshold and lower than the value set here. modplsqlSuccessfulRespo A threshold value used by OracleAS 80 nsesCriticalThreshold Portal to determine whether the status of the mod_plsql Services is reported to be critical, that is, when myPortal

startComponent

mid904.myMachine.xyz.c om_OC4J_Portal

the percentage of successful responses drops below the value set here. mod_plsql Services are considered to be in a warning state if the percentage of successful responses is modplsqlSuccessfulRespo higher than 90 nsesWarningThreshold modplsqlSuccessfulResponsesCritica lThreshold and lower than the value set here. A threshold value used by OracleAS Portal to determine whether the status of a Provider's Portlet Timing portletResponseCriticalThr is reported to be critical, that is, 4500 eshold when the average portlet response time (in milliseconds) is greater than the value set here (in milliseconds). Portlet response times are considered to be in a warning state if the average response time for Provider portletResponseWarningT portlets is less than 4000 hreshold PPESuccessfulResponsesCriticalThr eshold and greater than this value (in milliseconds). oracle_ias CompositeMembership NAME The target name of the Oracle Application Server instance with mid904.myMachine.xyz.c which OracleAS Portal is associated. om This is the oracle_ias target with the same $ORACLE_HOME as the HTTP Server on which OracleAS Portal is running. Typically, there is a single oracle_ias target in an Oracle Application Server instance, however, in Oracle Enterprise Manager 10g Grid Control Console there may be several oracle_ias targets.

The format of the name is: <iasName>.<machine_name> The Oracle Enterprise Manager Application Server Console's global proxy setting is used by default. Alternatively, you can use your own proxy settings, or turn the default proxy off. To turn off the default proxy, enter the following: useProxy ProxyHost ProxyPort <Property NAME="useProxy" VALUE="false" /> To specify your own proxy, enter appropriate values for those properties shown in bold: <Property NAME="useProxy' VALUE='false" /> <Property NAME="proxyHost' VALUE='PROXY_HOST" /> <Property NAME="proxyPort' VALUE='PROXY_PORT" /> "FALSE" myProxyServer.mydomai n myProxyPort

For example:
<Target TYPE="oracle_portal" NAME="as904.webdbsvr1.us.xyz.com_Portal:myPortal" DISPLAY_NAME="Portal:myPortal" VERSION="1.0"> <Property NAME="OracleHome" VALUE="/usr/local/shiphome/as904"/> <Property NAME="version" VALUE="9.0.4"/> <Property NAME="PortalListeningHostPort" VALUE="webdbsvr1.us.xyz.com:7778"/> <Property NAME="HTTPMachine" VALUE="webdbsvr1.us.xyz.com"/> <Property NAME="HTTPPort" VALUE="7779"/> <Property NAME="HTTPProtocol" VALUE="http"/> <Property NAME="portal_DAD" VALUE="myPortal"/> <Property NAME="OidRepSchemaName" VALUE="myPortal"/>

<Property NAME="startComponent" VALUE="as904.webdbsvr1.us.xyz.com_OC4J_Portal"/> <Property NAME="PPESuccessfulResponsesCriticalThreshold" VALUE="80"/> <Property NAME="PPESuccessfulResponsesWarningThreshold" VALUE="90"/> <Property NAME="portletResponseCriticalThreshold" VALUE="4500"/> <Property NAME="portletResponseWarningThreshold" VALUE="4000"/> <Property NAME="modplsqlSuccessfulResponsesCriticalThreshold" VALUE="80"/> <Property NAME="modplsqlSuccessfulResponsesWarningThreshold" VALUE="90"/> <CompositeMembership> <MemberOf TYPE="oracle_ias" NAME="as904.webdbsvr1.us.xyz.com"/> </CompositeMembership> </Target> Note:

In Oracle Application Server 10g (9.0.4) you may encounter monitoring issues if OracleAS Portal is running in a mixed SSL mode environment. A fix is available in the 9.0.4.1 patch release and this also fixes the issue in Oracle Enterprise Manager Grid Control 10g (10.1.0.2.0). To make use of the monitoring capabilities you must update the version property and the PortalListeningHostPort property. Set the version property to "9.0.4.1" and pre-pend the PortalListeningHostPort with the OracleAS Portal listening protocol. For example, if the 9.0.4 entry is "myMachine.xyz.com:7778", the 9.0.4.1 entry where an OracleAS Portal is fronted by an SSL enabled Web Cache would be "https://myMachine.xyz.com:7778". The HTTP protocol must always match the HTTP Server protocol.
Back to Top

Back to Top

Adding New Targets to Enterprise Manager Consoles

Once you have defined the OracleAS Portal target in the XML format illustrated above you can insert the details into targets.xml. This configuration file is located at $ORACLE_HOME/sysman/emd/targets.xml, where ORACLE_HOME is either the:

Oracle Application Server Home (Application Server Control Console) Management Agent Home (Grid Control Console)

Once you have updated one or both of these files, you must reload each updated configuration file in the appropriate Oracle Enterprise Manager console. To do this, follow the appropriate steps below.

To update target information in the Application Server Control Console

Follow these steps to update targets.xml in the Oracle Application Server 10g home ($ORACLE_HOME) and load the new target information in the Oracle Enterprise Manager Application Server Control Console: 1. Create a backup copy of $ORACLE_HOME/sysman/emd/targets.xml. For example, $ORACLE_HOME/sysman/emd/targets.xml.7thApril2004. 2. Open $ORACLE_HOME/sysman/emd/targets.xml in your favorite Text Editor. 3. Insert the XML segment describing your OracleAS Portal target directly above the closing </Targets> tag at the base of the file. 4. Reload the targets in the Application Server Control Console: On Solaris/Linux, enter: $ORACLE_HOME/bin/emctl reload On Windows: $ORACLE_HOME\bin\emctl reload

To update target information in the Grid Control Console

To update targets.xml in the Oracle Enterprise Manager Grid Control Console, follow the steps above replacing $ORACLE_HOME with the Management Agent Home.
Back to Top

Summary
This Technical Note describes how to add new OracleAS Portal targets to both the Application Server Control Console and Grid Control Console. This information is useful if you want to use these Oracle Enterprise Manager consoles to monitor/administer additional OracleAS Portal targets. To check that your XML is valid you may wish to verify that:

XML is valid. Use an XML validation tool, such as XML Spy. Alternatively, for a more simplistic approach, save each OracleAS Portal target definition as an XML

document and check whether it displays correctly in Internet Explorer (which performs some XML format validation). Property values are valid. Login to the OracleAS Portal instance you wish to verify and access some pages. This creates metrics which should be reported in the Oracle Enterprise Manager consoles. If you do not see any metrics, or some metrics are missing, verify that all the properties are as expected.

Also, check to see whether you can access OracleAS Portal through a browser by combining the relevant PortalListeningHostPort and DAD properties to form a URL. For example: <HTTPProtocol>://<PortalListeningHostPort>/pls/<portal_DAD> If you find incorrect properties, update the relevant target segment and re-start the appropriate Oracle Enterprise Manager console. If you still have issues, examine the contents of the agent log file located at: $ORACLE_HOME/sysman/log/emagent.log If you can not resolve the problem, revert to the backed up copy of targets.xml file and contact Oracle Customer Support.