6 Managing Components

This chapter describes how to use the Component Wizard to create new Oracle Content Server components, how to use the Component Manager to administer and enable/disable system and custom Oracle Content Server components, and how to use a command-line tool to install, enable, and disable Oracle Content Server components.

6.1 About Components

A component is a functional unit that can be plugged into the Oracle Content Server system to provide additional features or to modify existing functionality. The primary use for components is to modify the user interface of existing pages and to alter behavior of existing services. Standard components are provided with the Oracle Content Server system, and additional components can be acquired from the Oracle Technology Network. Administrators and developers can create their own custom components for their sites.

Note:

For detailed information on the structure and use of components, see the Oracle Fusion Middleware Developer's Guide for Oracle Universal Content Management.

Table 6-1 lists most standard Oracle Content Server components. Not all components are installed or enabled by default.

Table 6-1 Oracle Content Server Components

Component Description

ActiveDirectoryLdapComponent

Enables the Oracle Content Server instance to authenticate users against an Active Directory server via LDAP. The provider also pulls in all group membership and specified user metadata from Active Directory.

AddCCToArchiveCheckin

Adds Content Categorizer to the CHECKIN_NEW and CHECKIN_UNIVERSAL services by overriding the standard Oracle Content Server service scripts, such that Content Categorizer is called to provide values for the various metadata fields before the actual checkin takes place.

AddCCToNewCheckin

Adds Content Categorizer to the CHECKIN_NEW and CHECKIN_UNIVERSAL services by overriding the standard Oracle Content Server service scripts, such that Content Categorizer is called to provide values for the various metadata fields before the actual checkin takes place.

BpelIntegration

Adds the ability to interact with Business Process Execution Language (BPEL) Process Manager from within Oracle Content Server workflows. Administrators can configure Oracle Content Server workflows to initiate a deployed process on the BPEL server.

BrowserUrlPath

Changes the computation of the Oracle Content Server variable HttpBrowserFullCgiPath and the function proxiedBrowserFullCgiWebUrl() so that they are no longer hardwired to a particular protocol. If the request comes in on port 443 (the SSL port), then the variable or function returns a result with HTTPS as the protocol. Otherwise, the variable or function returns a result with HTTP as the protocol.

CleanContent

Contains clean content libraries and generates descriptions of the documents for use by the DesktopTag component.

ContentFolios

Provides a quick and effective way to assemble, track, and access logical groupings of multiple content items from within the secure environment of the Oracle Content Server instance. For example, this component can be used to set up a new project that requires a virtual place to assemble all relevant content items in a particular hierarchy, whenever they are checked in, with restricted access to particular areas of the hierarchy.

ContentAccess

Performs standard "in place" conversion and filtering for the Oracle Content Server instance. It is used to create HTML renderings of native content, extract text for full text indexing, and extract links for link reference management.

ContentBasket

Enables users to select renditions of content items and place them in a personal storage space called the Content Basket. When this component is installed independently, renditions can be selected and placed in the Content Basket from either the Search Result or Content Information pages via the Actions dropdown on either page. Users can choose either native file or web-viewable renditions. When using Image Manager or Video Manager, additional rendition types can be selected for the Content Basket via Actions options on the Rendition Information page.

Note: the ContentBasket component is required when using either Image Manager or Video Manager.

ContentCategorizer

Suggests metadata values for documents being checked into the Oracle Content Server instance, and it can be used to recategorize the metadata of documents that are already in. Metadata values are determined according to search rules provided by the administrator.

ContentTracker

Monitors activity on an Oracle Content Server instance and records selected details of those activities. It then generates reports that can help administrators understand the ways in which the system is being used.

ContentTrackerReports

Reports on the data generated by the Content Tracker component.

DAMConverter

This Inbound Refinery component is the primary component for the Digital Asset Management feature.

DBSearchContainsOpSupport

Adds support of hasAsWord(Contains) operator to DATABASE and DATABASEFULLTEXT on SQL Server, Oracle, and DB2 databases.

DamConverterSupport

Enables Inbound Refinery to create multiple packaged (zipped) renditions of a checked-in graphic file. The ZipRenditionManagement component can be used to access the renditions created by the refinery.

DesktopIntegrationSuite

Provides a set of embedded applications that help administrators seamlessly integrate the desktop experience with the Oracle Content Server system. It provides convenient access to the Oracle Content Server system from Microsoft Windows Explorer, desktop applications like Microsoft Word and Excel, and e-mail clients like Microsoft Outlook and Lotus Notes.

DesktopTag

Modifies documents supported by the CleanContent component by maintaining a set of custom properties in the documents. These properties are used by the Desktop Integration Suite Microsoft Office integrations to aid in using files with the Oracle Content Server system.

DigitalAssetManager

Enables users to define and provide images and videos in specified formats and sizes for download. The component creates multiple formats of digital assets automatically when an image or video is checked into the Oracle Content Server system, and lists the formats under one content ID.

