If using DocFetch, this method returns a file path to the document in the backend repository.

Return Value

the path to the file

Remarks

During crawl-time indexing, this file will be copied to the Web-accessible

IndexFilePath

location specified in the IndexFilePath parameter of the Web.Config file. The value returned by getDocument will then be appended to the value entered in the IndexURLPrefix parameter in the same Web.Config file and will be returned to the portal via a URL to that temporary location. During click-through, this file will be streamed back via the DocFetch servlet to the browser. Note that the IndexFilePath must be web-accessible, the IndexURLPrefix must point to the IndexFilePath, and the IndexURLPrefix must be a full url, i.e. start with http:// or https://. If any cleanup is required due to temporary file usage, it should be done on subsequent calls to IDocumentProvider.AttachToDocument() and IDocumentProvider.Shutdown(). If not using DocFetch, this method should just return an empty string "".

See Also

IDocument Interface | Plumtree.Remote.Crawler Namespace

---