Aras Innovator 30 - HTML to PDF Converter Setup Guide

Aras Innovator 30

HTML to PDF Converter Setup Guide

Document #: D-008111

Last Modified: 11/15/2023

Aras Innovator 30

HTML to PDF Converter Setup Guide

Aras Corporation

100 Brickstone Square

Suite 100

Andover, MA 01810

Phone: 978-691-8900

E-mail: [email protected]

Website: https://www.aras.com/

Notice of Rights

This document is protected by U.S. and international copyright laws and conventions. No copyright may be obscured or removed

from this document. This document may not be modified or altered, or reproduced or transmitted in any form, without the explicit

permission of the copyright holder.

Aras Innovator, Aras, and the Aras Corp "A" logo are registered trademarks of Aras Corporation in the United States and other

countries.

All other trademarks referenced herein are the property of their respective owners.

Notice of Liability

THIS DOCUMENT IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY, AND THE CONTENTS HEREOF ARE SUBJECT

TO CHANGE WITHOUT NOTICE. THE INFORMATION CONTAINED IN THIS DOCUMENT IS DISTRIBUTED ON AN "AS IS"

BASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR A WARRANTY OF NON-

INFRINGEMENT. ARAS SHALL HAVE NO LIABILITY TO ANY PERSON OR ENTITY WITH RESPECT TO ANY LOSS OR

DAMAGE CAUSED OR ALLEGED TO BE CAUSED DIRECTLY OR INDIRECTLY BY THE INFORMATION CONTAINED IN THIS

DOCUMENT OR BY THE SOFTWARE OR HARDWARE PRODUCTS DESCRIBED HEREIN.

Aras Innovator 30

HTML to PDF Converter Setup Guide

Table of Contents

Send Us Your Comments ............................................................................................. 4

Document Conventions ................................................................................................ 5

1 Overview ................................................................................................................... 6

2 Prerequisites ............................................................................................................ 7

2.1 Microsoft Visual C++ Redistributable Package ............................................................................ 7

2.2 Feature License Key .................................................................................................................... 7

2.2.1 Requesting a Feature License ...................................................................................... 7

2.2.2 Installing the License ..................................................................................................... 8

3 Installing the Aras HTML to PDF Converter .......................................................... 9

3.1 Installation Process ...................................................................................................................... 9

3.2 Configuring the Conversion Server .............................................................................................. 9

Aras Innovator 30

HTML to PDF Converter Setup Guide

Send Us Your Comments

Aras Corporation welcomes your comments and suggestions on the quality and usefulness of this

document. Your input is an important part of the information used for future revisions.

o Did you find any errors?

o Is the information clearly presented?

o Do you need more information? If so, where and what level of detail?

o Are the examples correct? Do you need more examples?

o What features did you like most?

If you find any errors or have any other suggestions for improvement, indicate the document title, and the

chapter, section, and page number (if available).

You can send comments to us in the following ways:

Email:

[email protected]

Subject: Aras Product Documentation

Or,

Postal service:

Aras Corporation

100 Brickstone Square

Suite 100

Andover, MA 01810

Attention: Aras Technical Documentation

If you would like a reply, provide your name, email address, address, and telephone number.

If you have usage issues with the software, visit https://www.aras.com/support/

Aras Innovator 30

HTML to PDF Converter Setup Guide

Document Conventions

The following table highlights the document conventions used in the document:

Convention

Description

Bold

This shows the names of menu items, dialog boxes, dialog

box elements, and commands.

Example: Click OK.

Code

Code examples appear in courier font. It may represent

text you type or data you read.

Yellow highlight

Code highlighted in yellow draws attention to the code that

is being indicated in the content.

Yellow highlight

with red text

Red text highlighted in yellow indicates the code parameter

that needs to be changed or replaced.

Italics

Reference to other documents.

Note:

Notes contain additional useful information.

Warning

Warnings contain important information. Pay special

attention to information highlighted this way.

Successive menu

choices

Successive menu choices may appear with a greater than

sign (-->) between the items that you select consecutively.

Example: Navigate to File --> Save --> OK.

Aras Innovator 30

HTML to PDF Converter Setup Guide

1 Overview

The Aras Innovator Conversion Server is a framework to manage file conversion processes used to

transform native files into other viewable formats such as TIFF or PDF.

This document walks through installation of the Aras HTML to PDF Converter used to convert HTML into

PDF files.

Aras Innovator 30

HTML to PDF Converter Setup Guide

2 Prerequisites

Before proceeding, you need to install a Conversion Server and make sure that you meet the additional

prerequisites.

For instructions on installing a conversion server, see the Aras Innovator 30 – Installation Guide.

2.1 Microsoft Visual C++ Redistributable Package

You must install The Microsoft Visual C++ 2010, 2012, 2013, and 2015 Redistributable Packages on the

Conversion Server in order to run the Aras Innovator HTML to PDF Converter. The links to these

downloads can be found at Microsoft’s latest supported Visual C++:

