3.2 About Directories and Files

3.2.1.1 Elements in HDA Files

Each HDA file contains a header line and one or more sections. The header line identifies the Content Server version, character set, and Java encoding for the HDA file. If an HDA file contains double-byte (Asian language) characters, the correct character set and encoding must be specified so the Content Server can read the file properly. The header line is not required for single-byte characters, but it is a good practice to include it in your HDA files.

The Properties Section and ResultSet Section are the two section types that are relevant to component development. These are used to define the Properties of the file (name, location, and so on) and the ResultSet which defines a table or columns and rows of data. ResultSets often represent the results of a query. All other sections tags are for internal application use only.

Comments are not allowed within a section of an HDA file. However, you can place comments in the HDA file before the first section, between sections, or after the last section. Blank lines within a section of an HDA file are interpreted as a NULL value. Blank lines before the first section, between sections, or after the last section are ignored. None of the section types are mandatory in an HDA file, so unused sections can be deleted.

• The Properties section contains a group of name/value pairs. For a custom component, the most common name for a Properties section is LocalData, which means that the name/value pairs are valid only for the current HDA file.

  You can also define global name/value pairs in a Properties section called Environment, but this section type is rarely used. The recommended practice is to define global environment variables in a configuration file in an Environment resource.

  The following is an example of a Properties section in an HDA file.

  @Properties LocalData
  PageLastChanged=952094472723
  LocationInfo=Directory,Public,
  IsJava=1
  refreshSubMonikers=
  PageUrl=/intradoc/groups/public/pages/index.htm
  LastChanged=-1
  TemplatePage=DIRECTORY_PAGE
  IdcService=PAGE_HANDLER
  LinkSelectedIndex=0
  PageName=index
  HeaderText=This is a sample page.  The Page Name must remain index.  The Page Properties for this index page should be customized.
  PageFunction=SavePage
  dSecurityGroup=Public
  restrictByGroup=1
  PageType=Directory
  PageTitle=Oracle Content Server Index Page
  @end
  

• Each ResultSet section of an HDA file defines a table, or columns and rows of data. A ResultSet can be used to pass information to a database or to represent the results of a database query. A ResultSet section has the following structure:

  • The first line defines the name of the ResultSet table using the format @ResultSet resultset_name.

  • The second line defines the number of columns.

  • The next n lines define the column names.

  • The remaining lines define the values in each cell of the table.

  • The last line of the section ends the table using the format @end.

  The following example shows a ResultSet called Scores that has 4 columns and 3 rows.

  @ResultSet Scores
  4
  name
  match1
  match2
  match3
  Margaret
  68
  67
  72
  Sylvia
  70
  66
  70
  Barb
  72
  71
  69
  @end
  

  The following table shows the ResultSet data in a columnar form. A ResultSet can be given any name.

  name	match1	match2	match3
  Margaret	68	67	72
  Sylvia	70	66	70
  Barb	72	71	69

  
  

  The Content Server uses some predefined ResultSets, so the following names should not be used for custom component tables:

  ResultSet Name	Location	Purpose
  Components	IntradocDir/data/components/idccuston-name_components.hda	Defines the name and location of any custom components you have created. You must specify the custom name.
  IntradocReports	IdcHomeDir/resources/core/reports/reports.hda	Specifies the default report templates for the Content Server.
  IntradocTemplates	IdcHomeDir/resources/core/templates/templates.hda	Specifies all of the default templates for the Content Server (except for search results and report templates).
  ResourceDefinition	DomainHome/ucm/short-product-id/custom/component_name/component_name.hda	Defines resources for a custom component.
  SearchResultTemplates	IdcHomeDir/resources/core/templates/templates.hda	Specifies the default search results templates for the Content Server.

  
  

3.2.1.2 The idc_components.hda File

The idc_components.hda file is a text file that tells the Content Server which components are enabled and where to find the definition file for each component.

The idc_components.hda file is always stored in the IntradocDir/data/components/ directory. The Component Wizard, Component Manager, and ComponentTool can be used to make changes to this file if needed.

The following is an example of an idccs_components.hda file, listing several enabled components such as schema, configuration migration, and SOAP.

@properties LocalData
blDateFormat=M/d/yy 
@end
@ResultSet Components
2
name
location
SchemaDCL
custom/SchemaDCL/SchemaDCL.hda
ConfigMigrationUtility
custom/ConfigMigrationUtility/Cmu.hda
Soap
custom/Soap/Soap.hda
@end

3.2.1.3 Component Definition Files

A component definition file points to the custom resources that you have defined. This file specifies information about custom resources, ResultSets, and merge rules. Because it serves as the "glue" that holds a component together, the component definition file is sometimes called the glue file.

The definition file for a component is typically named component_name.hda, and is located in the DomainHome/ucm/short-product-id/custom/component_name/ directory. The Component Wizard can be used to create and make changes to a definition file.

The following example of a component definition file points to an environment resource file called customhelp_environment.cfg.

<?hda version="5.1.1 (build011203)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
blFieldTypes=
@end
@ResultSet ResourceDefinition
4
type
filename
tables
loadOrder
environment
customhelp_environment.cfg
null
1
@end

3.2.3.1 LocalData

The @Properties LocalData section in an HDA file maps to the LocalData of the DataBinder. The LocalData consists of name/value pairs.

The LocalData information is maintained only during the lifetime of the Content Server request and response. Unlike information about the server environment, which rarely changes, the LocalData information for each request is dynamic.

From the point of view of an HTTP request, the initial LocalData is collected from the REQUEST_METHOD, CONTENT_LENGTH, and QUERY_STRING HTTP environment variables. As the service request is processed, the LocalData values can be added and changed.

3.2.3.2 Active or Non-active ResultsSets

Each @ResultSet section of an HDA file maps to a named result in the DataBinder. A ResultSet becomes active when the ResultSet is looped on during page assembly. The active ResultSet take precedence over any other ResultSets during a value search of the DataBinder. When a service request requires data and the value is not found in the LocalData or an active ResultSet, the non-active ResultSet values are searched next.

3.2.3.3 Environment

Environment values are placed in the DataBinder as name/value pairs, which are defined in configuration files such as IntradocDir/config/config.cfg, intradoc.cfg, and environment-type resource files.

3.2.5.1 Customized Site Files

You can add customized files for your site to change the look or actions of the Content Server. For example, the following types of files are often referenced in custom resources:

• Graphics: Replace the icons, backgrounds, and logos that constitute the standard Content Server interface.

• Help: With the assistance of Consulting Services, help files can be customized for your content management system.

• Classes: Java code can change or extend the functionality of the Content Server. Java class files must be packaged into directories before placing them in the DomainHome/ucm/short-product-id/classes/ directory.

3.2.5.2 Component Zip File

A component zip file contains all files that define a Content Server component. It can be unpackaged to deploy the component on other Content Servers.

3.2.5.3 Custom Installation Parameter Files

When you define one or more custom installation parameters, several additional files are created in addition to the files that compose the basic component file structure.

If installation parameters are created for the component, then during the component installation process the component installer automatically places two files in the component directory within the data/components directory. These files hold the preference data as follows:

• config.cfg: Contains the parameters that can be reconfigured after installation.

• install.cfg: Contains the preference data definitions and prompt answers.

• Backup zip file: A backup file that is created if the component is currently installed and is being reinstalled.