DynamicConverter

Converts a document into a Web page for everyone to see without use of the application used to create that document.

ElectronicSignatures

Enables and supports the creation and management of Electronic Signatures for managed content objects.

EmailMetadata

Extracts information from Microsoft Outlook messages (MSG) and Internet Mail Messages (EML), and populates e-mail specific fields in the Oracle Content Server system. This process occurs when users check in files using the Oracle Content Server Folders functionality in Microsoft Outlook, Lotus Notes, or Windows Explorer. This also occurs when checking in MSG or EML files using the Web browser interface.

ExtranetLook

Enables customization of the out-of-box Oracle Universal Content Management (Oracle UCM) look and feel. This component has two parts: one part enables customization of cookie-based login forms and pages; the other part modifies the error and challenge pages issued by the web server.

FileStoreProvider

Enables the Oracle Content Server system to have more control over how files are stored. Files can either be stored in the database or on the file system. The component has extension options where you can write components that store files in other types of storage repositories. When files are stored on the file system, the component allows additional flexibility in path computations. For web-viewable paths, the types of paths allowed are restricted.

FolderStructureArchive

Enables administrators to configure an Oracle Content Server Archive to archive the folder structure as well as its associated content. The structure of the folders is archived using database table replication.

Folders_g

Provides a hierarchical folder interface to content in the Oracle Content Server system in the form of "virtual folders" (also called "hierarchical folders").

FormEditor

Provides the ability to use cross-platform browsers to create Oracle Content Server hcsf forms.

HTMLConverter

Enables Inbound Refinery to convert native Microsoft Office formats (Word, Excel, PowerPoint and Visio) to HTML using the Office application.

HTMLConverterSupport

Enables Inbound Refinery to convert native Microsoft Office formats (Word, Excel, PowerPoint and Visio) to HTML using the Office application.

InboundRefinerySupport

Enables the Oracle Content Server system to use Inbound Refinery for the conversion of files. Without this component the Oracle Content Server system cannot use Inbound Refinery.

LinkManager8

Extracts URL links of indexed documents, evaluates, filters and parses the URLs according to a pattern engine, and then stores the results in a database table. Because the link extraction occurs during the indexing cycle, only the links of released documents are managed.

MSOfficeHtmlConverterSupport

Enables the Oracle Content Server system and Inbound Refinery to convert select Microsoft Office formats to HTML using the native application.

NativeOsUtils

(Required) Provides the native JNI calls needed by the Oracle Content Server instance. The Oracle Content Server system can run without this component enabled, but it loses some functionality. The two noticeable degradations are as follows:

  • In schema publishing, all files are rewritten instead of using hard links to have new files link back to existing files when the content does not change.

  • When a component is installed that has native executables, the executable bit on the files is not toggled properly. This can affect components such as ContentAccess.

OpenOfficeConversion

Enables Inbound Refinery to integrate with OpenOffice.

OpssPolicyStore

Integrates Oracle UCM with OPSS policy store.

OracleQueryOptimizer

Aids in tuning queries against the Oracle database by allowing query hints to be added to ensure that the best execution plan is used.

PDFExportConverter

Enables Inbound Refinery to use Oracle OutsideIn PDF Export to convert native formats directly to PDF without the use of any third-party tools.

PDFWatermark

Enables watermarks to be applied to PDF files generated by the Inbound Refinery PDFConverter component and returned to the Oracle Content Server system. PDF files already residing on the Oracle Content Server system also can be watermarked. Dynamic watermarks are generated on-the-fly and can contain variable information.

RoleEntityACL

Integrates Oracle UCM with OPSS access control list permissions.

SESCrawlerExport

Adds functionality to allow the Oracle Content Server system to be searched using Oracle Secure Enterprise Search. The service generates a snapshot of content currently on the Oracle Content Server system and provides it to the Oracle SES Crawler.

SiebelEcmIntegration

Part of Siebel Adapter for Oracle UCM that enables Siebel CRM users to store and retrieve attachments stored in an Oracle Content Server repository.

SiebelIntegrationSearchDisplay

Displays Oracle UCM documents as managed attachments to Siebel entities in an iFrame within the Siebel application.

SiteStudio

A powerful, flexible Web development application suite that offers a comprehensive approach to designing, building, and maintaining enterprise-scale web sites. It offers both web site creation and content management.

ThreadedDiscussions

Enables the ability to create discussion documents about another document. It takes any content item and adds "_d" to the document ID to create a new hcsp style document that is focused on discussion about the originating document.

ThumbnailGenerator

Enables the Oracle Content Server instance to create thumbnails of checked-in content without having to set up a full Inbound Refinery. It can only be used with content that is not sent to Inbound Refinery for conversion.

TiffConverter

Enables the Oracle Content Server system and Inbound Refinery to integrate with CVista PDF Compressor. The component defines the TIFFConversion conversion and steps that are required by the conversion.

