Important Nexla Help Center Update:
Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.
Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.
Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).
_______________________________________________
You can enrich your Collibra data catalog by using Nexla's App Integration with Collibra.
Once a Nexla organization administrator links and activates Nexla's Collibra App Integration all members of that organization get the ability to register any of their Nexsets in the connected Collibra account.
Contents
1. [Post Setup]: Register Nexset in a connected Collibra account
2. [Post Setup]: Update Nexset entry in the connected Collibra account
3. [Post Setup]: View Nexsets in Collibra
4. [One Time Setup For Org Administrators]: Setup & Activate Collibra App Integration
4.1 Collibra Setup: Create Resources in Collibra
4.2 Nexla Setup: Link and Activate Collibra App Integration
4.2.1 Create Collibra Credential
4.2.2 Configure Collibra properties
4.3 Validate the Integration
Sections 1, 2, and 3 below cover steps any organiation member can execute anytime they want to register a Nexset to Collibra. Section 4 covers initial setup that must be done once by an organization administrator for activating the Collibra App Integration.
1. [Post Setup]: Register Nexset in a connected Collibra account
Once the organization administrator has configured and activated the App Integration for Collibra, all ordaganization members will be able to register their Nexsets to Collibra.
- Click on any Nexset to view its Overview section. If the Nexset has not yet been registered on Collibra, you'll see a button titled Register on Collibra
- Click on the button to start registration. Registration might take a moment to complete. Click on the refresh icon next to the button for viewing registration progress.
- Once the registration is complete you'll see a link to the Collibra resource.
- Click on the link to launch Collibra screen for viewing the Nexset in Collibra. Here you can view the Nexset documentation, schema, samples, and a link to Nexla UI for the Nexset.
2. [Post Setup]: Update Nexset entry in the connected Collibra account
After a Nexset has been registered on Collibra, you can click on the Update Entry on Collibra button anytime to sync latest Nexset settings into Collibra.
Clicking on the button will pickup the Nexset's current name, description, documentation, schema, and samples and update relevant sections of the linked Collibra resource.
3. [Post Setup]: View All Nexsets in Collibra
Previous steps showed how you can launch the Collibra screen of a Nexset by clicking on the Collibra resource link for any Nexset from the Nexset's overview tab.
You can also view all your registered Nexsets directly in Collibra and launch Nexla UI screen from the Nexla Nexset in Collibra.
4. [One Time Setup For Org Administrators]: Setup & Activate Collibra App Integration
This integration creates a link between Nexla Nexsets and corresponding Schema tables in Collibra.
In order to configure this integration, there are two setup steps to be executed. Both these steps take no more than a few minutes for organization administrators to execute.
Step 1: In Collibra UI: Create a new Schema in Collibra. This is optional and you can use any Schema, but we recommend creating a new Schema solely for Nexsets for better management of Collibra assets.
Step 2: In Nexla UI: Configure Nexla's Collibra App Integration with relevant credentials and property names for entities created in Step 1.
4.1 Collibra Setup: Create Resources in Collibra
Performed by: Collibra administrator.
Using: Collibra UI
These steps are optional for Nexla Integration. However, we recommend creating a new Schema for better management of Collibra assets.
As a Collibra administrator you will create a new Schema resource. You might also want to create a dedicated user just for this integration.
All of this should take just a few minutes of clicking around in Collibra UI.
4.1.1 (Optional) Create a New Schema
Nexla's integration with Collibra requires a Schema ID where all Nexsets will be registered. You can use an existing data domain and a Schema, or alternately create a new Data Domain also along with Schema.
- In your Collibra account, click on the big green + button on the top nav bar. This launches a popup form for Creating new resources.
- In the search box look for Schema. Click on the result.
- In the Schema creation form:
- Make sure asset type is set to Schema
- Select the desired Domain. In this example we are going to create a schema in the Nexla Nexsets Domain.
- Set a desired name for the Schema. In this example we are going to call it Nexsets
- Click ont he detailed view of the generated Schema. Grab the Schema ID from the URL.
4.1.2 (Optional) Create a New User
You can use an existing user's credentials in the next step. However we recommend creating a new user solely for this integration so all entities created in Collibra are appropriately attributed to this user.
Now that we are completely done with setting up Collibra let's setup Nexla UI.
Note down these key entries that will be needed for setting up Nexla UI.
- ID of the Schema. This could either be the schema we just created, or a Schema already present in the account.
- Username and password of the account that will be used for authentication. This could be an existing user or a newly created user in the previous step. This user must have administrative permissions to the Schema that will be used.
4.2 Nexla Setup: Link and Activate Collibra App Integration
Performed by: Nexla org administrator.
Using: Nexla UI
Login to your Nexla account as a Nexla org administrator. When you click on Settings you'll see a new menu item for App Integrations. Click on that to open the Collibra configuration tile.
4.2.1 Create Collibra Credential
- Click on the Configure button in the Collibra tile under Data Catalogs.
- In the Authentication part of the configuration drawer
- Credential Name: Give a meaningful name to this credential for your bookkeeping.
- Credential Description:Give a meaningful short description to this credential for your bookkeeping.
- Collibra Base URL: Enter the main url to your Collibra installation. You can get it from the browser URL when you login to Collibra. For the tests in this document we used
https://nexla.collibra.com
- Username: Enter the Collibra username that you saved in the previous step.
- Password: Enter the password for the Collibra user that you saved in the previous step.
- Click Authenticate. If your settings are correct this should result in a new credential with the name and a button to edit the credential.
4.2.2 Configure Collibra properties
In the same drawer as 4.2.1 above, let's now enter rest of the configuration options.
- Collibra Schema ID: Set this to Schema ID of the desired schema you saved in the previous step.
- Click Save
- Close the drawer and turn on the toggle switch on the Collibra tile. This activates your integration.
- You can pause the integration at any time by turning this switch off.
4.3 Validate the Integration
Let's quickly validate that this setup is working fine.
In the Nexla UI, open up any Nexset in the Discover or Integrate menu items. Then execute steps from 1. [Post Setup]: Register Nexset in a connected Collibra account above to make sure Nexsets are registered and visible in Collibra.
Comments
0 comments
Article is closed for comments.