Preface
Introduction to Informatica Connector Toolkit
- Supported features
- Informatica Connector perspective
  - Connector Navigator
  - Connector Progress
Before you begin
- Download the welcome kit
- Download and install Eclipse IDE
- Download and install the Informatica Connector Toolkit
- Download OpenJDK and configure environment variables
- Log in to Informatica Intelligent Data Management Cloud
Develop a connector for Cloud Data Integration
- Create a new connector project
- Phase 1: Establish a connection
  - Create a connection
  - Test a connection
- Phase 2: Define the metadata
- Phase 3: Configure the runtime behavior
- Phase 4: Generate the connector package
  - Naming Convention
- Phase 5: Generate and run the test scenarios
  - Generate the test scenarios
    - Configure parameters in test suite file
    - Regenerate a test case
  - Run the test scenarios
    - Unit tests and sanity tests
    - Integration tests
Develop a connector for Data Loader
- Create a new connector project
- Phase 1: Establish a connection
  - Create a connection
  - Test a connection
- Phase 2: Define the metadata
- Phase 3: Configure the runtime behavior
- Phase 4: Generate the connector package
  - Naming Convention-DLT
- Phase 5: Generate and run the test scenarios
  - Generate the test scenarios
    - Configure parameters in test suite file
    - Regenerate a test case
  - Run the test scenarios
    - Unit tests and sanity tests
    - Integration tests
Import a connector
Connection attributes
- Connection attribute properties
Type system
- Native types and semantic categories
  - Native Type Properties
- Cloud Data Integration types
Connector metadata
- Metadata components
- Import dialog box settings
Partitioning capability
- Automatic partitioning
- Static partitioning
Pushdown capability
- Pushdown optimization execution flow
- Classes and methods for pushdown capabilities
Mappings in advanced mode
- Project, classes, and methods
Manual changes to Informatica Connector Toolkit source code
- Code changes for connection pooling
  - Connection Pooling through API
- Code changes for custom query
- Code changes for object path override
- Code changes for pushdown capability
- Code changes for SQL transformation
- Code changes for stored procedures
Runtime behavior
- Runtime Java functions
Connector example: MySQL_Cloud
- MySQL_Cloud Connector requirements
- Building the sample connector
- MySQL_Cloud Connector components
Version control integration
- Git version control integration
  - Prerequisites
  - Build a connector in Git repository
- Perforce version control integration
Appendix A: Metadata models
- Metadata model components
- Metadata patterns
- Features of type A metadata template
Appendix B: ASO model
- ASO model components
- ASO projections
Appendix C: Connector project migration
- Migrate connector project from Windows platform to other platforms
Appendix D: Frequently used generic APIs in Informatica Connector Toolkit
Appendix E: Frequently asked questions

Cloud Data Integration Connector Toolkit Developer Guide

Back Next

Add metadata for JDBC driver-based connector

Define the object metadata and enable the read and write capabilities for a JDBC driver-based connector

Click

Add Object Metadata

To enable read capability for the connector, select

Enable Read Capability

Select whether the connector supports filter operation when the connector reads from the data source.

To specify operators and expression syntax recognized by Cloud Data Integration for the filter operation, select

Platform

To specify an expression for the join or filter operation that is specific to the data source for which you build the connector, select

Native

When a connector supports platform filter, you can use the default operators such as

=, !=, >, >=, <

, and

for filter conditions. You can specify advanced operators such as

Contains, Starts With, Ends With, Is Null

, and

Is Not Null

for filters when you define the read capability for the endpoint metadata object.

For the code changes to include the advanced operators, see the RuntimeDataAdapter class of the MySQL_Cloud sample connector in the following location:

source\ict\samples\MySQL_Cloud

Select whether the connector supports sort to retrieve data from the data source in a specific order.

To add runtime attributes, select Configure Runtime Attributes
, and then click

Add

and configure the following attribute properties:

