Informatica Enterprise Information Catalog Custom Metadata Integration Guide

Transcription

1 Informatica 10.2 Enterprise Information Catalog Custom Metadata Integration Guide

2 Informatica Enterprise Information Catalog Custom Metadata Integration Guide 10.2 August 2017 Copyright Informatica LLC 2017 This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. 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 LLC. Informatica and the Informatica logo are trademarks or registered trademarks of Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at Other company and product names may be trade names or trademarks of their respective owners. U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR , Commercial Computer Software License. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright Sun Microsystems. All rights reserved. Copyright RSA Security Inc. All Rights Reserved. Copyright Ordinal Technology Corp. All rights reserved. Copyright Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright Meta Integration Technology, Inc. All rights reserved. Copyright Intalio. All rights reserved. Copyright Oracle. All rights reserved. Copyright Adobe Systems Incorporated. All rights reserved. Copyright DataArt, Inc. All rights reserved. Copyright ComponentSource. All rights reserved. Copyright Microsoft Corporation. All rights reserved. Copyright Rogue Wave Software, Inc. All rights reserved. Copyright Teradata Corporation. All rights reserved. Copyright Yahoo! Inc. All rights reserved. Copyright Glyph & Cog, LLC. All rights reserved. Copyright Thinkmap, Inc. All rights reserved. Copyright Clearpace Software Limited. All rights reserved. Copyright Information Builders, Inc. All rights reserved. Copyright OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright International Organization for Standardization All rights reserved. Copyright ej-technologies GmbH. All rights reserved. Copyright Jaspersoft Corporation. All rights reserved. Copyright International Business Machines Corporation. All rights reserved. Copyright yworks GmbH. All rights reserved. Copyright Lucent Technologies. All rights reserved. Copyright University of Toronto. All rights reserved. Copyright Daniel Veillard. All rights reserved. Copyright Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright MicroQuill Software Publishing, Inc. All rights reserved. Copyright PassMark Software Pty Ltd. All rights reserved. Copyright LogiXML, Inc. All rights reserved. Copyright Lorenzi Davide, All rights reserved. Copyright Red Hat, Inc. All rights reserved. Copyright The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright EMC Corporation. All rights reserved. Copyright Flexera Software. All rights reserved. Copyright Jinfonet Software. All rights reserved. Copyright Apple Inc. All rights reserved. Copyright Telerik Inc. All rights reserved. Copyright BEA Systems. All rights reserved. Copyright PDFlib GmbH. All rights reserved. Copyright Orientation in Objects GmbH. All rights reserved. Copyright Tanuki Software, Ltd. All rights reserved. Copyright Ricebridge. All rights reserved. Copyright Sencha, Inc. All rights reserved. Copyright Scalable Systems, Inc. All rights reserved. Copyright jqwidgets. All rights reserved. Copyright Tableau Software, Inc. All rights reserved. Copyright MaxMind, Inc. All Rights Reserved. Copyright TMate Software s.r.o. All rights reserved. Copyright MapR Technologies Inc. All rights reserved. Copyright Amazon Corporate LLC. All rights reserved. Copyright Highsoft. All rights reserved. Copyright Python Software Foundation. All rights reserved. Copyright BeOpen.com. All rights reserved. Copyright CNRI. All rights reserved. This product includes software developed by the Apache Software Foundation ( and/or other software which is licensed under various versions of the Apache License (the "License"). You may obtain a copy of these Licenses at Unless required by applicable law or agreed to in writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses. This product includes software which was developed by Mozilla ( software copyright The JBoss Group, LLC, all rights reserved; software copyright by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License Agreement, which may be found at The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University, Copyright ( ) , all rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to terms available at and This product includes Curl software which is Copyright , Daniel Stenberg, <daniel@haxx.se>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. The product includes software copyright ( ) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at license.html. The product includes software copyright , The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at kawa/software-license.html. This product includes OSSP UUID software which is Copyright 2002 Ralf S. Engelschall, Copyright 2002 The OSSP Project Copyright 2002 Cable & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by Boost ( or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at / This product includes software copyright University of Cambridge. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at and at This product includes software licensed under the terms at license.html, httpunit.sourceforge.net/doc/ license.html, release/license.html, license-agreements/fuse-message-broker-v-5-3- license-agreement; licence.html;

3 Consortium/Legal/2002/copyright-software ; license.html; software/tcltk/license.html, iodbc/wiki/iodbc/license; index.html; EaselJS/blob/master/src/easeljs/display/Bitmap.js; jdbc.postgresql.org/license.html; LICENSE; master/license; LICENSE; intro.html; LICENSE.txt; and This product includes software licensed under the Academic Free License ( the Common Development and Distribution License ( the Common Public License ( the Sun Binary Code License Agreement Supplemental License Terms, the BSD License ( the new BSD License ( opensource.org/licenses/bsd-3-clause), the MIT License ( the Artistic License ( licenses/artistic-license-1.0) and the Initial Developer s Public License Version 1.0 ( This product includes software copyright Joe WaInes, XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by the Indiana University Extreme! Lab. For further information please visit This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject to terms of the MIT license. See patents at DISCLAIMER: Informatica LLC provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica LLC does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice. NOTICES This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software Corporation ("DataDirect") which are subject to the following terms and conditions: 1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS. The information in this documentation is subject to change without notice. If you find any problems in this documentation, please report them to us in writing at Informatica LLC 2100 Seaport Blvd. Redwood City, CA Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT. Publication Date:

4 Table of Contents Preface... 6 Informatica Resources Informatica Network Informatica Knowledge Base Informatica Documentation Informatica Product Availability Matrixes Informatica Velocity Informatica Marketplace Informatica Global Customer Support Chapter 1: Overview... 8 Custom Metadata Integration Overview Custom Metadata Integration Workflow Chapter 2: Custom Metadata Integration Concepts Custom Metadata Integration Components and Configuration Options Business Example to Create a Custom Model Custom Model Components Class Properties Attribute Properties Association Properties Data Type Properties Chapter 3: Create Custom Models Model Definition Guidelines Define the Custom Model XML File for the Business Example Sample Custom Model XML File Creating Custom Models Exporting Models Updating Custom Models Deprecating Custom Models Chapter 4: Preparing the Export Template for Metadata Ingestion Metadata Ingestion Overview Exporting the Custom Resource Type Template Entering Class Details Sample Class Data File for the Business Example Entering Association Details Sample Association Data File for the Business Example Table of Contents

5 Chapter 5: Create Custom Resources Custom Resource Type Overview Creating Custom Resource Types Deleting Custom Resource Types Creating Custom Resources Table of Contents 5

6 Preface The Informatica Enterprise Information Catalog Custom Metadata Integration Guide provides methodology and procedures for integrating custom metadata into the Enterprise Information Catalog. This book is written for system administrators who want to load metadata from a custom data source for which Enterprise Information Catalog does not package a model. Informatica Resources Informatica Network Informatica Network hosts Informatica Global Customer Support, the Informatica Knowledge Base, and other product resources. To access Informatica Network, visit As a member, you can: Access all of your Informatica resources in one place. Search the Knowledge Base for product resources, including documentation, FAQs, and best practices. View product availability information. Review your support cases. Find your local Informatica User Group Network and collaborate with your peers. Informatica Knowledge Base Use the Informatica Knowledge Base to search Informatica Network for product resources such as documentation, how-to articles, best practices, and PAMs. To access the Knowledge Base, visit If you have questions, comments, or ideas about the Knowledge Base, contact the Informatica Knowledge Base team at KB_Feedback@informatica.com. Informatica Documentation To get the latest documentation for your product, browse the Informatica Knowledge Base at If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through at infa_documentation@informatica.com. 6

7 Informatica Product Availability Matrixes Product Availability Matrixes (PAMs) indicate the versions of operating systems, databases, and other types of data sources and targets that a product release supports. If you are an Informatica Network member, you can access PAMs at Informatica Velocity Informatica Velocity is a collection of tips and best practices developed by Informatica Professional Services. Developed from the real-world experience of hundreds of data management projects, Informatica Velocity represents the collective knowledge of our consultants who have worked with organizations from around the world to plan, develop, deploy, and maintain successful data management solutions. If you are an Informatica Network member, you can access Informatica Velocity resources at If you have questions, comments, or ideas about Informatica Velocity, contact Informatica Professional Services at ips@informatica.com. Informatica Marketplace The Informatica Marketplace is a forum where you can find solutions that augment, extend, or enhance your Informatica implementations. By leveraging any of the hundreds of solutions from Informatica developers and partners, you can improve your productivity and speed up time to implementation on your projects. You can access Informatica Marketplace at Informatica Global Customer Support You can contact a Global Support Center by telephone or through Online Support on Informatica Network. To find your local Informatica Global Customer Support telephone number, visit the Informatica website at the following link: If you are an Informatica Network member, you can use Online Support at Preface 7

8 C h a p t e r 1 Overview This chapter includes the following topics: Custom Metadata Integration Overview, 8 Custom Metadata Integration Workflow, 9 Custom Metadata Integration Overview Custom metadata integration signifies ingesting metadata from custom data sources into the catalog. You can use custom metadata integration to extract and ingest metadata from sources for which Enterprise Information Catalog does not provide support. Based on the model for the data source, Enterprise Information Catalog extracts metadata from the data source. Enterprise Information Catalog, by default, provides models for multiple data sources from which you can extract metadata. These models are referred to as system models. To ingest custom metadata in the catalog, you must define a custom model as the first step. Custom metadata represents metadata that you define. Custom metadata includes custom properties, relationships, attributes, and classes in the custom data source. You can define a custom model in Catalog Administrator. The model defines the structure of the metadata stored in the catalog. You can reuse a system model and update the model to create and define a custom model. Alternatively, you can create a model on your own. After you define the custom model, you must create a custom resource type in Catalog Administrator based on the custom model. A custom resource type can reuse existing models or you might want to create a new model. A model represents the structure and properties of metadata ingested into the catalog. You can associate multiple models, both system and custom models, to a custom resource type. Based on the custom resource type, you can create a custom resource in Catalog Administrator. Custom metadata integration involves the following high-level steps: 1. Create the custom model. 2. Create the custom resource type. 3. Create the custom resource. 4. Provide the metadata that you extract from the source, in two CSV files bundled as a ZIP file when you configure the custom resource. 8

9 Custom Metadata Integration Workflow The custom metadata integration workflow starts with the definition of the custom model. The workflow includes the following tasks: 1. Verify if you can reuse an existing model. For example, for a relational data source, you can use any of the relational models included in Enterprise Information Catalog. 2. Creating custom models that involve the following steps: Define the model for the source metadata. Use the custom_model.xsd model definition file to validate the model you create. Specify the classes, attributes, and associations that need to be ingested in the catalog. Configure the search, sort, and filter options for the ingested custom metadata objects. Note: Search, sort, and filtering options are resource-intensive operations. Verify that you configure the options that you require. 3. Register the custom model with the Catalog Administrator. 4. Create a custom resource type. 5. Select the models that you want to assign to the custom metadata template. 6. Use the CSV files in the custom resource type template to fill metadata and associations from the data source for which you want to extract metadata and ingest into the catalog. Make sure that you fill data with the class and association details. 7. Create a custom resource and upload a ZIP file that includes the CSV files with data when you configure the resource. 8. Run the resource. When the resource runs, Enterprise Information Catalog processes the metadata from the CSV files and ingests the metadata into the catalog. Custom Metadata Integration Workflow 9

10 C h a p t e r 2 Custom Metadata Integration Concepts This chapter includes the following topics: Custom Metadata Integration Components and Configuration Options, 10 Business Example to Create a Custom Model, 12 Custom Model Components, 13 Custom Metadata Integration Components and Configuration Options When you create custom models for custom metadata integration, you configure the custom metadata that you want to ingest in the catalog. You can also configure options to search, filter, and sort the custom metadata ingested into the catalog. Custom metadata integration includes the following components: Model A model represents the structure and properties defined for metadata ingested into the catalog. You must define the model as an XML file. Metadata ingested includes classes, associations, and attributes. The following image shows the structure of a model: 10

11 System Models Models that Enterprise Information Catalog bundles by default to extract metadata from multiple data sources. You can export a system model XML file and update the file to create a custom model of your choice using Catalog Administrator. Custom Models Class Object Models that you define for extracting metadata from custom resources. A class defines the type of objects that a metadata source contains. Classes include associations and attributes. An object represents an entity about which you can store facts or attributes in the catalog. Attribute or Fact An attribute represents a single record of information provided by the source, in the catalog. An attribute describes the characteristics of an object. Association An association represents the relationship between two objects in the catalog. Association Kind An association kind represents the type of relationship or association between objects in the data source. For example, a parent-child inheritance relationship, Data Type Note: You cannot define a new association kind in a model. A data type defines the types of values possible for an attribute. For example, string and integer. The following image shows the relationship between objects, associations, and attributes: Custom Metadata Integration Components and Configuration Options 11

12 Business Example to Create a Custom Model In the following use case, the requirement is to ingest the extracted metadata from the Microsoft Access database that you provide in the links.csv and objects.csv files. Enterprise Information Catalog does not provide a model for Microsoft Access database and you cannot use any of the existing models in Enterprise Information Catalog. You must create a custom model to represent the metadata for Microsoft Access database, in the catalog. The custom resource must extract custom metadata for the following classes, attributes, and associations from the data source: Classes Class AccessSchema AccessTable AccessTableColumn AccessView AccessViewColumn Type Schema Table Column View View column 12 Chapter 2: Custom Metadata Integration Concepts

13 Attributes Attribute Name Abbreviation BusinessUsage DateCreated Datatype Length Data Type String String String String String String Associations Association AccessSchemaAccessTable AccessTableAccessTableColumn AccessSchemaAccessView AccessViewAccessViewColumn Association Type Parent-child Parent-child Parent-child Parent-child In the model that you define for the Microsoft Access data source, make sure that you include the required classes, attributes, and associations in the definition. You can create a custom model in one of the following ways: Export an existing model definition file and update the file to create the custom model. Create a custom model following the recommendations in the model definition file that you can download in Catalog Administrator. See chapter Creating Custom Models for more information about creating custom models. Custom Model Components The following are the components in a custom model definition: Package Version The name of the custom model. For example <packagename>com.example.accessdb</packagename> Note: Verify that the package name does not start with com.informatica or com.infa. The version of the custom model. Custom Model Components 13

14 Required Packages A comma (,) separated list of required or reused package names. You must use fully-qualified package names if you are reusing any components such as classes, attributes, or associations from other packages. Verify that you define the name of the package as core if you are reusing other packages. For example, <packagename>core</packagename> Attributes Classes List of attributes to include in the model from the data source. List of classes to include in the model from the data source. Associations List of classes included in the package. Class Properties The model properties or the package properties includes the properties that you must define for the package component in the custom model. The following table lists the properties that you must define package component, in the custom model XML file: Property Description Example name Name of the class. Table label superclasses Text displayed for the class that is visible to the user. List of classes with which the class has a semantic relationship. Included Table core.dataelement Make sure that you include the prefix core to the super class name. description Description for the class. This is a table class. isfirstclass boost deprecated Use this property to specify if the class must be prioritized in search. The property type is boolean. If you set the property to true, Enterprise information Catalog displays the object count of the classes after you run the resource. You can also view the count of first class objects in the Asset Details view. Specifies the priority for the class in a search index. The possible values are LOW, MEDIUM, or HIGH. Specifies if the class is deprecated. Default is false. true HIGH false 14 Chapter 2: Custom Metadata Integration Concepts

15 Make sure that you do not change values for the following properties in an existing model when you update the model: name superclasses Attribute Properties The following table lists the properties that you can define for the Attribute component, in the custom model XML file: Property Description Example name Name of the attribute. Comment label datatype searchable facetable boost Text that appears for the attribute. Data type of the attribute. The data type can be any of the data types listed in the Data Type Properties section. Use this property to specify that the attribute can be searched in Enterprise Information Catalog. The property value is boolean. Default is false. Use this property to specify that the attribute must appear as a filter to refine the search results in Enterprise Information Catalog. The property value is boolean. Default is false. Use this property to specify the priority for the attribute in search. The possible values are LOW, MEDIUM, or HIGH. Comment core.string Make sure that you prefix the term core to data type. false false HIGH description Description of the attribute. This is a string-type attribute. multivalued suggestable Use this property to specify if the attribute can have multiple values. The property value is boolean. Default is true. Use this property to specify that the attribute can appear as suggestions when you search in Enterprise Information Catalog. The property value is boolean. Default is false. true. false Custom Model Components 15

16 Property Description Example sortable visible Use this property to specify that you can sort the search results using the attribute. The property value is boolean. Default is false. Use this property to specify that the attribute must be visible. The property value is boolean. Default is true. If you set the value to false, you cannot view the attribute in Enterprise Information Catalog. false true Make sure that you do not change values for the following properties in an existing model when you update the model: name datatype Note: Apart from the Name, Label, and Data Type attributes, the remaining attributes vary based on the facts from the data source. Association Properties The following table lists the properties that you can specify for the Association component, in the custom model XML file: Property Description Example name Name of the association. DatabaseSchema fromclass toclass fromlabel tolabel Source class of the association. Target class of the association. Text that describes the relationship from the source class. Text that describes the relationship to the target class. com.ldm.custom.customdbrelational3.da tabase Make sure that you specify the class name in the following format:com.ldm.custom.<custom model name>.<class name> com.ldm.custom.customdbrelational3.sc hema Make sure that you specify the class name in the following format: Make sure that you specify the class name in the following format: com.ldm.custom.<custom model name>.<class name> Database Schema 16 Chapter 2: Custom Metadata Integration Concepts

17 Property Description Example associationkinds The type of association. core.parentchild Make sure that you prefix the term core with the association kind. deprecated Indicates if the association is deprecated. <deprecated>false</deprecated> unidirectional Indicates if the association is only valid for one direction. <unidirectional>false</unidirectional> Make sure that you do not change values for the following properties in an existing model when you update the model: associationkinds name toclass fromclass unidirectional Note: If you want to modify the values listed, for an existing model, you must create a new association and define the required values. Data Type Properties The following list includes the core data types that you can define for the data types component in the custom model XML file: String Boolean Date Decimal Integer Path Classifier Range* Use the data type to limit the values based on a range of values. The data type is based on integer, decimal, and date core data types. List*. Use the data type to limit the values to a set of values. Regular Expression* Use the data type to limit the values based on a regular expression. The data type is based on string and path core data types. * indicates custom data types allowed based on the core data types. Custom Model Components 17

18 C h a p t e r 3 Create Custom Models This chapter includes the following topics: Model Definition Guidelines, 18 Define the Custom Model XML File for the Business Example, 18 Creating Custom Models, 25 Exporting Models, 25 Updating Custom Models, 25 Deprecating Custom Models, 26 Model Definition Guidelines You can use the model definition XSD file that the Catalog Administrator bundles to verify the guidelines to create a custom model. You can download the model definition XSD file by performing the following steps: 1. Click Manage > Models in Catalog Administrator. The Models page appears. 2. Click (Add). The menu appears. 3. Select Download Model Definition File from the menu. Enterprise Information Catalog downloads the custom_model.xsd file to your machine. Define the Custom Model XML File for the Business Example The following tables show how to define classes, attributes, and associations for the Microsoft Access database from which you want to extract metadata: 18

19 Package Definitions The following table lists the entries in the custom model XML file that you must enter to define the package for Microsoft Access database: Package Definition Entry Value Description packagename com.example.acessdb The name of the custom model. packagedescription Model created to load Access database Description for the model. packagelabel Access Database Label for the model. version 1 Version number for the model. Ensure that you increment the version by one when you update the model. requiredpackages <packagename>core</ packagename> A comma (,) separated list of required model names and the corresponding versions. Verify that you define the name of the package as core if you are using any core class such as core.dataset, core.dataelement. For example, <packagename>core</ packagename> Class Definitions The following table lists the entries for the AccessSchema class that you must define in the custom model XML file: Class Definition Entry Value Description name AccessSchema Name of the class. label Access Schema Text displayed for the class that is visible to the user. isfirstclass true Use this property to specify if the class must be prioritized in search. boost LOW Specifies the priority for the class in a search index. superclasses <superclass>core.datasource </superclass> List of classes with which the class has a semantic relationship. Make sure that you include the prefix core to the super class name. deprecated false Specifies if the class is deprecated. See the Sample Custom Model XML File section for more information to add definitions for other classes. Define the Custom Model XML File for the Business Example 19

20 Attribute Definitions The following table lists the entries in the custom model XML file that you must enter to define the attributes in the Microsoft Access database: Attribute Definition Entry Value Description name BusinessUsage Name of the attribute. label Business Usage Text that appears for the attribute. datatype core.string Data type of the attribute. The data type can be any of the data types listed in the Data Type Properties section. Make sure that you prefix the term core to data type. searchable false Use this property to specify that the attribute can be searched in Enterprise Information Catalog. facetable false Use this property to specify that the attribute must appear as a filter to refine the search results in Enterprise Information Catalog. suggestable false Use this property to specify that the attribute can appear as suggestions when you search in Enterprise Information Catalog. multivalued false Use this property to specify if the attribute can have multiple values. visible true Use this property to specify that the attribute must be visible. If you set the value to false, you cannot view the attribute in Enterprise Information Catalog. sortable false Use this property to specify that you can sort the search results using the attribute. boost LOW Use this property to specify the priority for the attribute in search. See the Sample Custom Model XML File section for more information to add definitions for other attributes. 20 Chapter 3: Create Custom Models

21 Association Definitions The following table lists the entries in the custom model XML file that you must enter to define the associations in the Microsoft Access database: Association Definition Entry Value Description name AccessSchemaAccessTable Name of the association. fromclass toclass com.example.acessdb.acces sschema com.example.acessdb.acces stable Source class of the association. Make sure that you specify the class name in the following format:com.ldm.custom.<custom model name>.<class name> Target class of the association. Make sure that you specify the class name in the following format: Make sure that you specify the class name in the following format: com.ldm.custom.<custom model name>.<class name> fromlabel Access Schema Text that describes the relationship from the source class. tolabel Access Table Text that describes the relationship to the target class. associationkinds <associationkind>core.parent Child</associationKind> The type of association. Make sure that you prefix the term core with the association kind. deprecated false Indicates if the association is deprecated. unidirectional false Indicates if the association is only valid for one direction. See the Sample Custom Model XML File section for more information to add definitions for other associations. Sample Custom Model XML File <Package> <packagename>com.example.acessdb</packagename> <packagedescription>model created to load Access database</packagedescription> <packagelabel>access Database</packageLabel> <version>1</version> <requiredpackages> <requiredpackage> <packagename>core</packagename> <version>1</version> </requiredpackage> </requiredpackages> <referencedatatypes/> <referenceattributes/> <classes> <class> <name>accessschema</name> <label>access Schema</label> <description/> Define the Custom Model XML File for the Business Example 21

22 22 Chapter 3: Create Custom Models <isfirstclass>true</isfirstclass> <boost>low</boost> <superclasses> <superclass>core.datasource</superclass> </superclasses> <deprecated>false</deprecated> </class> <class> <name>accesstable</name> <label>access Table</label> <description/> <isfirstclass>true</isfirstclass> <boost>low</boost> <superclasses> <superclass>core.dataset</superclass> </superclasses> <deprecated>false</deprecated> </class> <class> <name>accesstablecolumn</name> <label>access Table Column</label> <description/> <isfirstclass>false</isfirstclass> <boost>low</boost> <superclasses> <superclass>core.dataelement</superclass> </superclasses> <deprecated>false</deprecated> </class> <class> <name>accessview</name> <label>access View</label> <description/> <isfirstclass>true</isfirstclass> <boost>low</boost> <superclasses> <superclass>core.dataset</superclass> </superclasses> <deprecated>false</deprecated> </class> <class> <name>accessviewcolumn</name> <label>access View Column</label> <description/> <isfirstclass>false</isfirstclass> <boost>low</boost> <superclasses> <superclass>core.dataelement</superclass> </superclasses> <deprecated>false</deprecated> </class> </classes> <attributes> <attribute> <name>name</name> <label>name</label> <datatype>core.string</datatype> <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> <attribute>

23 <name>abbreviation</name> <label>abbreviation</label> <datatype>core.string</datatype> <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> <attribute> <name>businessusage</name> <label>business Usage</label> <datatype>core.string</datatype> <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> <attribute> <name>datecreated</name> <label>date Created</label> <datatype>core.string</datatype> <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> <attribute> <name>datatype</name> <label>datatype</label> <datatype>core.string</datatype> <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> <attribute> <name>length</name> <label>length</label> <datatype>core.string</datatype> Define the Custom Model XML File for the Business Example 23

24 24 Chapter 3: Create Custom Models <searchable>false</searchable> <facetable>false</facetable> <boost>low</boost> <description/> <multivalued>false</multivalued> <suggestable>false</suggestable> <sortable>false</sortable> <visible>true</visible> <deprecated>false</deprecated> <derived>false</derived> <fuzzy>false</fuzzy> <data>false</data> </attribute> </attributes> <associations> <association> <name>accessschemaaccesstable</name> <fromclass>com.example.acessdb.accessschema</fromclass> <toclass>com.example.acessdb.accesstable</toclass> <fromlabel>access Schema</fromLabel> <tolabel>access Table</toLabel> <associationkinds> <associationkind>core.parentchild</associationkind> </associationkinds> <deprecated>false</deprecated> <unidirectional>false</unidirectional> </association> <association> <name>accesstableaccesstablecolumn</name> <fromclass>com.example.acessdb.accesstable</fromclass> <toclass>com.example.acessdb.accesstablecolumn</toclass> <fromlabel>access Table</fromLabel> <tolabel>access Table Column</toLabel> <associationkinds> <associationkind>core.parentchild</associationkind> </associationkinds> <deprecated>false</deprecated> <unidirectional>false</unidirectional> </association> <association> <name>accessschemaaccessview</name> <fromclass>com.example.acessdb.accessschema</fromclass> <toclass>com.example.acessdb.accessview</toclass> <fromlabel>access Schema</fromLabel> <tolabel>access View</toLabel> <associationkinds> <associationkind>core.parentchild</associationkind> </associationkinds> <deprecated>false</deprecated> <unidirectional>false</unidirectional> </association> <association> <name>accessviewaccessviewcolumn</name> <fromclass>com.example.acessdb.accessview</fromclass> <toclass>com.example.acessdb.accessviewcolumn</toclass> <fromlabel>access View</fromLabel> <tolabel>access View Column</toLabel> <associationkinds> <associationkind>core.parentchild</associationkind> </associationkinds> <deprecated>false</deprecated> <unidirectional>false</unidirectional> </association> </associations> <associationkinds/> <datatypes/> <classattributes/> </Package>

25 Creating Custom Models Perform the following steps to create a custom model: Verify that you have created and saved the model XML file and validated the file with the XSD file. 1. Click Manage > Models. The Models page appears. 2. Click. The menu appears with the following options: Create New Custom Model. Download Custom Model Definition File. 3. Click Create New Custom Model. The Upload Custom Model Definition File dialog box appears. 4. Click Browse and select the model XML file that you had created and saved. The custom model is registered with the catalog. Exporting Models You can export a system model or a custom model XML file to your machine. You can then use the exported XML file to create a custom model. 1. Click Manage > Models. The Models page appears. 2. Select the model that you want to export and click Export. Enterprise Information Catalog downloads the model XML file to your machine. Updating Custom Models You can make changes to a custom model based on your requirements. Ensure that you increment the version number of the model by one. Verify that you exported the custom model XML file to your machine, made the required changes, and saved the file. See the following sections to know more about the properties that you must not modify when you update custom models: - Association Properties - Attribute Properties - Class Properties 1. Click Manage > Models. The Models page appears. Creating Custom Models 25

26 2. Select the custom model that you want to edit and click Update. The Upload Custom Model dialog box appears. 3. Click Browse to select the modified custom model XML file. The custom model updates take effect during the subsequent scan by the resource. Deprecating Custom Models You can deprecate a custom model. After you deprecate a custom model, you cannot create custom resource types based on the deprecated custom model or associate the deprecated custom model to existing custom resource types. When you deprecate a custom model, Enterprise Information Catalog places the model in the Deprecated Models section on the Models page. Verify that the custom model is not associated to any custom resource type. If a custom resource type is associated with the custom model that you want to deprecate, remove the association and associate the resource type with another model. 1. After you deprecate a custom model, you cannot change it back to a model that you can use to create custom resource types. 1. Click Manage > Models. The Models page appears. 2. Select the custom model that you want to deprecate and click Deprecate. The confirmation dialog box appears. 3. Click OK to deprecate the custom model. The custom model appears in the Deprecated Models section on the Models page. After you deprecate a custom model, Enterprise Information Catalog continues to scan and ingest metadata into the catalog using the custom resource that you created based on the custom model. 26 Chapter 3: Create Custom Models

27 C h a p t e r 4 Preparing the Export Template for Metadata Ingestion This chapter includes the following topics: Metadata Ingestion Overview, 27 Exporting the Custom Resource Type Template, 27 Entering Class Details, 28 Entering Association Details, 29 Metadata Ingestion Overview To ingest custom metadata into the catalog, you must enter the data from the custom data source into a template following the template structure. The custom resource uses the data provided in the template to extract and ingest metadata into the catalog. After creating a custom resource type based on the custom model, you must perform the following steps to ingest metadata into the catalog: 1. Export the custom resource type ZIP file. 2. Extract the CSV files included in the ZIP file. 3. Fill the details in the CSV files according to the structure. 4. Include the updated CSV files in the ZIP file. 5. Provide the ZIP file when you configure the custom resource. Exporting the Custom Resource Type Template You can use the custom resource type template to add the object details of a particular class defined in the model. Enterprise Information uses the details entered in the template to ingest metadata into the catalog. 1. Click Manage > Custom Resource Types. The Custom Resource Types page appears. 27