Go to main content
1/18
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Conventions
1
What Is Transformation Server?
1.1
What's New in this Release
1.2
Components of Transformation Server
1.2.1
The Transformation Agent (TSAGENT)
1.2.2
The Transformation Manager (TSMANAGER)
1.2.3
The C Client Module (SCCTS)
1.2.4
The Java Client (TSAPI)
1.3
Architecture
1.3.1
The Transformation Manager
1.3.2
The Transformation Agent
1.3.3
C Language Client Module (sccts)
1.3.4
Java Client Object
1.4
Directory Structure
2
Installing and Running Transformation Server
2.1
Installation
2.1.1
Installing Multiple SDKs
2.1.2
Motif Library Compatibility Information
2.1.3
Visual C++ Redistributable Dependency
2.1.4
Environment Variables on UNIX
2.1.5
Libraries and Structure
2.2
Running Transformation Server
2.2.1
tsmanager
2.2.1.1
Startup Parameters
2.2.1.2
Command Line Options with Parameters
2.2.1.2.1
--host
2.2.1.2.2
--port
2.2.1.2.3
--pipedir
2.2.1.2.4
--numagents
2.2.1.3
Command Line Flags
2.2.1.3.1
--trace_on
2.2.1.3.2
--version
2.2.1.4
Command Line Syntax
2.2.1.5
Command Line Examples
2.2.1.6
Logging
2.2.1.7
Configuration File
2.2.2
tsagent
2.2.2.1
Command Line Flags with Parameters
2.2.2.1.1
--host
2.2.2.1.2
--port
2.2.2.2
Command Line Flags
2.2.2.2.1
--help
2.2.2.2.2
--oneclient
2.2.2.2.3
--standalone
2.2.2.2.4
--stdinout
2.2.2.2.5
--version
2.3
Configuration Files
2.3.1
Examples
2.4
The Option Set Editor
2.4.1
Using the Option Set Editor
2.5
Extending the Functionality of Transformation Server
3
Initiating Transformations Using the SOAP API
3.1
TransformRequest
3.2
TransformationResponse
3.3
Transformation Server's HTTP GET/POST Interface
3.3.1
Differences Between the HTTP POST/GET and Full SOAP/XML Interfaces
3.3.2
Using the GET/POST Interface
3.3.3
Example
3.3.3.1
Using the GET Interface
3.3.3.2
Using the POST Interface
3.3.3.3
The HTTP Response
3.3.4
Sample Pages
3.3.4.1
tsget.htm
3.3.4.2
tspost.htm
4
Initiating Transformations Using the C/C++ API
4.1
TSInit
4.1.1
TSINITPARAMSVER2 Structure
4.2
TSMemFree
4.3
TSSetOption
4.4
TSSetOptionById
4.5
TSRunTransform
4.6
TSDeInit
4.7
Sample Applications
4.7.1
tsclient
4.7.2
tsdemo
5
Initiating Transformations Using the Java API
5.1
Key Packages
5.2
Key Classes
5.3
Redirected IO
5.4
Sample Applications
5.4.1
TSJavaDemo
5.4.1.1
Notes on the Sample Application
5.4.2
URL Input and Output
5.4.3
Redirected Input and Output
6
Transformation Engine Specification
6.1
Getting Started
6.1.1
Transformation Engine Interface
6.1.1.1
Loading Mechanism
6.1.1.2
The Agent-to-Engine Interface
6.1.1.3
The Engine-to-Agent Interface
6.1.2
Required Header Files
6.1.3
Transformation Agent Configuration
6.2
Transformation Engine Entry Point
6.2.1
LoadEngine
6.3
Engine Interface
6.3.1
EngineInterface Structure
6.3.2
openTransform
6.3.3
setOption
6.3.4
transform
6.3.5
closeTransform
6.4
Agent Interface
6.4.1
AgentInterface Structure
6.4.2
openIO
6.4.3
addToOutputList
6.4.4
setResultMsg
6.4.5
logMessage
7
IO Provider Specification
7.1
IO Provider Interface
7.1.1
Why Use IO Providers?
7.1.2
IO Specifications
7.1.3
Server-Side Versus Client-Side IO Providers
7.1.4
The C Version
7.1.5
The Java Version
7.2
Configuration
7.2.1
Server-Side Versus Client-Side Operation
7.2.1.1
Installing an IO Provider on the Server
7.2.1.2
Using an IO Provider on the Client
7.3
IO Provider Entry Point
7.3.1
OpenIO
7.3.2
The BASEIO Structure
7.4
IO Provider Functions
7.4.1
IOClose
7.4.2
IORead
7.4.3
IOWrite
7.4.4
IOSeek
7.4.5
IOTell
7.4.6
IOGetInfo
7.4.6.1
IOGetInfo Info IDs
7.4.6.1.1
IOGETINFO_FILENAME_IOP
7.4.6.1.2
IOGETINFO_PATHNAME_IOP
7.4.6.1.3
IOGETINFO_HYPERLINK - HTML Export Only
7.4.6.1.4
IOGETINFO_GENSECONDARY_IOP
7.4.6.1.5
IOGETINFO_CREATENEWIOSPEC
7.4.6.1.6
IOGETINFO_PROVIDERDATA
7.5
IO Consumer Interface
7.5.1
Alloc
7.5.2
Free
7.5.3
UTF8toUCS2
7.5.4
UCS2toUTF8
7.5.5
IOConsumerInterface Data Structure
8
Upgrading Applications to Use Transformation Server
8.1
Basic Transformation Operations
8.2
Initialization and De-initialization
8.3
Setting Transformation Parameters
8.3.1
Options
8.3.1.1
Replacing the Document Handle with an "Option Set Handle"
8.3.1.2
Setting Options
8.3.1.3
Exceptions to This Rule (HTML Export Only)
8.3.2
Callbacks
8.3.2.1
EX_CALLBACK_ID_CREATENEWFILE
8.3.2.2
EX_CALLBACK_ID_NEWFILEINFO
8.3.2.3
EX_CALLBACK_ID_ALTLINK (HTML Export Only)
8.3.2.4
EX_CALLBACK_ID_PROCESSLINK (HTML Export Only)
8.3.2.5
Unsupported Callbacks
8.4
Performing a Transformation
8.4.1
Specifying Inputs and Outputs with TS_IOSpec
8.4.2
Initiating the Transformation
8.4.3
Inspecting the Results
8.5
Advanced Transformation Operations
8.5.1
Handling Redirected IO
8.5.1.1
Server-Side vs. Client-Side Redirected IO
8.5.1.2
What's Different About Redirected IO in Transformation Server
8.5.1.2.1
Specifying IO Targets
8.5.1.2.2
IOGetInfo Messages
8.5.1.3
Redirected IO on the Client Side
8.5.1.4
Redirected IO on the Server Side
8.6
How Embedded API Options Map to the New SOAP Options
8.6.1
XML Export
8.6.2
PDF Export
8.6.3
Image Export
8.6.4
Search Export
8.6.5
HTML Export
A
SOAP Data Types and Options
A.1
Simple Types
A.2
Complex Types
A.2.1
IOSpec
A.2.2
stringData
A.2.3
stringList
A.2.4
TransformResponse
A.3
Enumerations
A.3.1
CharacterByteOrderEnum
A.3.2
CharacterSetEnum
A.3.3
ComplianceEnum
A.3.4
DatabaseFitToPageEnum
A.3.5
DefaultInputCharSetEnum
A.3.6
DefaultPageUnitsEnum
A.3.7
DocumentMemoryModeEnum
A.3.8
EmailHeaderOutputEnum
A.3.9
ExtractEmbeddedFilesEnum
A.3.10
FallbackFormatEnum
A.3.11
FlavorEnum
A.3.12
GraphicCroppingEnum
A.3.13
GraphicSizeMethodEnum
A.3.14
GraphicTypeEnum
A.3.15
GraphicWatermarkScaleTypeEnum
A.3.16
GridAdvanceEnum
A.3.17
MimeHeaderOutputEnum
A.3.18
oleEmbeddingsEnum
A.3.19
ReorderMethodEnum
A.3.20
SearchMLUnmappedTextEnum
A.3.21
SpreadSheetBordersEnum
A.3.22
SpreadsheetFitToPageEnum
A.3.23
SpreadsheetPageDirectionEnum
A.3.24
TiffByteOrderEnum
A.3.25
TiffColorSpaceEnum
A.3.26
TiffCompressionEnum
A.3.27
TiffFillOrderEnum
A.3.28
WatermarkPositionEnum
A.3.29
WatermarkScalingEnum
A.3.30
XmlDefinitionMethodEnum
A.4
SOAP Options
A.4.1
How Options Work
A.4.2
Character Mapping
A.4.2.1
defaultInputCharset
A.4.2.2
characterByteOrder
A.4.2.3
outputCharacterSet
A.4.2.4
unmappableCharacter
A.4.3
Output
A.4.3.1
altlink
A.4.3.2
showChangeTracking
A.4.3.3
collapseWhiteSpace
A.4.3.4
compliance
A.4.3.5
extractEmbeddedFiles
A.4.3.6
flavor
A.4.3.7
noSourceFormatting
A.4.3.8
showHiddenSpreadsheetData
A.4.3.9
showHiddenText
A.4.3.10
simpleStyleNames
A.4.3.11
preferOITRendering
A.4.4
Input Handling
A.4.4.1
fallbackFormat
A.4.4.2
extendedTestForText
A.4.4.3
ignorePassword
A.4.4.4
oleEmbeddings
A.4.4.5
parseXMPMetaData
A.4.4.6
reorderBIDI
A.4.4.7
skipLinkedImages
A.4.4.8
timezone
A.4.4.9
extractXMPMetaData
A.4.4.10
htmlCondCommentIE5On
A.4.4.11
htmlCondCommentIE6On
A.4.4.12
htmlCondCommentIE7On
A.4.4.13
htmlCondCommentIE8On
A.4.4.14
htmlCondCommentIE9On
A.4.4.15
htmlCondCommentAllOn
A.4.4.16
pdfFilterDropHyphens
A.4.4.17
pdfFilterMaxEmbeddings
A.4.4.18
pdfFilterMaxVectorPaths
A.4.4.19
pdfFilterWordDelimiterFraction
A.4.5
Layout
A.4.5.1
fallbackFont
A.4.5.2
fontFlags
A.4.5.3
genBulletsAndNums
A.4.5.4
gridAdvance
A.4.5.5
gridCols
A.4.5.6
gridRows
A.4.5.7
gridWrap
A.4.5.8
javaScriptTabs
A.4.5.9
pageSize
A.4.5.10
preventGraphicOverlap
A.4.5.11
template
A.4.6
Compression
A.4.6.1
applyZLIB
A.4.6.2
allowJPEG
A.4.6.3
allowLZW
A.4.7
Graphics
A.4.7.1
acceptAlternateGraphics
A.4.7.2
graphicGifInterlaced
A.4.7.3
graphicCropping
A.4.7.4
graphicHeight
A.4.7.5
graphicHeightLimit
A.4.7.6
graphicOutputDPI
A.4.7.7
graphicSizeLimit
A.4.7.8
graphicSizeMethod
A.4.7.9
graphicTransparencyColor
A.4.7.10
graphicType
A.4.7.11
graphicWidth
A.4.7.12
graphicWidthLimit
A.4.7.13
tiffOptions
A.4.7.14
graphicJpegQuality
A.4.7.15
enableAlphaBlending
A.4.7.16
renderEmbeddedFonts
A.4.8
Spreadsheet and Database File Rendering
A.4.8.1
databaseFitToPage
A.4.8.2
databaseShowGridLines
A.4.8.3
databaseShowHeadings
A.4.8.4
maxSsDbPageHeight
A.4.8.5
maxSsDbPageWidth
A.4.8.6
showSpreadsheetBorder
A.4.8.7
spreadsheetBorders
A.4.8.8
showHiddenSpreadsheetCells
A.4.8.9
spreadsheetPageDirection
A.4.8.10
spreadsheetFitToPage
A.4.8.11
spreadsheetShowGridLines
A.4.8.12
spreadsheetShowHeadings
A.4.8.13
spreadsheetScalePercentage
A.4.8.14
spreadsheetScaleXPagesHigh
A.4.8.15
spreadsheetScaleXPagesWide
A.4.8.16
generateExcelRevisions
A.4.8.17
omitEmptyEdgeCells
A.4.9
Page Rendering
A.4.9.1
defaultMargins
A.4.9.2
defaultPageHeight
A.4.9.3
defaultPageWidth
A.4.9.4
defaultPageUnits
A.4.9.5
emailHeaderOutput
A.4.9.6
endPage
A.4.9.7
startPage
A.4.9.8
useDocumentPageSettings
A.4.9.9
usePageRange
A.4.10
Font Rendering
A.4.10.1
defaultFont
A.4.10.2
embedFonts
A.4.10.3
excludeFont
A.4.10.4
includeFont
A.4.10.5
fontDirectory
A.4.10.6
fontAlias
A.4.10.7
strokeText
A.4.11
Watermarks
A.4.11.1
graphicWatermarkOpacity
A.4.11.2
graphicWatermarkPath
A.4.11.3
graphicWatermarkScaleType
A.4.11.4
graphicWatermarkScalePercent
A.4.11.5
graphicWatermarkHorizPos
A.4.11.6
graphicWatermarkVertPos
A.4.11.7
enableWatermark
A.4.11.8
watermarkHorizOffset
A.4.11.9
watermarkImage
A.4.11.10
watermarkPosition
A.4.11.11
watermarkScalePercent
A.4.11.12
watermarkScaling
A.4.11.13
watermarkVertOffset
A.4.12
XML
A.4.12.1
allCapsOn
A.4.12.2
boldOn
A.4.12.3
cellInfoOn
A.4.12.4
changeNumbertoTextOn
A.4.12.5
documentPropertiesOn
A.4.12.6
doubleUnderlineOn
A.4.12.7
embeddingsOn
A.4.12.8
errorInfoOn
A.4.12.9
generateSystemMetaDataOn
A.4.12.10
hiddenCellInfoOn
A.4.12.11
hiddenOn
A.4.12.12
italicOn
A.4.12.13
metadataOnlyOn
A.4.12.14
originalCharsetOn
A.4.12.15
outlineOn
A.4.12.16
produceURLsOn
A.4.12.17
revisionAddOn
A.4.12.18
revisionDeleteOn
A.4.12.19
revisionsOn
A.4.12.20
smallCapsOn
A.4.12.21
strikeoutOn
A.4.12.22
underlineOn
A.4.12.23
xmlDefinitionMethod
A.4.12.24
xmlDefinitionLocation
A.4.12.25
nullReplacementCharacter
A.4.12.26
printerName
A.4.12.27
paragraphStyleNamesOn
A.4.12.28
includeTextOffsets
A.4.12.29
paragraphAttributes
A.4.12.30
unmappedText
A.4.12.31
suppressArchiveSubDocsOn
A.4.12.32
suppressAttachmentsOn
A.4.12.33
textOutOn
A.4.12.34
xmlDeclarationOff
A.4.12.35
optimizeSections
A.4.12.36
charMappingDefault
A.4.12.37
charMappingNone
A.4.12.38
charMappingText
A.4.12.39
charMappingBoth
A.4.12.40
convertChartObjects
A.4.12.41
convertDateTimeProperties
A.4.12.42
convertImageObjects
A.4.12.43
convertPresentationObjects
A.4.12.44
convertVectorObjects
A.4.12.45
delimiters
A.4.12.46
flattenStyles
A.4.12.47
noBitmapElements
A.4.12.48
noChartElements
A.4.12.49
noPresentationElements
A.4.12.50
noVectorElements
A.4.12.51
removeFontGroups
A.4.12.52
separateStyleTables
A.4.12.53
subStreamRoots
A.4.12.54
useFullFilePaths
A.4.13
File System
A.4.13.1
fileAccess
A.4.13.2
readBufferSize
A.4.13.3
memoryMappedInputSize
A.4.13.4
tempBufferSize
B
C/C++ Client Data Types
B.1
Simple Types
B.2
Complex Types
B.2.1
All Export Products
B.2.1.1
TS_binaryData
B.2.1.2
TS_char*
B.2.1.3
TS_IOSpec
B.2.1.4
TS_OutputList
B.2.1.5
TS_stringArray
B.2.1.6
TS_stringData
B.2.1.7
TS_TransformResult
B.2.2
HTML Export
B.2.2.1
OIT_AltLink
B.2.2.2
OIT_DefaultFont
B.2.2.3
OIT_FontFlags
B.2.3
Search Export
B.2.3.1
OIT_CharacterAttributes
B.2.3.2
OIT_ParagraphAttributes
B.2.3.3
OIT_SearchMLFlags
B.2.4
Image Export
B.2.4.1
OIT_DefaultFont
B.2.4.2
OIT_DefaultMargins
B.2.4.3
OIT_TiffOptions
B.3
Enumerations
B.3.1
All Export Products
B.3.1.1
OIT_DefaultInputCharSetEnum
B.3.1.2
OIT_FallbackFormatEnum
B.3.1.3
OIT_DocumentMemoryModeEnum
B.3.2
HTML Export
B.3.2.1
OIT_CharacterByteOrderEnum
B.3.2.2
OIT_ComplianceEnum
B.3.2.3
OIT_EmailHeaderOutputEnum
B.3.2.4
OIT_ExtractEmbeddedFilesEnum
B.3.2.5
OIT_FlavorEnum
B.3.2.6
OIT_GraphicSizeMethodEnum
B.3.2.7
OIT_GraphicTypeEnum
B.3.2.8
OIT_GridAdvanceEnum
B.3.2.9
OIT_ReorderMethodEnum
B.3.2.10
OIT_SpreadSheetBordersEnum
B.3.2.11
TS_CharacterSetEnum
B.3.3
Search Export
B.3.3.1
OIT_OleEmbeddingsEnum
B.3.3.2
OIT_SearchMLUnmappedTextEnum
B.3.3.3
OIT_XmlDefinitionMethodEnum
B.3.4
Image Export
B.3.4.1
OIT_DatabaseFitToPageEnum
B.3.4.2
OIT_EmailHeaderOutputEnum
B.3.4.3
OIT_GraphicCroppingEnum
B.3.4.4
OIT_GraphicSizeMethodEnum
B.3.4.5
OIT_GraphicWatermarkScaleTypeEnum
B.3.4.6
OIT_MimeHeaderOutputEnum
B.3.4.7
OIT_ReorderMethodEnum
B.3.4.8
OIT_SpreadsheetFitToPageEnum
B.3.4.9
OIT_SpreadsheetPageDirectionEnum
B.3.4.10
OIT_TiffByteOrderEnum
B.3.4.11
OIT_TiffColorSpaceEnum
B.3.4.12
OIT_TiffCompressionEnum
B.3.4.13
OIT_TiffFillOrderEnum
B.3.5
PDF Export
B.3.5.1
OIT_DefaultPageUnitsEnum
B.3.5.2
OIT_EmailHeaderOutputEnum
B.3.5.3
OIT_ReorderMethodEnum
B.3.5.4
OIT_WatermarkPositionEnum
B.3.5.5
OIT_WatermarkScalingEnum
B.3.6
XML Export
B.3.6.1
OIT_GraphicSizeMethodEnum
B.3.6.2
OIT_GraphicTypeEnum
B.3.6.3
OIT_OleEmbeddingsEnum
B.3.6.4
OIT_ReorderMethodEnum
B.3.6.5
OIT_XmlDefinitionMethodEnum
C
Java Client Data Types
C.1
Simple Types
C.2
Complex Types
C.2.1
All Products
C.2.1.1
IOSpec
C.2.1.2
StringData
C.2.1.3
TransformReponse
C.2.2
HTML Export
C.2.2.1
AltLink
C.2.2.2
DefaultFont
C.2.2.3
FontFlags
C.2.3
Search Export
C.2.3.1
CharacterAttributes
C.2.3.2
ParagraphAttributes
C.2.3.3
SearchMLFlags
C.2.4
Image Export
C.2.4.1
DefaultFont
C.2.4.2
DefaultMargins
C.2.4.3
TiffOptions
C.3
Enumerations
C.3.1
All Export
C.3.1.1
DefaultInputCharSetEnum
C.3.1.2
FallbackFormatEnum
C.3.1.3
DocumentMemoryModeEnum
C.3.2
HTML Export
C.3.2.1
CharacterByteOrderEnum
C.3.2.2
CharacterSetEnum
C.3.2.3
ComplianceEnum
C.3.2.4
ExtractEmbeddedFilesEnum
C.3.2.5
FlavorEnum
C.3.2.6
GraphicSizeMethodEnum
C.3.2.7
GraphicTypeEnum
C.3.2.8
GridAdvanceEnum
C.3.2.9
ReorderMethodEnum
C.3.2.10
SpreadSheetBordersEnum
C.3.3
Search Export
C.3.3.1
OleEmbeddingsEnum
C.3.3.2
SearchMLUnmappedTextEnum
C.3.3.3
XmlDefinitionMethodEnum
C.3.4
Image Export
C.3.4.1
DatabaseFitToPageEnum
C.3.4.2
GraphicCroppingEnum
C.3.4.3
GraphicSizeMethodEnum
C.3.4.4
GraphicWatermarkScaleTypeEnum
C.3.4.5
MimeHeaderOutputEnum
C.3.4.6
ReorderMethodEnum
C.3.4.7
SpreadsheetFitToPageEnum
C.3.4.8
SpreadsheetPageDirectionEnum
C.3.4.9
TiffByteOrderEnum
C.3.4.10
TiffColorSpaceEnum
C.3.4.11
TiffCompressionEnum
C.3.4.12
TiffFillOrderEnum
C.3.5
PDF Export
C.3.5.1
DefaultPageUnitsEnum
C.3.5.2
ReorderMethodEnum
C.3.5.3
WatermarkPositionEnum
C.3.5.4
WatermarkScalingEnum
C.3.6
XML Export
C.3.6.1
GraphicSizeMethodEnum
C.3.6.2
GraphicTypeEnum
C.3.6.3
OleEmbeddingsEnum
C.3.6.4
ReorderMethodEnum
C.3.6.5
XmlDefinitionMethodEnum
D
Copyrights and Licensing
D.1
Outside In Transformation Server Licensing
Scripting on this page enhances content navigation, but does not change the content in any way.