Global Functions Oracle Fusion Middleware Online Documentation Library

3-12 Oracle Fusion Middleware Idoc Script Reference Guide

3.4 Environment Variables

Web server variables are the CGI environment variables that are set when the server executes the gateway program. In order to pass data about the information request from the server to the script, the server uses command-line arguments and environment variables. These environment variables can be used to output information to a log file or can be used within Idoc Script statements and as part of evaluations. For example, this Idoc Script statement evaluates whether the remote host address matches a specific string: if strEquals207.0.0.1,REMOTE_HOST This HTML and Idoc Script markup displays a list of web server environment information on the page: PHTTP_INTERNETUSER=HTTP_INTERNETUSERP PREMOTE_HOST=REMOTE_HOSTP PSCRIPT_NAME=SCRIPT_NAMEP The following is a list of web server variables. CONTENT_LENGTH on page 6-24 GATEWAY_INTERFACE on page 6-59 HTTP_ACCEPT on page 6-73 HTTP_ACCEPT_ENCODING on page 6-74 HTTP_ACCEPT_LANGUAGE on page 6-75 HTTP_COOKIE on page 6-76 HTTP_HOST on page 6-77 HTTP_INTERNETUSER on page 6-78 HTTP_REFERER on page 6-79 HTTP_USER_AGENT on page 6-80 PATH_INFO on page 6-189 PATH_INFO on page 6-189 QUERY_STRING on page 6-198 REMOTE_ADDR on page 6-203 REMOTE_HOST on page 6-204 REQUEST_METHOD on page 6-205 SCRIPT_NAME on page 6-219 SERVER_NAME on page 6-233 SERVER_PORT on page 6-234 SERVER_PROTOCOL on page 6-235 SERVER_SOFTWARE on page 6-236

3.5 Global Functions

