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

Hierarchical output

Hierarchical output

Configure the metadata of the object of hierarchical type. Use the Swagger-based or API based method to generate the metadata for an object.
  1. Click
    Add Object Metadata
    .
    Add the metadata of the object of hierarchical type
  2. Select
    Output Format Type
     as
    Hierarchical
    .
    Select the output format type as hierarchical.
  3. Select one of the following generation methods:
    • Swagger Based
    • API Based
  4. Click
    Next
    .

API-based

Use the API-based method to generate metadata for an object of hierarchical type.
  1. Add advanced attributes for the object.
    Add advanced attributes for the object.
    1. Click
      Add
       and configure the following fields to add advanced attributes for the object.
      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. Click
      OK
      .
  2. Click
    Generate Code
    .
    The first time you add metadata for API-Based generation method, you can only add the advanced attributes for the object. To configure the additional metadata and additional field information, you must edit the object.
  3. Click
    Edit Object Metadata
    .
    Edit object to configure the additional metadata and additional field information.
  4. Click
    Next
    .
  5. Select
    Add Additional Metadata
     to add additional information for the object.
    Add additional information for the object.
    1. Click
      Add
       and configure the following fields to add additional metadata for the object.
      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.
      • 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
      .
  6. Click
    Next
    .
  7. Select
    Add Additional Field Information
     to add additional information for the fields.
    Add additional information for the fields.
    1. Click
      Add
       and configure the following fields to add additional metadata for the fields.
      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.
      • 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
      .
  8. 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 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 Connector perspective. You have to manually edit the source code and make changes if you add, remove, or change the endpoint metadata attributes.

Swagger-based

When you use the Swagger-based method to generate metadata for an object of hierarchical type, you can use one of the following options:
Use an existing swagger specification
You can select an existing Swagger 2.0 file or an Open API file to generate the metadata.
  1. Select
    Use an existing swagger specification
     and click
    Browse
     to upload a swagger file in JSON format.
  2. Click
    Generate Code
    .
Generate swagger specification by sampling
You can use a sample response to generate the metadata. When you use a sample response, the toolkit generates a Swagger 2.0 file.
  1. Select
    Generate swagger specification by sampling
     and specify the
    Base URL
    .
    Generate swagger specification to generate metadata for an object of hierarchical type.
  2. Click
    Next
    .
  3. Configure the REST Endpoint.
    Configure the REST endpoint.
    1. Click
      Add
       and configure the following fields to generate the swagger specification for the REST endpoint:
      Property
      Description
      Path
      The path of the REST endpoint.
      Object Name
      Name of the object.
      Method
      The HTTP method used to retrieve data from or send data to the endpoint.
      Content Type
      The content type header to specify the content type of the request body.
      • application/json. Indicates that the request body format is JSON.
      • application/xml. Indicates that the request body format is XML.
      • application/x-www-form-urlencoded. Indicates that the request body is URL encoded.
      Accept
      The accept header to specify the content type of the output.
      • application/json. Indicates that the output type is JSON.
      • application/xml. Indicates that the output type is XML.
      The following image shows the field you must configure to generate the swagger specification:
      The image shows the fields you must configure to generate the swagger specification.
    2. Click
      Generate
      .
    3. Click
      OK
      .
  4. Click
    Next
    .
  5. Add advanced attributes for the object.
    Add advanced attributes for the object.
    1. Click
      Add
       and configure the following fields to add advanced attributes for the object.
      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. Click
      OK
      .
  6. Click
    Generate Code
    .
    After you define the connector metadata, the Informatica Connector Toolkit generates the
    <NMOName>MetadataAdapter.java
     file in the
    Metadata
     folder. To implement features specific to the data source, you can also modify code in 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 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!