TiffConverterSupport

Enables the Oracle Content Server system and Inbound Refinery to convert tiff files to searchable PDF files.

WinNativeConverter

Extends the PDFConverter feature and requires the Refinery feature. It enables Inbound Refinery to convert native files to a postscript with either the native application or OutsideInX and convert postscript to PDF.

XMLConverter

Enables Inbound Refinery to produce FlexionDoc and SearchML styled XML as the primary Web viewable or as renditions.

XMLConverterSupport

Enables the Oracle Content Server system and Inbound Refinery to convert various formats to FlexionDoc or SearchML as either the primary Web rendition or an additional rendition. It also enables the Oracle Content Server system and Inbound Refinery to preform XSLT transformations.

YahooUserInterfaceLibrary

(Required) Provides a wrapper for the Yahoo! User Interface Library (YUI) available under the BSD license. The Oracle Content Server product adopted the YUI library for its user interface implementation because of its ability to implement folder move operations (move an item from one folder to another) and for its support of Accessibility (specifically keyboard operations). The YUI library is also used for its calendar control and its ability to support popup choice lists in type-ahead fields.

ZipRenditionManagement

Enables users to create and edit additional attachment files that are maintained in a zip file. It does this by creating a new rendition type 'Z' with description "Zipped Attachments". This component is used as part of Digital Asset Management.

6.2 Using the Component Manager

This section describes the following tasks you can perform with the Component Manager to manage Oracle Content Server system and custom components:

6.2.1 Viewing Information about a Component

To view descriptive information about a component on your system using the Component Manager:

  1. Open the Admin Server Page.

    The Component Manager Page is displayed. A brief description is provided for each component displayed on the page.

  2. Click advanced component manager to view the Advanced Component Manager Page.

  3. Select a component name either in the list of Enabled or Disabled components.

    Information about the component is displayed in a pane next to the list, including component name, tags, location, feature extensions, class path, and so forth.

6.2.2 Enabling and Disabling a Component

To enable or disable a component using the Component Manager:

  1. Open the Admin Server Page.

    The Component Manager Page is displayed.

  2. Click All Features.

    All components from the Document Management, Folders, Inbound Refinery, Integration, and Web Content Management categories are displayed.

  3. Select the checkbox for each component you want to enable. Deselect the checkbox for each component you want to disable. If you do not see the component, verify that the appropriate filter checkboxes are selected so the components are displayed.

    If you do not want to make the changes you selected, click Reset.

  4. Click Update.

  5. Restart the Oracle Content Server instance. See Section 3.1.3, "Restarting Oracle Content Server."

    The Oracle Content Server instance restarts, and the component is now enabled or disabled.

  6. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

    Note:

    When the Oracle Content Server instance is started, enabled components are loaded in the order shown in the Components list.

6.2.3 Uploading a Component

To upload a component zip file using the Component Manager:

Tip:

Components can also be uploaded (unpackaged) using the Component Wizard. For details, see Section 6.3, "Using the Component Wizard."

  1. Open the Admin Server Page.

    The Component Manager Page is displayed.

  2. Click advanced component manager to view the Advanced Component Manager Page.

  3. Click the Browse button next to the Install New Component field.

  4. Navigate to and select the component zip file.

  5. Click Open.

    The path and file name appears in the Install New Component field.

  6. Click Upload.

    The component files are unpackaged on the Oracle Content Server instance, and the name of the component appears in the Disabled Components list.

    Note:

    Uploading a component does not enable it. For details, see Section 6.2.2, "Enabling and Disabling a Component."

  7. If you are having difficulty uploading the component, check the Oracle Content Server output messages by clicking the View Admin Output link in the sidebar menu. The Admin Server Output Page is displayed where you can verify the recent actions.

6.2.4 Downloading a Component

A component cannot be downloaded unless it meets these requirements:

  • The component must exist outside of the ECM_ORACLE_HOME/ucm/idc/system directory. This excludes all shipped components unless a patch has been uploaded to a component. The component must have a zip file with the appropriate name, located inside the component directory. Usually this occurs only when the component has been uploaded or installed manually.

To package a component as a component zip file:

  1. Open the Admin Server Page.

    The Component Manager Page is displayed.

  2. Click advanced component manager to view the Advanced Component Manager Page.

  3. Select the component to be packaged from the Download Component list.

  4. Click Download.

    The File Download screen is displayed.

  5. Select the Save this file to disk option and click OK.

    The Save As screen is displayed.

  6. Navigate to the directory where you want to save the component zip file.

  7. Change the name of the component zip file as necessary.

  8. Click Save.

    The component is saved as a component zip file.

6.2.5 Modifying a Component Configuration

Several methods are available for modifying a component configuration after installation. Not all components can have their configuration changed.

6.2.5.1 Using the Advanced Component Manager

