65
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 35 of 84
2.6.2.13 AutoCAD specific switches
The AutoCAD converter is highly configurable and allows the following
settings to be specified either globally,
for all requests using the service’s
config file, or on a request-by-request basis using the ConverterSpecific
Settings property on the web services interface.
For full details search the service’s config file for all keys starting with
CadConverterFullFidelity.
PaperSize: Specify the paper size of the generated PDF file, either using
standardised paper size names such as A4 or Letter, or using custom
dimensions in inches or millimetres.
PageMargin: Determine the margin around the page, either as a single
uniform value or using a different value for Left, Top, Right and Bottom .
PaperOrientation: Automatically detect the drawing
’
s orientation or force
it to Portrait or Landscape.
BackgroundColor: Some AutoCAD drawings have been created using a
non-white background colour, in which case you may want to force the
background colour in the PDF file using this setting.
ForeGroundColor: The PDF Converter supports a number of automatic
re-
colouring options to make sure that foreground colours don’t conflict
with background colours or to convert all colours to grey scale. For details
see the in-line
documentation in the service’s config file.
Content: By default all valid layouts found in a DXF or DWG file are
converted to PDF. However, you may want to override this setting and
only convert specific layouts. This can be particularly useful when
converting 3D AutoCAD files.
EmptyLayoutDetectionMode: Specifies how the conversion handles
empty or nearly empty layouts.
LayoutSortOrder: Specify the sort order for layout names.
2.6.2.14 MSG & EML (email) specific switches
The email converter allows the following settings to be specified either globally
for all requests,
using the service’s config file
, or on a request-by-request
basis using the ConverterSpecificSettings property on the web services
interface.
For full details search the service’s config file for all keys starting with
MSGConverterFullFidelity.
PaperSize: Specify the paper size of the generated PDF file, either using
standardised paper size names such as A4 or Letter, or using custom
dimensions in inches or millimetres.
ConvertAttachments: This config value determines if email attachments
will be converted (and merged to the main email), or not.
DisplayAttachmentSummary: Specify whether the attachment filenames
are displayed in the email header. This setting works independently to
ConvertAttachments.
63
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 36 of 84
HTMLScaleMode: Define how images inside HTML based emails are
scaled. Unless you have a real good reason to change this value, leave it
on the default FitWidthScaleImagesOnly setting.
PlainTextBodyLineBreaks: Determine how return characters (new lines)
in plain text MSG bodies are handled. By default, Outlook removes certain
return characters in plain text emails and the PDF Converter emulates this
behaviour. Accepted values are:
o
RetainAll - All carriage returns in the plain text message are retained.
Lines may wrap before 80 characters in length.
o
RemoveExtra - Lines that appear to be wrapped due to their length
have the return characters removed. Similar
to Outlook’s
implementation.
o
Legacy - A legacy implementation of RemoveExtra used prior to
version 7.1 of the PDF Converter
BestBodyMode: Determines which email body content (Text / HTML /
RTF / RTFHTML) to extract when processing MSG files. Accepted values
are:
o
Strict - Implementation of the MS-OXBBODY Best Body algorithm.
When RTF content is in sync with the native email content (HTML /
Text) the RTF content takes precedence.
o
Default - The default implementation uses the first content found in
order of HTML, RTFHTML, RTFTEXT, RTFTEXT and lastly Text.
NOTE: Always used when converting EML emails.
EmailAddressDisplayMode: Determines how email addresses (except
the From address or Calendar Organizer) are displayed. Where multiple
types of email addresses are found (SMTP, Exchange), the SMTP
address is favoured. Accepted values are:
o
Name - Display the email name only, omitting any address details. If
the name is not found the email address is displayed.
o
NameAndAddress - Display both the name and email address.
o
Address - Display the email address only, omitting any name details. If
the email address is not found, the name is displayed.
o
NameAndSMTPAddress - Display the email recipient name as well as
their email address, but only if an SMTP address is found.
FromEmailAddressDisplayMode: As per EmailAddressDisplayMode
except only applicable to the From addresses and Calendar Organizer.
BreakOnUnsupportedAttachment: When an unsupported attachment is
found, the conversion is halted and an error message is returned.
BreakOnUnsupportedEmbeddedObject: When an unsupported
embedded object is found, e.g. an embedded OLE object where no file
type identification is provided, the conversion is halted and an error
message is returned.
63
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 37 of 84
EmbeddedObjectDisplayMode: Determines how embedded objects are
displayed. NOTE: Where the embedded object is displayed as an icon,
use EmbeddedObjectIconDisplayMode. Accepted values are:
o
InlineNoScale - The embedded object is displayed as it appears in
Outlook. If the object is larger than the current page size, it will be
cropped.
o
InlineFitWidth - The embedded object is scaled so that its (width)
content fits on the page.
o
Disabled - The embedded object is hidden from any output.
EmbeddedObjectIconDisplayMode: Determines how embedded objects
are displayed where they are stored as an icon. Accepted values are:
o
IconOnly - The embedded object icon is displayed as it appears in
Outlook.
o
Disabled - The embedded object icon is hidden from any output.
SentDateMissingDisplayMode: Control what is displayed when the sent
date of an email is not found (ie, the email was never sent).
Accepted values are:
o
ModifiedDate - Displays the modified date of the MSG file itself (not
supported in EML)
o
Any Text - Displays the text as entered.
2.6.2.15 Switches used for overriding settings
The following settings can be changed to allow any client side settings to be
globally overridden. Unless you have a specific reason to change them, leave
these settings alone.
Merging.ForceBreakOnError: Override the BreakOnError value during
merge oeprations. Leave empty to use the setting specified in the web
service call (MergeSettings). Specify 'True' to fail the entire operation when
an error occurs. Use 'False' to continue and skip any problematic files.
Merging.ForceOmitErrorPages: Override the OmitErrorPages value during
merge operations. Leave empty to use the setting specified in the web
service call (MergeSettings). Specify 'False' to insert pages into the PDF
indicating that an error has occurred while converting a specific document.
Merging.StripDigitalSignatures: When merging PDF files (or InfoPath /
MSG attachments) that contain digital signatures then please set this value to
'true' to remove all digital signatures. Signed documents cannot be merged.
Merging.ForceDocumentStartPage: Leave empty to use the setting
specified in the web service call (MergeSettings) or specify one of the
following options:
o
Next - When merging, start each document on the next page.
o
Odd - When merging, start each document on an odd page (usually the
right hand page when printing double sided).
o
Even - When merging, start each document on the next even page.
72
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 38 of 84
OpenOptions.ForceAllowMacros: Override the AllowMacros value during
conversion. Leave empty to use the setting specified in the web service call
(in OpenOptions). Accepted values are members of the Muhimbi.
DocumentConverter.WebService.Data.MacroSecurityOption enumeration or
an empty string.
o
None - Don't allow any macros to run
o
SignedOnly - Only allow macros to run with a valid digital signature
o
All - Allow all macros, regardless of their origin and digital signature. This
is not recommended as it may compromise the security of the server.
OpenOptions.ForceRefreshContent: Override the RefreshContent value
during conversion. Leave empty to use the setting specified in the web
service call (in OpenOptions). Accepted values are 'true', 'false' or empty
string.
ConversionSettings.ForceQuality: Override the Quality value during
conversion. Leave empty to use the setting specified in the web service call
(in ConversionSettings). Accepted values are members of the Muhimbi.
DocumentConverter.WebService.Data.ConversionQuality enumeration or an
empty string.
o
OptimizeForPrint - Optimise the file size and resolution for print purposes.
o
OptimizeForOnScreen - Optimise the file size and resolution for use on a
computer screen
ConversionSettings.ForceRange: Override the Range value during
conversion. Leave empty to use the setting specified in the web service call
(in ConversionSettings). Accepted values are members of the Muhimbi.
DocumentConverter.WebService.Data.ConversionRange enumeration or an
empty string.
o
VisibleDocuments - Skips, in case of Excel and PowerPoint, any hidden
tabs or slides.
o
AllDocuments - Export all tabs or slides in a workspace.
o
ActiveDocuments - Exports, in case of Excel, the selected tabs.
ConversionSettings.ForceGenerateBookmarks:
Override
the
GenerateBookmarks value during conversion. Leave empty to use the
setting specified in the web service call (in ConversionSettings).
Accepted values are members of the Muhimbi.DocumentConverter.
WebService.Data.BookmarkGenerationOption enumeration or an empty
string.
o
Disabled - Don't generate any bookmarks.
o
Automatic - Based on headings, if applicable.
o
Custom - Based on bookmarks defined in the document, e.g. MS-Word
Bookmarks, if applicable.
ConversionSettings.ForcePDFProfile: Override the PDFProfile value
during conversion. Leave empty to use the setting specified in the web
service call (in ConversionSettings). Accepted values are members of the
Muhimbi.DocumentConverter.WebService.Data.PDFProfile enumeration or
an empty string.
o
PDF_1_5 - Use PDF Version 1.5
o
PDF_A1B - Use the PDF/A standard for long term archiving
47
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 39 of 84
2.6.2.16 PDF & Security Settings
The default PDF Security and Encryption settings have been designed to be
compatible with the widest possible range of PDF Readers. However, this
means that security has been ‘dumbed down’ a bit. If all your
users are on
relatively recent versions of PDF Readers then you may want to tighten up the
security settings.
PDF.EncryptionKeySize: Set the security key size for encrypting PDF files.
Possible values are 40, 128 and 256. Please note that 256 Bit is not
supported on versions of Acrobat older than version 9 and many other PDF
readers.
PDF.EncryptionAlgorithm: Set the security algorithm, either RC4 or AES.
Although cryptographically stronger, be careful when using AES as only
Acrobat Reader 7 or newer can open AES encrypted files.
PostProcessSecuredFiles: Define whether PDF files that are already
secured will be post processed by the system. Post processing can include
watermarking and applying security settings.
PostProcessPDF1.5: For legacy reasons PDFProfile.PDF_1_5 is treated the
same as the PDFProfile.Default PDF output type. As a result it is not
guaranteed to be 100% 1.5 compliant. Enable this setting to make sure the
file is post processed and forced to be 1.5 compliant. (Requires Pro license)
ConvertAttachments: Convert, and merge, files that are attached to the
PDF. This setting is disabled by default.
ConvertAttachmentMode: What to do with attachments after conversion
(Only used when PDF.ConvertAttachments is enabled):
o
RemoveAll: Convert and delete all files attached to the PDF, even file
formats not supported by the converter. This is the default setting.
o
RemoveSupported: Convert and delete all files supported by the PDF
converter, but leave unsupported files attached.
2.6.3 Hardening the Conversion Service
Some environments have particularly strict security requirements and require
the server running the conversion service to be 'hardened' from a security
perspective. For detailed guidance on this topic see the Knowledge Base
article at http://support.muhimbi.com/entries/23471233
.
59
PDF Converter - Installation & Administration Guide
PDF Converter - Installation & Administration Guide - Version 8.0 - 15/10/15
© Copyright 2015, Muhimbi Ltd
Page 40 of 84
2.7 Un-installation
Both parts of the solution, the Conversion Service as well as the SharePoint
front end,
can be uninstalled using Windows’
Add or Remove programs facility
(appwiz.cpl). Even though the SharePoint front-end may have been rolled out
to multiple servers, the uninstaller is only present on the server where the
original installation was carried out.
If, for whatever reason, the SharePoint front-end must be uninstalled by hand
then please follow the steps outlined below:
1.
Open Central Administration and navigate to Solution Management:
a. SharePoint 2007: Operations > Solution Management.
b. SharePoint 2010 (and later): Central Administration > System
Settings > Manage Farm Solutions.
2.
For each of the Muhimbi PDF Conversion related WSPs follow these
steps:
a. Click on the Solution to retract, e.g.
‘Muhimbi.pdfconverter.wsp’.
b.
Click the ‘
Retract Solution
’ button.
c. Accept the default settings and click OK.
d. Depending on the size of the web farm this may take a few minutes.
Refresh the ‘
Solution Management
’ page until the status is set to ‘Not
Deployed’
e. Click on the solution name again.
f. Click the
‘
Remove Solution
’
button to completely remove it from the
farm.
2.8 Upgrading from a previous version
Although the PDF Converter is a friendly and well tested application, its
underpinnings are quite complex. It is rare for the Muhimbi support desk to
receive any complaints about the upgrading process, yet
we don¶t recommend
upgrading unless there is a specific feature in a new version that you need.
We recommend following industry best practices and deploy the new version
in Development and Test environments first and only deploy to Production
after thorough testing.
Upgrading the software from a previous version is simple and straight forward.
However, there are some things to take into account.
1.
Service’s config fi
le: The Conversion Service uses a standard .config file
to control the default behaviour of the product (see 2.6.2 Fine-tuning the
Document Conversion service). Please note that any changes to this file
are not maintained during an upgrade. You will need to manually re-apply
any changes that may have been made since the previous installation.
Documents you may be interested
Documents you may be interested
