When you configure the erwin Mart Server catalog source, you define the settings for the metadata extraction capability.
The metadata extraction capability extracts source metadata from external source systems. You can also configure other capabilities that the catalog source includes.
You can save the catalog source configuration at any point after you enter the connection information. After you save the catalog source, you can choose to run the catalog source job. To run the job once, click Run. To run metadata extraction and other capabilities on a recurring schedule, configure schedules on the Schedule tab.
Configure metadata extraction
When you configure the erwin Mart Server catalog source, you choose a runtime environment, define filters, and enter configuration parameters for metadata extraction.
1In the Connection and Runtime area, choose a serverless runtime environment or the Secure Agent group where you want to run catalog source jobs.
Note:
Serverless runtime environment options are available if the catalog source works with a serverless runtime environment.
2Choose to retain, delete, or deprecate objects that are deleted from the source system in the catalog with the Metadata Change Option.
- Retain. Retains objects that are deleted from the source system in the catalog. If you update or add a filter, the catalog retains objects extracted from the previous job and extracts additional objects that match the current filter. Objects deleted from the source system are not deleted from the catalog. Enrichments added on deleted objects and relationships are retained.
- Delete. Deletes metadata from the catalog based on objects deleted from the source system and changes you make to the filter. Enrichments added on deleted objects and relationships are also permanently lost. Objects renamed in the source system are removed and recreated in the catalog.
- Deprecate. The lifecycle of objects imported into the catalog moves to Obsolete based on objects deleted from the source system and changes you make to the filter. This does not impact enrichments added on deprecated objects and relationships. Objects renamed in the source system are removed and recreated in the catalog. When you run the catalog source job again for other capabilities such as data classification, relationship discovery, or glossary association, the job doesn't consider obsolete objects. Obsolete objects remain in the catalog until they are purged when you run a Purge Obsolete Objects job on the Explore page.
Note:
You can also change the configured metadata change option when you run a catalog source.
3In the Filters area, define one or more filter conditions to apply for metadata extraction:
aSelect Yes to view filter options.
bFrom the Include Metadata list, choose to include metadata based on the filter parameters.
cFrom the Object type list, select Objects.
dFrom the Filter criteria list, enter the include filter value.
Each pattern can contain wildcards. Use '?' in place of '/' in report or folder names.
Filters can contain the following wildcards:
▪ Question mark. Represents a single character.
▪ Asterisk. Represents multiple characters or empty text.
The following image shows the filter condition options:
eOptionally, to define an additional filter with an OR condition, click the Add icon.
The following image shows a filter that includes metadata from the objects named erwinMart1 and erwinMart2:
4In the Configuration Parameters area, enter the configuration parameters.
The following table describes the properties that you can enter:
Property
Description
Browse Mode
Specifies how you browse the erwin Mart Server.
- Libraries and Models. Retrieves the tree of libraries and models.
- Libraries Only. Selects libraries. This mode is more efficient on large marts.
Incremental Import
Select one of the following options to specify if you want to extract metadata that has changed since the previous run or extract complete metadata:
- True. Extracts only the changes to the metadata since the last metadata extraction job.
- False. Extracts the complete metadata.
Import UDPs
Specify how to import property definitions and values. A user-defined property (UDP) is usually defined with a property definition object that has a default value.
Import Relationship Name
Specifies how to import erwin Mart Server relationship names.
- From relationship name. Imports relationship names from the name property.
- From derived name. Imports relationship names from the verb phrase derived name.
Import Column Order From
Specifies how to import the erwin column order.
- Column Order. Imports the column order from the erwin physical view.
- Physical Order. Imports the column order from the database as generated in SQL Data Definition Language.
Import Owner Schemas
Specifies how to import erwin owner schemas.
- True. Imports the owner schema of tables, views, and other database objects.
- False. Doesn't import the owner schema of tables, views, and other database objects. Use this option for models where physical names are not unique.
Move Entities to Subject Areas
If entities belong to one subject area, they are placed in the corresponding package. Other entities are placed in the model.
- True. If you want the subject areas to be used as conventional UML design packages with corresponding names spaces.
- False. If you don't want to move the entities to the subject areas.
Miscellaneous Options
Optionally, specify miscellaneous options starting with a dash and followed by parameters.
5Configure additional capabilities for the catalog source by clicking on the tabs.
Configure lineage discovery
Enable the lineage discovery capability and use CLAIRE to build complete lineage by recommending endpoint catalog source objects to assign to reference catalog source connections.
1Click the Lineage Discovery tab.
2Select Enable Lineage Discovery.
3In the Filters area, define one or more filter conditions to apply for lineage discovery.
To define filters, you can choose to select catalog source types, asset groups, or enter a catalog source name or search from a list of catalog sources.
aSelect Yes to view filter options.
bFrom the Include/Exclude list, choose to include or exclude catalog sources for lineage discovery based on the filter parameters.
cFrom the filter type list, select catalog source type, catalog source name, or asset group.
dIn the filter value field, select the required catalog source types, or click the Search button and select catalog sources or asset groups.
Filters can contain the asterisk wildcard to represent multiple characters or empty text.
The filter options appear.
Examples:
▪ To include or exclude all Oracle catalog sources, select Catalog Source Type as the filter type and select Oracle in the filter value field.
▪ To include or exclude the 'Oracle_Retail' catalog source, select Catalog Source Name as the filter type and search for the catalog source or enter Oracle_Retail in the filter value field.
▪ To include or exclude all catalog sources with names that start with 'Oracle', select Catalog Source Name as the filter type and search for the catalog source or enter Oracle* in the filter value field.
▪ To include or exclude all catalog sources with names that end with 'Retail', select Catalog Source Name as the filter type and search for the catalog source or enter *Retail in the filter value field.
▪ To include or exclude all catalog sources with names that contain 'Ret', select Catalog Source Name as the filter type and search for the catalog source or enter *Ret* in the filter value field.
▪ To include or exclude all catalog sources that are part of the 'Financial Group' asset group, select Asset Group as the filter type and search Financial Group in the filter value field.
Note:
You can't add more than one include or exclude filter for the same filter type.
eOptionally, to define an additional filter with an AND condition, click the Add icon.
For more information about lineage discovery, see Lineage discovery.