This chapter lists Idoc Script variables and functions in alphabetical order, and provides details about each item.
Aborts the current page and displays an error message.
This function evaluates the StatusCode variable, and if a negative numeric value (-1) is returned, the display of the current page is aborted and is substituted with an error page.
The StatusMessage variable can be used as the error message string.
The only parameter is the error message string.
Returns the error message string on an error page.
Aborts the current page and displays Access Denied as an error message:
<$abortToErrorPage("Access Denied")$>
Aborts the current page and displays the value of the StatusMessage variable as an error message:
<$abortToErrorPage("<$StatusMessage$>")$>
This configuration variable changes the default behavior of core collaboration, where an empty access control list allows access to everyone, to instead deny access. When all access control lists are blank, permission is denied to all users except those with the admin role.
When this flag is set to FALSE, users could lose access to or be unable to checkin documents to Oracle WebCenter Content Server unless they specify the appropriate access control list. For example, if a user who has a testrole role wants to checkin and access a document when AccessListPrivilegesGrantedWhenEmpty=false is set, the user must specify testrole with Read/Write (RW) privileges in the Role Entity access control list.
There are no parameters, just the setting of 0 (FALSE) to deny access to everyone.
This example denies access to everyone (except users with the admin role) when the access control list is empty:
AccessListPrivilegesGrantedWhenEmpty=0
Specifies that a metadata field option list has blank value as the first option in the list.
Returns TRUE if the first value in the option is blank.
Returns FALSE if the first value in the option list is not blank.
Specifies that the first value in the option list is blank:
<$if ForceDocTypeChoice and isTrue(ForceDocTypeChoice)$>
<$addEmptyOption = 1$>
<$endif$>
Specifies whether the current page was created immediately after a login.
Returns TRUE if the page was created immediately after a login.
Returns FALSE if the page was not created immediately after a login.
Displays an alternate URL if the page was not created immediately after a login:
<$if not AfterLogin$>
<a href="<$redirect$>">
<$endif$>
When set to TRUE, the date validation code is changed so that dates that match a prior revision date are valid.
Setting this variable allows an archive import and batch load process to import revisions of a content item that have matching creation dates or release dates.
Standard date validation in the archiver normally disallows an import of a revision that matches or is within a minute of the prior revision of a document.
IntradocDir/config/config.cfg
AllowMatchesInDateCheck=TRUE
Defines the path to the default archive collection directory.
Default is DomainHome/ucm/cs/archives/.
IntradocDir/config/config.cfg
DomainHome/ucm/cs/bin/intradoc.cfg
This setting must be included in both configuration files.
As a configuration setting:
ARCHIVE_COLLECTION=f:/domain_archives/
Activates a locking algorithm on archive files at the file system level.
If you do automated imports or transfers with multiple Oracle WebCenter Content Server instances sharing an instance, set this variable to TRUE.
If only one instance is doing automated imports or transfers in a load balancing configuration, then this variable does not need to be set.
There is no default setting.
IntradocDir/config/config.cfg
As a configuration setting:
ArchiverDoLocks=true
Defines the time that a contending Oracle WebCenter Content Server instance will wait before it will treat an archive lock file whose timestamp has not changed as having expired. The Oracle WebCenter Content Server instance will also touch any locks it is maintaining twice during this interval.
An archive lock is created by placing a lock file into an appropriate directory. In order for the lock to persist, the timestamp on the file must change periodically; otherwise any contending Oracle WebCenter Content Server instance will treat the lock as an expired lock.
The smaller the value of this setting, the quicker that locks can alternate between Oracle WebCenter Content Server instances. The larger the value, the more likely that high activity (which could keep a touch request delayed for many seconds) on the network drive will cause a Oracle WebCenter Content Server instance to falsely report a lock as having expired. If a lock is falsely expired, it can cause duplicated effort (although it should not have any long term impact on the state of the Oracle WebCenter Content Server instance).
The default is 12000 milliseconds (12 seconds).
IntradocDir/config/config.cfg
As a configuration setting:
ArchiverTouchMonitorInterval=15000
Dumps trace information to the console for timestamp maintenance on any outstanding archive locks and the discovery of timestamp changes on locks maintained by other servers.
An archive lock is created by placing a lock file into an appropriate directory. In order for the lock to persist, the timestamp on the file must change periodically; otherwise any contending Oracle WebCenter Content Server instance will treat the lock as an expired lock.
There is no default setting.
Note:
This variable is obsolete as of the Oracle WebCenter Content Server 7.0 release. The functionality is now available in the System Audit Information page.IntradocDir/config/config.cfg
As a configuration setting:
ArchiverTraceLockMaintenance=true
Dumps trace information to the console when locks on an archive are acquired and released.
There is no default setting.
Note:
This variable is obsolete as of the Oracle WebCenter Content Server 7.0 release. The functionality is now available in the System Audit Information page.IntradocDir/config/config.cfg
As a configuration setting:
ArchiverTraceLocks=true
Specifies the e-mail address of the author of a content item.
Returns a string or Boolean value depending on use.
Standard use: Returns the e-mail address of the content item's author as a string.
Used in a conditional statement:
Returns TRUE if the content item author has a defined e-mail address.
Returns FALSE if the content item author has no e-mail address.
Can be used to alert the content item author through e-mail when a revision is made.
<$AuthorAddress$>
Defines the path to the default batch load text file.
Returns the file path as a string.
DomainHome/ucm/cs/bin/intradoc.cfg
As a Windows configuration entry:
BatchLoaderPath=c:/domain/BatchLoader/batchfile.txt
As a Solaris/UNIX configuration entry:
BatchLoaderPath=/u1/intradoc3/batLd/batchfile
As script, returns the file path as a string:
<$BatchLoaderPath$>
Defines the authorized user name for the Batch Loader utility. The user name must belong to the admin role.
Default is sysadmin.
Returns the Batch Loader user name as a string.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
BatchLoaderUserName=sysadmin
Defines the path to the Oracle WebCenter Content Server launch executable files, such as IdcServer.exe.
IntradocDir/config/config.cfg
As a configuration setting:
BinDir=c:/domain/bin/
Often used to terminate a loop.
The break instruction causes the innermost loop to be exited.
Control resumes with the first statement following the end of the loop.
Retrieves the version number of the client browser.
Returns the browser version number as a string.
Can be used to ensure that the user has a browser version compatible with the Oracle WebCenter Content Server.
<$BrowserVersionNumber$>
Specifies a comment in Idoc Script code.
Places a comment in the code:
<$c = "Sets the variables to empty strings."$>
This function acts similar to the "inc" IdocScript function. It will evaluate the dynamic html include corresponding to 'includeName', and display it on the page. The difference is that if possible, it will pull the rendered html from a cache, instead of evaluating it again.
For more information, see Section 2.4.1, "Keywords Versus Functions."
Takes three required parameters and two optional parameters. For example:
cacheInclude(includeName, scope, lifeSpan [, cacheName, key])
| Parameter | Description |
|---|---|
| includeName | The name of the dynamic html element to evaluate. |
| scope | Set to 'session' if each user should see different html, or 'application' if all users will see the same thing. |
| lifeSpan | The lifespan of this include in the cache, in seconds. |
| cacheName | Optional: if you want to place this data into a named cache instead of the default cache. If an empty string is passed, it will cache the include into the default cache for the session. |
| key | Optional: if you do not want automatic name-scoping of your cache to prevent conflicts, you can specify a unique key here. |
This will cache the "std_page_begin" include for each user for ten minutes. This is about 10k per user in the cache.
<$cacheInclude("std_page_begin", "session", 600)$>
Specifies the width of a metadata field, in percent.
Returns the width of the current metadata field in percent.
Used as script:
<$if isInfo$>
<$captionFieldWidth="30%"$>
<$captionEntryWidth="70%"$>
<$elseif isEditMode$>
<$captionFieldWidth="20%"$>
<$captionEntryWidth="80%"$>
<$endif$>
Specifies the width of a metadata field caption, in percent.
Returns the width of the current metadata field caption in percent.
Used as script:
<$if isInfo$>
<$captionFieldWidth="30%"$>
<$captionEntryWidth="70%"$>
<$elseif isEditMode$>
<$captionFieldWidth="20%"$>
<$captionEntryWidth="80%"$>
<$endif$>
Outputs chunked file transfer requests on the Oracle WebCenter Content Server Output page in the Admin Server.
When set to TRUE, chunking requests are output to the Oracle WebCenter Content Server Output page.
When set to FALSE, chunking requests are not output.
For this setting to output data, the Chunking function must be enabled using DisableHttpUploadChunking.
Default is FALSE.
IntradocDir/config/config.cfg
As a configuration setting:
ChunkedRequestTrace=true
Determines whether files should be deleted from the file system as they are being batch loaded.
When set to TRUE, deletes each batch loaded file from the hard drive after it is successfully checked in or updated.
Default is FALSE.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
CleanUp=true
Checks if the page was accessed from the ODMA Client.
This value is passed by the string for controlling the update process that is provided by the client.
Returns TRUE if the page was accessed from the ODMA Client.
Returns FALSE if the page was not accessed from the ODMA Client.
Checks if the page was accessed from the ODMA Client:
<$ClientControlled$>
Defines where the default Archive collection is located.
Default is DomainHome/ucm/cs/archives.
IntradocDir/config/config.cfg
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
CollectionLocation=c:/domain/new/archives/
Defines the path to the config directory.
Default is IntradocDir/config.
DomainHome/ucm/cs/bin/intradoc.cfg
As a configuration setting:
ConfigDir=c:/domain/config/
Set this variable in the URL of a service request to display only the form. The std_page_begin and std_page_end include files will not be displayed.
None.
Returns the current date and time.
This variable is similar to dateCurrent, which is used more frequently.
Returns a string formatted according to the user locale.
Used as script:
<$CURRENT_DATE$>
Evaluates which row of a ResultSet you are in.
The first row in a ResultSet is row zero (0).
Returns the row number.
Used as script:
<$CURRENT_ROW$>
Defines the path to the data directory.
Default is IntradocDir/data.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
DataDir=c:/domain/data/
Returns the current date and time.
Can be used to return the current date and time to the user or to create commands using date evaluations.
The only optional parameter is an integer, which adjusts the date by the specified number of days relative to the current date.
Returns a date formatted according to the user locale.
In the following examples, dates are formatted according to the default English-US locale:
m/d/yy h:mm XM
The following returns the current date and the current time (for example, 8/12/01 1:55 PM):
<$dateCurrent()$>
Returns the date ten days in the future and the current time (for example, 8/22/01 1:55 PM):
<$dateCurrent(10)$>
Returns the date ten days in the past and the current time (for example, 8/2/01 1:55 PM):
<$dateCurrent(-10)$>
Sets the date output format for the Indexer.
There is no default value.
IntradocDir/config/config.cfg
Used as a configuration entry:
DateOutputFormat=M/d/yyyy hh:mm:ss a
This function loads a dynamicdata table into a result set. It is very similar to ddLoadIndexedColumnResultSet. The main difference is that if the Idoc Script result set already exists, the new result set created from the dynamicdata table is appended to it. Any fields found in the dynamicdata table, but not in the target result set, are automatically added.
The following table lists parameters for this function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be appended. |
indexColumn |
The name of an indexed column in the dynamicdata table. |
indexValue |
The value to use to select a section of the original table. This value will be checked in a case-insensitive manner against the indexColumn in each row. If it matches, that row is loaded into the result set; otherwise it is skipped. |
mappingTableName |
The name of a dynamicdata table used to rename the columns of the final result set. The renaming is done by mapping the column names in the specified mapping table to the values of the first row in the same table. This is done exactly the same in ddLoadResultSet. |
If the dynamicdata table is successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
1, 3, 9
<@end@>
<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "first value"$>
<$MyResultSet.fieldB = "second value"$>
<$exec ddLoadIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "1")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$> [[% (foo == 'second value') %]]<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$> [[% (bar == '3') %]]
This function loads a dynamicdata table into a result set. It is very similar to ddLoadResultSet. The main difference is that if the Idoc Script result set already exists, the new result set created from the dynamicdata table is appended to it. Any fields found in the dynamicdata table, but not in the target result set, are automatically added.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be appended. |
mappingTableName |
The name of a dynamicdata table used to rename the columns of the final result set. The renaming is done by mapping the column names in the specified mapping table to the values of the first row in the same table. This is done exactly the same in ddLoadResultSet. |
If the dynamicdata table is successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
field1, field2, field3
a, b, c
d, e, f
<@end@>
<$exec rsCreateResultSet("MyResultSet", "field1,field2")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.field1 = "first value"$>
<$MyResultSet.field2 = "second value"$>
<$exec ddAppendResultSet("MyDataTable", "MyResultSet")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.field1$> [[% (foo == 'first value') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.field3$> [[% (bar == 'c') %]]
This function sorts an existing result set using the rules defined in a particular dynamicdata table.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to use for its sorting rules. |
resultSetName |
The name of the result set into which the dynamicdata table should be appended. |
If the sorting is successfully performed, it returns TRUE.
<@dynamicdata MyDataTable@>
<?commatable sortcolumn="order" sortType="int" sortOrder="asc"?>
user, service, order
jane, DOC_INFO, 10
bob, GET_SEARCH_RESULTS, 20
annette, CHECKIN_NEW, 30
<@end@>
<$exec rsCreate("MyResultSet")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.user = "james"$>
<$MyResultSet.service = "GET_FILE"$>
<$MyResultSet.order = 75$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.user = "zoe"$>
<$MyResultSet.service = "DOC_INFO_BY_NAME"$>
<$MyResultSet.order = 20$>
<$exec ddApplyTableSortToResultSet("MyDataTable", "MyResultSet")$>
This function takes a dynamicdata table and returns a comma-separated string containing the names of the columns in the table. It is expected that many dynamicdata tables consist only of field names without any rows just to supply comma-separated lists of values to code in the Oracle WebCenter Content Server system.
This function has one parameter. dataTableName is the name of the dynamicdata table to load.
If the dynamictable exists, it returns True.
<@dynamicdata MyDataTable@>
foo,bar,baz
<@end@>
<$fieldList = ddGetFieldList("MyDataTable")$>
<$trace(fieldList, "#console")$> [[% Outputs: foo,bar,baz %]]
This function executes a resource include, but protects values specified by a dynamicdata table from being changed. The column names in the data table are used as the list of variables names that must be protected. These variables are protected by temporarily caching them, calling the include, and then resetting those variables back to the cached values. If a variable was null, it is set to blank.
If one of the column names in the table starts with a dollar symbol ($), then the string that follows is assumed to be the name of a result set. In that case, it is the pointer to the result set that is temporarily cached in memory and then replaced after the resource include has finished executing. If the result set did not exist at the time of caching, then any result set that exists with that key at the end are removed. If the result set is active at the time it has its pointer cached, new result sets of the same name can be created during the call of the include and the previously active result set will be recovered appropriately without disturbing the loop. The one side effect is that if a new result set is created that temporarily replaces the active result set, then the algorithm for variable substitution that retrieves values first from active result sets can find values for a variable from the cached active result set (assuming the variable is not found as a field in an active result set with higher precedence). The cached active result set maintains its place in the active result set stack,
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
includeName |
The name of the resource include to execute. |
| dataTableName | The name of the dynamicdata table to use for preserving local data and result sets.. |
A string representing the output of the executed resource include.
<@dynamicdata MyPreservedFields@>
foo, bar, $baz
<@end@>
<@dynamichtml my_include@>
<$foo = "tempValue1"$>
<$bar = "tempValue2"$>
<@end@>
<$foo = 5$>
<$ddIncludePreserveValues("my_include", "MyPreservedFields")$>
<$trace(foo, "#console")$> [[% Outputs: 5 %]]
This function loads a dynamicdata table into a result set. This function is similar to ddLoadResultSet except that it only loads those rows whose values for indexColumn match indexValue. The comparisons made on this column are case-insensitive.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be loaded. |
indexColumn |
The name of an indexed column in the dynamicdata table. |
indexValue |
The value to use to select a section of the original table. This value will be checked in a case-insensitive manner against the indexColumn in each row. If it matches, that row is loaded into the result set; otherwise it is skipped. |
mappingTableName |
The name of a dynamicdata table used to rename the columns of the final result set. The renaming is done by mapping the column names in the specified mapping table to the values of the first row in the same table. This is done exactly the same in ddLoadResultSet. |
If the dynamicdata table is successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
1, 3, 9
<@end@>
<$exec ddLoadIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "1")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$> [[% (foo == '2') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$> [[% (bar == '9') %]]
This function loads a dynamicdata table into a result set.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be loaded. |
mappingTableName |
The name of a dynamicdata table used to rename the columns of the final result set. The renaming is done by mapping the column names in the specified mapping table to the values of the first row in the same table. This is done exactly the same in ddLoadResultSet. |
If the dynamicdata table is successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
1, 3, 9
<@end@>
<$exec ddLoadResultSet("MyDataTable", "MyResultSet")$>
<$exec ddLoadResultSet("MyDataTable", "MyAliasedResultSet")$>
<$exec rsFirst("MyResultSet")$>
<$exec rsFirst("MyAliasedResultSet")$>
<$foo = MyResultSet.field1$> [[% (foo == 'a') %]]
<$bar = MyAliasedResultSet.alias2$> [[% (bar == 'c') %]]
This function merges a dynamicdata table into a result set. This function is similar to ddMergeResultSet except that it only merges those rows whose values for indexColumn match indexValue. The comparisons made on this column are case-insensitive.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be merged. |
indexColumn |
The name of an indexed column in the dynamicdata table. |
indexValue |
The value to use to select a section of the original table. This value is checked in a case-insensitive manner against the indexColumn in each row. If it matches, that row is loaded into the result set; otherwise it is skipped. |
mergeType |
The type of merge to perform. Set this to replace to prevent the merge from appending any new rows. Any other value for this parameter is treated as append. |
mappingTableName |
The name of a dynamicdata table which should be used to rename the columns of the final result set. This renaming is done by mapping the column names in this mapping table to the values of the first row in this same table. This is done exactly as it is done in ddLoadResultSet. |
If the dynamicdata table is successfully merged, it returns TRUE.
<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
1, 3, 9
<@end@>
<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "8"$>
<$MyResultSet.fieldB = "23"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "8"$>
<$MyResultSet.fieldB = "21"$>
<$MyResultSet.fieldB = "59"$>
<$exec ddMergeIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "4", "replace")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$> [[% (foo == '5') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$> [[% (bar == '59') %]]
This function merges a dynamicdata table into an existing result set. If the target result set does not exist, then this function acts exactly like ddLoadResultSet and the target result set is simply created. Otherwise, the merge is performed using the first column of the new result set as the merge key. By default, the merge appends any rows from the new result set that do not match any rows in the existing Idoc Script table, unless the mergeType parameter is set to replace, in which case no new rows are added to the Idoc Script result set.
Note that this merge does not replace all rows matched by a particular row of the new result set, just the first one that it finds. The matching is case-sensitive. The mergeType parameter is optional and defaults to null.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be merged. |
mergeType |
The type of merge to perform. Set this to replace to prevent the merge from appending any new rows. Any other value for this parameter is treated as append. |
mappingTableName |
The name of a dynamicdata table which should be used to rename the columns of the final result set. This renaming is done by mapping the column names in this mapping table to the values of the first row in this same table. This is done exactly as it is done in ddLoadResultSet. |
If the dynamicdata table is successfully merged, it returns TRUE.
<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
<@end@>
<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "52"$>
<$MyResultSet.fieldC = "18"$>
<$exec ddMergeResultSet("MyDataTable", "MyResultSet", "replace")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$> [[% (foo == 52) %]]
<$bar = MyResultSet.#numRows$> [[% (bar == 1) %]]
This function pulls selective rows from a dynamicdata table and use them to replace particular row values in a target result set. The values of a particular column in the target result set are used as values for an index look up into the dynamicdata table. The sub table retrieved is used to replace column values in the target result set that have matching column names. The dynamicdata table is assumed to have only one row in the sub table selected out by the index value. If it has more than one row, only the first row is used to merge in values into the target result set.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
idocTableName |
The name of the result set into which the dynamicdata table should be merged. |
indexColumn |
The name of an indexed column in the dynamicdata table and the name of the column in the target result set from which values are retrieved to select out sub tables in the dynamicdata table. |
mappingTableName |
The name of a dynamicdata table which should be used to rename the columns of the final result set. This renaming is done by mapping the column names in this mapping table to the values of the first row in this same table. This is done exactly as it is done in ddLoadResultSet. |
If the dynamicdata table is successfully merged, it returns TRUE.
<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
7, 8, 9
<@end@>
<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "8"$>
<$MyResultSet.fieldB = "23"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "7"$>
<$MyResultSet.fieldB = "20"$>
<$MyResultSet.fieldB = "41"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "8"$>
<$MyResultSet.fieldB = "21"$>
<$MyResultSet.fieldB = "59"$>
<$exec ddMergeIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$> [[% (foo == '5') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$> [[% (bar == '9') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$> [[% (bar == '59') %]]
This function takes a dynamicdata table and iterates over it, setting local data values for each row. The first column of the table is used as the list of keys, while the second column is used as the list of values.
This function has one parameter, dataTableName, which is the name of the dynamicdata table to load.
If the dynamicdata table exists, it returns TRUE.
<@dynamicdata MyDataTable@>
key, value
foo, 15
bar, 23
baz, 77
<@end@>
<$exec ddSetLocal("MyDataTable")$>
<$tmp1 = #local.foo$> [[% (tmp1 == '15') %]]
<$tmp2 = #local.bar$> [[% (tmp2 == '23') %]]
<$tmp3 = #local.baz$> [[% (tmp3 == '77') %]]
This function takes the first row of a dynamicdata table and, using the column names as keys, sets a local value for each column and its corresponding value. If there is no first row, then this function does nothing. This can be a useful method for quickly setting a lot of local values. The filterInclude and includeColumns properties of the dynamicdata table are ignored.
This function has one parameter, dataTableName, which is the name of the dynamicdata table to load.
If the dynamicdata table was successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
foo, bar, baz
<@end@>
<$exec ddSetLocalByColumnsFromFirstRow("MyDataTable")$>
<$tmpStr1 = #local.fieldA$> [[% (tmpStr1 == 'foo') %]]
<$tmpStr2 = #local.fieldC$> [[% (tmpStr2 == 'baz') %]]
This function takes the first row of a dynamicdata table, and, using the column names as keys, sets a local value for each column and its corresponding value. If there is no first row, then this function does nothing. This function is almost identical to ddSetLocalByColumnsFromFirstRow. The only difference is that this function uses the first row given an indexed column and value instead of the very first row of the dynamicdata table. If no indexed row is found then this function does nothing.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
dataTableName |
The name of the dynamicdata table to load. |
indexColumn |
The name of an indexed column in the dynamicdata table. |
indexValue |
The value to use to select a row of the original table. This value will be checked in a case-insensitive manner against the indexColumn in each row. If it matches, that row will be used and the rest of the table will be ignored. |
If the dynamicdata table is successfully loaded, it returns TRUE.
<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldB"?>
fieldA, fieldB, fieldC
1, 2, 3
4, 5, 6
7, 8, 9
3, 5, 2
<@end@>
<$exec ddSetLocalByColumnsFromFirstRowIndexed("MyDataTable", "fieldB", 5)$>
<$tmpStr1 = #local.fieldA$> [[% (tmpStr1 == '4') %]]
<$tmpStr2 = #local.fieldC$> [[% (tmpStr2 == '6') %]]
This function takes a dynamicdata table and iterates over it, clearing local data. The first column is used as the keys to clear.
This function has one parameter, dataTableName, which is the name of the dynamicdata table to use.
If the dynamicdata table exists, it returns TRUE.
<@dynamicdata MyDataTable@>
key
foo
bar
baz
<@end@>
<$foo = 1$>
<$bar = 2$>
<$baz = 3$>
<$exec ddSetLocalEmpty("MyDataTable")$>
<$if foo or bar or baz$>
[[% This will not be executed as foo, bar, and baz are all empty. %]]
<$endif$>
This function takes a dynamicdata table and uses the columns to clear values in local data.
This function has one parameter, dataTableName, which is the name of the dynamicdata table to use.
If the dynamicdata table exists, it returns TRUE.
<@dynamicdata MyDataTable@>
foo, bar, baz
<@end@>
<$bar = "asdf"$>
<$exec ddSetLocalEmptyByColumns("MyDataTable")$>
<$if bar$>
[[% This will not execute as bar will be empty. %]]
<$endif$>
Specifies the include to use to display the metadata field.
Sets the default field display include for a hidden field on a query page to std_query_hidden_field:
<$if isFieldHidden$>
<$if isQuery and not (fieldType like "Date") and not (fieldType like "Int")$>
<$defaultFieldInclude = "std_query_hidden_field"$>
<$endif$>
Defines a piece of Idoc Script that displays a standard option list field.
None.
Generates an option list using the optList function:
<$if optionsAllowPreselect and fieldValue$>
<$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
<$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>
Loops on the current option list ResultSet to generate an option list:
<@dynamichtml compute_resultset_option_list_script@>
<$if not optionListKey$>
<$optionListKey = fieldName$>
<$endif$>
<$defaultOptionListScript = "<$loop " & optionListResultSet & "$>" & "<$inc('std_resultset_option_list_item')$>" & "<$endloop$>"$>
<@end@>
Retrieves a comma-delimited, colon-delimited list of roles the current user belongs to.
Returns the user role list as a string.
Returns a list of roles formatted as follows:
:guest:,:PublicContributor:,:ClassifiedConsumer:
Enables logging and defines the path for the log file during temporary locking of directories.
Any errors that occur during temporary locking of directories will be reported to this log file.
If this setting has no value, logging is disabled.
There is no default value.
IntradocDir/config/config.cfg
Used as a configuration entry:
DirectoryLockingLogPath=C:/temp/locking.log
Used to disable Content Profile functionality but does not remove profiles which have already been created. Profiles remain available through the user interface.
This configuration variable can be used to help determine if specific behavior is caused by Content Profiles or by another component.
After debugging has been completed, remove this variable from the config.cfg file and restart the Oracle WebCenter Content Server instance to use Content Profiles again.
IntradocDir/config/config.cfg
DisableContentProfiles=true
Disables gzip compression of HTML pages and log files. Pages are compressed only if the client browser supports compressed HTML. Compression makes pages an average of 80% smaller and is supported by any HTTP 1.1 compatible browser.
When set to TRUE, pages will not be compressed before being sent to a client web browser.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
DisableGzipCompression=true
Disables timestamp checking on all loaded resources.
When set to TRUE, resource files defined in components will be refreshed only when the Oracle WebCenter Content Server instance is restarted.
This setting does not stop timestamp checking on HCST and HCSP pages.
This setting can be used to limit file system activity, typically when the Oracle WebCenter Content Server file system is on a network share. This setting is particularly important in production environments where file checking and timestamp overhead can seriously degrade performance. In a development environment this setting can be optional.
See the clustering documentation for more information.
IntradocDir/config/config.cfg
Used as a configuration entry:
DisableSharedCacheChecking=true
Loads all the includes in a specified content item for use in the display of the current page.
The content item specified must have the file extension idoc.
This function sets StatusCode as a side effect. Use the abortToErrorPage function if the specified file must successfully load for the page to correctly display.
Takes a CGI-encoded parameter list that specifies a content item that is checked into the Oracle WebCenter Content Server system. The parameter options are listed in the following table.
| Optional Parameters | Description |
|---|---|
| dID | If dID is not present, dDocName and RevisionSelectionMethod must be present. A rendition of the revision of the content item with this ID will be returned, if it exists, and the RevisionSelectionMethod parameter does not exist or has the value Specific. |
| dDocName | It is recommended that dDocName be present in all requests for content items where the dDocName is known. Error messages assume that it is present, as do other features such as forms.
|
| RevisionSelectionMethod | If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. The value may be Specific, Latest, or LatestReleased.
|
| Rendition |
|
Note:
When used in .hcsp pages, the ampersand (&) character in the CGI-encoded parameter list must be changed to the & character.None.
Loads the resource includes in the primary vault rendition of the latest revision of mydoc.
<$docLoadResourceIncludes("dDocName=mydoc&RevisionSelectionMethod=Latest")$>
Retrieves the file name of a file without the extension or directory path.
This function is typically used to extract the Content ID (dDocName) part of a Oracle WebCenter Content Server-controlled static URL.
Takes one parameter:
The only parameter is a path and file name.
Returns the file name as a string.
Returns the value mydoc:
docRootFilename("/groups/public/documents/adacct/mydoc.pdf")
Enables the multiple file Download Applet.
When set to TRUE, the Download Applet is enabled so that multiple files can be downloaded from a search results page.
When set to FALSE, the Download Applet is disabled.
Default is FALSE.
System Properties, Options tab, Enable download applet
Admin Server, General Configuration, Enable download applet
IntradocDir/config/config.cfg
As a configuration setting, enables the Download Applet:
DownloadApplet=true
As script, evaluates the condition of the Download Applet:
<$DownloadApplet$>
Retrieves the default path and suggested name for a file being downloaded.
The suggested name is based on the original file name of the content item.
Returns the path and suggested name for the downloaded file as a string.
Returns the path and suggested name for the downloaded file:
<$DownloadSuggestedName$>
Function used to return the value set by the dpSet function.
Both dpGet and dpSet are used to control the logic of Content Profile rules that are to be displayed. Commonly, a user may create an activation condition that sets a value for a specified key. Even if the condition evaluates to false (that is, the rule fails to fire), the key is set. Another rule can now access the key and retrieve the value when evaluating its activation condition. By using these two functions, a user can create a dependency between rules. For example, a user may want a rule to be evaluated only when a preceding rule is evaluated.
This function takes one parameter:
Key: The designation for the value to be returned.
<$myValue = dpGet("myKey")$>
Function used to 'promote' values from a rule evaluation context into the request context. After the evaluation of all rules, the key and value specified by this function are pushed into the local data.
This function takes two parameters:
The first parameter is the designation for the value to be returned.
The second parameter is the value to be returned.
This example changes the value for AutoNumberPrefix for one request to be the value for dDocType:
<$dpPromote("AutoNumberPrefix", dDocType)$>
This example causes the Title field to be hidden on checkin pages:
<$dpPromote("dDocTitle:isHidden", "1")$>
Similar to dpPromote, this function allows a ResultSet that is generated in a profile rule to be promoted to the request context. The ResultSet is pushed into the databinder after the evaluation of all rules. The values are not evaluated during rule activation or manipulation but are available for page presentation.
This function can take two parameters:
The first parameter is the name of the ResultSet to push into the data.
Optional. The second parameter is an alternate name for the ResultSet.
Function used to set temporary values during the evaluation of activation conditions or rule values anywhere Idoc Script is evaluated.
The values are set into a working area and can be retrieved by the dpGet function call. The key and value that is set does not persist, but is globally available for the profile being evaluated. All key/value pairs can be accessed by the rules of the profile.
Both dpGet and dpSet are used to control the logic of Content Profile rules that are to be displayed. Commonly, a user may create an activation condition that sets a value for a specified key. Even if the condition evaluates to false (that is, the rule fails to fire), the key is set. Another rule can now access the key and retrieve the value when evaluating its activation condition. By using these two functions, a user can create a dependency between rules. For example, a user may want a rule to be evaluated only when a preceding rule is evaluated.
This function takes two parameters:
Key: The designation for the value to be returned.
Value: Value associated with the key.
<$dpSet("myKey", "1")$>
Enables the Environment Packager debugging function.
This function enables an administrator to package all files in the admin, config, and bin directories into a Zip archive, along with a text file called environment.txt. This text file contains additional information about the Java Virtual Machine, and the operating system of the server. The Zip file, server_environment.zip, is placed in the root directory of the Oracle WebCenter Content Server instance.
When set to TRUE, the Environment Packager function is enabled.
When set to FALSE, the Environment Packager function is disabled.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
EnableEnvironmentPackager=true
Generates a Batch Loader error file.
If errors are encountered during a batch load, an error file is generated with those problem records added.
When set to TRUE, an error file is generated.
There is no default value.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
EnableErrorFile=true
Evaluates a variable definition as if it were Idoc Script. Can be used to recursively evaluate a literal string.
The only parameter is a variable that defines a string to be evaluated as Idoc Script.
Returns the parameter string, with any Idoc Script in the variable definition resolved.
Variable one is assigned the string CompanyName, and variable two is assigned a string that includes variable one within Idoc Script delimiters. On a page, variable one presents the string CompanyName, variable two presents the string Welcome to <$one$> and eval(two) presents the string Welcome to CompanyName.
<$one="CompanyName"$> <$two="Welcome to <$one$>"$> <$one$><br> <$two$><br> <$eval(two)$>
Say you wanted to exclude all metadata fields that have the prefix xPrefix in their names. You could use the eval function to dynamically write and evaluate Idoc Script for this purpose:
<$loop DocMetaDefinition$>
<$if strIndexOf("xPrefix", dName) >= 0$>
<$myScript = "<$" & dName & ":isExcluded=1$>"$>
<$eval(myScript)$>
<$endif$>
<$endloop$>
Executes an Idoc Script expression and suppresses the output (does not display the expression on the page).
In earlier versions of Idoc Script, the exec keyword was required to suppress the value of any variable from appearing in the output file. In the current version, the exec keyword is needed only to suppress an expression from appearing in the output.
For example, the first line below is equivalent to the last two lines:
<$varA="stringA", varB ="stringB"$> <$exec varA="stringA"$> <$exec varB="stringB"$>
The exec keyword is typically used to evaluate behind-the-scenes code, such as specifying an include to be used later in the page.
The only parameter is an Idoc Script expression.
Returns the value of the expression, but does not display the expression on the page.
Evaluates the inc global functions to incorporate the specified includes without displaying their code on the page:
<@dynamichtml std_definitions@>
<$exec inc("std_page_variable_definitions")$>
<$exec inc("define_image_files")$>
<@end@>
Executes an Oracle WebCenter Content Server service.
This function allows the specified service to be executed while the page is being constructed. Generally, services are executed using a tool such as IdcCommand or the CGI URL on the browser.
Used with dynamic server pages.
Services that can be called with the executeService function must be scriptable, meaning that they do not require parameter input. Scriptable services have an access level of 32 or more.
The only parameter is the name of the service to be executed. The live data in the DataBinder is used as parameters to the specified service.
Returns a StatusCode of 0 if the service was executed successfully.
Returns a StatusCode of -1 if an error in the service execution occurred.
All output of the executed service is suppressed, but any ResultSets and loaded values are available.
Executes a service when given a service name:
<$executeService("servicename")$>
Retrieves the default roles for users who are defined by an external user base (NTLM, Active Directory, or LDAP).
Returns a comma-delimited list of accounts, with permissions for each account specified in parentheses after the account name.
The #none entry grants privileges to content items that have no account assigned. The #all entry grants privileges to all accounts.
As script, returns the default account information as a string:
<$ExternalUserAccounts$>
Retrieves the default roles for users who are defined by an external user base (NTLM, Active Directory, or LDAP).
Returns the list of roles as a string.
As script, returns the default role information as a string:
<$ExternalUserRoles$>
Specifies the caption label for a metadata field.
Returns the caption of the metadata field as a string.
Defines the caption for the dDocTitle metadata field as the wwTitle localized string:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>
Specifies the include to use to display the caption for the metadata field.
None.
Sets the caption display include to std_field_caption:
<$fieldCaptionInclude = "std_field_caption"$>
Specifies the style of the caption for the metadata field.
The following SPAN styles are typically used for captions. They are defined in the std_style_declaration include in the IdcHomeDir/resources/core/std_page.htm resource file:
searchLabel
infoLabel
tableEntry
requiredField
Returns the name of the caption style.
Sets the caption style to requiredField:
<$if isRequired and not suppressCaptionHighlighting$>
<$fieldCaptionStyle = "requiredField"$>
<$endif$>
Generates the standard field caption:
<@dynamichtml std_field_caption@>
<span class=<$fieldCaptionStyle$>><$fieldCaption$><$if not isFormSubmit$><$":"$><$endif$></span>
<@end@>
Specifies the default value for a metadata field.
Returns the default value of the metadata field as a string.
Defines the default value for the dDocTitle metadata field:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle"),
fieldDefault="Enter a Title"$>
Specifies the character width of the metadata input field on the HTML page. It is set in compute_namevalue_edit_widths, which is included in the resource compute_std_field_includes.
None.
Specifies the include to use to display the value for the metadata field.
Sets the value display include to std_checkbox_entry:
<$fieldEntryInclude = "std_checkbox_entry"$>
Specifies the name of the include file containing additional JavaScript validation for a specific metadata field. This is set in the resource compute_std_field_includes.
Specifies the name of the include to display a metadata field. The include file is usually std_namevalue_field, but it can be set to another include.
This is usually set at the top of the page with xFieldName:include but can also be set by overriding the resource compute_std_field_includes.
Specifies whether a metadata field has an option list.
When set to TRUE, the field has an option list.
When set to FALSE, the field does not have an option list.
Default is FALSE.
Returns TRUE if the field has an option list.
Returns FALSE if the field does not have an option list.
Defines the dDocAccount metadata field as an option list if predefined accounts exist:
<$if HasPredefinedAccounts$>
<$fieldIsOptionList = 1, optionListName = "docAccounts",
fieldOptionListType = "combo"$>
<$endif$>
Specifies the maximum length of the metadata field. This is not the size of the field but the maximum number of characters that the field can contain. It is usually set at the top of the page with xFieldName:include but can also be set by overriding the resource compute_std_field_includes.
Specifies the internal name of a metadata field.
Predefined metadata fields begin with a lowercase d (for example, dDocName).
Custom metadata fields begin with a lowercase x (for example, xComments).
Returns the name of the metadata field as a string.
Defines the dDocTitle metadata field:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>
Specifies the type of option list for a metadata field.
Possible values for this variable are:
| fieldOptionListType Value | Corresponding Option in Configuration Manager |
|---|---|
| strict | Select List Validated or Select List Not Validated |
| combo | Edit and Select List |
| multi | Edit and Multiselect List |
| access | None (Used in Collaboration Server for member access lists) |
Returns the option list type as a string.
Defines the dDocAccount option list type as combo (Edit and Select List):
<$if HasPredefinedAccounts$>
<$fieldIsOptionList = 1, optionListName = "docAccounts",
fieldOptionListType = "combo"$>
<$endif$>
Specifies the type of metadata field.
Possible values for this variable are:
| fieldType Value | Corresponding Option in Configuration Manager |
|---|---|
| Text | Text |
| BigText | Long Text |
| Int | Integer |
| Date | Date |
| Memo | Memo |
Returns the metadata field type as a string.
Defines the dDocTitle metadata field as a BigText (Long Text) field:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>
Specifies the value for a metadata field.
Returns the value of the current metadata field.
Generates the standard field value:
<@dynamichtml std_value_label@>
<span class="<$fieldValueStyle$>"><$fieldValue$></span><!--""-->
<@end@>
Specifies the style of the value for the metadata field.
The following SPAN styles are typically used for values. They are defined in the std_style_declaration include in the IdcHomeDir/resources/core/std_page.htm resource file:
tableEntry
xxsmall
strongHighlight
Returns the name of the value style.
Sets the value style:
<$if isFieldInfoOnly$>
<$if valueStyle$>
<$fieldValueStyle = valueStyle$>
<$else$>
<$fieldValueStyle = "tableEntry"$>
<$endif$>
<$endif$>
Generates the standard field value:
<@dynamichtml std_value_label@>
<span class="<$fieldValueStyle$>"><$fieldValue$></span><!--'"-->
<@end@>
Specifies the width of a metadata field, in characters.
Returns the width of the current metadata field.
Generates the Extension field with a width of 10 characters:
<$fieldName = "dExtension", fieldCaption = lc("wwNativeExtension"),
fieldWidth = 10$>
Specifies the file encoding to be used.
If the Oracle WebCenter Content Server is configured to use languages other than operating system's native language (for example, using both English and Japanese locales on an English system), this variable must be set to UTF8 in both the Oracle WebCenter Content Server and the Oracle WebCenter Content: Inbound Refinery instances.
Oracle WebCenter Content Server: DomainHome/ucm/cs/bin/intradoc.cfg
Oracle WebCenter Content: Inbound Refinery: Intradoc/data/configuration/connections/main/intradoc.cfg
Used as a configuration entry:
FileEncoding=UTF8
Adds a blank option as the default for the Type option list on checkin pages. This requires the user to select a Type.
Used on pages as a display option.
When set to TRUE, the checkin page displays the Type option list with a blank option.
Default setting is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
ForceDocTypeChoice=true
This function can be used to force the cache for a particular include to expire. This is useful in the case of a change in the page display, such as adding new metadata fields, or if the user has saved a new query, or altered which links are viewable.
If the value for 'includeName' is null, or an empty string, then the entire cache will be eliminated. This is useful when all includes for a particular page are placed into the same cache, and need to be expired at the same time.
See Keywords Versus Functions for more information
Takes two required parameters and two optional parameters. For example:
forceExpire(includeName, scope [, cacheName, key])
| Parameter | Description |
|---|---|
| includeName | The name of the dynamic html element to evaluate. |
| scope | Set to 'session' if each user should see different html, or 'application' if all users will see the same thing. |
| cacheName | Optional: if you want to place this data into a named cache instead of the default cache. If an empty string is passed, it will cache the include into the default cache for the session. |
| key | Optional: if you do not want automatic name-scoping of your cache to prevent conflicts, you can specify a unique key here. |
This can be used as a replacement for the 'std_page_begin' include. It will verify if the user executed one of the standard service calls to modify the links on the standard left navigation bar (saving a query, altering the portal design). If so, the cached html for the standard page begin will be invalidated. Then, the next 'cacheInclude' function will reevaluate the include, and place it back into the cache.
<$if strEquals(IdcService, "PNE_SAVE_QUERY") or strEquals(IdcService, "PNE_UPDATE_PORTAL_INFO")$>
<$forceExpire("std_main_page_begin", "session", "", "std_main_page_begin")$>
<$endif$>
<$cacheInclude("std_main_page_begin", "session", 600, "", "std_main_page_begin")$>
Adds a blank option as the default for the Security Group option list on checkin pages. This requires the user to select a Security Group.
Used on pages as a display option.
When set to TRUE, the checkin page displays the Security Group option list with a blank option.
Default setting is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
ForceSecurityGroupChoice=true
Reformats a date/time to the default date/time format.
Database-formatted dates cannot be evaluated (for example, 2001-06-15).
Long-formatted dates cannot be evaluated (for example, June 15, 2001).
The only parameter is a string that specifies a date/time.
Returns the date/time in the format used by dateCurrent (for example, 6/15/01 1:55 PM).
Returns null if the parameter cannot be evaluated.
If a time is not provided, returns a default time of 12:00 AM.
The following example formats the date and time and displays it as 12/14/99 2:00 PM:
<$formatDate("12/14/1999 02:00 PM")$>
The following example formats the date, assigns the default time, and displays it as 9/15/03 12:00 AM:
<$formatDate("09/15/2003")$>
The following script formats and displays a specified date and time. Line one evaluates an alternate date and time format and assigns it to a custom variable. Line two displays this date to a user.
<$my_customDateTime = formatDate("06/14/2004 15:05:34")$>
Final Approval: <$my_customDateTime$>
Output:
Final Approval: 6/14/04 3:05 PM
Reformats a date/time to a date/time format for display to the user. Uses the "Display Date Format" in System Properties to format the date.
The only parameter is a string that specifies a date/time.
Returns the date/time in the format used.
Returns null if the parameter cannot be evaluated.
<$formatDateDisplay$>
Reformats a date/time to the default date format and strips out the time.
Database-formatted dates cannot be evaluated (for example, 2000-02-02).
Long-formatted dates cannot be evaluated (for example, June 12, 2001).
The only parameter is a string that specifies a date/time.
Returns the date only in the format used by dateCurrent (for example, 7/12/00).
Returns null if the parameter cannot be evaluated.
Returns the current date only (for example, 9/12/01):
<$formatDateOnly(dateCurrent())$>
Returns the date ten days in the future (for example, 9/22/01):
<$formatDateOnly(dateCurrent(10))$>
Formats the date and time and displays the date only as 1/17/00:
<$formatDateOnly("01/17/2000 2:00 PM")$>
This script displays the current date and a date 100 days in the future. Line one assigns the current date only to a custom variable. Line two assigns a date 100 days in the future to a second custom variable. Line three displays these dates to a user (for example, Start Date: 10/12/01 and End Date: 1/20/02):
<$my_startDate = formatDateOnly(dateCurrent())$> <$my_endDate = formatDateOnly(dateCurrent(100))$> Start Date: <$my_startDate$> and End Date: <$my_endDate$>
Reformats a date to a date format for display to the user. Uses the "Display Date Format" in System Properties to format the date.
Similar to formatDateDisplay but only formats the date.
The only parameter is a string that specifies a date.
Returns the date in the format used.
Returns null if the parameter cannot be evaluated.
<$formatDateOnlyDisplay$>
Reformats a date/time to the long date format and strips out the time. Database-formatted dates cannot be evaluated (for example, 2000-02-02).
This setting is deprecated for version 5.1 and later. Use formatDateWithPattern.
The only parameter is a string that specifies a date/time.
Returns a long-formatted date:
month d, yyyy
Returns null if the parameter cannot be evaluated.
Returns the current date in long format:
<$formatDateOnlyFull(dateCurrent())$>
Returns the date 365 days in the future in long format (for example, September 12, 2002):
<$formatDateOnlyFull(dateCurrent(365))$>
Formats the date only and displays as June 12, 2001:
<$formatDateOnlyFull("6/12/01 3:00 PM")$>
Reformats a date/time to a specified date/time pattern.
Takes two parameters:
The first parameter is a date string used by the Oracle WebCenter Content Server instance, or a date object created with the parseDate or dateCurrent functions.
The second parameter is the date/time pattern, such as MM/dd/yyyy.
The capital letter Z denotes the use of a UTC time zone for the entry. The lowercase zzzz denotes the time offset (HHMM) from the UTC time, preceded by a plus (+) or minus (-) sign to indicate the offset.
Returns the date/time in the format specified by the pattern parameter.
Returns null if the parameter cannot be evaluated.
Displays Wed, 5 Jul 2006 12:08:56 -0700:
<$formatDateWithPattern(dateCurrent(),"EEE, d MMM yyyy HH:mm:ss zzzz")$>
Displays 2006-07-05 14:30:33Z:
<$formatDateWithPattern(dateCurrent(),"yyyy-MM-dd HH:mm:ssZ")$>
Reformats a date/time to the default time format and strips out the date.
The only parameter is a string or variable that specifies a date/time.
Returns a time only in the format used by dateCurrent (for example, 1:15 PM).
Returns null if the parameter cannot be evaluated.
Returns the current time only:
<$formatTimeOnly(dateCurrent())$>
Formats the time only and displays as 5:00 PM:
<$formatTimeOnly("2/2/99 5:00 PM")$>
Formats the time only and displays as 6:14 PM:
<$formatTimeOnly("04/21/2001 18:14:00")$>
Reformats a time to a time format for display to the user. Uses the "Display Date Format" in System Properties to format the time.
Similar to formatDateDisplay but only formats the time.
The only parameter is a string that specifies the time.
Returns the time in the format used.
Returns null if the parameter cannot be evaluated.
<$formatTimeOnlyDisplay$>
This function returns the unique ID for an HTML page. This is used with the id attribute in an HTML element to guarantee a unique ID.
The only parameter is the field name for which the ID will be generated.
Returns the ID for an HTML page.
Retrieves the output of the debug trace.
Returns the output of the accumulated debug trace for the page being constructed.
Returns an empty string if IsPageDebug has not been set.
Retrieves the output of the debug trace and outputs the information to a page:
<$getDebugTrace()$>
Retrieves the output of the error trace.
Error trace output is encoded for display in HTML pages. For example, the < and > delimiters are HTML-escaped and carriage returns are converted to <br> tags.
Returns the output of the accumulated error trace for the page being constructed.
The function returns an empty string if IsPageDebug has not been set.
Retrieves the output of the error trace and outputs the information to a page:
<$getErrorTrace()$>
This function is used when defining a content rule for a field. The value of a field for a content profile can be made dependent on a view by using this function. Because a field can have both a default and a derived value, the view can be used to create an interdependency between fields.
Takes three parameters:
Field. The name of a metadata field. This field must have an associated view.
Value. A lookup key for value.
Column name. A column in the view's table.
Returns the value in the column specified using the field value as a lookup.
In the following example, the view table for the field xEmployee has a column called type. Using the value as specified in the xEmployee metadata field, this function provides a lookup into this table and returns the type column value.
getFieldViewValue("xEmployee", #active.xEmployee, "type")
This function returns the amount of free memory in the Java Virtual Machine (JVM). This is a performance auditing function used on the System Audit Information page.
The amount of free JVM memory in megabytes.
<$freeMem = getFreeMemory()$>
This function returns a relative URL to a help page based on the name of the page.
The name of the page used.
<input type=Button value="<$lc("wwQuickHelp")$>"
onClick="QuickHelp('<$getHelpPage("QH_AdvancedSearch")$>', 'Search')">
This function returns the size of an option list. It is used to determine whether to display custom user metadata fields on the User Profile page.
The only parameter is the option list to be sized.
Returns the size of the specified option list.
This function is used on presentation pages to populate the Java script with the desired error message. The error message is set from the content rule user interface for a field that is designated as required. It returns a required message based on the following algorithm:
The function looks for the fieldname:requiredMsg.
If the value exists, it is localized.
If the value is undefined or the message is empty, the function returns the default message and does not localize it. To localize the message, the caller of the function must use the lc function on the default message before passing it to this function (getRequiredMsg).
This function takes two parameters:
Fieldname: Field associated with the error message.
Message: Default message to be used.
Gets the web version of a text file and returns its contents to a string.
This can be used only with files that have a format containing text, such as text/html, text/plain, or text/xml. Specifically, the dFormat field of the content item must start with text. For example, if a hcsp file is checked in, Formats: text/hcsp is displayed in the Content Info display; therefore the content is displayed by the getTextFile() function.
There must be enough information to determine the content item's web URL. The dID value is the only required metadata field.
The following information must be present:
dDocName, dWebExtension, dSecurityGroup, dRevLabel, and dDocType.
If Accounts are enabled, dDocAccount must also be specified.
This information is available automatically after a GET_SEARCH_RESULTS call or after a DOC_INFO call.
This function should be wrapped with a cacheInclude call for greater performance. That can, however, create a security issue if all docs go to the same cache.
This function does not take parameters but uses variables on the page to determine the document's URL.
<$loop SearchResults$>
<$fullDocument=getTextFile()$>
<h2><$dDocTitle$></h2>
<div><$fullDocument$></div>
<$endloop$>
This function returns the amount of total memory in the Java Virtual Machine (JVM). This is a performance auditing function used on the System Audit Information page to determine how much memory the server is using.
The total JVM memory in megabytes.
<$totalMem = getTotalMemory()$>
Retrieves the value of a user metadata field for the current user.
The parameter must refer to a column in the Users database table. Unlike the user personalization functions that have no support for global reference, information assigned to the user in the Users table can be available to the Oracle WebCenter Content Server instance.
The only parameter is a user-related variable.
Returns the value of the metadata field for the current user.
Evaluates to TRUE if the user value was retrieved.
Evaluates to FALSE if an error in retrieval occurred.
Returns a StatusCode of -1 if the value is unspecified or unknown.
Returns the User Type of the currently logged on user:
<$getUserValue('dUserType')$>
This function has multiple uses:
Retrieves the value of a particular metadata field from local, active, or environment data.
Retrieves the value of a particular column from a specific ResultSet.
Retrieves information about ResultSet rows.
Takes two parameters:
The first parameter is either the type of data or the name of a ResultSet.
The second parameter is the name of a metadata field, the column name, or a ResultSet row parameter.
You can also use a shorthand format that returns results identical to the getValue(arg1,arg2) function. The format uses the form <$arg1.arg2$>, where arg1 and arg2 are the literal string arguments "arg1" and "arg2" to the getValue function.
Note:
Data types (local, active, and env) and ResultSet parameters must start with the # symbol.The following parameter combinations can be used:
| getValue and Shorthand Formats | Description |
|---|---|
| getValue("#local",fieldName)
<$#local.fieldName$> |
Retrieves the value of the specified metadata field from the local data. |
| getValue("#active",fieldName)
<$#active.fieldName$> |
Attempts to retrieve the value of the specified metadata field from the data in the following order:
|
| getValue("#env",fieldName)
<$#env.fieldName$> |
Retrieves the value of the specified metadata field from the environment settings. |
| getValue(ResultSetName,fieldName)
<$ResultSetName.fieldName$> |
Retrieves the value of the specified metadata field from the current row of the specified ResultSet. |
| getValue(ResultSetName,columnName)
<$ResultSetName.columnName$> |
Retrieves the value of the specified column from the current row of the specified ResultSet. |
| getValue(columnName)
<$columnName$> |
Retrieves the value of the specified column from the current row of the current ResultSet. |
| getValue(ResultSetName,"#row")
<$ResultSetName.#row$> |
Retrieves the number of the current row in the specified ResultSet.
The first row is 0. |
| getValue(ResultSetName,"#numRows")
<$ResultSetName.#numRows$> |
Retrieves the total number of rows in the specified ResultSet. |
| getValue(ResultSetName,"#isRowPresent")
<$ResultSetName.#isRowPresent$> |
Checks if at least one row is present in the specified ResultSet.
This is useful when looping manually with rsNext. |
| getValue(ResultSetName,"#isEmpty")
<$ResultSetName.#isEmpty$> |
Checks if the specified ResultSet does not contain any rows. |
See Variations for output values.
Returns an empty string if a value is not found.
Gets the Content ID from the ResultSet named DOC_INFO:
<$name = getValue("DOC_INFO","dDocName")$>
or
<$name = <$DOC_INFO.dDocName$>
Checks to see if the passed parameter dDocType (which is in the local data) equals the value in the active ResultSet:
<$loop DocTypes$>
<$if strEquals(#active.dDocType, getValue("#local","dDocType"))$>
<!--do special HTML for selected document type-->
<$endif$>
<!-- additional statement-->
<$endloop$>
Retrieves the value of a user attribute for a specific user. This function can be useful for defining extended workflow functionality.
Takes two parameters:
The first parameter is the user name.
The second parameter is the name of a column in the Users database table that specifies a user attribute (such as dFullName, dUserType, or dEmail).
Returns the value of the user attribute for the specified user.
Returns an empty string if the value is not found.
Retrieves the full name for mjones.
<$getValueForSpecifiedUser('mjones', 'dFullName')$>
Checks whether the client computer has a copy of the requested content item in the download target directory.
Generally used to query the user whether to overwrite when downloading. For example, this variable is used by the Oracle ODMA Client.
Returns TRUE if a local copy is detected.
Returns FALSE if a local copy is not detected.
Checks for a local copy of the content item:
<$HasLocalCopy$>
Specifies that the metadata field has an option list.
Returns TRUE if the field has an option list.
Returns FALSE if the field does not have an option list.
Specifies that the field has an option list:
<$hasOptionList=1$>
Generates the option list values if the field has an option list:
<$if hasOptionList$>
<$if isQuery$></td><td><$endif$>
<$include std_option_list_entry$>
<$endif$>
Checks if the checkin is through the Oracle WebCenter Content Server ODMA client or Upload applet.
Returns TRUE if the ODMA client or Upload applet is being used for checkin.
Returns FALSE if the ODMA client and Upload applet are not being used for checkin.
Checks for check in method:
<$HeavyClient$>
Defines the path for the executable that is used to edit component files from within the Component Wizard.
This path is defined in the Component Wizard.
You should 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 may cause Idoc Script tags to be converted into a string of characters that will not be recognized by the Oracle WebCenter Content Server system.
There is no default value.
IntradocDir/config/config.cfg
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
HTMLEditorPath=C:/Program Files/Windows NT/Accessories/wordpad.exe
Similar to DefaultHtmlRefreshTimeoutInSeconds. Defines the time, in seconds, that a Work In Progress page, My Checked-Out Content page or My Workflow Assignments page refreshes.
htmlRefreshTimeout can be set in the URL or the service's databinder. This can be used to set a different refresh time for different pages. If that is needed, do not set DefaultHtmlRefreshTimeoutInSeconds in the config.cfg file, but instead set htmlRefreshTimeout in the URL or databinder.
In the page's URL:
&htmlRefreshTimeout=90
Used to set the URL of the page to load after a Work In Progress page, My Checked-Out Content page or My Workflow Assignments page is refreshed. The default is the current page. This variable can be set in the URL of the page or the databinder of the service.
In the page's URL:
&htmlRefreshUrl=http://www.home.com
Retrieves the Oracle WebCenter Content Server CGI path as a complete URL.
This variable cannot be modified directly; to change the path, use the HttpAbsoluteCgiRoot configuration setting.
Returns the path as a string.
Returned for an Oracle WebCenter Content Server domain:
HttpAbsoluteCgiPath=http://localhost/domain/idcplg/
Defines the Oracle WebCenter Content Server CGI path as a complete URL.
IntradocDir/config/config.cfg
For an Oracle WebCenter Content Server instance:
HttpAbsoluteCgiRoot=http://my_computer/idcplg/idc_cgi_isapi-instance.dll
Defines the web server root directory as a complete URL.
IntradocDir/config/config.cfg
For an Oracle WebCenter Content Server:
HttpAbsoluteWebRoot=http://my_computer/domain/
Retrieves the Admin Server CGI path as a relative URL.
Returns the Admin Server CGI path as a string.
Returned for an Oracle WebCenter Content Server instance:
HttpAdminCgiPath=/idcplg/idc_cgi_isapi-instance.dll/cs-admin/pxs
This variable is used to set explicit control over the CGI path construction made for applets and the Admin Server.
The Oracle WebCenter Content Server system evaluates the HTTP address in the address bar of the browser. If the HttpIgnoreWebServerInternalPortNumber configuration entry is not sufficient to assist the evaluation, HttpBrowserFullCgiPath can be set with an explicit answer.
Specify a relative path to the Oracle WebCenter Content Server instance (idc1 in the example below).
HttpBrowserFullCgiPath=http://localhost/idc1/idcplg
Retrieves the Oracle WebCenter Content Server CGI path.
The following configuration settings are used to determine the value of this variable:
| Variable | Description |
|---|---|
| UseSSL | When set to TRUE, the secure sockets layer (SSL) is used (https instead of http). |
| isAbsoluteCgi | Defines whether the complete URL is used instead of a relative path. This is an internal flag set by the Oracle WebCenter Content Server instance and is not intended for user configuration. |
Returns the path as a string.
Returned for an Oracle WebCenter Content Server:
HttpCgiPath=/domain/idcplg
Retrieves the URL of the common directory.
Multiple Oracle WebCenter Content Server instances can share resources from one Oracle WebCenter Content Server installation. This variable defines the URL path to the DomainHome/ucm/cs/common/ directory of the Oracle WebCenter Content Server instance whose resources are being shared. For example, the HttpCommonRoot defines the prefix to use for accessing the shared common directory where web applets are located.
Returns the relative URL as a string. If the URL is external, the complete URL is returned rather than the relative path.
Returned for an Oracle WebCenter Content Server:
HttpCommonRoot=/domain/common/
Retrieves the CGI path of an Oracle WebCenter Content Server instance as a relative URL.
Returns the Oracle WebCenter Content Server CGI path as a string.
Returned for an Oracle WebCenter Content Server:
HttpEnterpriseCgiPath=/idcplg/idc_cgi_isapi-instance.dll
Retrieves the URL of the help directory.
Multiple Oracle WebCenter Content Server instances can share online help files from one Oracle WebCenter Content Server installation. This variable defines the URL path to the DomainHome/ucm/cs/weblayout/help directory of the Oracle WebCenter Content Server instance whose help files are being shared.
Returns the relative URL as a string. If the URL is external, the complete URL is returned rather than the relative path.
Returned for an Oracle WebCenter Content Server:
HttpHelpRoot=/domain/help/
Retrieves the URL of the images directory.
Multiple Oracle WebCenter Content Server instances can share user interface images from one Oracle WebCenter Content Server installation. This variable defines the URL path to the DomainHome/ucm/cs/weblayout/images directory of the Oracle WebCenter Content Server instance whose image files are being shared.
Returns the relative URL as a string. If the URL is external, the complete URL is returned rather than the relative path.
Returned for an Oracle WebCenter Content Server:
HttpImagesRoot=/domain/images/
Retrieves the URL of the folder containing the current layout files. This is useful if you have additional JavaScript resources specific to the current layout.
Retrieves the relative URL of the Admin Server for an Oracle WebCenter Content Server instance.
Defaults to /cs-admin/ during installation.
Returns the relative URL as a string.
Returned for an Oracle WebCenter Content Server:
HttpRelativeAdminRoot=/cs-admin/
Defines the Oracle WebCenter Content Server CGI path as a relative URL.
IntradocDir/config/config.cfg
For an Oracle WebCenter Content Server:
HttpRelativeCgiRoot=/idcplg/idc_cgi_isapi-instance.dll
Defines the web server root directory as a relative URL.
A relative root such as /domain/ is used rather than a full root such as http://www.mycomputer.com/domain/.
Returns the relative web root directory as a string.
There is no default value.
System Properties, Internet tab, Http Relative Web Root
Oracle WebCenter Content Server: IntradocDir/config/config.cfg
As a configuration setting, defines the relative web root:
HttpRelativeWebRoot=/domain/
As script, returns the relative web root as a string:
<$HttpRelativeWebRoot$>
Defines the web server address as a partial URL.
A partial URL such as mycomputer is used rather than a full address such as http://www.mycomputer.com/.
Returns the web server address as a string.
There is no default value.
System Properties, Internet tab, HTTP Server Address
Oracle WebCenter Content Server: IntradocDir/config/config.cfg
As a configuration setting, defines the web server address:
HttpServerAddress=mycomputer
As script, returns the web server address as a string:
<$HttpServerAddress$>
Similar to the HttpHelpRoot variable except this variable returns the path to the help files for the default system language.
Returns the path to the help files.
HttpSystemHelpRoot=/domain/help/
Retrieves the URL path of the weblayout directory.
Multiple Oracle WebCenter Content Server instances can share resources from one Oracle WebCenter Content Server installation. This variable defines the URL path to the DomainHome/ucm/cs/weblayout/ directory of the Oracle WebCenter Content Server instance whose resource files are being shared.
The following configuration settings determine the value of this variable:
| Variable | Description |
|---|---|
| UseSSL | When set to TRUE, the secure sockets layer (SSL) is used (https instead of http). |
| isAbsoluteWeb | Defines whether the complete URL is used instead of a relative path. This is an internal flag set by the Oracle WebCenter Content Server instance and is not intended for user configuration. |
Returns the relative URL as a string. If the URL is external, the complete URL is returned rather than the relative path.
Returned for an Oracle WebCenter Content Server:
HttpWebRoot=/domain/
Specifies the location where the Oracle WebCenter Content Server Analyzer utility writes output files and transfers extra files detected during the file system analysis process.
You can specify a partial or complete directory path.
If a partial directory path (such as analyzer_logs/) is specified, this subdirectory is created in the DomainHome/ucm/cs/bin/ directory.
If a complete directory path (such as c:/analyzer_logs/) is specified, this is the log directory.
The log file name is specified by the LogName setting.
The default is DomainHome/ucm/cs/bin/logs/.
DomainHome/ucm/cs/bin/intradoc.cfg
As a configuration setting:
IdcAnalyzeLogDir=f:/domain/analyzer_logs/
Defines the location of the server media for Oracle WebCenter Content (WebCenter Content), which can run media for any of the following: Oracle WebCenter Content Server, Oracle WebCenter Content: Inbound Refinery, and Oracle WebCenter Content: Records.
The location can not be modified by an administration after WebCenter Content is deployed; it is a fixed location based on the current location of the media
DomainHome/ucm/idc
Used as a configuration setting:
IdcHomeDir=<MW_HOME>/user_projects/domains/<base_domain>/ucm/idc
Sets the value that is placed in the HTTP cookie of the client to keep track of the current user's locale.
IntradocDir/config/config.cfg
Used as a configuration entry:
IdcLocale=Deutsch
Used in clustered environments to bind the Oracle WebCenter Content Server instance to a specific IP address.
Set in the config.cfg file of the Oracle WebCenter Content Server instance listening for requests:
IntradocDir/config/config.cfg
Used as a configuration variable:
IdcServerBindAddress=IPaddress
Specifies the depth of the TCP/IP socket queue.
This setting can be used to tune Oracle WebCenter Content Server performance, particularly in a clustered environment. Decreasing this value might limit Oracle WebCenter Content Server throughput.
Default is 200.
IntradocDir/config/config.cfg
Used as a configuration entry:
IdcServerSocketQueueDepth=256
Specifies the checkout time. The configuration is defined for all user threads and applicable to all user services.
Large file checkins often time out due to the amount of I/O that occurs. Database locks are held while the large file is written and this blocks subsequent checkins. This configuration setting can be used to lengthen the checkout time.
IntradocDir/config/config.cfg
The setting is expressed in seconds. To make the timeout 5 minutes, set:
IdcServerThreadQueryTimeout=300
This function tests to find out if a dynamichtml resource exists.
This function has one parameter: includeName is the name of the dynamichtml resource.
If the resource exists, then it returns True.
<$if idocTestForInclude("std_page_begin")$> <$include std_page_begin$><$endif$>
Adds the code from an include resource to the page.
This function does the same thing as the include keyword, except that it can take an Idoc Script variable as the parameter. See Keywords Versus Functions for more information.
The only parameter is a variable that defines the name of an include.
Displays the code that is defined in the specified include resource.
Say you wanted to execute some Idoc Script for some, but not all, of your custom metadata fields. You could dynamically create includes based on the field names (such as specific_include_xComments) by executing this Idoc Script:
<$loop DocMetaDefinition$>
<$myInclude = "specific_include_" & dName$>
<$exec inc(myInclude)$>
<$endloop$>
Note the use of the exec keyword, which suppresses the output of the include specified by the inc function. If you don't use exec before the inc function, the HTML inside the specified include will be displayed on the page.
Note that if the specific_include_xComments does not exist, this code will not throw an error because the output is not being displayed.
Includes the entire contents of a text file in the display of the current page.
This function is used to generate the default portal page.
A global include file is a text file that contains HTML code, Idoc Script code, or both. It is loaded on server startup.
Global include files must have a .inc extension, and must be located in the DomainHome/ucm/cs/data/pages/ directory.
The only parameter is the name of a global include file without the .inc file extension.
Displays the code that is defined in the specified global include file.
When you change the portal page using the Update Portal function in the Web Layout Editor, a global include file called portal_message.inc is created to contain your modified text. This file is then referenced in the pne_home_page.htm template file as follows:
<$incGlobal("portal_message")$>
Adds the code from an include resource (defined by <@dynamichtml include_name@>) to the page.
This keyword is the most commonly used command in Idoc Script, as it allows you to reuse small chunks of code on multiple template pages.
See Includes for more information.
The only parameter is the name of the include.
Displays the code that is defined in the specified include resource.
The following includes are used to create the beginning and end of most Oracle WebCenter Content Server web pages. These includes are defined in the following file:
IdcHomeDir/resources/core/standard_page.htm
<$include std_html_head_declarations$>
<$include body_def$>
<$include std_page_begin$>
Hello World!
<$include std_page_end$>
Adds the contents of an Oracle WebCenter Content Server template to a page, after evaluating any Idoc Script.
You can use this function to include the content of an entire template. However, this usage is discouraged because resource includes are usually sufficiently flexible to support all requirements for the sharing of Idoc Script between pages.
The only parameter is the name of an Oracle WebCenter Content Server template file without the .htm file extension.
Displays the code that is defined in the specified template.
Retrieves the new_look template file.
<$incTemplate("new_look")$>
The directory containing the configuration and data specific to an Oracle WebCenter Content Server instance.
There is no default value. The value depends on which configuration is specified: cs (for Oracle WebCenter Content Server), ibr (for Oracle WebCenter Content: Inbound Refinery), or urm (for Oracle WebCenter Content: Records).
It is recommended that you move the directory onto a network share if you are managing a load balancing cluster.
Oracle WebCenter Content ServerDomainHome/ucm/cs/bin/intradoc.cfg
Oracle WebCenter Content: Inbound Refinery: DomainHome/ucm/ibr/bin/intradoc.cfg
Oracle WebCenter Content: Records: DomainHome/ucm/urm/bin/intradoc.cfg
Used as a configuration entry:
IntradocDir=c:/ucm/cs1
Checks if a section is being traced in the core.
Returns active trace results.
<$isActiveTrace()$>
Enables the automatic import or transfer of content items.
When set to TRUE, the Oracle WebCenter Content Server system will automatically import and transfer archives.
When set to FALSE, the Oracle WebCenter Content Server system will not automatically import or transfer archives.
The NoAutomation setting overrides this setting.
Default is TRUE.
IntradocDir/config/config.cfg
Used as a configuration entry:
IsAutoArchiver=false
Specifies if the current page is a checkin page.
When set to TRUE, the current page is identified as a checkin page.
When set to FALSE, the current page is not identified as a checkin page.
Returns TRUE if the page is a checkin page.
Returns FALSE if the page is not a checkin page.
Set at the top of a page:
isCheckin=1
Used as script:
<$if isCheckin or isUpdate or isQuery$>
<$isFormSubmit = 1$>
<$if not isQuery$>
<$isEditMode = 1$>
<$formName = "Checkin"$>
<$endif$>
<$else$>
<$isFormSubmit = ""$>
<$isEditMode = ""$>
<$endif$>
Checks if the page currently being displayed is the same as the page being looped over while building the Next/Previous navigation on search results pages.
Returns TRUE if the navigation loop is at the same page as the current page.
Returns FALSE if the navigation loop is not at the same page as the current page.
If the navigation loop is at the current page, the page number is displayed as plain text. If the navigation loop is not at the current page, the page number is displayed as a hypertext link:
<$loop NavigationPages$>
<$if IsCurrentNav$>
<$HeaderPageNumber$>
<$else$>
<a href="<$strRemoveWs(inc("searchapi_navigation_specific_page"))$>">
<$HeaderPageNumber$></a>
<$endif$>
<$endloop$>
Specifies if the current page is a page that displays metadata (such as search, checkin, and content information pages).
When set to TRUE, the current page is identified as a document page.
When set to FALSE, the current page is not identified as a document page.
Returns TRUE if the page is a document page.
Returns FALSE if the page is not a document page.
Set at the top of a page:
isDocPage=1
Used as script:
<$if isDocPage$>
<!--statement-->
<$endif$>
Used with Content Profiles. When set to TRUE, enables the Oracle WebCenter Content Server system to issue a fatal error when a global rule violation is encountered.
IntradocDir/config/config.cfg
IsDpSubmitErrorFatal=true
Checks if the page is presented dynamically to the user.
Most pages viewed by the user are dynamic. However, some static pages are designed to be delivered to the user without changes. Examples are the guest portal page and the content of some auto generated e-mails.
Returns TRUE if the page is being presented dynamically to the user.
Returns FALSE if the page is static or cannot be displayed.
Evaluates whether the page is presented dynamically:
<$if IsDynamic$>
<a href="<$redirect$>">
<$endif$>
Specifies if metadata fields on the current page can be edited.
This variable is set on checkin and content information update pages.
When set to TRUE, metadata fields on the current page can be edited.
When set to FALSE, metadata fields on the current page cannot be edited.
Returns TRUE if metadata fields on the current page can be edited.
Returns FALSE if metadata fields on the current page cannot be edited.
Set at the top of a page:
isEditMode=1
Used as script:
<$if isCheckin or isUpdate or isQuery$>
<$isFormSubmit = 1$>
<$if not isQuery$>
<$isEditMode = 1$>
<$formName = "Checkin"$>
<$endif$>
<$else$>
<$isFormSubmit = ""$>
<$isEditMode = ""$>
<$endif$>
Completely excludes the metadata field from the page.
Returns TRUE if the metadata field is excluded from the page.
Returns FALSE if the metadata field is not excluded from the page.
Excludes the current metadata field from the page:
<$isExcluded=1$>
Sets a custom variable depending on the active value of isExcluded for the current metadata field:
<$isCustomExcluded = getValue("#active", fieldName & ":isExcluded")$>
$isCustomRelocated = getValue("#active", fieldName & ":isRelocated")$>
<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
<$isFieldExcluded = 1$>
<$endif$>
Checks if the user is accessing the Oracle WebCenter Content Server instance from an external system, such as a LDAP system.
Returns TRUE if the user is accessing the Oracle WebCenter Content Server instance from an external system.
Returns FALSE if the user is accessing the Oracle WebCenter Content Server instance directly.
Checks if user is at an external location:
<$IsExternalUser$>
Checks if a string or expression evaluates to FALSE.
The only parameter is the string or expression to be evaluated.
If the parameter is a string:
Returns TRUE if the string begins with F, f, N, n, or is 0.
Returns FALSE if the string begins with any other character.
If the parameter is not a string:
Returns TRUE if the value is 0.
Returns FALSE if the value is not 0.
Evaluates the string false and returns TRUE (1):
<$isFalse("false")$>
Evaluates that the integer five is greater than one and returns FALSE (0):
<$isFalse(5>1)$>
Evaluates the result of the equation as zero and returns TRUE (1):
<$isFalse(1-1)$>
Evaluates the string equality statement as true and returns FALSE (0):
<$isFalse(strEquals("abc","abc"))$>
Specifies that the metadata field is excluded.
Returns TRUE if the field is excluded.
Returns FALSE if the field is not excluded.
Determines if the metadata field is excluded:
<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
<$isFieldExcluded = 1$>
<$endif$>
Specifies that the metadata field is hidden.
Returns TRUE if the field is hidden.
Returns FALSE if the field is not hidden.
Determines if the metadata field is hidden:
<$if isHidden or isCustomHidden$>
<$isFieldHidden = 1$>
<$else$>
<$isFieldHidden = ""$>
<$endif$>
Specifies that the metadata field is an information only field.
Returns TRUE if the field is an information only field.
Returns FALSE if the field is not an information only field.
Determines if the metadata field is information only:
<$if isInfo or isCustomInfo or isFieldHidden or isInfoOnly$>
<$isFieldInfoOnly = 1$>
<$else$>
<$isFieldInfoOnly = ""$>
<$endif$>
Specifies that the metadata field is a memo field.
Returns TRUE if the field is a memo field.
Returns FALSE if the field is not a memo field.
Determines if the field is a memo field:
<@dynamichtml compute_std_entry_type_info@>
<$if not hasOptionList and #active.fieldType like "Memo"$>
<$isFieldMemo = 1$>
<$else$>
<$isFieldMemo = ""$>
<$endif$>
<@end@>
Specifies if the current page is a submittable HTML form.
When set to TRUE, the current page is a submittable HTML form.
When set to FALSE, the current page is not a submittable HTML form.
Returns TRUE if the page is a submittable HTML form.
Returns FALSE if the page is not a submittable HTML form.
Set at the top of a page:
isFormSubmit=1
Adds a colon after the field captions if the page is not a submittable HTML form:
<@dynamichtml std_field_caption@>
<span class=<$fieldCaptionStyle$>>
<$fieldCaption$><$if not isFormSubmit$><$":"$><$endif$>
</span>
<@end@>
Hides the metadata field from the user but includes the field as hidden data on the page.
Returns TRUE if the metadata field is hidden on the page.
Returns FALSE if the metadata field is not hidden the page.
Hides the current metadata field from the user:
<$isHidden=1$>
Sets a custom variable depending on the active value of isHidden for the current metadata field:
<$isCustomHidden = getValue("#active", fieldName & ":isHidden")$>
<$if isHidden or isCustomHidden$>
<$isFieldHidden = 1$>
<$else$>
<$isFieldHidden = ""$>
<$endif$>
Specifies if the current page is an information-only page.
When set to TRUE, the current page is identified as an information-only page.
When set to FALSE, the current page is not identified as an information-only page.
Returns TRUE if the page is an information-only page.
Returns FALSE if the page is not an information-only page.
Set at the top of a page:
isInfo=1
Used as script:
<$if isInfo$>
<$captionFieldWidth="30%"$>
<$captionEntryWidth="70%"$>
<$elseif isEditMode$>
<$captionFieldWidth="20%"$>
<$captionEntryWidth="80%"$>
<$endif$>
Displays the metadata field as information only, not as an input field.
Returns TRUE if the metadata field is displayed as information only.
Returns FALSE if the metadata field can be edited.
Displays the current metadata field as information only:
<$isInfoOnly=1$>
Sets a custom variable depending on the active value of isInfoOnly for the current metadata field:
<<$isCustomInfo = getValue("#active", fieldName & ":isInfoOnly")$>
<$if isInfo or isCustomInfo or isFieldHidden or isInfoOnly$>
<$isFieldInfoOnly = 1$>
<$else$>
<$isFieldInfoOnly = ""$>
<$endif$>
Displays the local data of an Oracle WebCenter Content Server web page.
This variable can be set as a flag on a page or as a parameter to a service call.
When set to TRUE, returns the local data in the DataBinder.
When included in the code on an Oracle WebCenter Content Server web page, displays the local data of a page:
<$IsJava=1$>
When included in an Oracle WebCenter Content Server URL, displays the local data for the New Checkin page:
http://myinstance.com/idcplg/idc_cgi_isapi-instance.dll?IdcService=CHECKIN_NEW_FORM&IsJava=1
Enables Java Server Page functionality.
Java Server Page support enables developers to access and modify Oracle WebCenter Content Server content, ResultSets, personalization and security definitions, and predefined variables and configuration settings through Java Server Pages rather than through standard Oracle WebCenter Content Server component architecture. Oracle WebCenter Content Server services and Idoc Script functions can also be executed from Java Server Pages, which reside as executable content in the Oracle WebCenter Content Server system.
Default is FALSE.
System Properties, Server tab, Execute Java Server Page (Jsp)
Admin Server, General Configuration, Enable Java Server Page (Jsp)
IntradocDir/config/config.cfg
Used as a configuration entry:
IsJspServerEnabled=true
Checks if the client browser is running on a Macintosh operating system.
Returns TRUE if the client browser is running on a Mac.
Returns FALSE if the client browser is not running on a Mac.
Redirects to a different URL if the browser is running on a Mac:
<$if IsMac$>
<a href="<$redirect$>">
<$endif$>
Checks if there are more results on a Work In Progress or Report page than the MaxQueryRows setting allows.
Returns TRUE if the number of results is greater than the number of rows permitted.
Returns FALSE if the number of results is less than the number of rows permitted.
Returns an error message if the maximum number of rows is exceeded:
<$elseif IsMaxRows$>
<table border=0 cellpadding=1 cellspacing=1 width="100%">
<tr>
<span class=smallHighlight><$lc("wwOutputLimitedByMaxRows")$>
</span>
</tr>
</table>
Specifies that a metadata field option list allows multiple values to be selected.
Returns TRUE if the field is a multiselect option list.
Returns FALSE if the field is not a multiselect option list.
Specifies that the field is a multiselect option list:
<$isMultiOption=1$>
Determines the type of option list:
<$if #active.fieldOptionListType like "*multi*"$>
<$exec isMultiOption=1$>
<$elseif #active.fieldOptionListType like "access*"$>
<$exec isAccessList=1$>
<$exec isStrictList=1$>
<$elseif not (#active.fieldOptionListType like "*combo*")$>
<!--Strict choice-->
<$exec isStrictList=1$>
<$endif$>
Checks if multiple pages are needed for search results. This variable depends on the number of rows displayed per page, which is defined by the ResultCount input variable (default is 25).
Returns TRUE if the number of search results is greater than the number of rows permitted per page.
Returns FALSE if the number of search results is less than the number of rows permitted per page.
Evaluates number of rows and determines if multiple pages are needed:
<$IsMultiPage$>
Checks if the content item is new or a revision. This variable is set to TRUE by the CHECKIN_NEW_FORM and CHECKIN_SIMILAR_FORM standard services.
Returns TRUE if the content item is new.
Returns FALSE if the content item is a revision to an existing content item.
If the content item is new, a specified service is performed:
<$if isNew$>
<input type=hidden name=IdcService value="CHECKIN_NEW">
<$endif$>
If the content item is a revision, the original content item author is used:
<$if not isNew$>value="<$dDocAuthor$>"<$endif$>
If the content item is new, the default accounts for the current user are used:
<$if isNew$>
<$defaultAccounts$>
<$endif$>
Enables users to select a different conversion format upon checkin.
When set to TRUE, a Format option list is displayed for the Primary File and Alternate File on the checkin page.
Default is FALSE.
System Properties, Options tab, Allow override format on check in
Admin Server, General Configuration, Allow override format on check in
IntradocDir/config/config.cfg
As a configuration setting:
IsOverrideFormat=true
As script, returns the value of the override format function:
<$IsOverrideFormat$>
Enables a trace of all includes and calls to the Idoc Script eval function.
The contents of the eval function and any dynamically assigned includes are also shown as part of the trace. The trace is indented by one + character per nested level of include or eval call. The trace also shows any error messages (without the nested location information) and the output of any calls to the Idoc Script function trace.
Note:
This setting is not supported in Internet Explorer version 6.Results of the trace can be viewed through the debug menu toolbar options which are accessed from the debug trace displayed at the bottom of the web page.
Click the debug trace to display the debug menu toolbar, then click any of the following options:
| Element | Description |
|---|---|
| hide all | Hides any open debug popups. |
| idocscript trace | Displays a tree structure view of all includes being called. |
| request binder | Displays information on Local Data and Result Sets. Click a heading to expand the view of detailed information. |
| response binder | Displays information on Local Data and Result Sets. Click a heading to expand the view of detailed information. |
| final page binder | Displays information on Local Data and Result Sets. Click a heading to expand the view of detailed information. |
| javascript log | Displays "Logger Console" popup with default setting of Verbose. Select checkboxes to display the following options: info, warn, error, time, window, trace, global, schema, javascript, LogReader. Click Pause or Clear to control the speed and amount of information displayed on the Logger Console. |
Used as a configuration setting in the Oracle WebCenter Content Server config.cfg file, so it applies to the entire server:
IsPageDebug=1
In a web browser, added to the end of the page's URL in the Address field:
&IsPageDebug=1
Used on a templage page or in an include:
<$IsPageDebug=1$>
Tells the Oracle WebCenter Content Server instance that the vault and weblayout directories are on different file systems.
When set to TRUE, tells the server that the directories are on different file systems.
Default is FALSE.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
isPhysicallySplitDir=true
Specifies if the current page is a search page.
When set to TRUE, the current page is identified as a search page.
When set to FALSE, the current page is not identified as a search page.
Returns TRUE if the page is a search page.
Returns FALSE if the page is not a search page.
Set at the top of a page:
isQuery=1
Used as script:
<$if isCheckin or isUpdate or isQuery$>
<$isFormSubmit = 1$>
<$if not isQuery$>
<$isEditMode = 1$>
<$formName = "Checkin"$>
<$endif$>
<$else$>
<$isFormSubmit = ""$>
<$isEditMode = ""$>
<$endif$>
Excludes the metadata field unless the local variable is set to TRUE while the include is evaluated.
This variable is typically used to set a custom location for a metadata field. It allows a field to be defined on a page more than once, with the location of the field that is actually generated depending on the value of this variable.
Returns TRUE if the metadata field is included at that location on the page.
Returns FALSE if the metadata field is excluded from that location on the page.
Includes the current metadata field on the page:
<$isRelocated=1$>
Sets a custom variable depending on the active value of isRelocated for the current metadata field:
<$isCustomExcluded = getValue("#active", fieldName & ":isExcluded")$>
<$isCustomRelocated = getValue("#active", fieldName & ":isRelocated")$>
<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
<$isFieldExcluded = 1$>
<$endif$>
Checks if there is a request error condition present on the Oracle WebCenter Content Server instance by evaluating the StatusCode variable.
If StatusCode is set to a negative numeric value (-1), there is a request error condition present on the Oracle WebCenter Content Server instance.
The typical behavior when a request error condition is present is to abort the display of the current page and substitute an error page. See abortToErrorPage.
Returns TRUE if there is a request error condition present on the Oracle WebCenter Content Server instance (StatusCode = -1).
Returns FALSE if there is no request error condition present on the Oracle WebCenter Content Server instance (StatusCode is other than a negative numeric value).
Evaluates the request error condition:
<$IsRequestError$>
Specifies if a value is required for a metadata field.
When set to TRUE, the metadata field is required.
When set to FALSE, the metadata field is optional.
Returns TRUE if the metadata field is required.
Returns FALSE if the metadata field is optional.
Defines the dDocTitle metadata field as a required field:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>
Checks if a query has been saved to the current user's portal navigation bar.
Returns TRUE if the current query has been saved.
Returns FALSE if the current query has not been saved or no query is found.
Evaluates query status:
<$IsSavedQuery$>
Displays the local SOAP data of an Oracle WebCenter Content Server web page.
This variable can be set as a flag on a page or as a parameter to a service call.
When set to TRUE, returns the underlying SOAP code.
When included in the code on an Oracle WebCenter Content Server web page:
<$IsSoap=1$>
When included in an Oracle WebCenter Content Server URL:
http://myinstance.com/idcplg/idc_cgi_isapi-instance.dll?IdcService=CHECKIN_NEW_FORM&IsSoap=1
Specifies that a metadata field option list does not allow multiple values to be selected.
Returns TRUE if the field is not a multiselect option list.
Returns FALSE if the field is a multiselect option list.
Specifies that the field is not a multiselect option list:
<$isStrictList=1$>
Determines the type of option list:
<$if #active.fieldOptionListType like "*multi*"$>
<$exec isMultiOption=1$>
<$elseif #active.fieldOptionListType like "access*"$>
<$exec isAccessList=1$>
<$exec isStrictList=1$>
<$elseif not (#active.fieldOptionListType like "*combo*")$>
<!--Strict choice-->
<$exec isStrictList=1$>
<$endif$>
Checks if the client browser is running on a Sun system.
Returns TRUE if the client browser is running on Sun.
Returns FALSE if the client browser is not running on Sun.
Redirects to a different URL if the browser is running on Sun:
<$if IsSun$>
<a href="<$redirect$>">
<$endif$>
Checks if a string or expression evaluates to TRUE.
The only parameter is the string or expression to be evaluated.
If the parameter is a string:
Returns TRUE if the string begins with T, t, Y, y, or is 1.
Returns FALSE if the string begins with any other character.
If the parameter is not a string:
Returns TRUE if the value is not 0.
Returns FALSE if the value is 0.
Evaluates the string yes and returns TRUE (1):
<$isTrue("yes")$>
Evaluates that the integer five is greater than one and returns TRUE (1):
<$isTrue(5>1)$>
Evaluates the result of the equation as zero and returns FALSE (0):
<$isTrue(1-1)$>
Evaluates the string equality statement as true and returns TRUE (1):
<$isTrue(strEquals("abc","abc"))$>
Specifies if the current page is a content information update page.
When set to TRUE, the current page is identified as a content information update page.
When set to FALSE, the current page is not identified as a content information update page.
Returns TRUE if the page is a content information update page.
Returns FALSE if the page is not a content information update page.
Set at the top of a page:
isUpdate=1
Used as script:
<$if isCheckin or isUpdate or isQuery$>
<$isFormSubmit = 1$>
<$if not isQuery$>
<$isEditMode = 1$>
<$formName = "Checkin"$>
<$endif$>
<$else$>
<$isFormSubmit = ""$>
<$isEditMode = ""$>
<$endif$>
Specifies that an include is being used inside JavaScript. It is used to determine how metadata fields are uploaded.
When set to TRUE, the include is being used inside JavaScript.
When set to FALSE, the include is being used inside JavaScript.
Returns TRUE if the include is being used inside JavaScript.
Returns FALSE if the include is not being used inside JavaScript.
Set in the include that defines the JavaScript wrapper:
<@dynamichtml std_upload_java_script@>
<script language="JavaScript">
// Java script for uploading.
<$isUploadFieldScript = 1$>
<$include std_upload_info_script$>
<$isUploadFieldScript = ""$>
</script>
<@end@>
Used as script:
<$if isUploadFieldScript$>
<$defaultFieldInclude = "std_file_entry"$>
<$else$>
<$defaultFieldInclude = "std_nameentry_row"$>
<$fieldCaptionInclude = "std_field_caption"$>
<$fieldEntryInclude = "std_file_entry"$>
<$endif$>
Checks if an e-mail address is defined for the current user.
Returns TRUE if an e-mail address is defined for the user.
Returns FALSE if an e-mail address is not defined for the user.
Checks whether the user is logged in and has an e-mail address before performing a function.
<@dynamichtml subscription_action_script@>
function allowSubscription(form)
{
<$if IsLoggedIn$>
<$if IsUserEmailPresent$>
<$else$>
…
}
<@end@>
Checks if a section is being traced in the core. Verbose trace generates a full report.
Returns TRUE if tracing is set to Verbose.
Returns FALSE if tracing is set to any other debug level.
<$isVerboseTrace()$>
Checks if the client browser is running on a Windows operating system.
Returns TRUE if the client browser is running on Windows.
Returns FALSE if the client browser is not running on Windows.
Redirects to a different URL if the browser is running on Windows:
<$if IsWindows$>
<a href="<$redirect$>">
<$endif$>
Displays a raw dump of the HTML form when set to TRUE in a URL to a HCSP or HCSF file. This is useful for extracting form data or submitting forms from a remote application.
Returns the XML data contained in the form.
Formats a string for use in a "..." JavaScript literal string declaration.
This function performs string manipulation such as changing double quotes to single quotes.
The only parameter is the string.
Returns a string formatted for use in a JavaScript string declaration.
Formats the string variablestring for use in a JavaScript string declaration:
<$js("variablestring")$>
Defines which files are to be made available as web application files.
This setting is generally used to define the query to find the web application archiver (.war file) when deploying the Oracle JavaBean.
IntradocDir/config/config.cfg
Used as a configuration entry:
JspAdminQuery=dExtension <matches> war
Defines the default page for a web application.
This is a comma-delimited list of file names that defines a search sequence. If the first file is not present, the second file will be the default page, and so on.
Default is index.html,index.htm,index.jsp.
IntradocDir/config/config.cfg
Used as a configuration entry:
JspDefaultIndexPage=index.html,index.htm,index.jsp
Defines the security groups to be enabled for Java Server Page functionality.
Because Java Server Pages usually have full privileges to any resource on the hosting system, it can be important to restrict Java Server Pages to security groups which allow only contributors with certain permissions.
System Properties, Server tab, Jsp Enabled Groups
Admin Server, General Configuration, Jsp Enabled Groups
IntradocDir/config/config.cfg
Used as a configuration entry:
JspEnabledGroups=jsp,group1
Defines the location of the executable for the Java Virtual Machine command line.
There is no default value.
Oracle WebCenter Content Server: DomainHome/ucm/cs/bin/intradoc.cfg
Oracle WebCenter Content: Inbound Refinery: DomainHome/ucm/ibr/bin/intradoc.cfg
Used as a configuration entry:
JvmCommandLine="c:/jdk1.3.1/bin/java.exe" -classpath $CLASSPATH $STARTUPCLASS
Retrieves the value of a localization string based on the current user's locale.
Takes one required parameter and any number of optional parameters:
The first parameter is the localization key (such as apLabelHelp or wwMyString).
The optional parameters are expressions that are resolved according to arguments inside curly braces in the localized string (for example, {1}).
Returns the value of the localization string for the current user's locale.
Returns the string ID (such as wwMyString) if the value is not found.
Retrieves the options for metadata search operators on a search page:
<select name="op" >
<option value="Contains"><$lc("wwContains")$>
<option value="Matches"><$lc("wwMatches")$>
<option value="Starts"><$lc("wwStarts")$>
<option value="Ends"><$lc("wwEnds")$>
<option selected value="Substring"><$lc("wwSubstring")$>
</select>
Sets the subject line for a workflow started notification e-mail. If the name of the workflow (dWfName) is Marketing, the resulting value in English is Workflow 'Marketing' has been started.
<@dynamichtml wf_started_subject@>
<$lc("wwWfStarted", dWfName)$>
<@end@>
Function that wraps a string into a caption. This will usually place a colon to the right of the string. For right-to-left reading languages, such as Hebrew and Arabic, the colon is placed on the left of the string.
Takes one required parameter:
The string to be wrapped.
optional parameters are expressions that are resolved according to arguments inside curly braces in the localized string (for example, {1}).
Loads the DocMetaDefinition database table into the active data as a ResultSet.
After the DocMetaDefinition database table is loaded, it can be looped on.
None.
None.
Loads the DocMetaDefinition table into the active data as a ResultSet.
<$loadDocMetaDefinition()$>
Loads a content profile as specified by the trigger value for page presentation. This is called during the presentation of Search, Check In, Info, and Update pages. This function is called on request and the page on which it is called determines the action (for example, search, or info).
This information is dependent on context. The isCheckin, isUpdate, isQuery, or isInfo variables are set in local data and direct the loadDocumentProfile function to the page to be loaded and presented.
None.
None.
<$loadDocumentProfile()$>
Loads mappings between the full set of operator names and the search syntax. Used on the Search page.
None
Returns expressions associated with operator names (search operator map).
<$loadSearchOperatorTables()$>
This function loads the custom user metadata definition. This exists in the UserMetaDefinition table which is placed on the page as a ResultSet. This is used on LDAP administration pages to help administers map user metadata to the Oracle WebCenter Content Server instance.
None.
Specifies the naming format for Archiver batch file subdirectories. Often used when exporting and importing with different versions of the Oracle WebCenter Content Server system.
Default is yy-MMM-dd_HH.mm.ss_SSS. For example, 03-feb-04_15.04.14_174.
IntradocDir/config/config.cfg
Used as a configuration entry:
LocaleArchiverDateFormat=dd-mm-yy
This function returns the page type for a page in the library folders. This may be a directory or a query page. This function is usually used by the Layout Manager API. When Trays is the selected layout it is used to construct a tree view of the library's pages.
Takes one parameter, the link data used to construct the tree view.
Adds a prefix to log entries to designate which Oracle WebCenter Content Server instance is creating the entry.
Typically used in a master/proxy environment.
There is no default value.
DomainJHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
LogMessagePrefix=Master
Specifies the file name of the log file created by the Oracle WebCenter Content Server Analyzer utility.
This log file will be created in the directory specified by the IdcAnalyzeLogDir setting.
Default is IdcAnalyze.log.
IntradocDir/config/config.cfg
As a configuration setting:
LogName=contentserver1_analyze.log
Enables the Upload and Download Applets for Macintosh clients.
Used only when Macintosh clients are used.
When set to TRUE, Macintosh clients can use the Upload and Download Applets for checking multiple files in and out.
When set to FALSE, Macintosh clients cannot use the Upload and Download Applets.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
MacSupportsSignedApplets=true
Sets the number of errors after which the Archiver stops importing or exporting. Default is 50.
IntradocDir/config/config.cfg
Used as a configuration entry:
MaxArchiveErrorsAllowed=10
Sets the number of errors after which the Batch Loader stops processing records from the batch load file.
If you plan to run the Batch Loader with a large number of content items overnight, then increase the default value. If you monitor the Batch Loader with a small amount of content items, then decrease the default value.
Default is 50.
Returns value as integer.
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
MaxErrorsAllowed=50
Sets the maximum number of characters allowed in a metadata field.
Returns the maximum length of the field.
Sets the maximum length of the field to 100 characters:
<$maxLength=100$>
Specifies a custom field length based on the length of the current field:
<$customFieldLength = getValue("#active", fieldName & ":maxLength")$>
Checks whether the client browser is Microsoft Internet Explorer.
Returns TRUE if the client browser is Internet Explorer.
Returns FALSE if the client browser is not Internet Explorer.
Redirects to a different URL if the browser is anything other than Internet Explorer:
<$if not MSIE$>
<a href="<$redirect$>">
<$endif$>
Enables the multiple file Upload Applet.
When set to TRUE, the Upload Applet is enabled so that multiple files can be zipped and checked in as a single content item.
When set to FALSE, the Upload Applet is disabled.
Default is FALSE.
System Properties, Options tab, Enable upload applet
Admin Server, General Configuration, Enable upload applet
IntradocDir/config/config.cfg
As a configuration setting, enables the Upload Applet:
MultiUpload=true
As script, evaluates the condition of the Upload Applet:
<$MultiUpload$>
Defines whether to display the Info column on search results pages.
When set to TRUE, a column containing links to Content Information pages is displayed on the standard search results page.
When set to FALSE, Info links are not displayed on the standard search results page.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
noInfoColumn=1
Specifies that the MultiCheckin component should not prefill metadata fields.
This variable can be used on special pages such as custom HCST and contribution folders component pages.
When set to TRUE, the MultiCheckin component will not prefill metadata fields.
When set to FALSE, the MultiCheckin component will prefill metadata fields.
Returns TRUE if the MultiCheckin component will not prefill metadata fields.
Returns FALSE if the MultiCheckin component will prefill metadata fields.
Set near the top of the page:
noMCPrefill=1
Used as script:
<$noMCPrefill$>
Defines whether to display the Revisions column on search results pages.
When set to TRUE, a column containing links to Revision History pages is displayed on the standard search results page.
When set to FALSE, Revision History links are not displayed on the standard search results page.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
noRevisionsColumn=1
Formats how a required metadata field is displayed.
When set, the required field appears with the indicated string in front of the metadata field.
The string is included in a cascading style sheet.
If StyleForRequiredFields is defined, NotationforRequiredFields will be formatted in the style defined by StyleForRequiredFields.
The only parameter is the string.
IntradocDir/config/config.cfg
To set an asterisk in front of a required field:
NotationForRequiredFields=*
Used in Oracle WebCenter Content Server version 6.x to provide backward compatibility for importation of Oracle WebCenter Content Server 7.x archives.
Oracle WebCenter Content Server 7.x includes a millisecond data format that was not present in earlier versions. When the 6.x Archiver attempts to import the 7.x archives, the millisecond field causes an error.
Perform the following steps to add this entry to the 6.x config.cfg file:
Copy the 6.x config.cfg file to another name (to save it as a backup).
Edit the config.cfg file in a text editor, adding the following setting:
OdbcDateFormat='{ts' "yyyy-MM-dd HH:mm:ss{.SSS}"'}'
Restart the server.
Specifies the name of a ResultSet column that contains option list values.
Returns the values of the option list ResultSet column.
Specifies dFormat as the column in the DocFormats ResultSet to get option list values from for the standard Format field on a checkin page:
<@dynamichtml std_override_format_field@>
<$if not isInfo and IsOverrideFormat$>
<$fieldIsOptionList = 1, optionListResultSet = "DocFormats",
optionListKey = "dFormat",
optionListValueInclude = "std_override_format_option_value",
addEmptyOption = 1, emptyOptionLabel = lc("wwEmptyFormatOption")$>
<$include std_display_field$>
<$endif$>
<@end@>7
Specifies the name of an option list.
For standard metadata fields, this is the name of the internal option list (see Internal Option Lists).
For custom metadata fields, this is the name of the field with a suffix of .options.
Returns the option list name.
Sets the option list name to docAuthors if the field is not restricted to a single user:
<$if SingleUser$>
<$isInfoOnly = 1$>
<$else$>
<$fieldIsOptionList = 1, optionListName = "docAuthors"$>
<$if HasExternalUsers$><$fieldOptionListType= "combo"$>
<$endif$>
<$endif$>
Defines the default option list script:
<$if optionsAllowPreselect and fieldValue$>
<$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
<$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>
Specifies the name of a ResultSet that contains option list values.
Returns the option list ResultSet.
Specifies DocFormats as the option list ResultSet for the standard Format field on a search page:
<@dynamichtml std_format_fields@>
<$if ClientControlled or dFormat or dExtension$>
<$fieldName = "dFormat", fieldCaption = lc("wwNativeFormat"),
optionListResultSet = "DocFormats"$> <$include std_display_field$>
<$fieldName = "dExtension", fieldCaption = lc("wwNativeExtension"),
fieldWidth = 10$>
<$include std_display_field$>
<$endif$>
<@end@>
Creates an option list by looping over a ResultSet:
<@dynamichtml compute_resultset_option_list_script@>
<$if not optionListKey$>
<$optionListKey = fieldName$>
<$endif$>
<$defaultOptionListScript = "<$loop " & optionListResultSet & "$>" &
"<$inc('std_resultset_option_list_item')$>" & "<$endloop$>"$>
<@end@>
When this variable is set to a non-empty value, the eval function is used when displaying the option list for the field. This variable allows the standard implementation of option lists (defined by the defaultOptionListScript variable) to be overridden.
Returns TRUE if the value is nonempty.
Returns FALSE if the value is an empty string.
Defines a custom script for creation of an option list:
<$customOptionListScript = getValue("#active", fieldName & ":optionListScript")$>
Specifies an include that defines the values for an option list.
Returns the include code.
Defines std_override_format_option_value as the option list value include:
<@dynamichtml std_override_format_field@>
<$if not isInfo and IsOverrideFormat$>
<$fieldIsOptionList = 1, optionListResultSet = "DocFormats",
optionListKey = "dFormat",
optionListValueInclude = "std_override_format_option_value",
addEmptyOption = 1, emptyOptionLabel = lc("wwEmptyFormatOption")$>
<$include std_display_field$>
<$endif$>
<@end@>
<@dynamichtml std_override_format_option_value@>
<$dDescription$>
<@end@>
Specifies the include to use to display options in an option list from a ResultSet:
<@dynamichtml std_resultset_option_list_item@>
<$curValue = getValue("#active", optionListKey)$>
<option value="<$curValue$>" <$if optionsAllowPreselect and strEquals(curValue, fieldValue)$>selected<$endif$>>
<$if optionListValueInclude$>
<$inc(optionListValueInclude)$>
<$else$>
<$curValue$>
<$endif$>
<@end@>
Specifies that the metadata field option list can be prefilled with its last value.
Returns TRUE if the option list can be prefilled.
Returns FALSE if the option list cannot be prefilled.
Specifies that the option list can be prefilled:
<$optionsAllowPreselect=1$>
Determines if the option list will be prefilled:
<$if optionsAllowPreselect and fieldValue$> <$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$> <$else$> <$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$> <$endif$>
Generates an option list.
This function is used extensively to create option lists on Oracle WebCenter Content Server pages.
This function only produces output when used with a service that calls loadMetaOptionsList
Takes one parameter and one optional argument to the parameter:
The only parameter is a field name, option list key, or a variable.
Field name syntax is <$optList fieldName$>. For custom metadata fields, the field name will resolve to <$optList xFieldName.options$>, or you can specify the .options suffix directly.
Option list key syntax is <$optList ListName$>.
For standard metadata fields, the ListName is the name of the internal option list (such as docAuthors). See Internal Option Lists.
For custom metadata fields, the ListName is the name of the option list key, such as FieldNameList.
Variable syntax is <$optList variable$>. The variable must resolve to a field name or an option list key.
One of the following optional arguments can be added to the parameter:
:noselected-No values are selected when the option list is displayed.
:fieldValue-The value specified by the fieldValue variable is selected as the default value in the option list.
Returns a list of values.
This script generates a list of possible authors from the internal docAuthors list:
<$optList docAuthors$>
This script generates a list of the options specified in the xRegion custom metadata field:
<$optList xRegion.options$>
This script generates an option list from the variable optionListName and specifies the default value:
<$if optionsAllowPreselect and fieldValue$>
<$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
<$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>
Checks whether a directory page in the Library has a parent page.
Returns TRUE if the directory page is a child (subfolder) of another directory page.
Returns FALSE if the directory page is not a child (subfolder).
Checks if the directory page is a subfolder:
<$PageParent$>
Parses a date but uses the failover logic for using the alternate parsing formats.
Dates convert to milliseconds when used with standard comparison operators. For example, the expression (60*60*1000) equals one hour.
A common usage of this function is to adjust the current time using a multiplication expression that represents a number of seconds, minutes, hours, or days.
The only parameter is an expression to be parsed.
Returns a Java date object, which is converted to a string for display.
<$parseDataEntryDate$>
Parses a date/time to allow evaluation and arithmetic.
Dates convert to milliseconds when used with standard comparison operators. For example, the expression (60*60*1000) equals one hour.
A common usage of this function is to adjust the current time using a multiplication expression that represents a number of seconds, minutes, hours, or days.
The only parameter is an expression to be parsed.
Returns a Java date object, which is converted to a string for display.
Each of the following expressions returns the date and time one day in the past:
<$parseDate(dateCurrent(-1))$> <$parseDate(dateCurrent()-(24*60*60*1000))$> <$dateCurrent(-1)$> <$dateCurrent()-(24*60*60*1000)$>
Returns the time one hour in the future. The first line adds one hour using a time multiplication expression, assigns that time and date to a custom variable, and suppresses the output. The second line references the custom variable and defines that only the time is displayed:
<$exec my_customParseTime parseDate(dateCurrent()+(1000*60*60))$> <$formatTimeOnly(my_customParseTime)$>
Returns the date one year in the future. The first line adds one year using a time multiplication expression, assigns that time and date to a custom variable, and suppresses the output. The second line references the custom variable and defines that only the date in long format is displayed:
<$exec my_customParseTime parseDate(dateCurrent()+(1000*60*60*24*365))$> <$formatTimeOnly(my_customParseTime)$>
This script evaluates whether the date seven days in the future is greater than the expiration date and returns a message to the user if true:
<$if dOutDate$>
<$if dateCurrent(7) > parseDate(dOutDate)$>
Content item expires in one week.
<$endif$>
<$endif$>
This script uses parseDate within a conditional statement for customized workflow jumps. The script specifies that if the last time we entered this step was four days ago, go to the first step in workflow wf_late and set the return step to be the next step:
<$if parseDate(wfCurrentGet("lastEntryTs")) < dateCurrent(-4)$>
<$wfSet("wfJumpName", "lateJump")$>
<$wfSet("wfJumpTargetStep", "step_1@wf_late")$>
<$wfSet("wfJumpReturnStep", wfCurrentStep(1))$>
<$wfSet("wfJumpEntryNotifyOff", "0")$>
<$endif$>
Parses a date/time to a specified date/time pattern.
Dates convert to milliseconds when used with standard comparison operators. For example, the expression (60*60*1000) equals one hour.
A common usage of this function is to adjust the current time using a multiplication expression that represents a number of seconds, minutes, hours, or days.
Takes two parameters:
The first parameter is a date string used by the Oracle WebCenter Content Server instance, or a date object created with the parseDate or dateCurrent functions.
The second parameter is the date/time pattern, which is a standard Java SimpleDateFormat pattern string, such as MM/dd/yyyy.
Returns a Java date object, which is converted to a string for display.
Displays the current date and time in the format specified by the pattern (for example, Wed, 4 Jul 2001 12:08:56 -0700):
<$parseDateWithPattern(<$dateCurrent()$>,"EEE, d MMM yyyy HH:mm:ss Z")$>
Enables the left sidebar navigation.
Set as a name/value pair:
pneNavigation=1
Default value is 1 (enabled).
To disable this function, it must be set to a null string.
Evaluates to TRUE or FALSE.
Enables the sidebar navigation:
<$pneNavigation=1$>
To force the sidebar navigation off, set it to a null string:
<$pneNavigation=""$>
Setting the definition to other than 1 or a null string value is invalid and will not disable the sidebar navigation:
<$pneNavigation=0$>
Defines the path to the /providers directory.
Default is DomainHome/ucm/cs/data/providers.
IntradocDir/config/config.cfg
As a configuration setting:
ProviderDir=c:/domain/data/providers
Used with verbose tracing when the Request Audit trace is activated.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of service requests and length of time to perform the requests. After a summary is reported for the specified interval the values are reset and the cumulative totals and averages are computed again for the next interval period.
This configuration variable is a comma-delimited list of additional fields to display when reporting information about the request.
IntradocDir/config/config.cfg
RequestAuditAdditionalVerboseFieldsList=xComment,dDocType
Used to specify the short audit interval for the Request Audit trace.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of service requests and length of time to perform the requests. After a summary is reported for the specified interval the values are reset and the cumulative totals and averages are computed again for the next interval period.
Specify the value in seconds.
The default value is 120 seconds (2 minutes).
IntradocDir/config/config.cfg
RequestAuditIntervalSeconds1=240
Used to specify the long audit interval for the Request Audit trace.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of service requests and length of time to perform the requests. After a summary is reported for the specified interval period the values are reset and the cumulative totals and averages are computed again for the next interval period.
Specify the value in seconds.
The default value is 3600 seconds (1 hour).
IntradocDir/config/config.cfg
RequestAuditIntervalSeconds2=7200
Used to specify the number of services to present in the Request Audit trace.
This configuration value applies only to the short audit period.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of service requests and length of time to perform the requests.
This variable is used to specify the number of services to present from a sorted list of requests. The list is sorted in descending order by elapsed time consumed.
The default value is 5.
IntradocDir/config/config.cfg
RequestAuditListDepth1=7
Used to specify the number of services to present in the Request Audit trace.
This configuration value applies only to the long audit period.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of requests and length of time to perform the requests.
This variable is used to specify the number of services to present. The list is sorted in descending order by elapsed time consumed.
The default value is 20.
IntradocDir/config/config.cfg
RequestAuditListDepth2=25
Used to specify an internal field, usually a metadata field for documents, whose value is appended to the service name in order to differentiate the name in the Request Audit list.
The Request Audit trace appears on the System Audit Information Page. This trace creates two separate summaries calculated over two different time intervals. The trace calculates the number of service requests and length of time to perform the requests.
In some cases, the service name does not create an adequate breakdown of the different types of requests. This entry helps to differentiate the types of entries.
IntradocDir/config/config.cfg
RequestAuditSubClassificationField=xDepartment
Specifies the error message to be displayed if a required metadata field does not have a value upon checkin.
Returns the error message as a string.
Defines the required field error message for the dDocTitle metadata field as the wwSpecifyTitle localized string:
<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>
Getting Started with the SDK
This function is meant for internal use only.
This function returns a localized string representation of an internal key code. These key codes are used to store status and state flags for content items. This function is used on the Content Information page and workflow pages to display descriptions of the internal state.
Takes two parameters:
The name of the table where the keys are stored.
The key to be localized.
This function returns a result set given the name of the result set. Because the actual object it returns is a result set, certain actions can be performed on the return value that cannot be performed on the return values of other functions. In particular, the loop syntax can be applied to the result.
This function has one parameter, resultSetName, which is the name of the result set to return.
A result set object if found, otherwise null.
Suppose MyResultSet is the name of a result set, then you could loop on the result set using the following syntax:
<$loop rs("MyResultSet")$>... Script inside loop ...<$endloop$>
This function also can be used when temporarily assigning variables when calling Idoc Script functions. In particular, the following example will temporarily assign the variable 'rsParam' to point to the same result set as pointed to by MyResultSet for the duration of the call to include the resource include my_include. If the result of the rs function is assigned to a variable, then that variable will have a shared pointer to the result set creating the same effect as if rsCreateReference were called.
<$inc("my_include", rsParam=rs("MyResultSet"))$>
Adds new fields to a ResultSet. This function will only add the field if it is not already present. Note that setValue(...) can also add new fields but it only works on ResultSets that are nonempty and are on a currently valid row.
Takes two parameters:
The first parameter is the name of the ResultSet to get new fields (columns) added.
The second parameter is a comma separated list of fields to add.(the column names to be added).
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsAddFields(rsName, fieldsList)$>
This function adds new fields to an existing result set. Unlike rsAddFields, this function provides the ability to specify default values for any fields that are added. Note that rsAddFieldsWithDefaults never over-writes any data in fields that already exist; it only adds new fields to a result set.
The following table lists parameters for the function.
| Parameters | Description |
|---|---|
resultSetName |
The name of the result set. |
newFields |
A comma-separated list of fields to append to the result set. Any specified fields that already exist in the result set are ignored. |
defaultValues |
An optional comma-separated list of default values that are set for the new fields in each row. Each value in this list corresponds to the new field in the same spot of the list newFields. If you need to set a default value with a comma in it, you can use '^' as a comma. If the defaultValues list is longer or shorter than newFields list, then the function ignores the extra default values or uses the empty string for unspecified default values, respectively. |
Nothing.
<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6")$>
In this basic example, we create a result set MyList, fill it with some values, then add three more fields to MyList, without setting default values. The resulting table will look like the following:
| field1 | field2 | field3 | field4 | field5 | field6 |
|---|---|---|---|---|---|
| A | B | C | |||
| D | E | F |
<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6", "X,Y,Z")$>
Here we define default values for the new fields. The resulting table will look like the following:
| field1 | field2 | field3 | field4 | field5 | field6 |
|---|---|---|---|---|---|
| A | B | C | X | Y | Z |
| D | E | F | X | Y | Z |
<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field1,field4,field5", "X,Y,Z")$>
In this case, we try and add a field that already exists in MyList. This action is completely ignored, and old field values are preserved. The resulting table will look like the following:
| field1 | field2 | field3 | field4 | field5 |
|---|---|---|---|---|
| A | B | C | X | Y |
| D | E | F | X | Y |
Fewer default values specified
<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6", "X,Y")$>
Notice in this example how there are not enough default values in the default value list for all fields. In this case, it just fills in blanks for the unspecified column.
| field1 | field2 | field3 | field4 | field5 | field6 |
|---|---|---|---|---|---|
| A | B | C | X | Y | |
| D | E | F | X | Y |
This function adds a new field whose value for each row is the row count for that row. The count starts at 0. This function is useful to use just before using rsSort(...) on XML data island ResultSets (inside .hcsp files) so that the original row location can be preserved.
Takes two parameters:
The first parameter is the name of ResultSet to be modified so that it has an new row count column.
The second parameter is the name of the field that will hold the row count.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsAddRowCountColumn(rsName, countFieldName)$>
This function is similar in nature to rsMerge, except there are no merge test criteria. All rows from the ResultSet rsNameSource are appended to the ResultSet rsNameTarget. In addition, all fields in rsNameSource not in rsNameTarget will be added to rsNameTarget. Useful for doing a simple combining of ResultSets.
Takes two parameters:
The first parameter is the ResultSet that will be modified by the merge
The second parameter is the ResultSet containing the rows that will be appended to the target.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsAppend("targetRsetName", "sourceRsetName")$>
Appends a new row to the end of the ResultSet. The current row is not affected.
The only parameter is the name of the ResultSet to receive the new row.
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
<$rsAppendNewRow("SearchResults")$>
A utility function for adding new rows to a ResultSet. The values list is a comma-delimited list of values (using the escape rule of ',' -> '^', '^' -> '#^', '#' -> '##' to encode each value) split up into rows. Assume nfields is the number of fields in the ResultSet. The values list is split up into rows by counting nfields values to create a new row and then taking the next nfields values to create each following row and so on. If the number of values is not an exact multiple of nfields then the last row has its fields values padded out with empty strings. This function is useful for compactly hard coding ResultSets using Idoc Script.
Takes two parameters:
The first parameters the name of the ResultSet that is to get new rows.
The second parameter is the new values to add.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rowValues = "a1, b1, a2, b2"$>
<$rsCreateResultSet("ResultSet1", "ColumnA,ColumnB")$>
<$rsAppendRowValues("ResultSet1", rowValues$>
<table border=2>
<tr><td>ColumnA</td><td>ColumnB</td></tr>
<$loop ResultSet1$>
<tr><td><$ColumnA$></td><td><$ColumnB$></td>
</tr>
<$endloop$>
</table>
The resulting HTML would look like the following.
| Column A | Column B |
|---|---|
| Column A | Column B |
| A1 | B1 |
| A2 | B2 |
This function copies only selected rows from one ResultSet to create another ResultSet. Any prior ResultSet with name rsNameTarget will be replaced. The rows are selected by testing each row's value of filterField using a test against the pattern in filterPattern. The pattern match is the same as used in the Idoc Script like operator.
Takes four parameters:
The first parameter is the ResultSet that is providing the rows to copy.
The second parameter is the new ResultSet created by the copy.
The third parameter is the name of the field being tested.
The fourth parameter is the pattern match to apply to see if the row should be copied.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsCopyFiltered(rsNameSource, rsNameTarget, filterField, filterPattern)$>
This function sets an Idoc Script variable with a shared reference to a pre-existing result set in the request data.
This function has the following parameters:
| Parameters | Description |
|---|---|
sourceResultSet |
The name of a pre-existing result set. |
targetResultSet |
The name of the variable that will share a reference to precisely the same result set. |
If successful, returns True.
The current value of <$MyResultSet.field2$> and <$MyResultSetAlias.field2$> will both be the letter E.
<$rsCreateResultSet("MyResultSet", "field1,field2,field3")$>
<$rsAppendRowValues("MyResultSet", "A,B,C,D,E,F")$>
<$rsCreateReference("MyResultSet", "MyResultSetAlias")$>
<$rsNext("MyResultSetAlias")$>
Creates a ResultSet initialized with the list of fields in fieldList. All the fields will be set as string type.
Takes two parameters:
The first parameter is the name of the ResultSet to create.
The second parameter is a comma separated list of fields.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsCreateResultSet(rsName, fieldList)$>
Deletes the current row in the ResultSet. The current row is advanced to the next row (or points to after the end of the ResultSet if the end row in the ResultSet is deleted).
The only parameter is the name of the ResultSet whose current row is deleted.
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
<$rsDeleteRow("Folders")$>
Checks if the current user is allowed to view the URL of the content item referenced by the current row of a ResultSet.
This function is useful for selectively showing the URLs of a ResultSet generated by a content item query.
The only parameter is the name of a ResultSet whose current row contains information about a content item.
Returns TRUE if the user is allowed to view the URL of the content item.
Returns FALSE if the user is not allowed view the URL or the ResultSet is empty.
Checks if the user can view the URL of the content item in the current row of resultSet1.
<$rsDocInfoRowAllowDisclosure("resultSet1")$>
Checks to see if a result set exists.
Takes one parameter, the name of the result set.
Returns TRUE if the result set is found.
Returns FALSE if the result set does not exist or if it is empty.
<$if rsExists("resultSet1")$>
code to execute if TRUE
<$endif$>
Retrieves the name of the field at a specified column index, starting from zero.
Takes two parameters:
The name of the ResultSet.
The index number.
<$rsFieldName = rsFieldByIndex("resultSet1", "2")$>
Checks to see if the named result set contains the specific field.
Takes two parameters:
The name of the result set to be searched.
The name of the field to be found.
Returns TRUE if the field is found.
Returns FALSE if the field does not exist.
<$if rsFieldExists("resultSet1", "FieldName1")$>
code to execute if TRUE
<$endif$>
Searches the first column of a ResultSet for a matching value.
Takes two parameters:
The first parameter is the name of a ResultSet whose first column is to be searched.
The second parameter is the value to be searched for.
Returns TRUE if the specified value is found in the first column of the specified ResultSet.
Returns FALSE if the specified value is not found.
Searches the first column of resultSet1 until a value matching value1 is found.
<$rsFindRowPrimary("resultSet1","value1")$>
Moves to the first row in a ResultSet.
The only parameter is the name of a ResultSet.
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
Advances the SearchResults ResultSet to the first row:
<$exec rsFirst("SearchResults")$>
Inserts a row just before the current row of the ResultSet being manipulated. The new row then becomes the current row.
The only parameter is the name of the ResultSet in which to have a new row inserted.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsInsertNewRow("SearchResults")$>
Checks the status of the current row in a result set.
Takes one parameter, the name of the result set.
Returns TRUE if the result set is currently on a valid row.
Returns FALSE if not on a valid row.
<$if rsIsRowPresent("resultSet1")$>
code to execute if TRUE
<$endif$>
This function loops on a result set, executing a resource include once for each row. During the execution of this include, the result set is temporarily made active (as is done with the standard <$loop ...$> construction).
This function has the following parameters:
| Parameters | Description |
|---|---|
ResultSetName |
The name of the result set to loop over. |
includeName |
The name of the resource include to execute. |
The combined output of the various iterations of the resource include.
<$rsLoopInclude(resultSetName, includeName)$>
This function temporarily promotes a result set to be active while executing a single resource include. It functions much like rsLoopInclude, however the include is only executed once for the current row of the result set.
This function has the following parameters:
| Parameters | Description |
|---|---|
ResultSetName |
The name of the result set to make active. |
includeName |
The name of the resource include to execute. |
The output of the resource include.
<$rsLoopSingleRowInclude(resultSetName, includeName)$>
Creates a single-column ResultSet from an option list.
Takes two required parameters and one optional parameter:
The first parameter is the name of the ResultSet to be created.
The second parameter is the name of an existing option list (for example, docAccounts or xMyCustomField.options).
The third optional parameter is the name of the ResultSet column. If no value is specified, the column name defaults to row.
Creates a ResultSet with one column, populated by the values in the specified option list.
Creates two ResultSets called ListA and ListB from the securityGroups and docAuthors option lists:
<$lista = "securityGroups"$>
<$rsMakeFromList("ListA", lista)$>
<$rsMakeFromList("ListB", "docAuthors", "name")$>
<table border=2>
<tr><td>Security Groups</td><td>Authors</td></tr>
<tr>
<td><$loop ListA$><$row$><br>
<$endloop$></td>
<td><$loop ListB$><$name$><br>
<$endloop$></td>
</tr>
</table>
The ResultSets would look like the following.
@ResultSet ListA 1 row Public Secure @end @ResultSet ListB 1 name hchang pkelly sysadmin user1 @end
The resulting HTML would look like the following.
| ListA | ListB |
|---|---|
| Security Groups | Authors |
| hchang | |
| Public | okelly |
| Secure | sysadmin |
| user1 |
Creates a single-column ResultSet from a string.
Takes two required parameters and one optional parameter:
The first parameter is the name of the ResultSet to be created.
The second parameter is a comma-delimited list of strings to be parsed (such as a,b,c,d), or a variable that has a comma-delimited string as its value.
The third optional parameter is the name of the ResultSet column. If no value is specified, the column name defaults to row.
Creates a ResultSet with one column, populated by the specified string values.
Creates two ResultSets called StringA and StringB:
<$stringa = "a,b,c,d"$>
<$rsMakeFromString("StringA", stringa)$>
<$rsMakeFromString("StringB", "A,B,C,D", "name")$>
<table border=2>
<tr><td>StringA</td><td>StringB</td></tr>
<tr>
<td><$loop StringA$><$row$><br>
<$endloop$></td>
<td><$loop StringB$><$name$><br>
<$endloop$></td>
</tr>
</table>
The ResultSets would look like the following.
@ResultSet StringA 1 row a b c d @end @ResultSet StringB 1 name A B C D @end
The resulting HTML would look like the following.
| Stringa | Stringb |
|---|---|
| A | A |
| B | B |
| C | C |
| D | D |
Merges the rows of one ResultSet into another. If the value from the rsNameSource ResultSet in the rsCommonField field matches the value for the same field in a row for rsNameTarget, then that row will be replaced. Otherwise, the row from rsNameSource will be appended. If there are multiple rows in rsNameTarget that are matched by the same value, then only the first row is replaced and it is replaced by the last row in rsNameSource that has a matching row. Any fields in the ResultSet rsNameSource that are not in rsNameTarget are added as new fields to rsNameTarget. This function is best performed on ResultSets that have only unique values in the rsCommonField field so that issues with multiple matches are avoided.
Takes three parameters:
The first parameter (rsNameTarget) is the ResultSet that will be modified by the merge.
The second parameter (rsNameSource) is the ResultSet containing the rows that will be merged into the target.
The third parameter (rsCommonField) is the field that occurs in both results sets that will be used as the basis of the merge.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsMerge(rsNameTarget, rsNameSource, commonField$>
Analogous to rsMergeReplaceOnly, except matching rows in the ResultSet rsNameTarget are removed instead of replaced. It is useful for removing rows from one ResultSet that already occur in another.
Takes three parameters:
The first parameter (rsNameTarget) is the ResultSet that will be modified by the merge.
The second parameter (rsNameSource) is the ResultSet containing the rows that will be merged into the target.
The third parameter (rsCommonField) is the field that occurs in both results sets that will be used as the test for which rows to remove from rsNameTarget.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsMergeDelete(rsNameTarget, rsNameSource, rsCommonField)$>
Similar to rsMerge, but rows are only replaced; none are appended to the ResultSet rsNameTarget. In addition, new fields from rsNameSource are not added to rsNameTarget.
Takes three parameters:
The first parameter (rsNameTarget) is the ResultSet that will be modified by the merge.
The second parameter (rsNameSource) is the ResultSet containing the rows that will be merged into the target.
The third parameter (rsCommonField) is the field that occurs in both results sets that will be used as the basis of the merge
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$rsMergeReplaceOnly(rsNameTarget, rsNameSource, rsCommonField) $>
Moves to the next row in a ResultSet.
The only parameter is the name of a ResultSet.
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
Advances the SearchResults ResultSet to the next row:
<$exec rsNext("SearchResults")$>
Provides a count of the number of fields in a result set. This is useful when combined with rsFieldByIndex.
Takes one parameter, the name of the result set.
Returns the number of fields.
<$numFields = rsNumFields("resultSet1")$>
Provides a count of the number of rows in a result set.
Takes one parameter, the name of the result set.
Returns the number of rows.
<$numRows = rsNumRows("resultSet1")$>
Removes a result set.
Takes one parameter, the name of the result set.
<$rsRemove("resultSet1")$>
Renames a ResultSet.
If you use a variable to define the new ResultSet name, you will need to loop over the new ResultSet variable manually using rsFirst, rsNext, and #isRowPresent. For example:
<$rsNewName="MySearchResults"$>
<$rsRename("SearchResults", rsNewName)$>
<$rsFirst(rsNewName)$>
<$loopwhile getValue(rsNewName, "#isRowPresent")$>
<!--output code-->
<$rsNext(rsNewName)$>
<$endloop$>
Takes two parameters:
The first parameter is the name of an existing ResultSet.
The second parameter is the new ResultSet name. The call will fail if the resultset already exists.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
Renames the SearchResults ResultSet to MySearchResults:
<$rsRename("SearchResults", "MySearchResults")$>
Renames a field in the ResultSet.
Takes three parameters:
The first parameter is the name of the ResultSet whose field is being renamed.
The second parameter is the current name of the field.
The third parameter is the new name of the field.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
Renames the 'invoice' field to 'outlays' in the warehouse ResultSet.
<$exec rsRenameField("warehouse", "invoice", "outlays")$>
Moves to a specified row in a ResultSet.
Takes two parameters:
The first parameter is the name of the ResultSet.
The second parameter is the number of the row.
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
Advances the SearchResults ResultSet to the 10th row:
<$exec rsSetRow("SearchResults",10)$>
Sorts a ResultSet by a particular column.
Takes four parameters. For example:
rsSort(rsName,sortCol,sortType,sortOrder)
| Parameter | Description |
|---|---|
| rsName | The name of the ResultSet. |
| sortCol | The name of the column to sort by. |
| sortType | The type of sort (defaults to int):
string: sort alphabetically int: sort numerically date: sort by date |
| sortOrder | The sort order (defaults to asc):
asc: ascending order desc: descending order |
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
Sorts the SearchResults ResultSet by Content ID in descending order:
<$rsSort("SearchResults","dDocName","string","desc")$>
Sorts a ResultSet that is a representation of an XML data structure (with nodes, parent nodes, and depth attributes).
Takes seven parameters. For example:
rsSortTree(rsName,itemIdCol,parentIdCol,nestLevelCol,sortCol,sortType,sortOrder)
| Parameter | Description |
|---|---|
| rsName | The name of the ResultSet. |
| itemIdCol | The name of the column that contains the unique ID for each node. |
| parentIdCol | The name of the column that contains the ID for the parent node, if one exists. |
| nestLevelCol | The name of the column that contains the nest level (depth) for each node. |
| sortCol | The name of the column to sort by. |
| sortType | The type of sort (defaults to int):
string: sort alphabetically int: sort numerically date: sort by date |
| sortOrder | The sort order (defaults to asc):
asc: ascending order desc: descending order |
Returns TRUE if the function is successful.
Returns FALSE if the function fails or the ResultSet is empty.
Sorts the discussionPosts ResultSet by the itemNumber column in ascending order:
<$rsSortTree("discussionPosts", "discussionPosts!itemNumber",
"discussionPosts!parentNumber", "dpItemNestLevel",
"discussionPosts!itemNumber", "int", "asc")$>
Retrieves the location where extra Oracle WebCenter Content Server files are moved by the Oracle WebCenter Content Server Analyzer utility.
Default is a subdirectory in the log directory specified by the IdcAnalyzeLogDir setting.
This variable is not settable.
As script, returns the value of the configuration setting:
<$SafeDir$>
Sets the content type for the returned page so the browser renders it properly. For example, a content type (file-format type or MIME type) of text/plain, application/excel, or text/xml.
The only parameter is the content type.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$setContentType("text/plain")$>
This function can be used to set an absolute time for an expiration of a page. This is best used for pages with a long life that may be requested frequently. Due to problems in time synchronization between the client and the server, it is not totally reliable, especially for short-lived caches. The data must follow one of the acceptable HTTP date formats.
Refer to the W3 Protocols for more information:
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
The only parameter is an absolute date, formatted in the manner HTTP requires, after which this page should be refreshed
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
This will cause the page to expire at the given absolute time. Note that all time stamps must be in the GMT time zone.
<$setExpires("Sat, 02 Aug 2003 24:00:00 GMT")$>
This is a way to use other IdocScript functions to set the expiration date to 14 days from the current date.
<$date=formatDateWithPattern(dateCurrent(14), "EEE, dd MMM yyyy")$> <$setExpires(date & " 24:00:00 GMT"))$> >
This function can be used to set any HTTP header. Values include, but are not limited to, 'Cache-Control', 'Content-Type', 'Last-Modified', or any of the other acceptable HTTP headers.
Refer to the W3 Protocols for more information:
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
Takes two parameters. For example:
setHttpHeader(headerName, headerValue)
| Parameter | Description |
|---|---|
| headerName | The name of a valid HTTP header. |
| headerValue | The value for the header. |
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
This sets the content-type to XML, to enable your browser to render it with the passed XSLT.
<$setHttpHeader("Content-Type", "text/xml")$>
This function can be used to set an absolute time for an expiration of a page. This is best used for pages with a long life that may be requested frequently. Due to problems in time synchronization between the client and the server, it is not totally reliable, especially for short-lived caches. The data must follow one of the acceptable HTTP date formats.
Refer to the W3 Protocols for more information:
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
The only parameter is the lifetime of this page in seconds.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
This will expire the content of the page immediately:
<$setMaxAge(0)$>
This will set the cache lifetime for this page to 10 minutes, and tell the browser that it absolutely must try to refresh the page after that time is up:
<$setMaxAge(600)$>
<$setHttpHeader("Cache-Control", "must-revalidate")$>
Defines an include.
This function allows dynamically constructed script to be assigned to an include (much as the eval function enables such script to be parsed and evaluated).
If the specified include already exists, the super keyword can be used in the new script to refer to the existing include.
Takes two parameters:
The first parameter is the name of the include.
The second parameter is a string that defines the contents of the include. This string can contain Idoc Script.
Returns 0 if the include could not be parsed, 1 if it can be parsed.
Use exec to suppress this behavior.
Uses the string "My name is resource include" to dynamically construct script:
<$setResourceInclude("my_name","My name is <$my_name$>")$>
Uses the super keyword to modify the std_display_field include:
<$myInclude="<span class='field'><$include super.std_display_field$></span>"
<$setResourceInclude("std_display_field",myInclude)$>
The following example suppresses the returned result:
<$exec setResourceInclude("std_display_field",myInclude)$>
The target can either be #local or the name of a ResultSet. If the target is #local, then the parameter name identifies the name of a local data variable whose value is to be set by the parameter value. If the target area is nonempty and is not #local, then a field in a ResultSet named by the parameter target is being set. If the ResultSet exists and is currently on a valid current row, then that particular column's value (column named by the parameter name) on that row will be set with the value in the parameter value. If the field is currently not a part of that ResultSet, then the field will be added as a new column to the ResultSet and the value will be set. If the target ResultSet is not on a valid row, then this function will have no effect (but an internal exception will be reported on the server output). Note that this function should be contrasted with getValue.
Takes three parameters:
The first parameter is the target area to be set (either #local or the name of a ResultSet)
The second parameter is the name of key that holds the value to be set (either a local variable or a ResultSet field)
The third parameter is the value to be set.
Returns TRUE if the function is successful.
Returns FALSE if the function fails.
<$setValue(target, name, value)$>
Defines whether to display checkout links on the search results page.
This variable is also used to evaluate additional code for ODMA applications, such as Oracle Desktop. To display checkout links for an Oracle WebCenter Content Server instance that is not accessed by ODMA clients, use the showSearchResultsCheckoutColumn variable.
When set to TRUE, a column containing checkout links is displayed on the search results page.
When set to FALSE, checkout links are not displayed on the search results page.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
showDocActions=1
In later versions of the Oracle WebCenter Content Server system, the revision number of a document is not displayed on the Search Results page while using Classic view. This configuration variable is used to display the revision number.
When set to TRUE, the revision number of a document is displayed on the Search Results page while using Classic View.
This setting works in Classic search mode only.
Default is TRUE.
IntradocDir/config/config.cfg
Used as a configuration entry:
ShowRevisionsColumn=false
Defines whether to display checkout links on the standard search results page.
When set to TRUE, a column containing checkout links is displayed on the standard search results page.
When set to FALSE, checkout links are not displayed on the standard search results page.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
showSearchResultsCheckoutColumn=1
Sets the page width in pixels.
Default is 550.
IntradocDir/config/config.cfg
Used as a configuration entry:
StdPageWidth=1000
Returns the page width as a string:
<$StdPageWidth$>
Pads equal space on both sides of a string. An equal number of spaces is added to each side of the string to make it at least the specified length. A character will be added to the length of the string if required.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is the string.
The second parameter is the string length.
Returns a string with spaces on both sides.
Pads equal space on each side and creates a string seven characters long, using the form <space><space>inf<space><space>:
<$strCenterPad("inf", 7)$>
Pads equal space on each side and creates a string nine characters long, using the form <space><space><space>inf<space><space><space>:
<$strCenterPad("inf", 8)$>
Pads equal space on each side and creates a string nine characters long, using the form <space><space><space>inf<space><space><space>:
<$strCenterPad("inf", 9)$>
This function appends a new token to an existing string. It returns the string plus a comma plus the new token. If the token already exists in the string, it is not added.
Takes two parameters:
The first parameter is the string.
The second parameter is the token.
<$myString = strCommaAppendNoDuplicates(myString, "A")$> <$myString = strCommaAppendNoDuplicates(myString, "B")$> <$myString = strCommaAppendNoDuplicates(myString, "C")$> <$myString = strCommaAppendNoDuplicates(myString, "A")$> <$myString = strCommaAppendNoDuplicates(myString, "B")$>
Confines a string to a maximum length and appends padding if necessary.
If the string equals or is shorter than the specified length, it is unaffected.
If the string is longer than the specified length, it is shortened and three padding characters are appended to equal the specified length. The character used for padding can be specified by changing the StrConfineOverflowChars variable.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is the string.
The second parameter is the maximum string length.
Returns a string.
Confines the string and appends three padding characters (dots) to make it a string five characters long, using the form in<dot><dot><dot>:
<$strConfine("inform", 5)$>
Confines the string and appends padding characters (dots) to make it a string five characters long, using the form i<dot><dot><dot><dot>:
<$strConfine("i", 5)$>
Confines the string to a maximum of ten characters in length, so this six-character string is unaffected:
<$strConfine("inform", 10)$>
Confines the string to a maximum of six characters in length, so this six-character string is unaffected:
<$strConfine("inform", 6)$>
Defines a string padding character.
Defines the character used for padding by the strConfine function.
Default is a dot.
IntradocDir/config/config.cfg
Used as a configuration entry:
StrConfineOverflowChars=.
Checks if two strings are equal, including case.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is a string.
The second parameter is the string to be compared to the first parameter.
Returns TRUE if the strings are equal.
Returns FALSE if strings are not equal.
Evaluates whether the strings are equal and returns TRUE (1):
<$strEquals("Home","Home")$>
Evaluates whether the strings are equal and returns FALSE (0):
<$strEquals("home","Home")$>
Checks if two strings are equal, not including case.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is a string.
The second parameter is the string to be compared to the first parameter.
Returns TRUE if the strings are equal.
Returns FALSE if strings are not equal.
Evaluates whether the strings are equal and returns TRUE (1):
<$strEqualsIgnoreCase("home","Home")$>
Evaluates whether the strings are equal and returns FALSE (0):
<$strEqualsIgnoreCase("home","page")$>
This function generates a random string of hexadecimal characters. It outputs as many characters as specified by the length parameter. If length is not specified, it defaults to 16 characters.
Takes the length of the string as a parameter.
Determines if one string is a substring of another.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is a string.
The second parameter is the possible substring.
If the second string is a substring of the first, returns an index value that indicates where in the first string the substring begins. The first character has an index value of 0.
If the second string is not a substring of the first, returns a value of -1.
Evaluates whether xy is a substring of xyz and returns the index value 0:
<$if strIndexOf("xyz","xy") >=0$> check for substring <$endif$>
Evaluates whether yz is a substring of xyz and returns the index value 1:
<$if strIndexOf("xyz","yz") >=0$> check for substring <$endif$>
Evaluates whether ab is a substring of xyz and returns the index value –1 to indicate that this is not a substring:
<$if strIndexOf("xyz","ab") >=0$> check for substring <$endif$>
Fills the left side of a string with characters to make it a specified length.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes three parameters:
The first parameter is the string.
The second parameter is the fill character.
The third parameter is the length.
Returns a string, left-filled with the specified character if necessary,.
Formats the string sleep by left-filling with the character Z to ten spaces. This returns the string ZZZZZsleep:
<$strLeftFill("sleep",'Z',10)$>
Returns the string sleep:
<$strLeftFill("sleep",'Z',4)$>
Pads extra space to the left of a string to make it a specified length.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is the string.
The second parameter is the length.
Returns a string, left-filled with spaces if necessary.
Pads extra space on the left to make it a string five characters long, using the form <space><space>inf:
<$strLeftPad("inf", 5)$>
Returns the string information:
<$strLeftPad("information", 5)$>
Evaluates the length of a string.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns an integer value.
Evaluates the length of the string home and returns the integer 4:
<$strLength("home")$>
Formats a string in all lowercase letters.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns a string in all lowercase letters.
Evaluates the string Home and returns home.
<$strLower("Home")$>
Removes empty spaces from a string.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns a string with no spaces.
Formats the string h o m e as the string home:
<$strRemoveWs("h o m e")$>
Replaces an existing substring with another substring.
If there are multiple occurrences of the substring to be replaced, they will all be replaced by the new substring.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes three parameters:
The first parameter is the string on which the substitution will be performed.
The second parameter is the substring to be replaced.
The third parameter is the substring that will replace the existing substring.
Returns a string.
Replaces the word classified with restricted and results in the string This document is restricted.
<$strReplace("This document is classified.","classified","restricted")$>
Replaces the slashes in the date with periods, giving a date in the form 6.20.2001:
<$strReplace(formatDateOnly(dateCurrent()),"/",".")$>
Replaces an existing substring with another substring, performing the search without using case sensitivity.
If there are multiple occurrences of the substring to be replaced, they will all be replaced by the new substring.
Takes three parameters:
The first parameter is the string on which the substitution will be performed.
The second parameter is the substring to be replaced.
The third parameter is the substring that will replace the existing substring.
Returns a string.
<$hello = "Hello world! I love the world!"$> <$strReplaceIgnoreCase(hello, "WORLD", "universe")$>
Fills the right side of a string with characters to make it a specified length.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes three parameters:
The first parameter is the string.
The second parameter is the fill character.
The third parameter is the length.
Returns a string, right-filled with the specified character if necessary,.
Formats the string sleep by right filling with the character Z to ten spaces. This returns the string sleepZZZZZ:
<$strRightFill("sleep",'Z',10)$>
Returns the string sleep:
<$strRightFill("sleep",'Z',4)$>
Pads extra space to the right of a string to make it a specified length.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes two parameters:
The first parameter is the string.
The second parameter is the length.
Returns a string, right-filled with spaces if necessary.
Pads extra space on the right to make it a string five characters long, using the form inf<space><space>:
<$strRightPad("inf", 5)$>
Returns the string information:
<$strRightPad("information", 5)$>
Retrieves a substring from a string.
The first character has an index value of 0.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.Takes either two or three parameters:
The first parameter is the string.
The second parameter is a number representing the start index.
The third optional parameter is a number representing the stop index.
Returns a substring.
If the stop index parameter is specified, the substring starting with the character at the start index and ending one character before the stop index is returned.
If the stop index parameter is not specified, the substring from the start index to the end of the string is returned.
Retrieves the first two characters of the string my:
<$strSubstring("mystring",0,2)$>
Retrieves the string after the second character string:
<$strSubstring("mystring",2)$>
Removes spaces from the beginning and end of a string.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns a string with no leading or trailing spaces.
Formats the string " homepage " as the string homepage:
<$strTrimWs(" homepage ")$>
Formats a string in all uppercase letters.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns a string in all uppercase letters.
Evaluates the string Home and returns HOME.
<$strUpper("Home")$>
Formats how a required metadata field is displayed.
When set, the required field is displayed in the style as defined in a cascading style sheet.
Values for the style can be any of the field caption styles defined for the Oracle WebCenter Content Server system.
The only parameter is the specified style.
IntradocDir/config/config.cfg
The following example displays a required field in red:
StyleForRequiredFields=requiredField
Defines the path to the /subjects directory.
Subjects are subsystems that are notified when an Oracle WebCenter Content Server service makes a change in the system, such as modifying an option list or adding a new user.
Default is DomainHome/ucm/cs/data/subjects/.
IntradocDir/config/config.cfg
Used as a configuration entry:
SubjectsDir=c:/domain_temp/data/subjects
Defines the system administrator e-mail address.
This is the address used in workflow and subscription notification e-mails that come from the Oracle WebCenter Content Server instance.
Returns a string.
There is no default value.
System Properties, Internet tab, Administrator Mail Address
Admin Server, Internet Configuration, Administrator Mail Address
IntradocDir/config/config.cfg
As a configuration setting:
SysAdminAddress=admin@example.com
As script, returns the value of the configuration setting:
<$SysAdminAddress$>
Sets the date/time format for the Oracle WebCenter Content Server instance.
Note that there are two types of date formats: one that stores seconds and one that truncates seconds and stores the date up to the minute. If seconds are used, dates can only be stored up to the year 2037.
If SystemLocale is not specified as a configuration setting, the SystemDateFormat will be deduced directly from the operating system settings in the Java VM instead of using the Oracle WebCenter Content Server configuration table settings for the SystemLocale. If SystemLocale is explicitly defined, then the date/time format from the Oracle WebCenter Content Server configuration tables for that locale will be used instead.
The syntax for this format is an extension of the date format functionality provided in the standard Java class libraries.
IntradocDir/config/config.cfg
Used as a configuration entry to set the standard US date time using the four digit year format:
SystemDateFormat=M/d{/yyyy} {h:mm[:ss] {aa}[zzz]}
Sets the system locale for the Oracle WebCenter Content Server instance.
This setting controls the following:
localized strings used in the Oracle WebCenter Content Server interface
character encoding for web pages
date/time format
time zone
parameters used for full-text indexing
Any of these individual features can be controlled by separate configuration entries or by changing the settings for the SystemLocale.
This setting can be changed on the Server tab of the System Properties utility. The defaults for a specific locale can be changed on the Localization tab of the System Properties utility.
If SystemLocale is not specified as a configuration setting, the SystemDateFormat will be deduced directly from the OS settings in the Java VM instead of using the Oracle WebCenter Content Server configuration table settings for the SystemLocale. If SystemLocale is explicitly defined, then the date/time format from the Oracle WebCenter Content Server configuration tables for that locale will be used instead.
System Properties, Server tab, System Locale
IntradocDir/config/config.cfg
Used as a configuration entry:
SystemLocale=Deutsch
Sets the default time zone for the Oracle WebCenter Content Server instance.
The SystemTimeZones table in the WC_CONTENT_ORACLE_HOME/shared/config/resources/std_locale.htm file lists the time zones that can be specified.
Default is the time zone set for the local computer's operating system. If the default is used, the variable does not appear in the configuration file.
System Properties, Server tab, System Timezone
IntradocDir/config/config.cfg
Used as a configuration entry:
SystemTimeZone=Europe/Berlin
Specifies the location where the Oracle WebCenter Content Server Analyzer utility duplicates and tests files.
Default is a temp subdirectory in the log directory specified by the IdcAnalyzeLogDir setting.
IntradocDir/config/config.cfg
Used as a configuration entry:
TempDir=f:/domain/analyzer_logs/temp/
Retrieves the classification of the template for the current page.
This variable makes it possible to create conditional content in a template based on the identity of the template. Use this variable within a template page to determine the source of the pages delivered by the server.
For standard templates, this variable is defined in the class column of the IntradocTemplates table in the templates.hda file.
For search results templates, this variable evaluates to Results.
For report templates, this variable evaluates to Reports.
For dynamic server pages, this variable is typically IdcDynamicFile.
Returns a string.
This markup displays a table of template information on the page:
<TABLE>
<TR><TD>Template Name</TD>
<TD><$TemplateName$></TD></TR>
<TR><TD>Template Class</TD>
<TD><$TemplateClass$></TD></TR>
<TR><TD>Template Type</TD>
<TD><$TemplateType$></TD></TR>
<TR><TD>Template File Path</TD>
<TD><$TemplateFilePath$></TD></TR>
</TABLE>
Retrieves the path from where the template was actually loaded.
This variable makes it possible to create conditional content in a template based on the identity of the template. Use this variable within a template page to determine the source of the pages delivered by the server.
Returns the path as a string.
This markup displays a table of template information on the page:
<TABLE>
<TR><TD>Template Name</TD>
<TD><$TemplateName$></TD></TR>
<TR><TD>Template Class</TD>
<TD><$TemplateClass$></TD></TR>
<TR><TD>Template Type</TD>
<TD><$TemplateType$></TD></TR>
<TR><TD>Template File Path</TD>
<TD><$TemplateFilePath$></TD></TR>
</TABLE>
Retrieves the internal name of the template for the current page. For example, DOC_INFO or CHECKIN_NEW_FORM.
This variable makes it possible to create conditional content in a template based on the identity of the template. Use this variable within a template page to determine the source of the pages delivered by the server.
Returns the template name as a string.
This markup displays a table of template information on the page:
<TABLE>
<TR><TD>Template Name</TD>
<TD><$TemplateName$></TD></TR>
<TR><TD>Template Class</TD>
<TD><$TemplateClass$></TD></TR>
<TR><TD>Template Type</TD>
<TD><$TemplateType$></TD></TR>
<TR><TD>Template File Path</TD>
<TD><$TemplateFilePath$></TD></TR>
</TABLE>
Provides the template type for the current page.
This variable makes it possible to create conditional content in a template based on the identity of the template. Use this variable within a template page to determine the source of the pages delivered by the server.
For standard templates, this variable is defined in the formtype column of the IntradocTemplates table in the templates.hda file.
For search results templates, this variable is defined in the formtype column of the SearchResultTemplates table in the templates.hda file.
For report templates, this variable is defined in the datasource column of the IntradocReports table in the reports.hda file.
For dynamic server pages, this variable is either hcsp or hcsf.
Returns the template type as a string.
This markup displays a table of template information on the page:
<TABLE>
<TR><TD>Template Name</TD>
<TD><$TemplateName$></TD></TR>
<TR><TD>Template Class</TD>
<TD><$TemplateClass$></TD></TR>
<TR><TD>Template Type</TD>
<TD><$TemplateType$></TD></TR>
<TR><TD>Template File Path</TD>
<TD><$TemplateFilePath$></TD></TR>
</TABLE>
Converts a string to an integer.
Note:
Use the Special String Operators for string concatenation, string inclusion, and simple comparison.The only parameter is the string.
Returns an integer value. If the string does not evaluate to a number, or evaluates to a non-integer number, an error is thrown.
Converts the string 4 to an integer and returns the value 4:
<$toInteger("4")$>
Enables logging a debug or trace message to the IsPageDebug output. A message can also be output to the console or to the system logs.
Takes one required and two optional parameters:
The first parameter is the message which is output. The value can be one of the following:
A string. If the string is passed as the only parameter, the IsPageDebug variable must be set for this function to execute. The string is added to the accumulated debug trace.
#local, which prepares a dump of all current local variables.
#all, which prepares a full HDA dump of all local data, result sets, and environment data.
The second (optional) parameter is the location where the message will be relayed. The values can be the following:
#console, to display to a console
#log to log a message in the HTML log files
the name of a variable (such as StatusMessage). In that case, the message is appended to the current value.
The third (optional) parameter is for the appropriate tracing section and is only relevant if the location parameter is set to #console.
The following example logs the string message to the system console, which is always logged:
<$trace("message", "#console")$>
The following example logs the string message to the system console in the pagecreation tracing section.
<$trace("message", "#console", "pagecreation")$>
The following example logs the string message to the HTML Oracle WebCenter Content Server log file.
<$trace("message", "#log")$>
The following example dumps all local variables and their values to the system console.
<$trace("#local", "#console")$>
The following example dumps all local variables, result sets, and environment variables to the system console.
<$trace("#all", "#console")$>
The following example dumps all data to the variable MyTraceDump, which can then be displayed on the page. This is useful for HCSP developers who may not have the appropriate access rights to view the console logs.
<$trace("#all", "MyTraceDump")$>
<$MyTraceDump$>
When the Oracle WebCenter Content Server instance is started from a command line, each system resource that is overridden twice by component resources is output to the command line.
When set to TRUE, system resources that are overridden by two or more component resources are output.
Default is FALSE.
IntradocDir/config/config.cfg
TraceResourceConflict=true
When the Oracle WebCenter Content Server instance is started from a command line, all resource loading activities are output to the command line.
When set to TRUE, all resources loaded, resource overrides, resource conflicts, and resource merges are output.
Default is FALSE.
IntradocDir/config/config.cfg
TraceResourceLoad=true
When the Oracle WebCenter Content Server instance is started from a command line, system resources and non-system component resources that are overridden by a component resource are output to the command line.
When set to TRUE, system resources and non-system resources that are overridden by one or more component resources are output.
Default is FALSE.
IntradocDir/config/config.cfg
TraceResourceOverride=true
Records Manager only.
Controls if the metadata field check boxes on the search page are shown.
If set to TRUE, the metadata field check boxes are not shown on the page. If set to FALSE, the metadata field check boxes are shown.
The default is TRUE.
DomainHome/ucm/urm/custom/RecordsManagement/records_management_environments.cfg
DomainHome/ucm/urm/custom/RetentionManager/retentionmanager_environments.cfg
Used as a configuration entry:
UieHideSearchCheckboxes=false
Enables the multiple file Upload Applet.
Important:
This setting is only for use by custom legacy versions of the Upload Applet. It should not be enabled when the standard MultiUpload variable is enabled.When set to TRUE, the Upload Applet is enabled so that multiple files can be zipped and checked in as a single content item.
When set to FALSE, the Upload Applet is disabled.
Default is FALSE.
IntradocDir/config/config.cfg
As a configuration setting, enables the Upload Applet:
UploadApplet=true
As script, evaluates the condition of the Upload Applet:
<$UploadApplet$>
Formats a string for use in a URL.
This function converts blank spaces and reserved characters to an escape sequence.
The only parameter is the string.
Returns a string formatted for use in a URL.
Formats the string home page as home%20page:
<$url("home page")$>
Formats the string home/page as home%2fpage:
<$url("home/page")$>
Formats the string home?page as home%3fpage:
<$url("home?page")$>
This function returns a URL-encoded version of the string parameter. This is similar to the url function but it only encodes characters that are not 7-bit clean (ASCII). Therefore this function can be called repeatedly on the same string.
If the url function is used to double encode a string, every % character is encoded to %25.
The only parameter is the string.
Returns a string formatted for use in a URL.
<$path = "mÿ fïlë.txt"$> 20fïlë.txt = <$url(path)$> mÿ%2520fïlë.txt = <$url(url(path))$> m%ff%20f%efl%eb.txt = <$urlEscape7Bit(url(path))$> m%ff%20f%efl%eb.txt= <$urlEscape7Bit(urlEscape7Bit(url(path)))$>
Enables an alternate look-and-feel for the Oracle WebCenter Content Server interface.
When set to TRUE, the Bellevue look-and-feel (green and red color scheme) is used.
If UseXpedioLook is TRUE, it overrides this setting.
There is no default value.
IntradocDir/config/config.cfg
Used as a configuration entry:
UseBellevueLook=true
This string is obsolete. Use SystemDateFormat.
Specifies a four-digit or two-digit year display format.
When set to TRUE, the Oracle WebCenter Content Server instance displays years with four digits.
When set to FALSE, the Oracle WebCenter Content Server instance displays years with two digits.
The Oracle WebCenter Content Server system supports both two-digit and four-digit years for data entry.
Default is TRUE.
IntradocDir/config/config.cfg
Used as a configuration entry:
UseFourDigitYear=false
Retrieves a comma-delimited list of accounts the current user is assigned to.
The #none entry indicates privileges to content items that have no account assigned.
The #all entry indicates privileges to all accounts.
Returns the account list as a string.
For example:
UserAccounts=BOS,SEA,MSP/Gen
This markup displays user variables on a page:
<$if UserName$>
Logon Name: <$UserName$><BR>
User Name: <$UserFullName$><BR>
E-mail Address: <$UserAddress$><BR>
Accounts: <$UserAccounts$><BR>
<$endif$>
Retrieves the e-mail address of the current user.
Returns the e-mail address as a string.
This markup displays user variables on a page:
<$if UserName$>
Logon Name: <$UserName$><BR>
User Name: <$UserFullName$><BR>
E-mail Address: <$UserAddress$><BR>
Default Account: <$UserDefaultAccount$><BR>
<$endif$>
Checks the application rights of the current user.
Returns a bit flag number specifying the user's rights:
| Admin Application | Bit Flag |
|---|---|
| User Admin | 1 |
| Web Layout Editor | 2 |
| Repository Manager | 4 |
| Workflow Admin | 8 |
| Configuration Manager | 16 |
| Archiver | 32 |
Displays application rights of the current user:
<$UserAppRights$>
For example, the following combinations would result in the following numbers:
User Admin + Web Layout Editor = 3
Repository Manager + Workflow Admin + Archiver = 44
All six applications = 63
Defines the path to the users directory, which is the location where user personalization information is stored.
Default is DomainHome/ucm/cs/data/users/.
IntradocDir/config/config.cfg
Used as a configuration entry:
UserCache=c:/myuserdata/
Sets the timeout in milliseconds for the temporary cache of global and external user information.
Default is 60000 milliseconds (1 minute).
IntradocDir/config/config.cfg
Used as a configuration entry:
UserCacheTimeout=120000
Retrieves the default account for the current user.
Returns the account name as a string.
This markup displays user variables on a page:
<$if UserName$>
Logon Name: <$UserName$><BR>
User Name: <$UserFullName$><BR>
E-mail Address: <$UserAddress$><BR>
Default Account: <$UserDefaultAccount$><BR>
<$endif$>
Enables the capture of output from the Java Virtual Machine. This includes logging output from any enabled tracing facilities and stack dumps resulting from the VM crash.
Used only on Windows systems and if the Oracle WebCenter Content Server system is running as a service.
IntradocDir/config/config.cfg
UseRedirectedOutput=true
The full name of the current user.
Returns the user's full name as a string.
If the user is not logged in, returns the string anonymous.
This markup displays user variables on a page:
<$if UserName$>
Logon Name: <$UserName$><BR>
User Name: <$UserFullName$><BR>
E-mail Address: <$UserAddress$><BR>
Default Account: <$UserDefaultAccount$><BR>
<$endif$>
Returns the two-letter code that represents the user's preferred language, as in en for English, fr for French, or ja for Japanese.
This is useful when constructing URLs to localized content.
Returns the code for the preferred language.
Returns the full name for a user's locale, as in English-US, English-UK or Japanese.
The locale contains information about language, date, and number formatting.
Returns the name of the preferred language.
Retrieves the username of the current user.
Returns the username as a string.
If the user is not logged in, evaluates to the string anonymous.
This markup displays user variables on a page:
<$if UserName$> Logon Name: <$UserName$><BR>
User Name: <$UserFullName$><BR>
E-mail Address: <$UserAddress$><BR>
Default Account: <$UserDefaultAccount$><BR>
<$endif$>
Allows the web server plug-in to refer to data in a local directory (stub directory) rather than the file system where the Oracle WebCenter Content Server system is installed.
This setting is used for clustered Windows Oracle WebCenter Content Server configurations. See the clustering documentation for more information.
Use the format UserPublishCacheDir=stub_dir/data/users, where stub_dir is the path of the stub directory (such as f:/domain/).
IntradocDir/config/config.cfg
Used as a configuration entry:
UserPublishCacheDir=f:/domain/data/users
Retrieves a comma-delimited list of roles the current user belongs to.
Returns the user role list as a string.
For example:
PublicContributor,ClassifiedConsumer
References the list of user roles:
<$if UserRoles$>
<$include optional_field$>
<$endif$>
Enables an alternate look-and-feel for the Oracle WebCenter Content Server interface.
When set to TRUE, the Xpedio look-and-feel (purple and blue color scheme) is used.
If this setting is TRUE, it overrides the UseBellevueLook setting.
There is no default value.
IntradocDir/config/config.cfg
Used as a configuration entry:
UseXpedioLook=true
Returns the value of a user property from a specified personalization (user topic) file.
User topic files are HDA files that are located in the IntradocDir/data/users/profiles/us/username/ directories.
Takes two parameters:
The first parameter is the name of a user topic HDA file.
The second parameter is the name of a property defined in the user topic file.
Returns the value of the property in the specified user topic file.
Returns the value of the emailFormat property in the current user's pne_portal.hda file:
<$utGetValue("pne_portal","emailFormat")$>
Loads a personalization (user topic) file so it is available for use by the utGetValue and utLoadResultSet functions.
User topic files are HDA files that are located in the IntradocDir/data/users/profiles/us/username/ directories.
The only parameter is the name of a user topic HDA file.
Loads the current user's wf_in_queue.hda file and makes it available to other user topic functions:
<$utLoad("wf_in_queue")$>
Used to retrieve information about a user's current My Check In and My Search links for content profiles.
Takes two parameters:
The user topic name.
The name of the result set containing the content profiles available for the user on the personalization links.
<$utLoadDocumentProfiles("pne_portal", "PneDocumentProfiles")
Loads a ResultSet specified in a personalization (user topic) file into the DataBinder.
User topic files are HDA files that are located in the IntradocDir/data/users/profiles/us/username/ directories.
Takes two parameters:
The first parameter is the name of a user topic HDA file.
The second parameter is the name of a ResultSet defined in the user topic file.
Returns TRUE if the ResultSet is successfully loaded into the DataBinder.
Returns FALSE if the function fails.
Loads the SavedQueries ResultSet from the current user's pne_portal.hda file into the DataBinder:
<$utLoadResultSet("pne_portal","SavedQueries")$>
Specifies the style of the value for the metadata field.
The following SPAN styles are typically used for values. They are defined in the std_style_declaration include in the WC_CONTENT_ORACLE_HOME/shared/config/resources/std_page.htm resource file:
tableEntry
xxsmall
strongHighlight
Returns the name of the value style.
Sets the value style:
<$if isFieldInfoOnly$>
<$if valueStyle$>
<$fieldValueStyle = valueStyle$>
<$else$>
<$fieldValueStyle = "tableEntry"$>
<$endif$>
<$endif$>
Uses the xxsmall style for the field value when the Download applet is used:
<$if useDownloadApplet$>
<$valueStyle="xxsmall", fieldValue = strTrimWs(inc("download_file_by_ applet_form_content"))$>
<$else$>
<$fieldValue = strTrimWs(inc("doc_file_get_copy"))$>
<$endif$>
Defines the path to the vault directory.
This is the root directory of the Oracle WebCenter Content Server native file repository.
This setting is required only if the vault directory is not located in the Oracle WebCenter Content Server root directory.
There is no default value.
Oracle WebCenter Content Server: DomainHome/ucm/cs/bin/intradoc.cfg
Oracle WebCenter Content: Inbound Refinery: IntradocDir/ucm/ibr/bin/intradoc.cfg
Used as a configuration entry:
VaultDir=f:/vault
Specifies whether the Oracle WebCenter Content Server installer displays a warning if it cannot determine the computer's time zone.
When set to TRUE, a default time zone is used and a warning is displayed.
When set to FALSE, a default time zone is used, but no warning is displayed.
Default is FALSE.
IntradocDir/config/config.cfg
Used as a configuration entry:
WarnAboutTimeZone=true
Defines the path to the Web browser that displays the Oracle WebCenter Content Server Help files from stand-alone applications.
There is no default value.
System Properties, Paths tab, Browser Executable Path
DomainHome/ucm/cs/bin/intradoc.cfg
Used as a configuration entry:
WebBrowserPath=c:/Program Files/Internet Explorer/Iexplore.exe
Defines the path to the weblayout directory.
This is the root directory of the Oracle WebCenter Content Server web site.
This setting is required only if the weblayout directory is not located in the Oracle WebCenter Content Server root directory.
There is no default value.
Oracle WebCenter Content Server: DomainHome/ucm/cs/bin/intradoc.cfg
Oracle WebCenter Content: Inbound Refinery: DomainHome/ucm/ibr/bin/intradoc.cfg
Used as a configuration entry:
WeblayoutDir=f:/weblayout
Formats a string for use in XML.
This function replaces non-alphanumeric characters with the correct XML sequence that represents the character. For example, the ampersand "&" character is replaced with the "&" sequence.
When using a double-quote character within a string, a backslash "\" must precede the double-quote to display it as a character. If the backslash is not used as an escape flag, the double-quote is interpreted as ending the string.
The only parameter is the string.
Returns a string formatted for use in a URL.
Escapes the ampersand and returns the XML formatted string, "Me & you."
<$xml("Me & you.")$>
Escapes the non-alphanumeric characters and returns the XML-formatted string, "Test the ", >, and < characters."
<$xml("Test the \", >, and < characters.")$>