XML Source Connector User Guide

download XML Source Connector User Guide

of 7

Transcript of XML Source Connector User Guide

  • 7/26/2019 XML Source Connector User Guide

    1/16

    2013 Informatica Corporation. No part of this document may be reproduced or transmitted in any form, by any means(electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. All other company andproduct names may be trade names or trademarks of their respective owners and/or copyrighted materials of such

    owners.

    XML SourceUser Guide

  • 7/26/2019 XML Source Connector User Guide

    2/16

    2

    Abstract

    XML Source user guide provides a brief introduction on cloud connectors and its features.

    The guide provides detailed information on setting up the XML source connector and runningdata synchronization tasks (DSS). A brief overview of supported features and task operations that

    can be performed using XML Source connector is mentioned.

    Table of Contents

    Overview .......................................................................................................................................... 3

    XML Source Connector ................................................................................................................... 3

    Supported Objects and Task Operations ........................................................................................ 4

    Enabling XML Source Connector .................................................................................................... 4

    Creating a XML Source Connection ................................................................................................ 4

    How XML Source Connector Works ................................................................................................ 6

    Creating a XML Source Data Synchronization Task ..................................................................... 10

    Increasing Heap Size to Execute Bigger XML Files ...................................................................... 13

    Guidelines for XML Source Connections ...................................................................................... 16

    Big Split Feature......................................................................................................................... 16

  • 7/26/2019 XML Source Connector User Guide

    3/16

    3

    Overview

    Informatica cloud connector SDKs are off-cycle, off release add-ins that provide data integrationto SaaS and on-premise applications, which are not supported natively by Informatica cloud. Thecloud connectors are specifically designed to address most common use cases such as movingdata into cloud and retrieving data from cloud for individual application.

    Figure 1. Informatica Cloud Architecture

    Once the XML Source cloud connector is enabled for your ORG Id, you need to create aconnection in Informatica cloud to access the connector.

    XML Source Connector

    The XML Source connector effectively parses the data within the document. By providing multiplesource support functionality, the connector offers flexibility to attach child with parent in singleData Synchronization Task (DSS).

  • 7/26/2019 XML Source Connector User Guide

    4/16

    4

    Supported Objects and Task Operations

    The following table provides the list of supported objects and operations by XML sourceconnector.

    Objects Source Target Query Insert Update Delete UpsertLookUp

    XML NA NA NA NA NA NA

    Remarks:

    The following multiple source are supported

    - Parent-Child

    - Sibling

    NA

    Enabling XML Source Connector

    To enable XML Source connector, contact Informatica support or Informatica representative. Itusually takes 15 minutes for the connector to download to secure agent, after it is enabled.

    Note: To install secure agent, seeInstalling Informatica Secure Agent.

    Creating a XML Source Connection

    To use XML source connector in data synchronization task, you must create a connection inInformatica Cloud.

    The following steps help you to create XML Source connection in Informatica Cloud.

    1. In Informatica Cloud home page, clickConfigure.

    2. The drop-down menu appears, select Connections.

    3. The Connections page appears.

    4. Click Newto create a connection.

    5. The New Connection page appears.

    : Supported

    : Not Applicable

    https://community.informatica.com/docs/DOC-1590https://community.informatica.com/docs/DOC-1590https://community.informatica.com/docs/DOC-1590https://community.informatica.com/docs/DOC-1590
  • 7/26/2019 XML Source Connector User Guide

    5/16

    5

    Figure 2. Creating a Connection

    6. Specify the following details.

    Connection Property Description

    Connection Name Enter a unique name for the connection.

    Description Provide a relevant description for the connection.

    Type Select XML source from the list.

    Secure Agent Select the appropriate secure agent from the list

    Sample XML File Name Enter the required XML file path (Mandatory). See AlsoBigSplit Feature.

    Sample XSD SchemaName

    Enter the required XSD file path.

    7. Click Okto save the connection.

    Note: It is recommended to test the connection before saving it. Click Testto evaluate theconnection.

  • 7/26/2019 XML Source Connector User Guide

    6/16

    6

    How XML Source Connector Works

    The XML source connector works on the simple principle of organizing the elements intotables/fields. The unbound elements are segregated and considered as separate tables.

    Let us consider the sample XML file of Customer Account/Address details to explain how a XMLsource connector works.

    The following figure is a sample XML file of Customer Account/Address details.

    Figure 3. How a XML Source Connector works

  • 7/26/2019 XML Source Connector User Guide

    7/16

    7

    Figure 4. How a XML Source Connector Works

  • 7/26/2019 XML Source Connector User Guide

    8/16

    8

    Table-1: Table CustomerAccountSummary_Customers_Customer with XPath/CustomerAccountSummary/Customers/Customer

    Table-2: Table Accounts_Account with XPathCustomerAccountSummary_Customers_Customer_Accounts_Account

    Table-3: Table Accounts_Account_PhoneNumbers_Phone with XPath/CustomerAccountSummary/Customers/Customer/Accounts/Account/PhoneNumbers/Phone

    Table-4: Accounts_Account_Addresses_Address with XPath/CustomerAccountSummary/Customers/Customer/Accounts/Account/Addresses/Address

    Note: Any bound element to the former element becomes the child element of the formerelement.

    For example,

    - Phone numbersis the child element of Accounts.

    - Accountsis the child element of customers.

    Note: All simple and attribute elements are considered as fields. Complex elements are notconsidered as fields to the table.

    The following figure displays the option to see tables in cloud source

    Figure 5. Option to Display Tables in Cloud Source

  • 7/26/2019 XML Source Connector User Guide

    9/16

    9

    The following figure depicts the relations between different tables.

    - Table-1and Table-2has a parent-child relation.

    - Table-2is parent to Table-3and Table-4.

    Figure 6. Relationship between Tables

    The following figure depicts the sibling relation between tables.

    - Table-3is sibling to Table-4

    Figure 7. Relationship between Tables

  • 7/26/2019 XML Source Connector User Guide

    10/16

    10

    Creating a XML Source Data Synchronization Task

    Note: You need to create a connection before getting started with data synchronization task.

    The following steps help you to setup a data synchronization task in Informatica Cloud.

    Let us consider the task operation Insertto perform the Data synchronization task.

    1. In Informatica Cloud home page, click Apps.

    2. The drop-down menu appears, select Data Synchronization.

    3. The Data Synchronization page appears.

    4. Click Newto create a data synchronization task.

    5. The Definition tab appears.

    Figure 8. Definition Tab

    6. Specify the Task Name, provide a Description and select the Task Operation Insert.

    7. Click Next.

    8. The Source tab appears.

  • 7/26/2019 XML Source Connector User Guide

    11/16

    11

    Figure 9. Source Tab

    9. Select the source Connection, Source Typeand Source Objectto be used for the task.

    Note: Source Objectcorresponds to tables present in the sample XML file used for creating aconnection.

    10. Click Next.

    11. The Target tab appears. Select the target Connectionand Target Objectrequired for the

    task.

    Note: In the above considered task operation Target object is a flat file/CSV file.

  • 7/26/2019 XML Source Connector User Guide

    12/16

    12

    Figure 10. Target Tab

    Note: To create a new target, click Create Target.

    Note: The Target Objectfile will contain the tables selected in the source object.

    12. Click Next.

    13. In Data Filters tab by default, Process all rows is chosen.

    14. Click Next.

    15. In Field Mappingtab, map source fields to target fields accordingly.

    Figure 11. Field Mapping

  • 7/26/2019 XML Source Connector User Guide

    13/16

    13

    16. Click Next.

    17. The Scheduletab appears.

    18. In Schedule tab, you can schedule the task as per the requirement and save.

    19. If you do not want schedule the task, click Save and Runthe task.

    Figure 12. Save and Run Task

    After you Save and Runthe task, you will be redirected to monitor log page. In monitor log page,you can monitor the status of data synchronization tasks.

    Increasing Heap Size to Execute Bigger XML Files

    When you want to setup data synchronization task for XML files (>10MB size), you need toincrease the JAVA heap size in associated secure agents for active instances.

    The following procedure helps you to increase Java heap size.

    1. At first, shutdown the secure agent and then proceed to configure the heap size.

    2. Login to Informatica Cloud environment using admin credentials.

    3. In Informatica Cloud home page, click Configuration.

    4. Select Secure Agent.

    5. The following screen appears.

  • 7/26/2019 XML Source Connector User Guide

    14/16

    14

    Figure 13. Increasing Heap Size-1

    6. Click pencil icon of the secure agent, for which you want to increase heap size.

    7. The following screen appears, in Typefield, select TOMCAT JRE from the drop-down list.

    Figure 14. Increasing Heap Size-2

  • 7/26/2019 XML Source Connector User Guide

    15/16

    15

    8. Click pencil icon corresponding to INFA_Memoryto edit. The default value ofXms32m-Xmx256mneeds to be edited toXms256m-Xmx512mor more according to the

    requirement.

    9. Click Okto save changes.

    10. In the same page, in Typefield, select DTMfrom the drop-down list.

    11. The following options appear, Click pencil icon corresponding to JVM_Option 1to edit.Mention the value asXmx512mor more according to the requirement.

    Figure 15. Increasing Heap Size-3

    12. Click Ok to save changes

    13. Restart the secure agent.

    You have successfully increased the heap size of the required secure agent.

  • 7/26/2019 XML Source Connector User Guide

    16/16

    16

    Guidelines for XML Source Connections

    The following guidelines help you to use XML source connections effectively.

    The XML file must have a valid XSD (XML schema directory).

    The XML file must not contain the path of DTD or XSD files.

    The XML file must not have references pertaining to other XML files.

    The XML file must not contain any name spaces with the root element.

    It is not suggested to run the same data synchronization task repeatedly, as it will createduplicate XML records.

    It is strongly recommended to use XML file for the XSD schema path in connection.

    When the XSD (XML Schema) file signifies the namespace that needs to be present in XMLfile, then avoid using schema file for metedata parsing.

    Big Split Feature

    When you have a XML file of large size, the big split feature helps you to divide the large XML fileinto many smaller files. By splitting the large XML file, you can parse the files without facing anymemory constraints. SeeCreating a XML Source Connection.

    While creating a connection mention the XML File path along with split tag. For example,

    C:\MyWorkspace\XML.xml;splitTag=.

    Note: The big spilt feature can be implemented only when you have XML file size greater than100MB.

    Note: splittag is the 1st unbound element from root node (for a given schema).