Enterprise Data Catalog Custom Metadata Integration Guide > Custom Metadata Integration Concepts > Custom Model Components
  

Custom Model Components

The following are the components in a custom model definition:
Package
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.
Version
The version of the custom model.
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
List of attributes to include in the model from the data source.
Classes
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
Text displayed for the class that is visible to the user.
Included Table
superClasses
List of classes with which the class has a semantic relationship.
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
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.
true
boost
Specifies the priority for the class in a search index. The possible values are LOW, MEDIUM, or HIGH.
HIGH
deprecated
Specifies if the class is deprecated. Default is false.
false
Make sure that you do not change values for the following properties in an existing model when you update the model:

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
Text that appears for the attribute.
Comment
dataType
Data type of the attribute. The data type can be any of the data types listed in the Data Type Properties section.
core.String
Make sure that you prefix the term core to data type.
searchable
Use this property to specify that the attribute can be searched in Enterprise Information Catalog. The property value is boolean. Default is false.
false
facetable
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.
false
boost
Use this property to specify the priority for the attribute in search. The possible values are LOW, MEDIUM, or HIGH.
HIGH
description
Description of the attribute.
This is a string-type attribute.
multivalued
Use this property to specify if the attribute can have multiple values. The property value is boolean. Default is true.
true.
suggestable
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.
false
sortable
Use this property to specify that you can sort the search results using the attribute. The property value is boolean. Default is false.
false
visible
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.
true
Make sure that you do not change values for the following properties in an existing model when you update the model:
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
Source class of the association.
com.ldm.custom.customdbrelational3.Database
Make sure that you specify the class name in the following format:com.ldm.custom.<custom model name>.<class name>
toClass
Target class of the association.
com.ldm.custom.customdbrelational3.Schema
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
Text that describes the relationship from the source class.
Database
toLabel
Text that describes the relationship to the target class.
Schema
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:
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:
* indicates custom data types allowed based on the core data types.