Manta Flow Alation: IBM Automatic Data Lineage-Alation Resource Mapping
Alation Resource Mapping Configuration
It is possible, and usually necessary, to map database objects in the Manta Flow metadata repository (tables, views, etc.) to Alation Data Catalog resources. This mapping can be set on the Manta Admin UI screen under Configurations > Integrations > Alation > <technology>
Alation Mapping, where <technology>
represents the technology the mapping is made for. Although the mapping is different for each technology, there are some common principles.
-
The first column always represents the Alation source ID or BI server ID. It is an output of the mapping.
-
The other columns each define a set of database or BI objects belonging to the Alation resource. They are an input of the mapping. The object set definition for each technology is described below.
-
The entries are case sensitive — for example,
HostAndInstanceName
,Host
,Global Database Name
, etc. must be specified with the exact case as internally defined in the database itself; otherwise, the mapping will not be applied.
Db2 Resource Mapping Configuration
The Db2 Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | Integer ID of the mapped Alation database source* | Can't be empty | 1 |
HostAndInstanceName | Name of the host and instances of the resource database objects, separated by backslashes (\ ) |
All objects of the processed connection belong to the resource | db2server\\inst |
DatabaseName | Name of the database of the resource database objects | All objects of the given host and instances belong to the resource | PROD |
IncludedSchemas | Regular expression matching the schemas that will be exported | All objects of the given database belong to the resource except the ones defined in ExcludedSchemas |
PROD_MART_.*|PROD_MRT |
ExcludedSchemas | Regular expression matching the schemas that will be excluded from the export | No schemas will be excluded | PROD_MART_TEST |
*For a description of how to get the Alation source ID, see How to Acquire an Alation BI Server ID.
The example mapping (see the values in the table above) says that the resource with the ID 1
should cover the database objects of the host db2server
, instance inst
, database PROD
, and schemas starting
with PROD_MART_
except for PROD_MART_TEST
.
MS SQL Resource Mapping Configuration
The MS SQL Alation mapping structure:
Column |
Description |
If empty |
Example value |
---|---|---|---|
DatabaseSourceId |
Integer ID of the mapped Alation database source |
Can't be empty |
|
Host |
Instance name of MS SQL Server, which can be either:
|
All objects of the connection processed belong to the resource |
|
Included database/schemas |
A comma-separated list of slash-separated (
|
All objects of the given server and instances belong to the resource except the ones defined in
|
|
Excluded database/schemas |
A comma-separated list of slash-separated (
|
No databases/schemas are explicitly excluded from the export |
|
The example mapping (see the values in the table above) says that the resource with the ID 2
should cover the database objects of the server 192.168.25.1
, instance SQL08
, database mart
, and all
schemas except the ones starting with test_
.
Netezza Resource Mapping Configuration
The Netezza Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | Integer ID of the mapped Alation database source | Can't be empty | 3 |
ServerName | Name of the server of the resource database objects | All objects of the connection processed belong to the resource | nzserver |
DatabaseName | Name of the database of the resource database objects | All objects of the server belong to the resource | MART |
IncludeSchemas | Regular expression matching the schemas that will be exported | All the schemas of the given server and instances belong to the resource except the ones defined in ExcludeSchemas |
ADMIN |
ExcludeSchemas | Regular expression matching the schemas that will be excluded from the export | No schemas are explicitly excluded from the export |
The example mapping (see the values in the table above) says that the resource with the ID 3
should cover the database objects of the server nzserver
, database MART
, and schema ADMIN
.
Oracle Resource Mapping Configuration
The Oracle Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | Integer ID of the mapped Alation database source | Can't be empty | 4 |
Global database name | Name of the database of the resource database objects | All objects of the connection processed belong to the resource | orcl.manta.eu |
Included schemas | Regular expression matching the schemas that will be exported | All schemas of the given database belong to the resource except the ones defined in Excluded Schemas |
PROD_MART_.*|PROD_MRT |
Excluded schemas | Regular expression matching the schemas that will be excluded from the export | No schemas are explicitly excluded from the export | PROD_MART_TEST |
The example mapping (see the values in the table above) says that the resource with ID 4
should cover the database objects of the global database orcl.manta.eu
and schemas starting with PROD_MART_
except
PROD_MART_TEST
.
Teradata Resource Mapping Configuration
The Teradata Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | Integer ID of the mapped Alation database source | Can't be empty | 5 |
Teradata server name | Name of the server of the resource database objects | All objects of the connection processed belong to the resource | 127.0.0.1 |
Included databases | Regular expression matching the databases that will be exported | All databases of the given database server belong to the resource except the ones defined in Excluded Databases |
PROD_MART_.*|PROD_MRT |
Excluded databases | Regular expression matching the databases that will be excluded from the export | No databases are explicitly excluded from the export | PROD_MART_TEST |
The example mapping (see the values in the table above) says that the resource with the ID 5
should cover the database objects of the server 127.0.0.1
and databases starting with PROD_MART_
except
PROD_MART_TEST
.
PostgreSQL Resource Mapping Configuration
The PostgreSQL Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | Integer ID of the mapped Alation database source | Can't be empty | 6 |
Host | Name of the host of the resource database objects | All objects of the connection processed belong to the resource | pghost |
Included schemas | A comma-separated list of slash-separated (/ ) regular expressions of the databases and schemas (e.g., “db1/sch1”) matching the databases and schemas that will be exported |
All databases and schemas of the given host belong to the resource except the ones defined in Excluded Schemas |
martdb |
Excluded schemas | A comma-separated list of slash-separated (/ ) regular expressions of the databases and schemas (e.g., “db1/sch1”) matching databases and schemas that will be excluded from the export |
No databases and schemas are explicitly excluded from the export | public |
The example mapping (see the values in the table above) says that the resource with the ID 6
should cover the database objects of the host pghost
, database martdb
, and schema public
.
SSAS Resource Mapping Configuration
The SSAS Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
ServerId | Integer ID of the mapped Alation BI server* | Can't be empty | 11 |
Server name | Name of the server of the resource objects | All objects of the connection processed belong to the resource | SQLServer |
Included databases / tabular models | Regular expression matching the databases / tabular models that will be exported | All databases / tabular models of the given server belong to the resource except the ones defined in Excluded Databases / Tabular Models |
ModelDB |
Excluded databases / tabular models | Regular expression matching the databases / tabular models that will be excluded from the export | No databases / tabular models are explicitly excluded from the export |
*For a description of how to get the Alation BI server ID, see How to Acquire an Alation BI Server ID.
The example mapping (see the values in the table above) says that the resource with the ID 11
should cover the database objects of the server SQLServer
and the database or tabular model ModelDB
.
Snowflake Resource Mapping Configuration
The Snowflake Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
ServerId | Integer ID of the mapped Alation database source | Can't be empty | 8 |
Account Name | Name of the account of the resource database objects, which will correspond to the naming of the Snowflake server node in Automatic Data Lineage | All objects of the connection processed belong to the resource | mantapartner |
Region | Name of the region of the resource database objects | All objects of the account with an unspecified region belong to the resource | us-east-1 |
Included Databases and Schemas | Slash-separated (/ ) regular expressions of the databases and schemas of the resource database objects |
All objects of the given server and instances belong to the resource except the ones defined in Excluded Schemas |
PROD_MART/DWH,PROD_MART/PUBLIC |
Excluded Databases and Schemas | Slash-separated (/ ) regular expressions of the databases and schemas with database objects excluded from the resource |
No objects are explicitly excluded from the resource |
The example mapping (see the values in the table above) says that the resource with the ID 8
should cover the database objects of the account mantapartner
, region us-east-1
, database PROD_MART
,
and schemas DWH
and PUBLIC
.
BigQuery Resource Mapping Configuration
The BigQuery Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
ServerId | Integer ID of the mapped Alation database source | Can't be empty | 17 |
Service URL | URL of the BigQuery service endpoint | All objects of the service URL belong to the resource | https://www.googleapis.com/bigquery/v2 |
Included projects/datasets | Slash-separated (/ ) regular expressions of the projects and datasets of the resource database objects |
All objects of the service URL belong to the resource except the ones defined in Excluded projects/datasets |
PROD_MART/DWH,PROD_MART/PUBLIC |
Excluded projects/datasets | Slash-separated (/ ) regular expressions of the projects and datasets with database objects excluded from the resource |
No objects are explicitly excluded from the resource |
The example mapping (see the values in the table above) says that the resource with the ID 17
should cover the database objects of the service URL https://www.googleapis.com/bigquery/v2
, project PROD_MART
,
and datasets DWH
and PUBLIC
.
SAP HANA Resource Mapping Configuration
The SAP HANA Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
DatabaseSourceId | ID of the server uploaded to Alation | Can't be empty | 17 |
Host | Hostname of the server | All objects of the hosts belong to the resource | hostname1 |
Database | Name of the database instance | All objects of the databases belong to the resource | dev1 |
Included schemas | List of schemas to extract, separated by commas; each item is evaluated as a regular expression | All objects of the host belong to the resource except the ones defined in Excluded schemas | .* |
Excluded schemas | List of schemas to be excluded, separated by commas. Each item is evaluated as a regular expression. If left blank, no schemas will be excluded. | No objects are explicitly excluded from the resource | schema1,schema2 |
The example mapping (see the values in the table above) says that the resource with the ID 17
should cover the database objects of the host hostname1
and database dev1
, including all schemas except
schema1
and schema2
.
BI Technologies (Reporting Tools) Resource Mapping Configuration
There is a common configuration structure for all supported reporting tools. The <technology>
Alation mapping structure:
Column | Description | If empty | Example value |
---|---|---|---|
ServerId | Integer ID of the mapped Alation BI server | Can't be empty | 12 |
ConnectionId | Name of the connection ID for the technology | All objects of the connection processed belong to the resource | obiee |
The example mapping (see the values in the table above) says that the resource with the ID 12
should cover the BI objects of the obiee
connection.
Custom Database Resource Mapping Configuration (Available as of R42.5)
There is a common configuration structure for all supported reporting tools. The <technology>
Alation mapping structure:
Column | Description | If empty | Example value 1 | Example value 2 |
---|---|---|---|---|
Virtual Datasource Id | Integer ID of the mapped Alation Virtual Datasource server | Can't be empty | 12 |
12 |
Server | Name of the Automatic Data Lineage server for the custom database | All custom database connections will be mapped to this Virtual Datasource Id, except if Included schemas defines the specific Database | 127.0.0.1 |
|
Included schemas | List of schemas to extract, separated by commas; each item is evaluated as a regular expression | All objects of the custom database belong to the resource except the ones defined in Excluded schemas | ORCL/.* |
ORCL/.* |
Excluded schemas | List of schemas to be excluded, separated by commas. Each item is evaluated as a regular expression. If left blank, no schemas will be excluded. | No objects are explicitly excluded from the resource | ORCL/schema1 |
The example 1 mapping (see the values in the preceding table) says that the resource with the ID 12
should cover the ORCL
custom database objects of the 127.0.0.1
server node, excluding schema1
.
The example 2 mapping (see the values in the preceding table) says that the resource with the ID 12
should cover the ORCL
custom database objects. This is valid in cases were the Server node is not present.
Filesystem resource mapping configuration (available as of R42.12)
The Filesystem Alation mapping structure is as follows:
Column | Description | If empty | Example value 1 | Example value 2 |
---|---|---|---|---|
Filesystem Source ID | ID of the filesystem source uploaded to Alation | Can't be empty | 1 |
|
Filesystem path | Slash-separated (/ ) entries of path to the Manta node representing the base directory of the filesystem resource |
Can't be empty | /S3/myBucket |
|
Included Folders | Regular expressions matching folders on the filesystem path to be exported | All folders to be exported except the ones defined in Excluded Folders | prod.* |
.* |
Excluded Folders | Regular expressions matching folders on the filesystem path to be excluded from the export | No folders are explicitly excluded | doc.*,temp.*,test.* |
|
Upload File Assets | Flag whether or not to upload file assets into Alation. Use false when using a native Alation filesystem source where assets are provided by Alation, and true for virtual Alation filesystem source. | Can't be empty | true | false |
The example 1 mapping (see the values in the preceding table) shows that the Alation source with the ID 1 should cover file assets in S3 Manta resource, on /myBucket base path, in folders starting with prod. The file assets are also uploaded into the Alation source.
The example 2 mapping (see the values in the preceding table) shows that the Alation source with the ID 1 should cover file assets in S3 Manta resource, on /myBucket base path, in all folders except the ones starting with doc, temp, or test. The file assets aren't uploaded into Alation and are expected to already exist in the Alation source.
How to Acquire an Alation Source ID
There are several places where the source ID value can be found.
The first option is to find the ID in the Alation UI. It is not explicitly rendered in the content of the screen, but the URL links leading to the source detail screen contain the ID. It is possible to go to the source overview screen and read the value from the URL or to hover over the link and read the value from the link URL that is typically shown in the lower-left corner.
Another option is to use Alation APIs to get the list of sources. The API endpoint [GET] http://<ALATION_URL>/integration/v1/datasource
can be used for this. The output (see the example below) contains both the
Title and the ID of the BI server.
[
...
{
"id": 9,
"title": "Oracle",
...
},
...
]
How to Acquire an Alation BI Server ID
There are several places where the BI server ID value can be found.
The first option is to find the ID in the Alation UI. It is not explicitly rendered in the content of the screen, but the URL links leading to the BI server detail screen contain the ID. It is possible to go to the BI server overview screen and read the value from the URL or to hover over the link and read the value from the link URL that is typically shown in the lower-left corner.
Another option is to use Alation APIs to get the list of BI servers. The API endpoint [GET] http://<ALATION_URL>/integration/v2/bi/server
can be used for this. The output (see the example below) contains both the
Title and the ID of the BI server.
[
...
{
"id": 25,
"title": "SAP BO:default",
...
},
...
]