|Oracle® Fusion Middleware Developer's Guide for Content Server
11g Release 1 (11.1.1)
Part Number E10807-01
Components are modular programs designed to interact with Content Server at run time. Server components are included with Content Server to add or change the core functionality of the standard content server instance. You can create and use custom components to modify a Content Server instance without compromising the system integrity. Custom components can alter defaults for your system, add new functionality, or streamline repetitive functions.
This section provides an overview of component management and the files and directory structure associated with components. It covers these topics:
The Component Wizard utility automates the process of creating custom components, including creating and editing all the files necessary for custom components. You can also use the Component Wizard to modify existing components and to package and unpackage components for use on Content Server instances.
The Component Wizard is discussed in more detail in the Oracle Fusion Middleware System Administrator's Guide for Content Server.
To access the Component Wizard
(Windows) From the Start menu click the instance name, then Utilities, then Component Wizard. The Component Wizard main page is displayed.
(UNIX) Run ComponentWizard, stored in DomainHome/ucm/short-product-id/bin. The Component Wizard main page is displayed.
The Advanced Component Manager provides a way to manage custom components in the Content Server. By using the Advanced Component Manager, you can easily enable or disable components, or add new components to the content server.
The Advanced Component Manager is discussed in more detail in the Oracle Fusion Middleware System Administrator's Guide for Content Server.
To use the Advanced Component Manager, click Administration on the portal navigation tray for your Content Server, then click Admin Server. On the Admin Server page, the Component Manager page is displayed. In the first paragraph of the Component Manager page, which displays lists of enabled and disabled server components, click advanced component manager. You can select individual components in the tables to view details about each component and select categories of components to view. You can enable and disable components on this page, plus install and uninstall custom components.
ComponentTool is a command-line utility for installing, enabling, and disabling components in Content Server. After installing a component, ComponentTool automatically enables it. ComponentTool is located in the DomainHome/ucm/cs/bin directory.
When you define a custom component, you create or make changes to the following files:
The idcshort-product-id_components.hda file, which tells the Content Server what components are enabled and where to find the definition file for each component.
The component definition (or glue) file, which tells the Content Server where to find the resources for the custom component.
Different custom resource files, which define your customization to standard Content Server resources.
Template files, which define custom template pages.
Other files which contain customization to Content Server graphics, Java code, help files, and so forth.
These files are all discussed in more detail in "About Directories and Files".
If you build or unpackage components in the Component Wizard, or upload and download components in the Component Manager, you work with the following files:
A compressed zip file used to deploy a component on other Content Servers.
A manifest.hda file that tells the Content Server where to place the files that are unpackaged or uploaded from a component zip file.
By definition, a component is enabled when it is properly defined in the Components ResultSet in the idc_components.hda file. A component is disabled if there is no entry or the entry is not formatted correctly.
There are several ways to enable or disable a component:
Manual editing: In the IntradocDir/data/components/ directory, open the idcshort-product-id_components.hda file in a text editor and add or delete the two-line entry for the component. Alternately, you can change only the
Disabled setting for the component and save the file.
ComponentTool: Run the DomainHome/ucm/short-product-id/bin/ComponentTool to enable or disable a component. For example,
Component Wizard: Select Enable or Disable from the Options menu. For details, see the Oracle Fusion Middleware System Administrator's Guide for Content Server.
Component Manager: Select the check box next to a component name to enable a server component specified on the Component Manager screen. Clear the check box next to a component name to disable a server component on the Component Manager screen. For details, see the Oracle Fusion Middleware System Administrator's Guide for Content Server.
Advanced Component Manager: Select a component name and click Disable to disable the component on the Advanced Component Manager screen. Select a component name and click Enable to enable the component on the Advanced Component Manager screen.