Microsoft Visual C++ 2010, 2012, 2013, and 2015 Redistributable Packages (x64):

https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-

downloads

The following redistributable packages are required to be installed in order to use the HOOPS

communicator on the Windows operating system:

• Microsoft Visual C++ 2010 64-bit redistributable

• Microsoft Visual C++ 2012 64-bit redistributable

• Microsoft Visual C++ 2013 64-bit redistributable

• Microsoft Visual C++ 2015 64-bit redistributable

2.2 Feature License Key

The Aras Innovator HTML to PDF Converter requires a Feature License in order to run.

To check whether a valid Feature License exists in Aras Innovator:

1. Log into Aras Innovator as an administrator.

2. Go to Administration --> Feature Licenses.

3. If an Aras.HTMLtoPDFConverter feature license is found, check the expiration date to confirm

that the license is still active.

2.2.1 Requesting a Feature License

In order to request a feature license activation key, customers with an active Aras subscription can send

an email to [email protected] or to your account representative in the following format:

• Subject: Aras Innovator HTML to PDF Converter Activation Key Required

• Body: Version of Aras Innovator

You will receive a reply containing the Feature License activation key.

Aras Innovator 30

HTML to PDF Converter Setup Guide

2.2.2 Installing the License

Once you have the activation key, install the feature license as follows:

1. Log into Aras Innovator as an administrator.

2. Click the User Menu icon , and select Activate Feature from the dropdown menu.

Figure 1.

3. Paste the acquired activation key and click Activate Feature. A success message should pop up.

Aras Innovator 30

HTML to PDF Converter Setup Guide

3 Installing the Aras HTML to PDF Converter

The Aras HTML to PDF Converter consists of files that get imported on top of the existing Aras

Conversion Server.

3.1 Installation Process

To install the Aras HTML to PDF Converter:

1. Copy the Aras HTML to PDF Converter package to a local drive on the Conversion Server.

This Aras HTML to PDF Converter folder is in the Utilities directory of the Aras Innovator CD

Image on the Aras FTP website (ftp://ftp.aras.com/InnovatorLatestRelease/)

2. Copy the ‘ConversionServer’ folder to the root directory where the Conversion Server was

installed, overwriting the existing ‘ConversionServer’ folder and its contents.

Figure 2.

3. Restart IIS.

3.2 Configuring the Conversion Server

After you install the Aras HTML to PDF Converter, configure the ConversionServerConfig.xml file as

follows:

1. Open ConversionServerConfig.xml file for editing.

Typically, this file is located at the root of the Aras Innovator code tree (Sample:

C:\Program Files (x86)\Aras\Innovator\ConversionServerConfig.xml)

2. After the comment <!-- Place here class configuration section definitions

for converters --> add:

<section name="PdfPublishingConverter"

type="Aras.Publishing.Configuration.PdfConverterConfig,

Aras.TDF.PublishingConverter"></section>

3. Into the section <Converters/> add:

<Converter name="tp_PdfPublishingConverter"

type="Aras.Publishing.PdfPublishingConverter,

Aras.TDF.PublishingConverter"/>

Aras Innovator 30

HTML to PDF Converter Setup Guide

4. Into the section <ConverterSettings/> after the comment <!-- Place here

configuration sections for converters --> add:

<ConvertionTool path="C:\Program Files

(x86)\Aras\Innovator\ConversionServer\Prince\bin\prince.exe"/>

</PdfPublishingConverter>

Note: The path may need to be modified to match the location of your ConversionServer

directory.

The following is a sample of a ConversionServerConfig.xml file with the required setup:

<?xml version="1.0" encoding="utf-8"?>

<section name="ConversionServer"

type="Aras.ConversionFramework.ConversionServer.Configuration.ConversionServerConfiguration

Section, Conversion_Base"/>

<section name="PdfPublishingConverter"

type="Aras.Publishing.Configuration.PdfConverterConfig,

Aras.TDF.PublishingConverter"></section>

</sectionGroup>

</configSections>

<InnovatorServer

url="http://localhost/InnovatorServer/Server/InnovatorServer.aspx"/>

<Converter name="tp_PdfPublishingConverter"

type="Aras.Publishing.PdfPublishingConverter, Aras.TDF.PublishingConverter"/>

</Converters>

</ConversionServer>

<ConvertionTool path="C:\Program Files

(x86)\Aras\Innovator\ConversionServer\Prince\bin\prince.exe"/>

</PdfPublishingConverter>

</ConverterSettings>

</configuration>

5. Save and close the ConversionServerConfig.xml file.

6. Confirm that the Conversion Server is configured to run via the Aras Agent Service. For details,

see Section 4.1 of the Aras Innovator 30 – Conversion Server Setup Guide.

Note: Because of difference between Windows and Linux file systems it is required to use OS-specific

path separator in paths. Remember that Linux file system is case sensitive so file names

"./path/to/file.xml" and "./path/to/File.xml" are different. For more information

about cross-platform development please see section "2.3 Cross-platform development"

in "Aras Innovator 30 - Programmer's Guide" document.