Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Data Integration Connector Toolkit
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to Informatica Connector Toolkit
  3. Before you begin
  4. Develop a connector for Cloud Data Integration
  5. Develop a connector for Data Loader
  6. Import a connector
  7. Connection attributes
  8. Type system
  9. Connector metadata
  10. Partitioning capability
  11. Pushdown capability
  12. Mappings in advanced mode
  13. Manual changes to Informatica Connector Toolkit source code
  14. Runtime behavior
  15. Connector example: MySQL_Cloud
  16. Version control integration
  17. Appendix A: Metadata models
  18. Appendix B: ASO model
  19. Appendix C: Connector project migration
  20. Appendix D: Frequently used generic APIs in Informatica Connector Toolkit
  21. Appendix E: Frequently asked questions

Cloud Data Integration Connector Toolkit Developer Guide

Cloud Data Integration Connector Toolkit Developer Guide

Back Next

Add metadata for third-party library-based connector

Add metadata for third-party library-based connector

Define the object metadata for a connector created using a third-party library SDK. Enable record extension and field extension to add additional metadata information for the object and fields respectively. Also, enable read and write capabilities for the connector.
  1. Click
    Add Object Metadata
     under Endpoint Object Metadata.
    Add object metadata for a connector created using a third-party library SDK.
  2. Enter the endpoint object metadata details.
    Property
    Description
    Name
    Name of the object.
    Display Name
    Display name of the object.
    Description
    Description of the object.
    Custom Query
    Select to use a custom query to import a data source.
    When you select
    Custom Query
    , you can select
    Query
     as the source type to import a data source.
    Object Path Override
    Select to override the object path at runtime.
    The following image shows the endpoint object metadata details:
    Specify endpoint object metadata details
  3. Click
    Next
    .
  4. To add additional metadata information for the object, select
    Add Record Extension
    .
    Add additional metadata information for the object.
    1. Click
      Add
       to add a record extension and configure the following 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.
      Allowed Values
      List of values allowed for the attribute.
    2. Click
      OK
      .
  5. Click
    Next
    .
  6. To add additional metadata information for the fields, select
    Add Field Extension
    . Add additional metadata information for the fields
    1. Click
      Add
       to add a field extension and configure the following 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.
      Allowed Values
      List of values allowed for the attribute.
    2. Click
      OK
      .
  7. Click
    Next
    .
  8. To enable read capability for the connector, select
    Enable Read Capability
    .
    Enable read capability and configure runtime attriburtes for the connector.
    1. 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.
    2. Select whether the connector supports lookup of data when the connector reads from the data source.
    3. Select
      Enable read in advanced mode
       to enable read capability for mappings in advanced mode.
      For more information, see Mappings in advanced mode.
    4. Select
      Read using Bulk API
       if the connector supports bulk processing to read large amount of data from the source.
    5. Select whether the connector supports join and filter operations when the connector reads from the data source.
      • To specify operators and expression syntax recognized by the Cloud Data Integration for the join or filter operation, select
        Platform Expression
        .
        If you plan to add key range partitioning capability for the connector, you must select support for filter operation and platform expression.
      • 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 Expression
        .
      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 MySQL_Cloud sample connector in the following location:
      source\ict\samples\MySQL_Cloud
    6. Select whether the connector supports sort operation to retrieve data from the data source in a specific order.
    7. Select whether the connector supports select operation to retrieve data for select rows from the data source.
  9. Click
    Next
    .
  10. To define write capability for the connector, select
    Enable Write Capability
    .
    Enable write capability and configure runtime attriburtes for the connector.
    1. 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.
    2. 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.
    3. Select whether the connector supports bulk processing to write large amounts of data to the target.
      When you select
      Enable Write Bulk API
      , specify the property
      -DENABLE_WRITER_BULK_PROCESSING=true
       in the Secure Agent properties.
    4. Select
      Enable write in advanced mode
       to enable write capability for mappings in advanced mode.
      For more information, see Mappings in advanced mode.
  11. Click
    Next
    .
  12. To define pushdown capability for the connector, select
    Enable Pushdown Capability
    . Enable pushdown capability for the connector
    When you specify the pushdown attribute properties, you can define the adapter ID for the source. Define whether the connector supports source or full pushdown or pushdown to single or multiple targets. When you enable pushdown capability, you must add at least one source adapter ID.
    Select the transformations that the connector must support for pushdown optimization:
    • Filter
    • Joiner
    • Sorter
    • Expression
    • Aggregator
    • Lookup
    • Router
    • Union
    • Update Strategy
    • Sequence Generator
  13. Click
    Next
    .
  14. Select whether the connector supports partitioning capability for the read operation. Enable partition capability for the connector
    1. To configure the connector to fetch partition information from the data source, select the
      Dynamic
       partitioning method and implement the partition logic. Extend the AutoPartitioningMetadataAdapter class to implement the partition logic.
    2. To configure the connector to get partition information from the user, select the
      Static
       partitioning method.
      If you want to implement a partition logic based on the partition information that the user specifies, select
      Fixed
      . Implement the partition logic in the DataAdapter class. The user can specify the required partition information before the connector reads from the data source.
    3. Select whether the connector supports partitioning capability for the write operation. By default, the dynamic partitioning method is selected for partition-enabled write operations. Extend the AutoPartitioningMetadataAdapter class to implement the partition logic.
  15. 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.
0 COMMENTS
We’d like to hear from you!