To modify the configuration settings for a component using the Advanced Component Manager:

  1. Open the Admin Server Page.

    The Component Manager Page is displayed.

  2. Click advanced component manager to view the Advanced Component Manager Page.

  3. Select a component name from the Update Component Configuration menu, then click Update.

    The Update Component Configuration screen for the component is displayed. The listed component parameters are those defined as being editable after the component is installed.

  4. When you have finished modifying the component configuration, click Update.

    The Oracle Content Server instance does not need to be restarted.

6.2.5.2 Using the Configuration for Instance Screen

To modify the configuration settings for a component using the Configuration for instance screen:

  1. Select Administration.

  2. Select Configuration for instance.

  3. Click Enabled Components Details.

  4. Click Configure next to the name of the component to be configured.

    • If the component can be configured, the Update Component Configuration screen for the component is displayed.

    • If the component cannot be configured, a message is displayed.

  5. When you have finished modifying the component configuration, click Update.

    The Oracle Content Server instance does not need to be restarted.

6.3 Using the Component Wizard

This section describes how to use the Component Wizard to create components. It contains the following major sections:

Note:

When using the Component Wizard with Red Hat Linux ES 3, set UseCustomModaling=FALSE in your DomainHome/ucm/cs/bin/intradoc.cfg file. This variable allows a modal dialog to lock only one frame, instead of all frames. Setting the variable in the intradoc.cfg file ensures that other applets are unaffected by this action. See the Oracle Fusion Middleware Idoc Script Reference Guide for details on its usage.

6.3.1 Component Wizard Overview

The following steps provide an overview on using the Component Wizard to create a custom component. The screens used to create this component are described in detail in Appendix A, "User Interface" and are referenced throughout the text.

  1. Launch the Component Wizard.

    The Component Wizard Main Screen is displayed, or the Component List Screen is displayed if other components are already available.

  2. If the Component List screen is displayed, select Add. Otherwise, select Options, then Add on the Component Wizard Main Screen.

    The Add Component Screen is displayed.

  3. Make sure the Create New Component option is selected and enter the name of the new component.

  4. Click OK.

    A confirmation screen is displayed.

  5. Click OK.

    The Component List screen closes, and the new component is opened in the Component Wizard screen, as indicated by its name in the Location field.

6.3.1.1 Working with Java Code

If your new component includes Java code, you can use the Java Code tab of the Component Wizard to view the contents of the ClassAliases table and the Filters table.

You can also remove classes and filters from the component glue file, although the file that is associated with the class or filter will not be deleted from your system. Select the class or filter and click the associated Remove button to remove it from the list.

6.3.1.2 Editing the Readme File

The Component Wizard provides a convenient way to create a Readme file for your custom component. Use the following procedure to edit a Readme file:

  1. Open the component in the Component Wizard.

  2. Select Edit Readme File from Options.

    The text editor opens a readme.txt file, with the name of the component entered on the first line.

  3. Enter text to document your component.

  4. Save and close the file.

    The readme.txt file is saved in the same directory as the component definition file, and will be included as a ComponentExtra entry if you use the Component Wizard to build a component zip file.

6.3.2 Creating a Component

Use the following procedure to create a component using the Component Wizard:

  1. Launch the Component Wizard.

    • (Windows) From the Start menu, click Programs, then Content Server, then instance_name, then Tools, then Component Wizard.

    • (UNIX/Linux) Navigate to the DomainHome/ucm/cs/bin/ directory and run the ComponentWizard program.

    For more information, see Section 3.4.2, "Running Administration Applications in Standalone Mode."

  2. The Component Wizard Main Screen is displayed, or the Component List Screen is displayed if other components are already available. The Component List screen shows all components and their status (enabled or disabled).

    Note:

    If no components are installed, the Component List screen does not appear.

  3. If the Component List screen is displayed, select Add. Otherwise, select Options, then Add on the Component Wizard Main Screen.

    The Add Component screen is displayed.

  4. Enter a name for the new component in the Name field.

  5. Accept the default directory (custom), or enter a new location for the component. This can be either an absolute path or can be a path relative to the Oracle Content Server install directory.

  6. To use an existing component as a starting point, select Copy Existing, click Browse, and navigate to and select the definition (glue) file (component_name.hda) for the component.

  7. Click OK.

    A new component definition (glue) file is created. If you copied an existing component, the resource files are renamed with the new component name and copied to the new component directory.

  8. Add and edit custom resources and other files as necessary as described in these sections:

6.3.2.1 Creating an Environment Resource

An environment resource defines configuration variables, either by creating new variables or replacing the value in existing variables.

Follow these steps to create an environment resource:

  1. Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.

    The Add Resource Screen is displayed.

  2. Select the Environment option.

  3. Enter the file name for the resource file. The default file name is componentname_templates.hda.

    • If a resource file has been created, you can add to the file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  5. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  6. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The file now appears in the Custom Resource Definition list.

    Note:

    If an HTML editor is not defined, select Configuration from Options in the Component Wizard main menu and enter the path and file name of the desired editor, or click Browse and navigate to the executable of the desired editor. For details, see Section 6.3.3.6, "Configuring the Default HTML Editor."

