|Oracle® Fusion Middleware Administering Oracle WebCenter Portal
11g Release 1 (126.96.36.199.3)
Part Number E27738-06
|PDF · Mobi · ePub|
This chapter describes the two main configuration files for WebCenter Portal and Portal Framework applications
connections.xml. This appendix describes both these files, how to locate them, and also when to configure these files and which tools to use.
Other configuration files, such as
webcenter-config.xml are described here too. See also Section 1.3.5, "Oracle WebCenter Portal Configuration Considerations."
This appendix includes the following topics:
web.xml are used to configure WebCenter Portal and Portal Framework applications and their back-end services. In addition, the
webcenter-config.xml configuration file, which is specific to the out-of-the-box application WebCenter Portal, is used to configure application-wide settings.
This section describes how applications use each file and the location of these files post deployment. This section includes the following subsections:
connections.xml both store design time configuration information, such as the discussions server, mail server, or content server that is used by the application in the development environment:
adf-config.xml - Stores application-level settings, such as which discussions server or mail server the application is currently using.
connections.xml - Stores connection details for WebCenter Portal services.
After you deploy WebCenter Portal or a Portal Framework application to a production environment, Oracle recommends that you use Fusion Middleware Control or WebLogic Scripting Tool (WLST) commands to reconfigure properties in these files. For example, you may want to modify connection details to point to production server instances. See Appendix A, "Configuration Tools."
The main advantage of using Fusion Middleware Control and WLST commands is that any configuration changes that you make, post deployment, are stored as customizations in the application's Oracle Metadata Services (MDS) repository. MDS uses the original deployed versions of
connections.xml as base documents and stores all subsequent customizations separately into MDS using a single customization layer. If the application is redeployed in the future, all previous configuration changes are retained.
When WebCenter Portal or a Portal Framework application starts up, application customizations stored in MDS are applied to the appropriate base documents and the application uses the merged documents (base documents with customizations) as the final set of configuration properties.
This section includes the following subsections:
For more information on MDS customizations, see "Understanding the MDS Repository" in Oracle Fusion Middleware Administrator's Guide.
Reviewing Post Deployment Customizations in MDS
Post deployment, always use Fusion Middleware Control or WLST commands to review the latest configuration or make configuration changes. In Fusion Middleware Control you will mostly use WebCenter Portal-specific configuration screens but a useful Systems MBean Browser is also available for reviewing configuration settings. These tools always show you the current configuration so, typically, there is no need for you to examine or change the content of base documents or MDS customization data for files such as
At times it might be useful to 'see' the information in MDS. If for any reason you must extract or examine configuration file customizations that are stored in MDS, use the WLST command
For detailed syntax and examples, see "exportMetadata" in Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.
For example, to determine MDS customizations for
connections.xml in WebCenter Portal, which has the application name
webcenter and is deployed to the
WC_Spaces managed server, the file name and location is always
/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml, you might specify:
exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml')
And similarly, to determine MDS customizations for
exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/adf-config.xml.xml')
You choose where to save file customizations by specifying
toLocation. If, for example,
toLocation is set to
/tmp/mydata, then the requested file is saved to
If no customizations exist for the requested file, then nothing is saved to the specified location—previously extracted customizations at the same location are not overwritten.
Exporting Configuration Files with MDS Customizations
You can use the System MBean Browser to obtain "current versions" of configuration files such as
connections.xml, that is, a version of the file that includes the base document merged with MDS customizations.
connections.xml with MDS customizations from the System MBean Browser:
Log in to Fusion Middleware Control and navigate to the home page for WebCenter Portal or your Portal Framework application. For more information, see:
Do one of the following:
For the WebCenter Portal application - From the WebCenter Portal menu, select System MBean Browser.
For Portal Framework applications - From the Application Deployment menu, select System MBean Browser.
Expand Application Defined MBeans.
Navigate to the MBean associated with the file you want to export.
For example, navigate to MBeans for
connections.xml as follows:
adf-config.xml - Click oracle.adf.share.config > Server: name> Application: name> ADFConfig> ADFConfig
For the WebCenter Portal application: oracle.adf.share.config > Server: WC_Spaces> Application: webcenter> ADFConfig> ADFConfig
connections.xml - Click oracle.adf.share.connections> Server: name> Application: name> ADFConnnections> ADFConnections
For the WebCenter Portal application: oracle.adf.share.config > Server: WC_Spaces> Application: webcenter> ADFConnections> ADFConnections
Click the Operations tab.
Alternatively, click ExportToDisk and then specify a sever location for the XML file.
If you selected the Export operation, the content of the XML file displays on the screen (Figure A-1).
Figure A-1 Exporting Configuration Files with MDS Customizations
Handling Configuration Conflicts
MDS customizations use references to elements in the base document to call out which elements must be inserted/deleted/replaced, and at what location. If an element is inadvertently removed from a future redeployment and MDS contains a reference to that element, then the WebCenter Portal or Portal Framework application's configuration appears corrupt.
For example, consider a Portal Framework application built using JDeveloper called
MyPortalApp, with a connection, created at design-time, called
myconnection. The application was deployed to a managed server, and a URL in
myconnection was modified. This modification is stored in MDS as a customization instruction to update
myconnection to use the new URL. If in the future,
myconnection is removed at design time and the application redeployed using the same MDS details, a configuration conflict occurs, that is, the customization instruction in MDS attempts to find
myconnection but no such configuration exists.
You are unlikely to face this problem but should a previously deployed application appear corrupt after making changes to
connections.xml you have the following options:
Remove the MDS customization causing conflict manually:
Extract MDS customization information for
For example, for WebCenter Portal specify:
exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/adf-config.xml.xml') exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml')
Remove the customization instruction that is causing conflict from the document.
Import the modified document back in to MDS.
For example, for WebCenter Portal specify:
importMetadata(application='webcenter', server='WC_Spaces', fromLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml') importMetadata(application='webcenter', server='WC_Spaces', fromLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/adf-config.xml.xml')
Restart the managed server.
Delete MDS customizations for
connections.xml, deploy the new EAR file, and reconfigure your application from scratch using Fusion Middleware Control or WLST.
See below for detailed steps, "Deleting MDS Customizations for adf-config.xml or connections.xml".
Redeploy the EAR file on a new partition or a partition where older customizations are deleted. In either case, all data previously stored in MDS for the application is lost, including any application customizations for
connections.xml, and all user customizations. You must reconfigure your application from scratch too, using Fusion Middleware Control or WLST.
See "deleteMetadata" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.
Deleting MDS Customizations for adf-config.xml or connections.xml
This section describes how to remove all post-deployment configuration for
adf-config.xml. This operation cannot be reversed; customizations are permanently removed.
If you do want to delete MDS customizations, Oracle recommends that you use the
"exportMetadata" command to save a copy of the existing files before completing the steps below.
exportMetadata command to backup
For example, for WebCenter Portal specify:
exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml') exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/META-INF/mdssys/cust/adfshare/adfshare/adf-config.xml.xml')
Delete customizations for
connections.xml, using WLST.
For example, for WebCenter Portal specify:
deleteMetadata(application='webcenter', server='WC_Spaces', docs='/META-INF/mdssys/cust/adfshare/adfshare/connections.xml.xml')
Delete customizations for
adf-config.xml, using WLST.
For example, for WebCenter Portal specify:
deleteMetadata (application='webcenter', server='WC_Spaces', docs='/META-INF/mdssys/cust/adfshare/adfshare/adf-config.xml.xml')
Restart the application.
Reconfigure your application from scratch using Fusion Middleware Control or WLST.
web.xml is a standard J2EE application deployment descriptor file and it is located in the
/META-INF directory for your application. Typical run-time settings in
web.xml include initialization parameters, custom tag library locations, and security settings.
web.xml properties are static so they are specified for the application at design time before generating and deploying the application's
.ear file. If you need to modify some properties in a deployed environment, you can edit some properties through the "Configure Web Modules" screen on the "Deployment Settings" page. See Figure 42-11 in Section 188.8.131.52, "Deploying Applications Using Fusion Middleware Control."
web.xml does not store post deployment customizations in MDS and you cannot use Fusion Middleware Control or WLST commands to modify
web.xml in an existing deployment, such as WebCenter Portal.
Do not edit the
web.xml file for WebCenter Portal or any Portal Framework application post deployment. Oracle does not recommend that you explode application
.ear files and risk corrupting your installation.
There are very few instances where you might want to modify
web.xml, for example, in some circumstances you may want to change:
Content repository upload parameters:
For Portal Framework Applications, see Section 9.12, "Changing the Maximum File Upload Size."
For WebCenter Portal, use the
uploadedFileMaxDiskSpace parameter in
webcenter-config.xml to configure a maximum upload size for files. For details, see Appendix A, "webcenter-config.xml."
Time after which HTTP sessions expire.
For Portal Framework Applications, see "Setting HTTP Session Timeout for a Portal Framework Application" in Oracle Fusion Middleware Performance and Tuning Guide.
For WebCenter Portal, see Section 48.10, "Specifying Session Timeout Settings".
JSP page timeout value.
For Portal Framework Applications, see "Setting JSP Page Timeout" in Oracle Fusion Middleware Performance and Tuning Guide.
Browser compatibility notifications for Internet Explorer. Set the
<!-- Suppress Browser Compatibility popup messages --> <context-param> <param-name> oracle.adf.view.rich.HIDE_UNSUPPORTED_BROWSER_ALERTS </param-name> <param-value>IECompatibilityModes</param-value> </context-param>
Note: Alternatively, Internet Explorer users can turn off Compatibility Mode before trying to access WebCenter Portal or Portal Framework applications. In Internet Explorer, select the Tools menu, and the Compatibility View Settings. In the Compatibility View Settings dialog, deselect all the options, and click Close.
webcenter-config.xml is a configuration file for the out-of-the-box application WebCenter Portal. This file contains application-level settings, such as the application name and logo. Most of the properties in this file are managed through WebCenter Portal administration screens so there is no need to edit
webcenter-config.xml directly. For more information, see Chapter 47, "Exploring the Administration Page in Portal Builder Administration" and Chapter 48, "Configuring Global Defaults Across Portals."
There are very few instances where you might be required to manually modify settings in
webcenter-config.xml; for example, if you want to change the following:
Maximum file upload size (
uploadedFileMaxDiskSpace) - the default setting is 2 GB.
If you want to modify this setting, you must export the latest version of
webcenter-config.xml from MDS and modify the
uploadedFileMaxDiskSpace value as follows:
Export the latest
webcenter-config.xml from MDS.
exportMetadata(application='webcenter', server='WC_Spaces', toLocation='/tmp/mydata', docs='/oracle/webcenter/webcenterapp/metadata/mdssys/cust/site/webcenter/webcen ter-config.xml.xml')
webcenter-config.xml is created in MDS the first time you configure global defaults on the General page in WebCenter Portal Builder administration. If the file does not yet exist in MDS you can edit
webcenter-config.xml directly. The file is located at:
webcenter-config.xml.xml exported from MDS in a text editor and add the following snippet, changing the
uploadedFileMaxDiskSpace value as required:
<mds:replace node="webcenter(xmlns(webcenter=http://xmlns.oracle.com/webcenter/webcenterapp) )/webcenter:uploadedFileMaxDiskSpace"/> <mds:insert after="webcenter(xmlns(webcenter=http://xmlns.oracle.com/webcenter/webcenterapp ))/webcenter:custom-attributes" parent="webcenter"> <uploadedFileMaxDiskSpace xmlns="http://xmlns.oracle.com/webcenter/webcenterapp">2147483648</uploadedFileMaxDiskSpace> </mds:insert>
Save and close
Import the updated
webcenter-config.xml.xml file to MDS.
importMetadata(application='webcenter', server='WC_Spaces', fromLocation='/tmp/mydata', docs='/oracle/webcenter/webcenterapp/metadata/mdssys/cust/site/webcenter/webcen ter-config.xml.xml')
All post deployment configuration through Fusion Middleware Control, WLST, or the Systems MBean Browser is stored as customizations in the MDS repository. In a cluster environment, since the MDS repository is shared across all nodes, all WebCenter Portal configuration changes done on one node are visible to all nodes in the cluster. To effect configuration changes that are not dynamic, all nodes in the cluster must be restarted. See Section 7.2, "Starting and Stopping Managed Servers for WebCenter Portal Application Deployments."
In WebCenter Portal and Portal Framework applications, most configuration changes that you make through Fusion Middleware Control or using WLST, are not dynamic. For example, when you add or modify connection details for various tools and services (analytics, activity graph, announcements, discussions, documents, events, mail, instant messaging and presence, search, worklists, and so on) you must restart the application's managed server.There are two exceptions; portlet producer and external application registration is dynamic. Any new portlet producers and external applications that you register are immediately available in your application and any changes that you make to existing connections take effect immediately too.
If you edit configuration files in a cluster environment, then you must ensure that identical changes are made in each cluster member so that the overall cluster configuration remains synchronized.
Oracle offers a range of tools for configuring WebCenter Portal and Portal Framework application deployments. This section outline which tools are available.
Most WebCenter Portal configuration parameters are immutable and cannot be changed at run time unless otherwise specified.
Post deployment, always use Fusion Middleware Control or WebLogic Scripting Tool (WLST) commands to review the latest configuration or make configuration changes. In Fusion Middleware Control you will mostly use WebCenter Portal-specific configuration screens but a useful Systems MBean Browser is also available for reviewing and modifying configuration settings.
For more information about these tools, read:
These tools always show you the current configuration so, typically, there is no need for you to examine or manually change the content of configuration files or MDS customization data for files such as
connections.xml. If you use the same MDS details when you redeploy the application, all configuration performed using these tools is preserved.
What Configuration Tool to Use
You can use any tool for post-deployment configuration. However, if you intend to repeat the configuration steps multiple times, for example, when provisioning newer instances or for automation, screen-based configuration using tools such as Fusion Middleware Control becomes less efficient. In such cases, Oracle highly recommends that you write WLST scripts to perform the required configuration.
All configuration operations possible through Fusion Middleware Control are available using Oracle WebCenter Portal's WLST commands. You can also use WLST scripts to configure other components, for example, to deploy applications, create managed servers, set MDS properties for an application, configure data sources, and so on.
If you want help to automate domain configuration, you can record configuration actions in the WebLogic Server Administration Console as a series of WLST commands and then use WLST to replay the commands. For more details on this topic, see "Recording WLST Scripts" in Oracle Fusion Middleware Introduction to Oracle WebLogic Server.
Where Oracle documentation describes steps in the WebLogic Server Administration Console, consider automating the process using the "Record" option.
Another way to configure deployment specific properties is through the WebCenter Portal or Portal Framework application's deployment plan. Typical properties changed on deployment include:
Host/port properties for connections
Standard J2EE artifacts in
While reconfiguration is possible this way, any metadata repository and ADF connection configuration changes that you make are not saved as part of the deployment plan, that is, they are saved in the archive that is deployed. Therefore, your configuration changes must be repeated on subsequent redeployments.
If you redeploy your application multiple times, Oracle recommends that you use Fusion Middleware Control or WLST commands to perform your post-deployment configuration. This way, configurations changes are saved in MDS and remain intact on redeployment.