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 data.world data catalog by using Nexla's App Integration with data.world.
Once a Nexla organization administrator links and activates Nexla's data.world App Integration all members of that organization get the ability to register any of their Nexsets in the connected data.world account.
Contents
1. [Post Setup]: Register Nexset in a connected data.world account
2. [Post Setup]: Update Nexset entry in the connected data.world account
3. [Post Setup]: View Nexsets in data.world
4. [One Time Setup For Org Administrators]: Setup & Activate data.world App Integration
4.1 data.world Setup: Create Resources in data.world
4.1.1 Setup metadata profile in catalog-config organization
4.1.2 Apply metadata profiles to the desired organization
4.1.3 Create a service account in desired organization
4.1.4 Create a service account in desired organization
4.2 Nexla Setup: Link and Activate data.world App Integration
4.2.1 Create data.world Credential
4.2.2 Configure data.world metadata 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 data.world. Section 4 covers initial setup that must be done once by an organization administrator for activating the data.world App Integration.
1. [Post Setup]: Register Nexset in a connected data.world account
Once the organization administrator has configured and activated the App Integration for data.world, all organization members will be able to register their Nexsets to data.world.
- Click on any Nexset to view its Overview section. If the Nexset has not yet been registered on data.world, you'll see a button titled Register on data.world
- 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 data.world resource.
- Click on the link to launch data.world screen for viewing the Nexset in data.world. 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 data.world account
After a Nexset has been registered on data.world, you can click on the Update Entry on Data.world button anytime to sync latest Nexset settings into data.world.
Clicking on the button will pickup the Nexset's current name, description, documentation, schema, and samples and update relevant sections of the linked data.world resource.
3. [Post Setup]: View All Nexsets in data.world
Previous steps showed how you can launch the data.world screen of a Nexset by clicking on the data.world resource link for any Nexset from the Nexset's overview tab.
You can also view all your registered Nexsets directly in data.world and launch Nexla UI screen from the Nexla Nexset in data.world.
- In your data.world organization, click on Nexla Nexsets resource type.
- You'll see a list of all Nexsets that have been registered into this data.world organization.
- Click on any Nexla Nexset item in this view. Click on the Nexset URL of the detailed view. This will launch Nexla UI screen for that Nexset.
4. [One Time Setup For Org Administrators]: Setup & Activate data.world App Integration
This integration creates a link between Nexla Nexsets and corresponding Analysis resources in data.world.
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 data.world UI: Create a new Analysis resource type "Nexla Nexset" in data.world along with relevant metadata fields.
Step 2: In Nexla UI: Configure Nexla's data.world App Integration with relevant credentials and property names for entities created in Step 1.
4.1 data.world Setup: Create Resources in data.world
Performed by: data.world administrator.
Using: data.world UI
data.world Organizations:
- Steps 4.1.1 - 4.1.2 in the catalog-config organization: This is the organization that is used for defining how resources are created in data.world
- Steps 4.1.3 - 4.1.4 need to be performed in the organization where you want your Nexsets registered. For this example we will be using catalog-sandbox organization.
These steps need to be performed by a data.world organization administrator
As a data.world administrator you will create a new analysis resource, assign some metadata form properties to this resource, apply this new metadata profile in the desired data.world organization, and generate Credential and Collection in the desired organization.
All of this should take just a minutes of clicking around in data.world UI.
4.1.1 Setup metadata profile in catalog-config organization
Step A. Create Nexla Nexset analysis type
First of all we will create a new Analysis type and name it Nexla Nexset
- Login to your data.world and open the Organization selection screen. Select the catalog-config organization.
- Click on New Resource > Other Resources
- In the form that pops up:
- Set Title to Nexla Nexset
- Set Choose Type to Type
- Click Continue. A new resource will be created and form will change for editing the resource.
- In the Nexla Nexset Edit form
- For the section "Ability to create in the UI" choose "Allow UI Creation"
- Click Save.
- For the section "Ability to create in the UI" choose "Allow UI Creation"
- In the Nexla Nexset type that is created above (you can find it by clicking Types in the catalog-config overview page. We are going to link this new entity to the Analysis type.
- Select the tab Related. Click Add a related Resource.
- In the popup form, type and select Analysis in the Related Type field.
- Make sure relationship type is set to Is parent of this Type.
- Click Add.
- Click Save. We have now defined the rule "Analysis is the parent type of Nexla Nexset"
- Select the tab Related. Click Add a related Resource.
- Set Title to Nexla Nexset
Now that we have a new Resource Type for Nexla Nexset, we will create some metadata form fields for this new type to hold Nexset information.
Step B. Create Nexset URL metadata field
This field will contain the Nexla UI link to Nexset.
- In the catalog-config Overview page, again click on New Resource > Other Resources
- This time we will set Choose Type to be Metadata field - freeform
- Give this a title of Nexset URL
- In the edit form screen we will customize some settings for this new field:
- Set Description to Nexla UI URL for the Nexset
- Set Display Order to 1
- Set External Access to Accessible through API
- Click Save.
- In the newly created resource (overview page for the created form field), create a relationship with Nexla Nexset
- Select the tab Related. Click Add a related Resource.
- In the popup form, type and select Nexla Nexset in the Related Type field.
- Make sure relationship type is set to Uses this Metadata Field
- Click Add.
- Click Save. We have now defined the rule "Nexla Nexset uses Nexset URL"
- Select the tab Related. Click Add a related Resource.
Step C. Create Nexset Summary metadata field
This field will contain the content of Nexset's rich text description.
- In the catalog-config Overview page, again click on New Resource > Other Resources
- This time we will set Choose Type to be Metadata field - freeform
- Give this a title of Nexset Summary
- In the edit form screen we will customize some settings for this new field:
- Set Description to Nexset description content
- Set Display Order to 2
- Set External Access to Accessible through API
- Set Field Size to Multiline
- Click Save.
- In the newly created resource (overview page for the created form field), create a relationship with Nexla Nexset
- Select the tab Related. Click Add a related Resource.
- In the popup form, type and select Nexla Nexset in the Related Type field.
- Make sure relationship type is set to Uses this Metadata Field
- Click Add.
- Click Save. We have now defined the rule "Nexla Nexset uses Nexset Summary"
- Select the tab Related. Click Add a related Resource.
Step D. Create Nexset Schema metadata field
This field will contain the schema of the Nexset.
- In the catalog-config Overview page, again click on New Resource > Other Resources
- This time we will set Choose Type to be Metadata field - freeform
- Give this a title of Nexset Schema
- In the edit form screen we will customize some settings for this new field:
- Set Description to Nexset output schema
- Set Display Order to 3
- Set External Access to Accessible through API
- Set Field Size to Multiline
- In the Technical Details tab select Add New Field > Presentation Template
- In the input box enter ```{{$1}}}```
- In the input box enter ```{{$1}}}```
- Click Save.
- In the newly created resource (overview page for the created form field), create a relationship with Nexla Nexset
- Select the tab Related. Click Add a related Resource.
- In the popup form, type and select Nexla Nexset in the Related Type field.
- Make sure relationship type is set to Uses this Metadata Field
- Click Add.
- Click Save. We have now defined the rule "Nexla Nexset uses Nexset Schema"
- Select the tab Related. Click Add a related Resource.
Step E. Create Nexset Samples metadata field
This field will contain the schema of the Nexset.
- In the catalog-config Overview page, again click on New Resource > Other Resources
- This time we will set Choose Type to be Metadata field - freeform
- Give this a title of Nexset Samples
- In the edit form screen we will customize some settings for this new field:
- Set Description to Samples from Nexset
- Set Display Order to 4
- Set External Access to Accessible through API
- Set Field Size to Multiline
- In the Technical Details tab select Add New Field > Presentation Template
- In the input box enter ```{{$1}}}```
- In the input box enter ```{{$1}}}```
- Click Save.
- In the newly created resource (overview page for the created form field), create a relationship with Nexla Nexset
- Select the tab Related. Click Add a related Resource.
- In the popup form, type and select Nexla Nexset in the Related Type field.
- Make sure relationship type is set to Uses this Metadata Field
- Click Add.
- Click Save. We have now defined the rule "Nexla Nexset uses Nexset Samples"
- Select the tab Related. Click Add a related Resource.
Step E. Validate all the settings
Before we apply the metadata profiles to desired organization, let's quickly make sure we have setup all relationships and fields properly. Validate that names of each property match exactly as listed below.
- In the catalog-config organization Overview page, click on Types
- In the list view look for Nexla Nexset and click on it.
- In the Nexla Nexset detail page, click on Related tab and make sure:
- There is 1 entry for Analysis is a parent of.
- There are 4 entries for each of these:
- Nexset URL is used by
- Nexset Summary is used by
- Nexset Schema is used by
- Nexset Samples is used by.
4.1.2 Apply metadata profiles to the desired organization
Now that we have created these new metadata fields, we will apply these changes to the desired organization.
Note that in this sequence we are applying changes to the catalog-sandbox organization. Change the selections to the specific organization you are interested in.
- In the catalog-config organization, select Projects
- Select the DDW Export Profiles project. This is the project used to exporting metadata profiles to different organizations.
- In the project screen, click on Launch Workspace
- In the Project Directory editor, expand Connected Datasets >> DDW Sandbox Catalog (this would be the organization you want to create nexsets in)
- In the expanded view, find the Metadata Profile.ttl file . In our case it is Sandbox Metadata Profile.ttl. Click this file.
- Click on the Sync Now button.
Validate that the settings got applied correctly: In the Overview page of the desired organization (catalog-sandbox, you should now see a tile for Nexla Nexset in the Resources list.
4.1.3 Create a service account in desired organization
Let's now create a Service Account for authentication. We will do this in the organization where you want Nexsets (catalog-sandbox for our use case)
- In the catalog-sandbox account overview page: click on Settings
- Click on Service Accounts > Add service account
- In the popup form give a meaningful name and set the expiration date for this service service account.
- We recommend giving name Nexla Nexset integration Service Account and expiration to never.
- Save the generated token. We will need it when setting up Nexla UI.
- We recommend giving name Nexla Nexset integration Service Account and expiration to never.
4.1.4 Create a Collection in desired organization
Let's finally create a new Collection for grouping all Nexsets. We will do this in the organization where you want Nexsets (catalog-sandbox for our use case)
- In the catalog-sandbox account overview page: scroll to Collections and click New
- In the popup form give a name for your collection. We recommend calling it Nexla Collection
Now we are completely done with setting up data.world let's setup Nexla UI.
Note down these key entries that will be needed for setting up Nexla UI.
- Name of the desired organization. For this document it is: catalog-sandbox
- Name of collection created in 4.1.4. For this document it is Nexla Collection
- Name of the new resource type we created in 4.1.1. For this document it is Nexla Nexset
- Token of the service account we created in 4.1.3.
4.2 Nexla Setup: Link and Activate data.world 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 data.world configuration tile.
4.2.1 Create data.world Credential
- Click on the Configure button in the data.world 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.
- Your data.world Base URL: Enter the main url to your data.world installation. You can get it from the browser URL when you login to data.world. For the tests in this document we used
https://nexlapartner.app.data.world
- Service Account Token: Enter the data.world Service Account Token that you saved in Step 4.1.3 above
- 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 data.world metadata properties
In the same drawer as 4.2.1 above, let's now enter rest of the configuration options.
- data.world Organization: Set this to name of the desired organization you've applied metadata to. For this document it was catalog-sandbox
- Collection Name: Set this to the collection name you used in 4.1.4 above. For this document it was Nexla Collection
- Type Label: Set this to the title of the metadata analysis type you created in 4.1.1 above. For this document it was Nexla Nexset
- Click Save
- Close the drawer and turn on the toggle switch on the data.world 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 data.world account above to make sure Nexsets are registered and visible in data.world.
Comments
0 comments
Article is closed for comments.