To convert an HTML document to PDF in Appian, install Vuram Technology’s HTML To PDF Conversion plug-in from the Appian AppMarket and use its Smart Service in a process model. Give it an Appian Document containing the HTML, set the output name and destination folder, and capture its returned document and error outputs. The plug-in listing describes it as free; it also warns that HTML tags such as <br> and <img> must be properly closed.
Which Appian plug-in should you use?
For an Appian workflow whose input is an HTML document and whose output should be a PDF document, the dedicated choice is Vuram Technology’s HTML To PDF Conversion plug-in. Its Appian AppMarket listing describes a Smart Service that accepts a source HTML Document and creates a PDF Document in a folder you select. The listing calls the plug-in free, community supported, and not supported by the author, so distinguish the listing’s price from a promise of vendor-backed support.
The current AppMarket record in the information available here lists version 3.0.1, compatibility with Appian 23.2, first release on 2020-06-15, and last update on 2025-12-02. Compatibility and release metadata can change; check the AppMarket record for your target environment before deploying. This record does not establish approval for every Appian Cloud environment, nor does it guarantee identical output for every HTML/CSS feature.
Install and configure the Smart Service
- Check the target environment. Confirm the plug-in’s current compatibility information in Appian AppMarket and follow your organization’s Appian deployment and approval process.
- Install the plug-in. Add the AppMarket plug-in to the environment in which the process model will run. For traditional plug-in deployment, Appian documentation describes JARs under
APPIAN_INSTALL/_admin/plugins/; each JAR must include anappian-plugin.xmlmanifest at its root. Appian can hot-deploy according to the configured plug-in polling interval; if that interval is zero, hot deployment is disabled and an application-server restart is required. Use the deployment method applicable to your environment rather than assuming that a traditional installation path applies to every hosted setup. - Prepare the input. Store the HTML as an Appian Document accessible to the process model. Check that it is valid enough for the converter and that any referenced images can be reached by the conversion process.
- Add the Smart Service to a process model. Select the HTML-to-PDF conversion node, then map the source HTML document and provide a new document name, description, and destination folder.
- Capture the outputs. Map New Document Created, Error Message, and Error Occurred to process variables. Use the error flag and message to route failures rather than treating an empty output as a successful conversion.
- Test with representative content. Run the process with a short HTML file first, then test the actual document’s images, styles, page breaks, and expected page count before relying on it in production.
Input and output mapping
| Smart Service field or output | What to provide or do |
|---|---|
| Source Document | The Appian Document containing the HTML to convert. |
| New Document Name | A meaningful name for the created PDF document. |
| New Document Desc | A description suitable for the generated document. |
| Save In Folder | The Appian folder where the PDF should be stored. |
| New Document Created | Capture the generated document reference and pass it to downstream process steps. |
| Error Message and Error Occurred | Capture both, then use them to identify and handle a failed conversion. |
Use a unique or otherwise collision-safe output name if repeated process runs could write to the same folder. The plug-in information here does not specify its behavior for duplicate names, so do not assume it overwrites, versions, or rejects a collision in a particular way.
Recommended Free Tools
Prepare HTML that the converter can handle
The plug-in listing specifically cautions that tags must be properly closed, naming <br> and <img> as examples. Even though some browsers tolerate unclosed markup, do not rely on browser error recovery for this conversion. Make the source markup explicit and well-formed, and validate it before debugging the process model.
Styles, images, and layout
- CSS: The listing says inline and internal styles are accepted. It does not establish full browser CSS parity, so test the specific selectors and layout features your document depends on.
- Images: Publicly hosted images are supported according to the listing, but the conversion process must be able to access the image URL. A URL that works in your desktop browser may still be inaccessible from the server environment.
- Appian images: Version 2.1.0 added support for Appian images using an
appiandocidimage attribute when the environment can access the internal file path. Verify that condition in your environment; do not assume all Appian image references will resolve automatically. - Page count: Multi-page PDFs are created according to content. The available product information does not specify a deterministic pagination algorithm or promise pixel-perfect reproduction of a browser view.
- Fonts: Version 2.1.10 fixed setting a specific font. Since that is a historical release note rather than a specification of every supported font, test the required font and ensure it is available to the conversion environment.
Orientation, page numbers, and custom fonts
Landscape orientation was added in version 2.0.0. Version 2.1.0 added Smart Services for page numbers and custom fonts. Version 2.1.9 fixed landscape-mode generation, and version 2.1.10 fixed setting a specific font. These release notes indicate that the plug-in has offered these capabilities, but the 3.0.0 release deprecated existing nodes in favor of new Smart Service nodes. When updating, use the current nodes and inspect existing process models rather than assuming old nodes and configuration behave identically.
Rank #2
Choose between HTML To PDF Conversion and Document Utilities
Appian also lists a Document Utilities plug-in. It is worth considering when the workflow needs more than HTML-to-PDF conversion: its listing includes HTML-to-DOCX and PDF-to-DOCX as well. Full functionality requires an Aspose PDF for Java license, unlike the free listing for the dedicated Vuram conversion plug-in.
| Consideration | HTML To PDF Conversion | Document Utilities |
|---|---|---|
| Outputs identified in the listing | HTML to PDF. | HTML to PDF, HTML to DOCX, and PDF to DOCX. |
| License / listing | Listing describes it as free; community supported and not supported by the author. | Full functionality requires an Aspose PDF for Java license. |
| Layout capabilities noted | Inline/internal styles and publicly hosted images; landscape orientation and Smart Services for page numbers and custom fonts appear in release history. | The information available here does not detail its CSS, image, or page-layout behavior. |
| Timeout information | Version 3.0.0 introduced new Smart Service nodes with a timeout parameter. | Timeout behavior is not stated in the listing information summarized here. |
| Deployment and compatibility | AppMarket record lists version 3.0.1 and Appian 23.2 compatibility, last updated 2025-12-02. | Current version and compatibility are not stated here; check its AppMarket record. |
| Support model | Community supported; not supported by the author, according to the listing. | The support model is not stated here. |
For a process whose only required output is PDF, the dedicated conversion plug-in is the direct fit. Choose Document Utilities when DOCX generation or PDF-to-DOCX conversion is a real requirement and the licensing condition is acceptable. Compare the current AppMarket entries and your environment’s compatibility before choosing either; the available listing details do not support a broader claim that one is universally more reliable or more faithful to a browser.
Do these 3 things before closing this tab:
1Repair Windows errors before they cause bigger problems2Scan for outdated or missing drivers - takes under a minute3Clear out junk files and repair common Windows errorsWhat changed across plug-in versions?
- 2.0.0: Added landscape orientation.
- 2.1.0: Updated the conversion JAR to address image-rendering issues; added Appian image support using an
appiandocidattribute when the environment can access the internal file path; added Smart Services for page numbers and custom fonts. - 2.1.9: Fixed landscape-mode generation.
- 2.1.10: Fixed setting a specific font.
- 2.1.11: Added conversion of an Appian Image to PDF.
- 3.0.0: Deprecated existing nodes in favor of new Smart Service nodes with the same functionality, a timeout parameter, and updated libraries.
- 3.0.1: The version listed in the AppMarket record described above.
Release history is useful when investigating older process models, but it is not a substitute for testing the version actually installed. If a model uses deprecated nodes, plan a controlled update and confirm that input mappings, output handling, and timeout settings are correct on the new node.
Troubleshoot failed or unexpected conversions
| Symptom | Likely check | Practical next step |
|---|---|---|
| The node errors immediately | Malformed HTML or unclosed tags; the listing calls out <br> and <img>. |
Validate and normalize the HTML, explicitly close tags, then retry with a minimal document. |
| A remote image is missing | The conversion environment may not be able to reach the image URL. | Test the URL from an environment with equivalent network access, and confirm it is publicly reachable if using the publicly hosted image path. |
| An Appian image does not render | Internal file-path access required for the appiandocid route may not be available. |
Verify that the environment can access the internal path and check the image reference in the HTML. |
| Layout is wrong or content spills unexpectedly | CSS behavior, content length, font availability, or page layout may differ from expectations. | Reduce to a minimal HTML test, then restore styles and content incrementally; test the needed orientation and page-number behavior on the installed node. |
| Landscape output is not as expected | Older node behavior or an older plug-in version may be involved; landscape generation received a fix in version 2.1.9. | Confirm the installed version and whether the process uses the current Smart Service node. |
| The process times out on a large document | Version 3.0.0 added a timeout parameter to the new nodes, but the available information does not state a recommended value or universal limit. | Review the node’s timeout configuration, test with representative document sizes, and handle timeout errors explicitly. |
| The plug-in does not appear after installation | Deployment method, plug-in polling interval, or application-server restart requirement may apply. | Check deployment status and the configured polling interval; when hot deployment is disabled, arrange the required application-server restart. |
In the process model, retain the error outputs even when a test appears to succeed. A successful run should give downstream steps a usable created-document reference; a failure should be observable through the error flag and message so that it can be logged or routed for correction.
Rank #4
Or skip the browser setup
If your actual task is capturing a published web page as a PDF or screenshot, rather than converting an Appian-stored HTML document inside a process model, ScreenshotNeo offers a one-request API. This does not replace the Appian Smart Service workflow described above; it is an alternative for URL-based capture. See the ScreenshotNeo API documentation.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpScreenshotNeo accepts a URL and returns PNG, JPEG, WebP, or PDF. It accepts cookie or consent banners like a visitor and removes more than 60 known consent platforms, newsletter popups, and chat widgets before capture; those cleanup steps can be disabled individually. Bot checks/CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed, and response headers identify the page verdict and billing status. Its MCP server provides take_screenshot, get_page_info, and capture_pdf for AI agents and MCP clients. The free plan includes 1,000 shots a month without a card; paid plans start at $5 for 3,000 shots.
Start free with ScreenshotNeo: 1,000 screenshots a month, no card required.
Best Value
Frequently Asked Questions
Does the HTML To PDF Conversion plug-in require an Aspose license?
The Vuram listing describes its dedicated plug-in as free. The Aspose PDF for Java license requirement applies to full functionality of the separate Document Utilities plug-in.
Can the plug-in convert an Appian Image directly to PDF?
The release history says version 2.1.11 added conversion of an Appian Image to PDF. Check the installed version and current AppMarket details before depending on that capability.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