Property	Description
Name	Name of the attribute.
Display Name	Display name for the attribute.
Description	Description of the connection attribute.
Data Type	Data type of the attribute.
Default Value	Default value for the attribute.
Min Length	Minimum length for the value of the attribute.
Max Length	Maximum length for the value of the attribute. The maximum length of any attribute cannot be greater than Integer.MAX_VALUE, which is 2,147,483,647.
Supports Parameter	Indicates whether you can parameterize the attribute. When you parameterize an attribute, you can assign values for the attribute at run time. Full Parameterization. Indicates you can parameterize the value of an attribute completely. Partial Parameterization. You can parameterize a part of the attribute value. No. The attribute does not support parameterization.
Encrypted	Indicates whether you can encrypt the attribute.
Mandatory	Indicates whether a connection attribute requires a value. If you set the Mandatory property to True but you do not display the attribute on the connection management user interface, you must set a default value for the attribute.
Hidden	Indicates whether you can hide the attribute.
Override Partitions	Indicates if the attribute can be overridden for each partition. Implement the <ConnectorID><NMOName>AutoPartitioningMetadataAdapter file to define the partition support.
Allowed Values	List of values allowed for the attribute.

Click

To define write capability for the connector, select

Enable Write Capability

Select the write operations that the connector supports.

Insert

Update

Delete

Upsert

When you select Upsert, Informatica Connector Toolkit adds the

UpdateMode

attribute to the write capability attribute list.

You can specify one of the following values for the

UpdateMode

attribute during runtime:

Update As Update

. If you specify the

Update As Update

value, you must implement the upsert logic so that the connector updates an existing row while writing to the target.

Update Else Insert

. If you specify the

Update Else Insert

value, you must implement the upsert logic so that the connector updates an existing row if the row exists in the target, else inserts a row while writing to the target.

To add runtime attributes, select Configure Runtime Attributes
, and then click

Add

and configure the following attribute properties:

Property	Description
Name	Name of the attribute.
Display Name	Display name for the attribute.
Description	Description of the attribute.
Data Type	Data type of the attribute.
Default Value	Default value for the attribute.
Min Length	Minimum length for the value of the attribute.
Max Length	Maximum length for the value of the attribute. The maximum length of any attribute cannot be greater than Integer.MAX_VALUE, which is 2,147,483,647.
Supports Parameter	Indicates whether you can parameterize the attribute. When you parameterize an attribute, you can assign values for the attribute at run time. Full Parameterization. Indicates you can parameterize the value of an attribute completely. Partial Parameterization. You can parameterize a part of the attribute value. No. The attribute does not support parameterization.
Encrypted	Indicates whether you can encrypt the attribute.
Mandatory	Indicates whether a connection attribute requires a value. If you set the Mandatory property to True but you do not display the attribute on the connection management user interface, you must set a default value for the attribute.
Hidden	Indicates whether you can hide the attribute.
Override Partitions	Indicates if the attribute can be overridden for each partition. Implement the <ConnectorID><NMOName>AutoPartitioningMetadataAdapter file to define the partition support.
Allowed Values	List of values allowed for the attribute.

Click

Generate Code

After you define the connector metadata, the Informatica Connector Toolkit generates the

<NMOName>MetadataAdapter.java

file in the

Metadata

folder. Implement the following methods in the

<NMOName>MetadataAdapter.java

file to import metadata.

populateObjectCatalog(): Populates metadata details in the import wizard for the connector consumer.
Data preview in Cloud Data Integration does not work if the values of the Record.setName and Record.setNativeName methods are different.
populateObjectDetails(): Gets metadata from the data source based on the import dialog options settings.

If you configured metadata write settings for the connector, implement the

writeObjects

method in the

<NMOName>MetadataAdapter.java

file.

If you regenerate code for the endpoint metadata definition project, the Informatica Connector Toolkit does not regenerate code for the user-exposed source code visible in the Informatica perspective. You have to manually edit the source code and make changes if you add, remove, or change the endpoint metadata attributes.

Rename Saved Search

Table of Contents

Cloud Data Integration Connector Toolkit Developer Guide

Cloud Data Integration Connector Toolkit Developer Guide

Add metadata for JDBC driver-based connector

Add metadata for JDBC driver-based connector