After saving, the new environment resource is displayed on the Component Wizard screen.

6.3.2.2 Creating a Template Resource

A template resource file defines names, types, and locations of custom templates to be loaded for the component. Follow these steps to add a template page:

  1. Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.

    The Add Resource Screen is displayed.

  2. Select the Template option. The Add Template Table Information Screen is displayed.

  3. Enter the file name for the resource file. The default file name is componentname_templates.hda.

    • You can enter templates/ before the file name to create a new /templates directory in your component directory.

    • If a template resource file has been created, you can append a new template table to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  5. Click Next.

    The Add Template Table Information Screen is displayed.

  6. Enter a name for the template table.

    • It is a good idea to leave the name of the component as a prefix.

    • Each template table in a component must have a unique name, even if the tables are in different resource files.

  7. Select which standard table to merge the new template table into:

    • IntradocTemplates

    • SearchResultTemplates

  8. Click Next.

    The Add/Edit Intradoc Template Screen is displayed.

  9. To start with an existing template definition:

    1. Click Select.

      A list of commonly used templates is displayed.

    2. To show the entire list of predefined templates, select Show All.

    3. Select a template from the list.

    4. Click OK.

      The template parameters are filled in.

      Note:

      You can also use an existing custom template file as a starting point. Select Copy From, and navigate to and select the template file. The template parameters will not be filled in automatically, but you could select a standard template to fill in the fields before selecting the template file.

  10. Edit the template parameters as necessary.

    Note:

    If you do not change the name of the template and this component is loaded last, the custom template will override the standard template and any other custom templates with the same name.

  11. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  12. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The file now appears in the Custom Resource Definition list, and the template table appears in the Table Name list in the right pane.

6.3.2.3 Creating a Query Resource

A query resource defines SQL queries, which are used to manage information in the database. Queries are used with services to perform tasks such as adding, deleting, or retrieving data from the database.

Follow these steps to add a query:

  1. On the Component Wizard Main Screen, click Add in the Resource Definition pane.

    The Add Resource Screen is displayed.

  2. Select the Query option.

  3. Enter the file name for the resource file. The default file name is resources/componentname_query.htm.

    • If a query resource file has been created with the default file name, the new default file name will have a number (1, 2, and so on) appended to it. You cannot append a query table to the existing default file unless you edit the resource file manually.

    • If a query resource file has been created with a file name other than the default, you can append a new query table to the existing file.

    • To create a new resource file with a different file name, enter the file name.

  4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  5. Click Next.

    The Add Query Table Information Screen is displayed.

  6. Enter a name for the query table. It is a good idea to leave the name of the component as a prefix.

    • If you are appending to an existing query resource file, you must enter a new table name. You cannot append a query definition to the existing table unless you edit the resource file manually.

  7. Click Next.

    The Add/Edit Query Screen is displayed.

  8. To start with an existing query definition:

    1. Click Select.

      A list of predefined queries is displayed.

    2. Select a query from the list.

    3. Click OK.

      The query expression and parameters are displayed and the Name field is filled in.

      Note:

      If you do not change the name of the query and this component is loaded last, the custom query will override the standard query and any other custom queries with the same name.

  9. Edit the query expression and parameters as necessary.

    • Parameters must appear in the Parameters list in the order they appear in the query expression. Use the Up and Down buttons to move the selected parameter.

    • To add a parameter, click Add. Enter a parameter Name, select the parameter Type, and click OK.

    • To edit a parameter type, select the parameter and click Edit. Select the parameter Type, and click OK.

    • To remove a parameter, select the parameter and click Delete.

  10. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  11. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The query resource file now appears in the Custom Resource Definition list, and the query table appears in the Table Name list in the right pane.

6.3.2.4 Creating a Service Resource

A service resource defines a function or procedure that is performed by the Oracle Content Server instance.

Use the following procedure to create a service resource using the Component Wizard.

  1. In the Component Wizard, open the component the resource will be created for.

  2. On the Resource Definition tab, click Add.

    The Add Resource Screen is displayed.

  3. Select the Service option.

  4. Enter the file name for the resource file. The default file name is resources/componentname_service.htm.

    • If a resource file has been created for services, you can append the new service table to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  6. Click Next.

    The Add Service Table Information Screen is displayed.

  7. Enter a name for the service table.

    • It is a good idea to leave the name of the component as a prefix.

    • Each service table in a component must have a unique name, even if the tables are in different resource files.

  8. Click Next.

    The Add/Edit Service Screen is displayed.

  9. To start with an existing service definition:

    1. Click Select.

      A list of commonly used services is displayed.

    2. To show the entire list of predefined services, select Show All.

    3. Select a service from the list.

      To view a service's details, click Preview. The Preview Information for Service Screen is displayed. Use this screen to view information about the service and the service actions.

    4. Click OK.

      The service attributes and actions are filled in.

      Note:

      If you do not change the name of the service and this component is loaded last, the custom service will override the standard service and any other custom services with the same name.

  10. Edit the service attributes and actions as necessary.

    • Actions must appear in the Actions list in order of execution. Use the Up and Down buttons to move the selected action.

    • To add an action, click Add. The Add/Edit Action Screen is displayed. Enter the action definition and click OK.

    • To edit an action, select the action and click Edit. Modify the action definition and click OK.

    • To remove an action, select the action and click Delete.

  11. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  12. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The service resource file now appears in the Custom Resource Definition list, and the service table appears in the Table Name list in the right pane.

