UrlPrefix

A prefix to apply to relative or inline (constructed) link URLs in the document. Use this prefix to direct the links to your viewing client application.

By default, when the View component returns a file that contains a subdocument, such as an image, it replaces the link to the subdocument with a path that includes its own IP address, so that it can find and return the image URLs. In most production setups, your end users do not have direct access to the View component by IP, and these requests for the subdocuments would fail.

Instead, you can use URLPrefix to define a link to use to point to the View component by host name, or to point to a Web server that serves up the links. When you specify a URL prefix, IDOL Server replaces all links to subdocuments with this prefix and a LinkSpec.

To view a subdocument, use the GetLink action, and pass the link to the subdocument in the LinkSpec parameter. For example:

URLPrefix=http://ViewserverHostname:14000/action=GetLink&noaci=True&linkspec=

You can specify a default value for UrlPrefix in the DefaultURLPrefix configuration parameter. If you do not set UrlPrefix or DefaultURLPrefix, links to subdocuments point back to the IDOL Server by IP address.

If UrlPrefix points to a Web server, IDOL Server uses the Web server to serve up links. For example:

URLPrefix=http://apacheserver/alias/

NOTE: By default, IDOL Server does not add the specified UrlPrefix to absolute links (full URLs). To edit these links, use the AbsoluteLinkPrefix configuration parameter.

NOTE: You can also use EmbedImages to base64 encode any images in the converted documents and include the data in the response, rather than using links.

Actions: GetLink
ViewGetDocInfo
View
Type: String
Default: DefaultURLPrefix
Example: UrlPrefix=http://myview:8080/action=GetLink&NoACI=True&LinkSpec=
See Also: EmbedImages
AbsoluteLinkPrefix configuration parameter
DefaultURLPrefix configuration parameter
RedirectAbsoluteLinks configuration parameter