IDOL Server 24.1

# Export

Converts a single local document to HTML and exports it as an HTML file (index.html), with all attachments and subdocuments (such as images and partition files), to a location that you specify.

## Example

    http://12.3.4.56:9000/action=Export&File=C:\reports\report1.doc&OutDir=C:\ReportsHTML\

This action converts the local file `report1.doc` into HTML, and exports it to `C:\ReportsHTML\`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
File | The local file to convert and export.
OutDir | The directory to export the converted HTML to.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Boolean | Whether to use phrases and query text for highlighting.
EndTag | The tag to use to mark the end of a highlighted term. If you set MultiHighlight to `True`, you must set the StartTag and EndTag for each link term.
Links | Terms to highlight.
MultiHighlight | Highlight multiple link terms with different HTML tags. If you set MultiHighlight to `True`, you must set the StartTag and EndTag for each link term.
StartTag | The tag to use to mark the beginning of a highlighted term. If you set MultiHighlight to `True`, you must set the StartTag and EndTag for each link term.
ViewTemplate | The template to use when converting the document content to HTML.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.1

Topic Title: Export