| Oracle® Fusion Middleware Idoc Script Reference Guide 11g Release 1 (11.1.1) Part Number E10726-01 |
|
|
View PDF |
| Oracle® Fusion Middleware Idoc Script Reference Guide 11g Release 1 (11.1.1) Part Number E10726-01 |
|
|
View PDF |
This section includes these topics:
Each metadata field has an internal field name, which is used in code. In addition, many fields have descriptive captions which are shown on web pages.
Use field captions when displaying metadata to the user.
Use internal field names when batch loading files or scripting dynamic server pages (.hcst,.hcsp, and .hcsf pages).
All internal metadata field names begin with either a d or an x:
Predefined field names begin with a d. For example, dDocAuthor.
Custom field names begin with an x. For example, xDepartment.
When you create a custom metadata field in the Configuration Manager, the x is automatically added to the beginning of your field name.
Important:
In all cases, internal metadata field names are case sensitive.This section describes the standard metadata fields that Content Server stores for each content item. The fields are grouped as follows:
The following metadata fields are the most commonly used in customizing the interface. These fields appear by default on checkin and search pages.
Do not confuse the Content ID (dDocName) with the dID. The dID is an internally generated integer that refers to a specific revision of a content item.
In addition to the Common Metadata Fields, the following metadata is stored for content items:
An option list is a set of values that can be selected for a metadata field. The following topics describe the use of option lists:
Content Server maintains the following internal option lists by default:
| Metadata Field | Option List |
|---|---|
| Author (dDocAuthor) | docAuthors |
| Security Group (dSecurityGroup) | securityGroups |
| Type (dDocType) | docTypes |
| Account (dDocAccount) | docAccounts |
| Role (dRole) | roles |
The securityGroups and docAccounts option lists are filtered according to the current user's permissions.
The following Idoc Script variables and functions are used to generate and enable option lists:
| Variable or Function | Description |
|---|---|
| optList function | Generates the option list for a metadata field. |
| optionListName variable | Specifies the name of an option list. |
| fieldIsOptionList variable | Specifies that a metadata field has an option list. |
| fieldOptionListType variable | Specifies the type of option list (strict, combo, multi, or access). |
| hasOptionList variable | Set to the value of the fieldIsOptionList variable. This variable is used in conditional statements. |
| defaultOptionListScript variable | Defines a piece of Idoc Script that displays a standard option list field. |
| optionListScript variable | Overrides the standard implementation of option list fields (as defined by the defaultOptionListScript variable). |
| optionsAllowPreselect variable | Specifies that a metadata field option list can be prefilled with its last value. |
| addEmptyOption variable | Specifies that the first value in the option list is blank. |
| optionListResultSet variable | Specifies a ResultSet that contains option list values. |
| optionListKey variable | Specifies the name of a ResultSet column that contains option list values. |
| optionListValueInclude variable | Specifies an include that defines the values for an option list. |
To create an option list, you can use one of the following methods:
Use the optList function to generate a basic option list. Note that this only produces output when used with a service that calls "loadMetaOptionsList".
For example, this code displays a list of possible authors as an HTML option list:
<select name="dDocAuthors">
<$optList docAuthors$>
</select>
Use the rsMakeFromList function to turn the option list into a ResultSet, and then loop over the ResultSet.
For example, this code creates a ResultSet called Authors from the docAuthors option list, and loops over the ResultSet to create an HTML option list. (Because the column name is not specified as a parameter for rsMakeFromList, the column name defaults to row.)
<$rsMakeFromList("Authors","docAuthors")$>
<select name="dDocAuthors">
<$loop Authors$>
<option><$row$>
<$endloop$>
</select>
These code samples are equivalent. Typically, you would use the rsMakeFromList function when you want to parse or evaluate the list options.
For dynamic server pages, several metadata values are stored with a ref: prefix, which makes them available to the page but does not replace ResultSet values. (This prevents pollution of ResultSets by dynamic server pages.)
When you reference any of the following metadata values on a dynamic server page, you must include the ref: prefix:
For example, the following statement determines if the document type is Page:
<$if strEquals(ref:dDocType,"Page"))$>
See the Oracle Fusion Middleware Developer's Guide for Content Server for more information.
|
 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|