| Oracle® Fusion Middleware System Administrator's Guide for Content Server 11g Release 1 (11.1.1) E10792-01 |
|
 Previous |
 Next |
Home > System Administrator' > Working With Components > Using the Component Wizard
| Oracle® Fusion Middleware System Administrator's Guide for Content Server 11g Release 1 (11.1.1) E10792-01 |
|
Previous |
Next |
Home > System Administrator' > Working With Components > 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, setUseCustomModaling=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. |
The following steps provide a general 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.
Launch the Component Wizard.
The Component Wizard Main Screen is displayed or the Component List Screen is displayed if other components are already available.
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.
Make sure the Create New Component option is selected and enter the name of the new component.
Click OK.
A confirmation screen is displayed.
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.
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.
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:
Open the component in the Component Wizard.
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.
Enter text to document your component.
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.
Use the following procedure to create a component using the Component Wizard:
Launch the Component Wizard.
For more information, see "Running Administration Applications in Standalone Mode".
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. |
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.
Enter a name for the new component in the Name field.
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 Content Server install directory.
To use an existing component as a starting point, select the Copy Existing check box, click Browse, and navigate to and select the definition (glue) file (component_name.hda) for the component.
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.
Add and edit custom resources and other files as necessary as described in these sections:
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:
Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.
The Add Resource Screen is displayed.
Select the Environment option.
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.
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. |
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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. See "Configuring the Default HTML Editor" for details. |
After saving, the new environment resource is displayed on the Component Wizard screen.
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:
Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.
The Add Resource Screen is displayed.
Select the Template option. The Add Template Table Information Screen is displayed.
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.
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. |
Click Next.
The Add Template Table Information Screen is displayed.
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.
Select which standard table to merge the new template table into: either IntradocTemplates or SearchResultTemplates.
Click Next.
The Add/Edit Intradoc Template Screen is displayed.
To start with an existing template definition:
Click Select.
A list of commonly used templates is displayed.
Select the Show All check box to show the entire list of predefined templates.
Select a template from the list.
Click OK.
The template parameters are filled in.
|
Note: You can also use an existing custom template file as a starting point. Select the Copy From check box, 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. |
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. |
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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.
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:
On the Component Wizard Main Screen, click Add in the Resource Definition pane.
The Add Resource Screen is displayed.
Select the Query option.
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.
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. |
Click Next.
The Add Query Table Information Screen is displayed.
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.
Click Next.
The Add/Edit Query Screen is displayed.
To start with an existing query definition:
Click Select.
A list of predefined queries is displayed.
Select a query from the list.
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. |
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.
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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.
A service resource defines a function or procedure that is performed by the Content Server.
Use the following procedure to create a service resource using the Component Wizard.
In the Component Wizard, open the component the resource will be created for.
On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.
Select the Service option.
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.
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. |
Click Next.
The Add Service Table Information Screen is displayed.
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.
Click Next.
The Add/Edit Service Screen is displayed.
To start with an existing service definition:
Click Select.
A list of commonly used services is displayed.
Select the Show All check box to show the entire list of predefined services.
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.
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. |
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.
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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.
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 Content Server web pages. Includes are resolved by the Content Server 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:
On the Component Wizard Main Screen in the Resource Definition section, click Add.
The Add Resource Screen is displayed.
Select the Resource - HTML Include/String option.
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.
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. |
Click Next.
The Add/Edit HTML Resource Include/String Screen screen is displayed.
Select the Include option.
To start with the code from an existing HTML include:
Click Select.
A list of commonly used includes is displayed.
Select the Show All check box to show the entire list of predefined includes.
Select an include from the list.
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. |
Edit the include code as necessary.
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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.
A string resource defines locale-sensitive text strings that are used in error messages and on Content Server web pages and applets.
Use the following procedure to create a string resource using the Component Wizard.
In the Component Wizard, open the component the resource will be created for.
On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.
Select the Resource - HTML Include/String option.
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.
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. |
Click Next.
The Add/Edit HTML Resource Include/String Screen is displayed.
Select the String option.
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. |
Edit the string code as necessary (for example, This is my string text.)
Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.
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.
A dynamic table provides dynamic (often changed) content in table format to the content server.
Use the following procedure to create a dynamic table resource using the Component Wizard.
In the Component Wizard, open the component the resource will be created for.
On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.
Select the Resource - Dynamic Table (Hda Format) option.
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.
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. |
Click Next.
The Add Dynamic Resource Table Information Screen is displayed.
Enter a name for the dynamic table. It is a good idea to leave the name of the component as a prefix.
To merge the new table with an existing table, select the Merge To check box and select a table from the list.
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.
Enter a column name in the Column Name field.
Click Insert. Repeat these steps until all of the table columns have been entered.
Click OK.
A dialog box asks if you want to launch the text editor to continue editing.
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.
Use the following procedure to create a static table resource using the Component Wizard.
In the Component Wizard, open the component the resource will be created for.
On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.
Select the Resource - Static Table (HTML Format) option.
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.
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. |
Click Next.
The Add Static Resource Table Information Screen is displayed.
Enter a name for the static table. It is a good idea to leave the name of the component as a prefix.
To merge the new table with an existing table, select the Merge To check box and select a table from the list.
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.
Enter a column name in the Column Name field.
Click Insert.
Repeat steps a and b until all of the table columns have been entered.
Click OK.
A dialog box asks if you want to launch the text editor to continue editing.
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.
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 Content Server.
Test the newly created component.
In addition to creating custom components, you can use the Component Wizard to build zip files of your components and create custom installation parameters.
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 content servers.
Use the following procedure to build a component zip file:
Open the component in the Component Wizard.
Select Build Settings from the Build menu.
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.
Click Add.
The Add screen is displayed (Add Screen).
Select an Entry Type.
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 content servers with the same installation directory path.
|
Note: Always use forward slashes in the path. |
Continue adding entry types and specifying the subdirectories until all of the files of your component are included.
Click OK.
Select Build from the Build menu.
The Main Build Screen is displayed.
Click OK.
The Component Wizard builds the component zip file in the DomainHome/custom/component_name/ directory.
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:
In the Component List Screen, select the component that will have custom installation parameters defined.
Click Open.
Select the Install/Uninstall Settings tab on the Add/Edit Preference Screen and select the appropriate check boxes:
Has Install/Uninstall Filter
Has Install Strings
Generally, both options will be used to create the desired installation parameters.
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. See the Oracle Fusion Middleware Developer's Guide for Content Server for more information.
Save and close the Install/Uninstall Filter Java code file.
Click the Add button on the Preference Data Setup pane to open the Add/Edit Preference Screen.
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.
Save and close the Install Strings Java code file.
Open the Build Settings Screen by selecting Build Settings from the Build menu.
Complete the fields on the Build Settings screen as necessary.
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.
Click OK.
If necessary, add more components to the zip file as component extras.
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 content server.
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. |
Open the component in the Component Wizard.
In the Component Wizard Main Screen, from the Options menu select Enable or select Disable.
Restart the content server.
The component is now enabled or disabled.
Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.
Use either of the following methods to display the Component List Screen:
Start the Component Wizard.
In the Component Wizard Main Screen, from the Options menu, select Open.
Select the component to be enabled or disabled.
Click Enable or Disable.
Restart the content server.
The component is now enabled or disabled.
Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.
Use the following procedure to remove a component from the content server:
|
Note: Removing a component means that the content server no longer recognizes the component, but the component files are not deleted from the file system. |
Disable the component you want to remove.
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.)
To display the Component List Screen:
Start the Component Wizard
Select Open from Options in the Component Wizard Main Screen
Select the component to be removed from the Component List Screen.
Click Remove.
A confirmation screen is displayed.
Click Yes.
The component no longer appears in the Component List.
Use the following procedure to open a component that has already been added to the Content Server:
To display the Component List Screen:
Start the Component Wizard
Select Open from Options in the Component Wizard Main Screen
Select the component to be opened from the Component List Screen.
Click Open.
The component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen.
You can edit text-based component files directly from the Component Wizard by launching the HTML editor.
For Windows, Microsoft WordPad (wordpad.exe) is the default.
For UNIX, 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 content server. |
Use the following procedure to define the default HTML editor:
Display the Component Wizard Main Screen.
From the Options menu, select Configuration.
The Component Configuration Screen is displayed.
Click Browse.
Navigate to and select the executable file for the HTML editor you want to use.
Click Open.
Click OK.
When you click any Launch Editor button in the Component Wizard, the file will open in the selected program.
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 content server, the older component will be zipped and copied to the DomainHome/ucm/cs/bin/ directory, with a filename beginning withbackup and ending with a time stamp (such as backup1008968718221.zip). |
Use either of the following methods to display the Install Screen:
In the Component Wizard Main Screen, from the Options menu, select Install.
From the Component List Screen, click Install.
Click Select.
The Zip File Path screen is displayed.
Navigate to and select the component zip file.
Click Open.
The contents of the component zip file are listed on the Unpackage screen.
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.
Use the following procedure to add an existing unpackaged component to the content server:
Use either of the following methods to display the Add Component Screen:
In the Component Wizard Main Screen, from the Options menu, select Add.
From the Component List Screen, click Add.
Select the Use Existing Component option.
Click Browse.
Navigate to and select the component definition (hda) file (components.hda).
Click Open.
The path and file name are displayed in the FilePath field.
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. |