6.3.2.5 Creating an HTML Include

An HTML include is a piece of reusable code that is referenced from a placeholder in another file or from another location in the same file. An include resource defines pieces of code that are used to build the Oracle Content Server web pages. Includes are resolved by the Oracle Content Server instance each time a web page is assembled. For this reason, includes are sometimes called dynamic content resources.

Follow these steps to add an HTML include resource:

  1. On the Component Wizard Main Screen in the Resource Definition section, click Add.

    The Add Resource Screen is displayed.

  2. Select the Resource - HTML Include/String option.

  3. Enter the file name for the resource file. The default file name is componentname_resource.htm.

    • If a resource file has been created for includes, strings, or static tables, or both, you can append the include to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  5. Click Next.

    The Add/Edit HTML Resource Include/String Screen screen is displayed.

  6. Select the Include option.

  7. To start with the code from an existing HTML include:

    1. Click Select.

      A list of commonly used includes is displayed.

    2. To show the entire list of predefined includes, select Show All.

    3. Select an include from the list.

    4. Click OK.

      The include code is displayed and the Name field is filled in.

      Note:

      If you do not change the name of the include and this component is loaded last, the custom include will override the standard include and any other custom includes with the same name.

  8. Edit the include code as necessary.

  9. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The resource file now appears in the Custom Resource Definition list, and the include appears in the Custom HTML Includes list.

6.3.2.6 Creating a String Resource

A string resource defines locale-sensitive text strings that are used in error messages and on Oracle Content Server web pages and applets.

Use the following procedure to create a string resource using the Component Wizard.

  1. In the Component Wizard, open the component the resource will be created for.

  2. On the Resource Definition tab, click Add.

    The Add Resource Screen is displayed.

  3. Select the Resource - HTML Include/String option.

  4. Enter the file name for the resource file. The default file name is componentname_resource.htm.

  • If a resource file has been created for includes, strings, or static tables, or both, you can append the include to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

  • To create a new resource file with a different file name, enter the file name.

  1. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  2. Click Next.

    The Add/Edit HTML Resource Include/String Screen is displayed.

  3. Select the String option.

  4. Enter the name of the string in the Name field (for example, myString.)

    Note:

    If you enter the name of an existing string and this component is loaded last, the custom string will override the standard string and any other custom strings with the same name.

  5. Edit the string code as necessary (for example, This is my string text.)

  6. Click Finish.

    A dialog box asks if you want to launch the text editor to continue editing.

  7. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The resource file now appears in the Custom Resource Definition list, and the string appears in the Custom Strings list.

6.3.2.7 Creating a Dynamic Table Resource

A dynamic table provides dynamic (often changed) content in table format to the Oracle Content Server instance.

Use the following procedure to create a dynamic table resource using the Component Wizard.

  1. In the Component Wizard, open the component the resource will be created for.

  2. On the Resource Definition tab, click Add.

    The Add Resource Screen is displayed.

  3. Select the Resource - Dynamic Table (Hda Format) option.

  4. Enter the file name for the resource file. The default path and file name is resources/componentname_resource.hda.

    • If a resource file has been created for dynamic tables, you can append the new table code to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  6. Click Next.

    The Add Dynamic Resource Table Information Screen is displayed.

  7. Enter a name for the dynamic table. It is a good idea to leave the name of the component as a prefix.

  8. To merge the new table with an existing table, select Merge To, and select a table from the list.

  9. Click Finish.

    • If you selected a table to merge to, a dialog box asks if you want to launch the text editor to continue editing.

    • If you did not select a table to merge to, the Column Information Screen is displayed.

      1. Enter a column name in the Column Name field.

      2. Click Insert. Repeat these steps until all of the table columns have been entered.

      3. Click OK.

        A dialog box asks if you want to launch the text editor to continue editing.

  10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The resource file now appears in the Custom Resource Definition list, and the table appears in the right pane of the Resource Definition tab.

6.3.2.8 Creating a Static Table Resource

