Configure Access to Enterprise Data Catalog
In Axon, you can configure Enterprise Data Catalog parameters from the Admin Panel. You must have the Super Admin profile to perform this task. After you configure the parameters, you can test the connectivity to Enterprise Data Catalog to ensure the entered parameters are correct.
After you install Axon, you can configure Enterprise Data Catalog parameters from the Admin Panel in the following scenarios:
- •You did not select advanced configuration during Axon installation.
- •You want to update the connection settings for Enterprise Data Catalog after the installation.
1. From the Axon toolbar, click the Admin Panel menu item under your user name.
2. In the menu on the left, under the Customize & Configure category, click System Settings.
3. In the Group list, select Enterprise Data Catalog.
4. Click Edit, and configure the following properties:
Property | Description |
|---|
Enterprise Data Catalog Server Host | URL of the Enterprise Data Catalog service in the following format: http(s)://<host_name> or http(s)://<IP_address> |
Enterprise Data Catalog Server Port | Port number of the Enterprise Data Catalog service. |
Enterprise Data Catalog Server Login User Name | User name to log in to Enterprise Data Catalog server. |
Enterprise Data Catalog Server Login Password | Password to log in to Enterprise Data Catalog server. |
Enterprise Data Catalog Server Login Namespace | User security domain of Enterprise Data Catalog server |
Enterprise Data Catalog Resource Name | Name of the resource created in Enterprise Data Catalog that connects to your Axon application. |
Accept Onboarded Objects | Optional. If you choose to accept onboarded object and the Confidence Score is 100%, the attributes from Enterprise Data Catalog appear with the Accepted review status in Axon. You do not have to curate these objects again in Axon. |
Axon Super Admin Email | Required. The email address of the SuperAdmin user responsible for onboarding discovered objects. |
Automatically Accept Lineage Recommendations | Create attribute links automatically based on the lineage recommendations from Enterprise Data Catalog. If you do not select this option, you can manually create links later from the lineage recommendation notifications. |
Enable Lineage Recommendation Notifications | Send notifications for the recommended attribute relationships based on the lineage in Enterprise Data Catalog. |
Default Glossary | The default glossary name that you want to associate with the objects onboarded from Enterprise Data Catalog. Axon uses this default glossary if you choose to not onboard objects with associated glossaries to a System object. |
Automatically Delete Attribute Relationships | Automatically deletes attribute relationships that are no longer valid if a linked physical field is deleted from Enterprise Data Catalog. This deletion applies to attribute relationships that are automatically created based on the lineage recommendations from Enterprise Data Catalog. |
View Custom Attributes for Physical Fields | View custom attributes for physical fields from Enterprise Data Catalog. |
Restrict Object Access Based on Enterprise Data Catalog | Restrict access to resources in Axon based on the access permissions to the assets in Enterprise Data Catalog. If you do not select this option, you can access all the assets in Axon irrespective of the access permissions to the assets in Enterprise Data Catalog. The default value is "False." Note: The access permission for a user from Enterprise Data Catalog is retrieved based on the email address. Ensure that the email filtering option is enabled in Enterprise Data Catalog. For more information, refer to Informatica 10.4.1 Enterprise Data Catalog User Guide . |
Configure Timeout Period for Enterprise Data Catalog API | The maximum time period in seconds that Axon waits for the Enterprise Data Catalog API to respond. |
Enterprise Data Catalog Server Proxy Host | The proxy host name for the Enterprise Data Catalog server. For more information on configuring the proxy parameters, contact Informatica Global Customer Support. |
Enterprise Data Catalog Server Proxy Port Number | The proxy port number for the Enterprise Data Catalog server. For more information on configuring the proxy parameters, contact Informatica Global Customer Support. |
5. To test the connectivity to Enterprise Data Catalog, click Test Connection.
If all the parameters are correct, you can view that the connection is successful. If any parameter is incorrect, the connection fails and an error message appears.
Note: You cannot test the connectivity for the Enterprise Data Catalog proxy parameters.
6. Click Save.
7. In the Linux environment, run the following command to clear the Axon cache and restart the necessary services:
sh <INSTALLATION_DIR>/axonhome/third-party-app/scripts/paramsync
When you run the paramsync script, Axon restarts the HTTPD, Memcached, and email notification services.
Note: When you clear the cache and restart the Axon services, the Axon web interface might be disrupted for some users that are logged into Axon. Informatica recommends that you update the cache after you save your changes in all the System Settings pages. Additionally, perform this action during a maintenance period when very few users are using Axon.
Catalog Notifications
If the relationships between attributes are created or deleted, Axon sends notifications to stakeholder based on the configuration of Enterprise Data Catalog properties in the Admin Panel.
Created Link Notifications
Axon sends email and interface notifications to the stakeholders based on configuration of the Automatically Accept Lineage Recommendations and Enable Lineage Recommendation Notifications options on the Admin Panel.
The following table describes the different combination of the values based on which Axon sends lineage notifications:
Automatically Accept Lineage Recommendations | Enable Lineage Recommendation Notifications | Notifications |
|---|
True | True | Data Steward receives email and interface notifications about the automatically created relationships. |
True | False | Data Steward receives email and interface notifications about the automatically created relationships. |
False | True | Data Steward receives email and interface notifications about the lineage recommendations. |
False | False | Axon does not send any notification. |
Deleted Link Notifications
Axon sends email and interface notifications about the deleted links to the stakeholders based on configuration of the Automatically Delete Attribute Relationships and Enable Lineage Recommendation Notifications options on the Admin Panel.
The following table describes the different combination of the values based on which Axon sends link removal notifications:
Automatically Delete Attribute Relationships | Enable Lineage Recommendation Notifications | Notifications |
|---|
True | True | Links are automatically deleted and the Data Set stakeholder receives email and interface notifications about the deleted links. |
True | False | Links are automatically deleted and the Data Set stakeholder receives email and interface notifications about the deleted links. |
False | True | Links are not deleted and the Data Set stakeholder receives email and interface notifications about the relationships that are not valid. |
False | False | Links are not deleted and Axon does not send any notification. |
Configure Custom Resource Types
In Axon, you can view custom resource types from Enterprise Data Catalog. You need to create custom resource types in Enterprise Data Catalog. For more information on custom resources, refer to Informatica® 10.2.2 Catalog Administrator Guide.
To view a custom resource type, you need to configure the required parameters, such as class type and label, for a field within a file in a predefined directory in Axon. Create a file with the name custom_edc_fields.yml in the following location:
<INSTALLATION_DIR>/axonhome/axon/src/Diaku/EIC/EICBundle/Resources/config/queries/custom
You can use the following syntax to configure the parameters in the custom_edc_fields.yml file:
In the file, you need to always start with the EDC_FIELDS : parameter to start configuring the parameters for a field in a custom resource type. Then, you need to enter a unique name for a field in the Enterprise Data Catalog resource that you want to display in Axon. Within the field, you need to configure the custom resource type parameters.
The following table lists the parameters that you need to configure within a field:
Parameter | Description |
|---|
classType | Required. The class type of the Enterprise Data Catalog field. |
label | Required. A unique label that you want to see in the Axon interface for this field. |
parentClassType | Required. The parent class type of the Enterprise Data Catalog field. |
parentIconFileName | Optional. The generic icon that you use for the parent file name. |
If you want to configure multiple custom resource types, you must create a separate section for each field to configure the parameters.
Before you deploy the configuration on the Axon server, you must validate the file using any YML validator tool.
In the Linux environment, run the following command to clear the Axon cache and restart the necessary services:
sh <INSTALLATION_DIR>/axonhome/third-party-app/scripts/paramsync
When you run the paramsync script, Axon restarts the HTTPD, Memcached, and email notification services.
Note: When you clear the cache and restart the Axon services, the Axon web interface might be disrupted for some users that are logged into Axon. Informatica recommends that you update the cache after you save your changes in all the System Settings pages. Additionally, perform this action during a maintenance period when very few users are using Axon.
Whenever you modify the custom_edc_fields.yml file, make sure that all Axon users clear their browser cache before they use Axon.
Example
The following sample file contains a field with parameters configured for a custom resource type:
EDC_FIELDS :
RELATIONAL_COLUMN :
classType : "com.ldm.custom.relational.column"
label : "RELATIONAL_COLUMN"
parentClassType : "com.ldm.custom.relational.table"
parentIconFileName : "dbcolumn"
In the example, the file starts with the EDC_FIELDS : parameter. The RELATIONAL_COLUMN field shows the configured parameters.