Idoc Script has many built-in global functions. Functions perform actions, including string comparison and manipulation routines, date formatting, and ResultSet manipulation. Some functions also return results, such as the results of calculations or comparisons. Information is passed to functions by enclosing the information in parentheses after the name of the function. Pieces of information that are passed to a function are called parameters. Some functions do not take parameters; some functions take one parameter; some take several. There are also functions for which the number of parameters depends on how the function is being used. Master List: Idoc Script by Type 3-13 The following is a list of Idoc Script global functions. abortToErrorPage on page 8-2 break on page 8-16 cacheInclude on page 8-19 clearSchemaData on page 6-20 computeDocUrl on page 6-22 computeRenditionUrl on page 6-23 dateCurrent on page 8-31 ddAppendIndexedColumnResultSet on page 8-33 ddAppendResultSet on page 8-35 ddApplyTableSortToResultSet on page 8-36 ddGetFieldList on page 8-37 ddIncludePreserveValues on page 8-38 ddLoadIndexedColumnResultSet on page 8-40 ddLoadResultSet on page 8-41 ddMergeIndexedColumnResultSet on page 8-42 ddMergeResultSet on page 8-44 ddMergeUsingIndexedKey on page 8-46 ddSetLocal on page 8-48 ddSetLocalByColumnsFromFirstRow on page 8-49 ddSetLocalByColumnsFromFirstRowIndexed on page 8-50 ddSetLocalEmpty on page 8-51 ddSetLocalEmptyByColumns on page 8-52 docLoadResourceIncludes on page 8-60 docRootFilename on page 8-62 docUrlAllowDisclosure on page 6-39 dpGet on page 8-65 dpPromote on page 8-66 dpPromoteRs on page 8-67 dpSet on page 8-68 encodeHtml on page 6-49 eval on page 8-71 executeService on page 8-73 forceExpire on page 8-94 formatDate on page 8-97 formatDateDatabase on page 6-57 formatDateDisplay on page 8-98 formatDateOnly on page 8-99 formatDateOnlyDisplay on page 8-100 formatDateOnlyFull on page 8-101 formatDateWithPattern on page 8-102 formatTimeOnly on page 8-103 formatTimeOnlyDisplay on page 8-104 getDebugTrace on page 8-106 getErrorTrace on page 8-107 getFieldViewDisplayValue on page 6-63 getFieldViewValue on page 8-108 getFreeMemory on page 8-109 getParentValue on page 6-64 getRequiredMsg on page 8-112 getTextFile on page 8-113 getTotalMemory on page 8-114 getUserValue on page 8-115 getValue on page 8-116 getValueForSpecifiedUser on page 8-118 3-14 Oracle Fusion Middleware Idoc Script Reference Guide getViewValue on page 6-65 getViewValueResultSet on page 6-66 hasAppRights on page 6-67 idocTestForInclude on page 8-147 inc on page 8-148 incDynamicConversionByRule on page 10-52 incGlobal on page 8-149 incTemplate on page 8-151 indexerSetCollectionValue on page 6-94 isActiveTrace on page 8-153 isFalse on page 8-163 isLayoutEnabled on page 6-118 isTrue on page 8-189 isUserOverrideSet on page 6-130 isValidateFile on page 6-131 js on page 8-196 jsFilename on page 6-140 lc on page 8-201 lcCaption on page 8-202 LmDefaultLayout on page 6-156 LmDefaultSkin on page 6-157 lmGetLayout on page 6-158 lmGetSkin on page 6-159 loadCollectionInfo on page 6-160 loadDocMetaDefinition on page 8-203 loadDocumentProfile on page 8-204 loadSchemaData on page 6-161 loadSearchOperatorTables on page 8-205 loadUserMetaDefinition on page 8-206 optList on page 8-228 parseDataEntryDate on page 8-231 parseDateWithPattern on page 8-234 pneNavigation on page 8-235 regexMatches on page 6-200 regexReplaceAll on page 6-201 regexReplaceFirst on page 6-202 rptDisplayMapValue on page 8-244 rs on page 8-245 rsAddFields on page 8-246 rsAddFieldsWithDefaults on page 8-247 rsAddRowCountColumn on page 8-249 rsAppend on page 8-250 rsAppendNewRow on page 8-251 rsAppendRowvalues on page 8-252 rsCopyFiltered on page 8-253 rsCreateReference on page 8-254 rsCreateResultSet on page 8-255 rsDeleteRow on page 8-256 rsDocInfoRowAllowDisclosure on page 8-257 rsExists on page 8-258 rsFieldByIndex on page 8-259 rsFieldExists on page 8-260 rsFindRowPrimary on page 8-261 rsFirst on page 8-262 rsInsertNewRow on page 8-263 Master List: Idoc Script by Type 3-15 rsIsRowPresent on page 8-264 rsLoopInclude on page 8-265 rsLoopSingleRowInclude on page 8-266 rsMakeFromList on page 8-267 rsMakeFromString on page 8-269 rsMerge on page 8-271 rsMergeDelete on page 8-272 rsMergeReplaceOnly on page 8-273 rsNext on page 8-274 rsNumFields on page 8-275 rsNumRows on page 8-276 rsRemove on page 8-277 rsRename on page 8-278 rsRenameField on page 8-279 rsSetRow on page 8-280 rsSort on page 8-281 rsSortTree on page 8-282 setContentType on page 8-286 setExpires on page 8-287 setHttpHeader on page 8-288 setMaxAge on page 8-289 setValue on page 8-291 setResourceInclude on page 8-290 stdSecurityCheck on page 6-250 strCenterPad on page 8-296 strCommaAppendNoDuplicates on page 8-297 strConfine on page 8-298 strEquals on page 8-300 strEqualsIgnoreCase on page 8-301 strGenerateRandom on page 8-302 strIndexOf on page 8-303 strLeftFill on page 8-304 strLeftPad on page 8-305 strLength on page 8-306 strLower on page 8-307 strRemoveWs on page 8-308 strReplace on page 8-309 strReplaceIgnoreCase on page 8-310 strRightFill on page 8-311 strRightPad on page 8-312 strSubstring on page 8-313 strTrimWs on page 8-314 strUpper on page 8-315 toInteger on page 8-327 trace on page 8-328 url on page 8-335 urlEscape7Bit on page 8-336 userHasAccessToAccount on page 6-265 userHasGroupPrivilege on page 6-266 userHasRole on page 6-267 utGetValue on page 8-353 utLoad on page 8-354 utLoadDocumentProfiles on page 8-355 utLoadResultSet on page 8-356 xml on page 8-362 3-16 Oracle Fusion Middleware Idoc Script Reference Guide

3.6 Page Variables