Use the following procedure to create a static table resource using the Component Wizard.

  1. In the Component Wizard, open the component for which the resource will be created.

  2. On the Resource Definition tab, click Add.

    The Add Resource Screen is displayed.

  3. Select the Resource - Static Table (HTML Format) option.

  4. Enter the file name for the resource file. The default file name is componentname_resource.htm.

    • If a resource file has been created for static tables, includes, or strings, or both, you can append the static table code to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

    • To create a new resource file with a different file name, enter the file name.

  5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

    Note:

    Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

  6. Click Next.

    The Add Static Resource Table Information Screen is displayed.

  7. Enter a name for the static table. It is a good idea to leave the name of the component as a prefix.

  8. To merge the new table with an existing table, select Merge To, and select a table from the list.

  9. Click Finish.

    • If you selected a table to merge to, a dialog box asks if you want to launch the text editor to continue editing.

    • If you did not select a table to merge to, the Column Information Screen is displayed.

    1. Enter a column name in the Column Name field.

    2. Click Insert.

    3. Repeat steps a and b until all of the table columns have been entered.

    4. Click OK.

    A dialog box asks if you want to launch the text editor to continue editing.

  10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.

    The resource file now appears in the Custom Resource Definition list, and the table appears in the Resource Tables list.

6.3.2.9 Enabling the Component

After creating a component, you should enable it and test it.

  • In the Component Wizard Main Screen, from the Options menu, select Enable.

  • Restart the Oracle Content Server instance.

  • Test the newly created component.

6.3.3 Additional Component Wizard Tasks

In addition to creating custom components, you can use the Component Wizard to build zip files of your components and create custom installation parameters.

6.3.3.1 Building a Component Zip File

The Build function of the Component Wizard enables you to build a component zip file (or package), which can then be saved as a backup or unpackaged to deploy the component on other Oracle Content Server instances.

Use the following procedure to build a component zip file:

  1. Open the component in the Component Wizard.

  2. From the Build menu, select Build Settings.

    The Build Settings Screen is displayed.

    A Component entry for the definition (glue) file and a ComponentExtra entry for a readme.txt file are created automatically. You should not remove the glue file entry, but you can delete the readme.txt entry.

  3. Click Add.

    The Add screen is displayed (Add Screen).

  4. Select an Entry Type.

  5. In the Sub Directory or File field, enter the location of the files for the selected entry type.

    • For the Component entry type, this setting is the file name for the glue file.

    • For other entry types, enter a path to select all files in a particular directory, or enter a path and file name to select an individual file.

    • The location should be a path relative to the DomainHome/custom/ directory. You can use an absolute path (such as C:/oracle/custom/my_component/), but then the component can only be installed on Oracle Content Server instances with the same installation directory path.

      Note:

      Always use forward slashes in the path.

  6. Continue adding entry types and specifying the subdirectories until all of the files of your component are included.

  7. Click OK.

  8. From the Build menu, select Build.

    The Main Build Screen is displayed.

  9. Click OK.

    The Component Wizard builds the component zip file in the DomainHome/custom/component_name directory.

6.3.3.2 Working With Installation Parameters

The Install/Uninstall Settings tab is used to create customized installation components that can include preference data parameters. These parameters can be user prompts and messages. Depending on how they are defined, the prompts and messages are displayed during the installation processes. These custom installation parameters allow the component author to ask for information from users before the component is installed.

To define custom installation parameters for a component:

  1. In the Component List Screen, select the component to have custom installation parameters defined.

  2. Click Open.

  3. On the Add/Edit Preference Screen, select the Install/Uninstall Settings tab, then select the appropriate checkboxes:

    • Has Install/Uninstall Filter

    • Has Install Strings

    Generally, both options are used to create the desired installation parameters.

  4. Click the Launch Editor for the Install/Uninstall Filter option to open a Java code template file. Edit the existing code and include additional Java code to the template as necessary to create the filter procedures.

    Each filter procedure will run once during the component installation or uninstall procedure. The values of user responses are saved in the installation configuration (install.cfg and config.cfg) files. For more information, see the Oracle Fusion Middleware Developer's Guide for Oracle Universal Content Management.

  5. Save and close the Install/Uninstall Filter Java code file.

  6. On the Preference Data Setup pane, click the Add button to open the Add/Edit Preference Screen.

  7. Click the Launch Editor for the Install Strings option to open a Java code template file. Edit the existing code and include additional Java code to the template as necessary to define the set up prompts or messages.

    Keep both the Add Preference screen and the Install Strings HTML template open to use simultaneously. Complete the fields on the Add Preference screen as necessary. Add the actual message or prompt text to the Install Strings HTML.

  8. Save and close the Install Strings Java code file.

  9. Open the Build Settings Screen by selecting Build Settings from the Build menu.

  10. Complete the fields on the Build Settings screen as necessary.

  11. If components have been specified to be included in the component zip file, they will need to be added as component extras using the Add Screen.

    Click the Add button to open the Add screen. Add each component individually.

  12. Click OK.

  13. If necessary, add more components to the zip file as component extras.

  14. On the Build Settings screen, click OK to create the component zip file.

