This is a list of Perceptive Enterprise Search symbols available for use in your templates, the second column indicates the scope from which the symbol is available.
Browse | |
| {FileDate} |
Used in directory browse, specifies the file date of the current file. |
| {FileDescription} |
Used in directory browse, specifies the description of the current file. |
| {FileIcon} |
Used in directory browse, specifies the file name of the icon representing the current file. |
| {Filename} |
Used in directory browse, specifies the file name of the current file. |
| {FileSize} |
Used in directory browse, specifies the file size of the current file. |
| {FileTime} |
Used in directory browse, specifies the file time of the current file. |
Concept | |
| {ConceptDescription} |
When the results being render are generated from a concept taxonomy node, this will return the description of the node that generated these results. |
| {ConceptQuery} |
When the results being render are generated from a concept taxonomy node, this will return the query of the node that generated these results. |
| {ConceptTitle} |
When the results being render are generated from a concept taxonomy node, this will return the title of the node that generated these results. |
Document | |
| {Frames} |
A URL that allows the document browse window to be opened in frames view. Parameters Top - Refers to the size of the top frame as a percentage or number of pixels Center - Refers to the size of the center frame as a percentage or number of pixels Bottom - Refers to the bottom frame size |
| {SearchTerms} |
Uses the specified template, outputting one line for each search term contained within the result list. The template may contain the following variables: %SEARCH_TERM%. Parameters Template - The text that is to be outputted for each search term. |
Error | |
| {Date} |
Used on error pages, specifies the current date and time. |
| {RequestPage} |
Used on error pages, specifies the page that caused the error. |
| {RequestType} |
Used on error pages, specifies the HTTP request type (GET, POST etc). |
| {StatusCode} |
Used on error pages, outputs the HTTP status code. |
| {StatusText} |
Used on error pages, outputs the HTTP status text. |
| {UserAgent} |
Used on error pages, outputs the user agent string sent by the clients web browser. |
Global | |
| {BaseURL} |
Returns the path portion of the URL to get to the root of the website. |
| {Concept} |
Output the root of the Concept Taxonomy Parameters filename - cols - subitems - cssclass - separator - |
| {Cond} |
Conditional text output, the specified text will only be shown if the test conditional evaluates to true. Parameters test - The expression that is to be evaluated text - The text that is to be shown if the test returns true. |
| {HTTPError} |
Returns the HTTP error text, if any. Used to generate error pages. |
| {HTTPStatus} |
Returns the HTTP status code returned for this page. Used to generate error pages. |
| {IfSecure} |
Conditional block, content between {IfSecure} and {EndIf} is only shown when the page is running in secure mode (i.e. not anonymous). |
| {IndexNames} |
Outputs a list of index names based on the specified pattern and template Parameters Pattern - An index name must match this pattern Template - The text that is to be outputted for each index. %INDEX_NAME% is substituted with its corrisponding value. |
| {ISYSError} |
Returns any ISYS error that may have occured during the generation of this page. |
| {ISYSUser} |
Returns the current user name. |
| {Now} |
Outputs the current UTC date and time. Parameters ... - Optional date/time format string. |
| {Referer} |
Returns the HTTP referrer when possible. |
| {Referrer} |
Returns the HTTP referer when possible. |
| {RequestURL} |
Returns the URL that was requested to generate this page. |
| {Section} |
Defines the start of a named section, this is used to enable customization using the Site Designer. When a section is disabled, content between {Section} and {SectionEnd} will not be shown. Parameters Name - Specifies the name of this section |
| {SectionEnd} |
Markes the end of a named section, it is possible to nest named sections. |
| {ServerFeedback} |
Returns any feedback messages from the server. These can include non-fatal warnings. |
| {ServerName} |
Returns the server name, ie: "localhost" |
| {ServerPort} |
Returns the port the server is listening on, ie: 80 |
| {ServerSoftware} |
Returns the server software details, ie: "ISYS:web/10.0" |
| {ServerURL} |
Returns the URL to the root of the server. |
| {Theme} |
Outputs the path to the currently active site theme, this is useful when referencing resources stored in the theme. |
| {Validation} |
Performs form validation of a given form element. Parameters For - Specifies the form element to validate Text - Specifies the text to display if the form element is not valid. |
| {Var} |
Outputs an Site Designer customization variable, this enables certain parts of the website to be modified without touching the HTML. Parameters Name - Indicates the variable that is to be outputted. Default - Indicates the default value to show when there is no stored value. |
| {ContentBegin} |
Designates the beginning of a named content section, this is used to handle multiple sections in a layout file. Parameters Name - Specifies the name of the content section |
| {ContentEnd} |
Designates the end of a named content section |
| {LanguageNames} | Parameters Template - The text that is to be outputted for each index. %NAME% and %ID% are substituted with there corrisponding values. |
| {LanguagePacks} | Parameters Template - The text that is to be outputted for each index. %NAME% and %ID% are substituted with there corrisponding values. |
| {Navigation} |
Outputs the pages breadcrumbs navigation bar. |
| {SignOut} |
Outputs the given HTML into the response if the website supports FORM authentication and a user is currently logged in. Parameters html - HTML to show if signout is supported |
| {TagCloud} | Parameters Index - Indicates the index for which the TagCloud is to be created. Type - Specify the type of cloud to create, maybe Meta:FieldName or TopSearches Width - Optional width in pixels Order - Specify the order of the items in the cloud, can be NAME, WEIGHT or RADIAL Font - Specify the font name to use to create the cloud FontMin - Specify the minimum font size, default is 8. FontMax - Specify the maximum font size, default is 24. ColorStart - Specify the starting color in HTML format ColorEnd - Specify the ending color in HTML format |
| {TagCloudMetadata} | Parameters Index - Indicates the index for which the TagCloud is to be created. Field - Specify the metadata field Width - Optional width in pixels Order - Specify the order of the items in the cloud, can be NAME, WEIGHT or RADIAL Font - Specify the font name to use to create the cloud FontMin - Specify the minimum font size, default is 8. FontMax - Specify the maximum font size, default is 24. ColorStart - Specify the starting color in HTML format ColorEnd - Specify the ending color in HTML format |
| {TagCloudSearchTrends} | Parameters Index - Indicates the index for which the TagCloud is to be created. Width - Optional width in pixels Order - Specify the order of the items in the cloud, can be NAME, WEIGHT or RADIAL Font - Specify the font name to use to create the cloud FontMin - Specify the minimum font size, default is 8. FontMax - Specify the maximum font size, default is 24. ColorStart - Specify the starting color in HTML format ColorEnd - Specify the ending color in HTML format |
Layout | |
| {Content} |
Used in layout files, indicates the location where a pages content should be injected. Parameters Name - Specifies the name of the content section to inject |
| {IfContent} |
Conditional block, content between {IfContent} and {EndIf} is only shown when the content section exists. Parameters Name - Specifies the name of the content section. |
| {IfNotContent} |
Conditional block, content between {IfNotContent} and {EndIf} is only shown when the content section does not exist. Parameters Name - Specifies the name of the content section. |
| {Title} |
Used in layout files, returns the title of the page. |
Results | |
| {AgentCheckbox} |
Outputs a checkbox used to handle marking documents as read. |
| {AgentUnsubscribe} |
Generates a URL that can be used to unsubscribe from a subscribed search |
| {AlternateURL} |
A URL that leads to a document of the same name, but with a different extension. Parameters ext - represents the extension |
| {BatchFirst} |
The number of the first document in the current batch. |
| {BatchLast} |
The number of the last document listed in the current batch. |
| {BatchSize} |
The number of documents in the current page-full of results. |
| {BestSuggestion} | |
| {BrowseDoc} |
A URL that will cause a document to be browsed. |
| {BrowseDocAtHit} |
A URL that will browse a document at the first hit. |
| {BrowseDocNoScript} |
Browses documents, ignoring JavaScript. |
| {BrowseDocRich} |
Browses documents of the type X, Y, Z in Rich HTML format. Parameters ... - Comma seperated list of document types. |
| {BrowseSmallOutlineLarge} |
A URL that forces the document to be browsed in Outline mode if the size of the document exceeds the specified KB, if smaller the document is browsed as normal. Used instead of the BrowseDoc symbols. Parameters size - Size is kilobytes of maximum document. |
| {Categories} |
Outputs the specified text for each category of document in the result list Parameters ... - The text to output for each category. %CATEGORY_NAME%, %CATEGORY_COUNT and %CATEGORY_URL% are substituted with their corrisponding values. |
| {Category} |
Returns the category of the current document. |
| {Context} |
The first # hits with # words shown either side. Parameters Hits - The number of hits to show Lines - The number of lines around each hit |
| {ContextNoMeta} |
The first # hits with # lines shown either side, excluding the meta data section of the document. Parameters Hits - The number of hits to show Lines - The number of lines around each hit |
| {Date} |
The date a document was last changed Parameters format - The format to use when displaying the date. |
| {DateIndexed} |
The date the document was indexed Parameters format - The format to use when displaying the date. |
| {DocDetails} |
Returns a URL to show the document details. This includes document properties such as title, last modified and date index, and document metadata. |
| {DocNum} |
Document number within current list of found documents. |
| {Entities} |
Enumerates search entity in the result list, outputting the template text for each one. Parameters ... - The text to output for each entity. %NAME%, %CORE%, %ID%, %COUNT%, %TYPE% and %TYPENUM% are substituted with their corrisponding values. |
| {EntityList} |
Outputs a pre-formatted table of entities, the look and feel can be controlled via styles. Parameters MaxItemsPerType - Specifies the maximum number of entities, for each class, to display. Type - Specifies one or more entity clases to display (People, Organizations, Websites, Email Address, Locations). CSSPrefix - Specifies a prefix to include infront of all styles. |
| {Filename} |
File name of original legacy document. |
| {FilePath} |
The fully qualified filename name of the original document. |
| {FileSize} |
Displays the size of the document in KB, used in the results list. |
| {Format} |
A name describing the format of a document, e.g.: "WordPerfect". |
| {FoundDB} |
The index identifier(s) for a given search. Useful for display at result list time when searching chained indexes. |
| {Hits} |
The number of hits in a document. |
| {Icon} |
Displays an image if the document type |
| {IfAgent} |
Conditional block, content between {IfAgent} and {EndIf} is only shown when the page is returned from a subscribed search. |
| {IfBestBet} |
Conditional block, content between {IfBestBet} and {EndIf} is only shown when the document is a best bet. |
| {IfCategories} |
Conditional block, content between {IfCategories} and {EndIf} is only shown when the result list contains categories. |
| {IfChanged} |
Inserts the designated message text if the document has changed since indexing. Parameters message - Text to show when document has been changed |
| {IfEntities} |
Conditional block, content between {IfEntities} and {EndIf} is only shown when the result list contains entities. |
| {Image} |
A URL linking to an image associated with a document. |
| {IndexPath} |
Returns the path to the searched index. |
| {IW_BATCHSIZE} |
Returns the batch size (items per page) of the current result list. |
| {IW_DATABASE} |
Returns the names of the indexes used to generate this search. |
| {IW_FILTER_CATEGORY_LIKE} | |
| {IW_FILTER_CATEGORY_UNLIKE} | |
| {IW_FILTER_DATE_AFTER} |
Returns the ending date filter applied to the current result list. |
| {IW_FILTER_DATE_BEFORE} |
Returns the starting date filter applied to the current result list. |
| {IW_FILTER_FIRST_DATE_AFTER} | |
| {IW_FILTER_FIRST_DATE_BEFORE} | |
| {IW_FILTER_FNAME_LIKE} |
Returns the filename filter applied to the current result list. |
| {IW_FILTER_FNAME_UNLIKE} |
Returns the filename exclusion filter applied to the current result list. |
| {IW_FILTER_INDEXED_DATE_AFTER} | |
| {IW_FILTER_INDEXED_DATE_BEFORE} | |
| {IW_FILTER_OMIT_PATH} |
Returns the path exclusion filter applied to the current result list. |
| {IW_FILTER_PATH} |
Returns the path filter applied to the current result list. |
| {IW_REQUERY} | |
| {IW_SORT} |
Returns the sort order of the current result list. |
| {IW_USE_THESAURUS} |
Returns on|off depending if the thesauras was used to generate this search. |
| {KeyEntities} |
Outputs the template text for the key entities of the given class Parameters Count - Specifies the maximum number of entities to display Seperator - Specifies the text to show between each entity Type - Specifies one or more entity clases to display (People, Organizations, Websites, Email Address, Locations). Template - Specifies the template text to output for each entity |
| {Lines} |
Display the given number of lines from the document Parameters Count - The number of lines to display. Start - Index or text of the first line. |
| {LongName} |
The long path name of a document, dropping the first n levels. Parameters DropLevels - The number of folders to drop from the beginning of the filename |
| {MetaData} |
Enumerates all metadata values for the current document. Parameters Template - Template text to substitue |
| {MetaValue} |
Returns the metadata value stored for the current document. When multiple keys are specified, the first value that is found is returned. Parameters ... - Comma seperated list of meta key names |
| {NextBatch} |
A URL linking to the next pagefull of results. Does not appear if next batch does not exist. |
| {NextBatchFirst} |
The number of the first document in the next batch. |
| {NextBatchLast} |
The number of the last document in the next batch. |
| {NextBatchSize} |
The number of documents in the next page-full of results. |
| {NextBatchText} |
Text linking to next batch of results in multi-page results list. Does not appear if next batch does not exist. Parameters messagetext - Text to display for next batch, %d refers to the batch size. |
| {NextDoc} |
A URL linking to the next document in the document list. |
| {NextDocDetails} |
Returns a URL to show the next document's details. This includes document properties such as title, last modified and date index, and document metadata. |
| {NextDocRich} |
Browses the next documents of the type X, Y, Z in Rich HTML format. Parameters ... - Comma seperated list of document types. |
| {NotesUrl} |
Returns a lotus notes URL (notes://) when the specified document is from lotus notes. |
| {NumDocs} |
Total number of found documents. |
| {OutlineDoc} |
A URL that opens the document in outline mode, showing n lines around each hit, and expand links at the top and bottom of each section. Parameters Lines - The number of lines to show around each hit. |
| {OutlineDocAtHit} |
A URL that opens a document in outline mode at the first hit. Parameters Lines - The number of lines to show around each hit. |
| {PageSelector} |
Generated a search result navigator where the user can jump straight to a specific page in the result list. |
| {PhrasedHits} |
The number of hits in a document. |
| {PrevBatch} |
A URL linking to the previous batch of documents. Disabled if a previous batch does not exist. |
| {PrevBatchSize} |
The number of documents in the previous page of results. |
| {PrevBatchText} |
Text linking to previous batch of results in multi-page results list. Does not appear if previous batch does not exist. Parameters messagetext - Text to display for previous batch, %d refers to the batch size. |
| {PrevDoc} |
A URL that leads to the previous document in the document list. |
| {PrevDocDetails} |
Returns a URL to show the previous document's details. This includes document properties such as title, last modified and date index, and document metadata. |
| {PrevDocRich} |
Browses the previous documents of the type X, Y, Z in Rich HTML format. Parameters ... - Comma seperated list of document types. |
| {PreviousQuery} |
A special-purpose symbol used as the value parameter of IW_REQUERY forms (compulsory for query-within). |
| {Query} |
Query responsible for the current result list. |
| {QueryError} |
Returns any error text that indicates why a result list failed to produce any results. |
| {Referrer} |
A URL that leads to the referring document. |
| {Relevance} |
The relative relevance of the document expressed as a percentage. |
| {RelevanceBar} |
A graphical bar indicating the relative relevance of the document. Parameters Style - Specifies the style of the relevance bar (default, boxes, stars). Color - Specifies the color of the relevance bar. Width - Width of relevance bar Height - Height of relevance bar |
| {ResultID} |
Returns the Result List identifier |
| {RSS} |
Outputs the URL used to indicate an RSS feed. |
| {RSSLink} |
Outputs the used to indicate an RSS feed, can be used in layout files. |
| {SearchTime} |
Returns the number of seconds it took to execute the search, rounded to two decimal places. |
| {SearchURL} |
A URL to the page from which the search was initiated. |
| {ShortName} |
Displays file name of document, allowing you to control how many parent folders to display. Parameters Folders - The number of folders to display. |
| {SimilarDoc} |
Executes a search to find documents similar to the specified document in the index(es) that were previously searched. |
| {SortBy} |
Returns a url that can be used to generate links that resort the current result list. Parameters Mode - Sort mode indicator. See Help |
| {SortByMeta} |
Returns a url that can be used to generate links that resort the current result list. Parameters ... - Specifies the metadata field to sort by. |
| {SortLink} |
Outputs a hyperlink to resort the result list, this also includes an image indicating the direction of the sort. Parameters Caption - Mode - Sort mode indicator. See Help CssClass - CssClass - |
| {SpellingTips} |
Displays an alternative spelling suggestion, if available. Parameters ... - Any text to display before the spelling suggestion. |
| {SubscribeUrl} |
Returns the URL that can be used to subscribe to this search. |
| {Summary} |
Same as {Lines}. |
| {ThisBatch} |
A URL linking to the current page of results. |
| {Title} |
The title of a document. |
| {TotalHits} |
Total number of found words (hits). |
| {URL} |
A URL that leads to the original legacy form of a document. |
| {ZipMemberName} |
Substituted for the actual file name of a document inside a zip file. |