Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 What Is Transformation Server?

• 1.1 What's New in Release 8.4.1
• 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
• 1.5 Copyright Information

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 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.3 Command Line Flags
    • 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.2 Command Line Flags
• 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.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.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

• A.1 Simple Types
• A.2 Complex Types
  • A.2.1 All Export Products
    • A.2.1.1 IOSpec
    • A.2.1.2 stringData
    • A.2.1.3 stringList
    • A.2.1.4 TransformResponse
  • A.2.2 HTML Export
    • A.2.2.1 AltLink
    • A.2.2.2 DefaultFont
    • A.2.2.3 FontFlags
  • A.2.3 Search Export
    • A.2.3.1 CharacterAttributes
    • A.2.3.2 ParagraphAttributes
    • A.2.3.3 SearchMLFlags
  • A.2.4 Image Export
    • A.2.4.1 DefaultFont
    • A.2.4.2 DefaultMargins
    • A.2.4.3 TiffOptions
• A.3 Enumerations
  • A.3.1 All Export Products
    • A.3.1.1 DefaultInputCharSetEnum
    • A.3.1.2 DocumentMemoryModeEnum
    • A.3.1.3 FallbackFormatEnum
  • A.3.2 HTML Export
    • A.3.2.1 CharacterByteOrderEnum
    • A.3.2.2 CharacterSetEnum
    • A.3.2.3 ComplianceEnum
    • A.3.2.4 EmailHeaderOutputEnum
    • A.3.2.5 ExtractEmbeddedFilesEnum
    • A.3.2.6 FlavorEnum
    • A.3.2.7 GraphicSizeMethodEnum
    • A.3.2.8 GraphicTypeEnum
    • A.3.2.9 GridAdvanceEnum
    • A.3.2.10 ReorderMethodEnum
    • A.3.2.11 SpreadSheetBordersEnum
  • A.3.3 Search Export
    • A.3.3.1 oleEmbeddingsEnum
    • A.3.3.2 SearchMLUnmappedTextEnum
    • A.3.3.3 XmlDefinitionMethodEnum
  • A.3.4 Image Export
    • A.3.4.1 DatabaseFitToPageEnum
    • A.3.4.2 EmailHeaderOutputEnum
    • A.3.4.3 GraphicCroppingEnum
    • A.3.4.4 GraphicSizeMethodEnum
    • A.3.4.5 GraphicWatermarkScaleTypeEnum
    • A.3.4.6 MimeHeaderOutputEnum
    • A.3.4.7 ReorderMethodEnum
    • A.3.4.8 SpreadsheetFitToPageEnum
    • A.3.4.9 SpreadsheetPageDirectionEnum
    • A.3.4.10 TiffByteOrderEnum
    • A.3.4.11 TiffColorSpaceEnum
    • A.3.4.12 TiffCompressionEnum
    • A.3.4.13 TiffFillOrderEnum
  • A.3.5 PDF Export
    • A.3.5.1 DefaultPageUnitsEnum
    • A.3.5.2 EmailHeaderOutputEnum
    • A.3.5.3 ReorderMethodEnum
    • A.3.5.4 WatermarkPositionEnum
    • A.3.5.5 WatermarkScalingEnum
  • A.3.6 XML Export
    • A.3.6.1 GraphicSizeMethodEnum
    • A.3.6.2 GraphicTypeEnum
    • A.3.6.3 oleEmbeddingsEnum
    • A.3.6.4 ReorderMethodEnum

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

Index