Preface
Introduction to Data Transformation
- Data Transformation Overview
- Data Transformation Process Architecture
- Data Transformation Components
Data Processor Transformation
- Data Processor Transformation Overview
- Data Processor Transformation Views
- Data Processor Transformation Ports
- Startup Component
- References
- Data Processor Transformation Settings
- Events
  - Event Types
  - Data Processor Events View
- Logs
- Data Processor Transformation Development
- Data Processor Transformation Import and Export
- Data Processor Transformation in a Non-native Environment
Wizard Input and Output Formats
- Wizard Input and Output Formats Overview
- COBOL Processing Library
- JSON
- XML
  - Creating a Transformation that Transforms XML
Relational Input and Output
- Relational Input and Output Overview
- Relational Input
- Relational Output
Using the IntelliScript Editor
- IntelliScript Editor Overview
  - Creating a Script
- Opening an IntelliScript Editor
- Editing Procedures
- IntelliScript Editor Menus
XMap
- XMap Overview
- XMap Schemas
- Mapping Statements
- XPath Expressions
- XMap Variables
  - Creating a Variable in the XMap Editor
- XMap Example
Libraries
- Libraries Overview
- Library Structure
- Element Properties
- Library Management
- Edit Libraries with the Library Editor
- Edit Libraries with the IntelliScript Editor
Schema Object
- Schema Object Overview
- Schema Object Overview View
  - Schema Files
- Schema Object Schema View
- Schema Object Advanced View
- Creating a Schema Object
- Schema Updates
  - Schema Synchronization
  - Schema File Edits
    - Setting a Default Schema File Editor
    - Editing a Schema File
Command Line Interface
- Command Line Interface Overview
- CM_console
Scripts
- Scripts Overview
- Script Components
- Script Component Properties
- Script Startup Components
  - Setting the Startup Component with the IntelliScript Editor
- Example Sources
- IntelliScript Editor
- Validate a Script
- Sample Scripts
  - Importing a Sample Script
Parsers
- Parsers Overview
- Platform-Independent Parsers
  - Newline Markers
  - File Paths
- Parser Component Reference
  - Parser
Script Ports
- Script Ports Overview
- Script Port Component Reference
Document Processors
- Document Processors Overview
- Defining a Document Processor
  - Display of Document Processor Output
- Document Processor Component Reference
- TextML XML Schema
- PdfToTxt_4 Table Configuration Editor
  - Editor Options
  - PDF Conversion Example
    - Configuring the First Table
    - Configuring the Second Table
Formats
- Formats Overview
- Standard Format Properties
- Format Component Reference
- Delimiters Component Reference
- Format Preprocessor Component Reference
  - HtmlProcessor
  - RtfProcessor
Data Holders
- Data Holders Overview
- XML Schemas
- Using a Schema to Map Anchors
- Generating Valid XML
  - Role of Schemas in Parsing
  - Role of Schemas in Serialization and Mapping
- Variables
- Variable Component Reference
  - Variable
- Multiple-Occurrence Data Holders
Anchors
- Anchors Overview
- Mapping Content Anchors to Data Holders
- Defining Anchors
- Standard Anchor Properties
- How a Parser Searches for Anchors
- Anchor Component Reference
- Searcher Component Reference
- Anchor Subcomponent Reference
Transformers
- Transformers Overview
- Defining Transformers
- Standard Transformer Properties
- Transformer Component Reference
Actions
- Actions Overview
- Standard Action Properties
- Action Component Reference
- Action Subcomponent Reference
Serializers
- Serializers Overview
- Serialization Anchors
  - Example of Serialization Anchors
  - Sequence of Serialization Anchors
- Standard Serializer Properties
- Serializer Component Reference
  - Serializer
- Serialization Anchor Component Reference
Mappers
- Creating a Mapper
- Components Nested within a Mapper
- Mapper Example
- Standard Mapper Properties
- Mapper Component Reference
  - Mapper
- Mapper Anchor Component Reference
Locators, Keys, and Indexing
- Overview of Locators, Keys, and Indexing
- Example of Locators
- Example of Indexing by Key
- Source and Target Properties
  - Source Property
  - Target Property
- Standard Locator and Key Properties
- Locator and Key Component Reference
Streamers
- Streamers Overview
- Text Streamers
- XML Streamers
- Standard Streamer Properties
- Streamer Component Reference
- Streamer Subcomponent Reference
Validators, Notifications, and Failure Handling
- Overview of Validators, Notifiers, and Failure Handling
- Failure Handling
  - Using the Optional Property to Handle Failures
  - Writing a Failure Message to the User Log
    - Configuring User Log Output
    - Viewing the User Log
- Validators
- Standard Validator Properties
- Validator Component Reference
- Notifications
- Notification Component Reference
Validation Rules
- Validation Rules Overview
- Validation Rules Element Reference
- Edit the Validation Rules in an External Editor
- Create a Validation Rules Object
- Import a Data Transformation Service with Validation Rules
Custom Script Components
- Custom Script Components Overview
- Custom Component Example
- Custom Component Properties
- Developing a Custom Component in Java
  - Java Interface Example
  - Sample Custom Java Components
- Developing a Custom Component in C or C++
- Configuring a Custom Component
  - Sample Scripts Containing Custom Components

User Guide

10.4.0
- 10.5.6
- 10.5.2
- 10.5

Back Next

C/C++ Interface Example

As an example of one of the C/C++ interfaces, consider a document processor that accepts file input. The processor must implement the

CMXProcessFile

function, which has the following syntax:

int CMXProcessFile(
    void* sessionToken,
    const CMXContext* params,
    const IFfile_char_t* in_file,
    int in_len,
    IFfile_char_t** out_file,
    int* out_len,
    CMXEventReporter* reporter)

The following table describes the parameters:

Parameter	Description
sessionToken	Input parameter. A pointer to the current session.
params	Input parameter. A structure containing the properties that the Script passes to the component.
in_file	Input parameter. The full path of the file upon which the component should operate.
in_len	Input parameter. The length, in bytes, of the input file path.
out_file	Output parameter. The full path of a file that contains the output of the component.
out_len	Output parameter. The length, in bytes, of the output file path.
reporter	Input parameter. Provides the report method, which the component can use to write events to the event log.
Return value	Output parameter. 1 if successful, 0 if unsuccessful.

Rename Saved Search

Table of Contents

User Guide

User Guide

C/C++ Interface Example

C/C++ Interface Example