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 Export and Import
- Data Processor Transformation Validation
  - Using a Speed-enhanced Data Transformation Engine for VRL Validations
- 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 Files
- Schema Object Overview View
- 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
  - Java Interface Example
  - Sample Custom Java Components
- Configuring a Custom Component
  - Sample Scripts Containing Custom Components

User Guide

10.5
- 10.5.6
- 10.5.2
- 10.4.0

Back Next

Configuring a Custom Component

After you develop a custom component, you must prepare a Script file that defines the component. You cannot prepare the TGP file in the IntelliScript editor. Instead, you must prepare it in a text editor.

After you install the component and the TGP file, you can configure the custom component in the IntelliScript editor.

Create a text file and save it with a

*.tgp

extension.

You can define more than one external component in a single TGP file.

For each property that your external component supports, add lines such as the following to the TGP file:

profile <CustomPropertyName1> ofPT <DataType>
{
    paramName = "<CustomPropertyName1>" ;
}

is the name of a property that you want to display in the IntelliScript editor.

is the data type of the property. The supported data types are

NamedParamIntT

for an integer property,

NamedParamBoolT

for a boolean property,

NamedParamStringT

for a string property, or

NamedParamListT

for a property that is a list of strings.

For each external component that you wish to define, add lines such as the following to the TGP file:

profile <ExternalComponentName> ofPT <ComponentType>
{
    jclass = "<ClassName>" ;
    param1 = <CustomPropertyName1>() ;
    param2 = <CustomPropertyName2>() ;
}

is the name of the external component that you want to display in the IntelliScript editor.

is one of the following values:

For	ComponentType
A Java document processor with 0 to 4 properties	ExternalJavaProcessorNoParamsT ExternalJavaProcessor1ParamsT ExternalJavaProcessor2ParamsT ...
A Java transformer with 0 to 10 properties	ExternalJavaTransformerNoParamsT ExternalJavaTransformer1ParamsT ExternalJavaTransformer2ParamsT ...

is the fully qualified name of the Java class. On Windows,

is the name of the DLL, without the

*.dll

extension. On Linux or UNIX, it is the name of the shared object, without the

lib

prefix or the

*.so

, extension.

and

are the names of the properties that you configured in step 2.

Save the

*.tgp

file.

Store the file in the

DataTransformation\autoInclude\user

subdirectory of the installation directory of every computer where you want to use the component.

If the Developer tool is open, close it and re-open it.

If an

autoInclude

error is displayed, review the TGP file for syntax errors or naming inconsistencies, and open the Developer tool again.

Open a project and insert the custom component in the Script. The custom component name, which you assigned in step 3 above, appears in the IntelliScript drop-down list. The IntelliScript editor displays its properties.

Rename Saved Search

Table of Contents

User Guide

User Guide

Configuring a Custom Component

Configuring a Custom Component