The zip file can be shipped to clients and can be installed using either the Component Wizard or the Component Manager within the Oracle Content Server instance.

6.3.3.3 Enabling and Disabling a Component

Use one of the following procedures to enable or disable a component from the Component Wizard:

Tip:

Components can also be enabled and disabled using the Component Manager.
6.3.3.3.1 Option 1

  1. Open the component in the Component Wizard.

  2. In the Component Wizard Main Screen, from the Options menu select Enable or select Disable.

  3. Restart the Oracle Content Server instance.

    The component is now enabled or disabled.

  4. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

6.3.3.3.2 Option 2

  1. Use either of the following methods to display the Component List Screen:

  2. Select the component to be enabled or disabled.

  3. Click Enable or Disable for the condition you want to set the component.

  4. Restart the Oracle Content Server instance.

    The component is now enabled or disabled.

  5. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

6.3.3.4 Removing a Component

Use the following procedure to remove a component from the Oracle Content Server instance:

Note:

Removing a component means that the Oracle Content Server instance no longer recognizes the component, but the component files are not deleted from the file system.

  1. Disable the component you want to remove.

  2. If the component to be removed is open in the Component Wizard, open a different component or close and restart the Component Wizard. (A component cannot be removed if it is open.)

  3. To display the Component List Screen:

  4. Select the component to be removed from the Component List Screen.

  5. Click Remove.

    A confirmation screen is displayed.

  6. Click Yes.

    The component no longer appears in the Component List.

6.3.3.5 Opening a Component

Use the following procedure to open a component that has already been added to the Oracle Content Server instance:

  1. To display the Component List Screen:

  2. Select the component to be opened from the Component List Screen.

  3. Click Open.

    The component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen.

6.3.3.6 Configuring the Default HTML Editor

You can edit text-based component files directly from the Component Wizard by launching the HTML editor.

  • For the Windows operating system, Microsoft WordPad (wordpad.exe) is the default.

  • For the UNIX operating system, vi is the default.

    Important:

    Specify a text editor (such as WordPad) rather than a graphical HTML editor (such as FrontPage). Graphical editors can insert or change HTML tags and might cause Idoc Script tags to be converted into a string of characters that will not be recognized by the Oracle Content Server instance.

Use the following procedure to define the default HTML editor:

  1. Display the Component Wizard Main Screen.

  2. From the Options menu, select Configuration.

    The Component Configuration Screen is displayed.

  3. Click Browse.

  4. Navigate to and select the executable file for the HTML editor you want to use.

  5. Click Open.

  6. Click OK.

    When you click any Launch Editor button in the Component Wizard, the file will open in the selected program.

6.3.3.7 Unpackaging a Component

Use the following procedure to unpackage a component Zip file:

Note:

If you unpackage a component with the same name as an existing component on the Oracle Content Server instance, the older component will be zipped and copied to the DomainHome/ucm/cs/bin/ directory, with a filename beginning with backup and ending with a time stamp (such as backup1008968718221.zip).

  1. Use either of the following methods to display the Install Screen:

  2. Click Select.

    The Zip File Path screen is displayed.

  3. Navigate to and select the component zip file.

  4. Click Open.

    The contents of the component zip file are listed on the Unpackage screen.

  5. Click OK.

    The component files are copied to the correct locations (there might be a short delay while the files are unzipped), the Unpackage screen closes, and the component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen. The component is also added to the Component List.

    Note:

    Unpackaging a component does not enable it. See Section 6.3.3.3, "Enabling and Disabling a Component."

6.3.3.8 Adding an Existing Component

Use the following procedure to add an existing unpackaged component to the Oracle Content Server instance:

  1. Use either of the following methods to display the Add Component Screen:

  2. Select the Use Existing Component option.

  3. Click Browse.

  4. Navigate to and select the component definition (hda) file (components.hda).

  5. Click Open.

    The path and file name are displayed in the FilePath field.

  6. Click OK.

    The component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen. The component is also added to the Component List.

    Note:

    Adding an existing component does not enable it.

6.4 Using the Command Line

The ComponentTool component enables administrators to use a command line to install, enable, and disable components in the Oracle Content Server system. ComponentTool is installed (enabled) with the Oracle Content Server instance.

When Oracle UCM is deployed, the ComponentTool launcher is installed by default for UNIX and Windows. The executable is located in the DomainHome/ucm/cs/bin/ directory.

UNIX

ComponentTool

Windows

ComponentTool.exe

Component Tool supports the commands listed in Table 6-2.

Table 6-2 ComponentTool Commands

Task Command

Install a component (also automatically enables the component)

ComponentTool --install path/component_name

Enable a component

ComponentTool --enable component_name

Enable a component

ComponentTool --disable component_name

List enabled components

ComponentTool --list-enabled

List disabled components

ComponentTool --list-disabled

List all components

ComponentTool --list

Access ComponentTool help

ComponentTool --help