Skip to main content

Add the configuration file to the application

Important

These instructions are specifically for adding browse card using the Catalog Toolkit. If your system does not have Catalog Toolkit, you can follow these instructions to set up browse card using Metadata Profile files.

STEP 1: Add the configuration files to ddw-browse-card-files dataset

Note

These tasks are performed in the Catalog configuration organization.

  1. From the Organization profile page, browse to the DDW Browse Card Files (ddw-browse-card-files) dataset.

  2. Add the excel files with the browse card configuration to the dataset.

STEP 2: Configure the ddw-profile-configuration dataset

In this section we will grant all members of the organization View access to the special dataset DDW Organization_Name Profile Configuration (ddw-profile-configuration ). This access is required for users to be able to see the Browse card on the Organization profile page.

Next, we will setup the validation queries available for browse cards. Although this is an optional step, we recommend that you do this task, as it lets you know in a glance if there are any issues with the configuration and helps with troubleshooting.

Note

These tasks are performed in the organization (sandbox or main) where you are adding the browse card.

  1. Browse to the DDW Organization_Name Profile Configuration (ddw-profile-configuration ) dataset.

  2. Go to Settings tab > Access and Ownership section. Click Grant access to all members. In the Grant access window, select View and then click Grant access. This only gives View access to users and this access is required for users to be able to see the Browse card on the Organization profile page.

    grant_access.png
  3. Next, click the Launch workspace button. Locate the Is SHACL Passing? and SHACL Validation Report queries in the dataset.

  4. Save the results of the Is SHACL Passing? and SHACL Validation Report queries to the Dataset Summary section [using Markdown code available from Copy URL or Embedded code option].

    copy_markdown.png
  5. On the Dataset details page, you should see the validation detail for the file that you have uploaded to the dataset.

    status_of_configuration.png

STEP 3: Configure the ddw-export-browse-card project

Note

These tasks are performed in the Catalog configuration organization.

  1. From the Organization profile page, go to the DDW Export Browse Card (ddw-export-browse-card) project.

  2. On the project page, click Launch workspace.

  3. Locate the query corresponding to the organization where you are adding the browse card and run it.

    ctk_browse_card.png
  4. On the query results page, click Download > Save to datasets and project and save the results to the corresponding DDW Organization_Name Profile Configuration (ddw-profile-configuration ) dataset. Make sure to remove .rq from the file name.

    ctk_browse_card02.png

View the results­čą│

Note

You have to be a member of the organization to be able to see the browse card for that organization.

  • Browse to the Organization profile page and you should now see the newly added browse card available there. Click through to access the various collections, datasets, projects, pages. If users do not have access to specific resources highlighted through the browse card, they will see an error page.

Note

Any time you make changes to the browse card configuration, refresh the page to see the updated browse card on the Organization profile page.

view_browse_card.png

Need to add new sections or update sections in the browse card?

  1. Follow the steps available here to add the new section or make changes in the existing section.

    Note

    Always make a backup copy of the configuration file before you start making changes.

  2. In the Catalog Configuration organization, add the updated file to the DDW Browse Card Files (ddw-browse-card-files) dataset.

  3. In the Main/Sandbox organization, browse to the DDW Organization_Name Profile Configuration (ddw-profile-configuration ) dataset. In the Sandbox organization, sync the Sandbox Browse Card.ttl file. If you are in the Main organization, sync the Main Browse Card.ttl file.

  4. Any time you make changes to the browse card configuration, refresh the page to see the updated browse card on the Organization profile page.

Troubleshooting the browse card

If you are running into issues with the browse card, please follow the basic troubleshooting tasks in this section to resolve your issues. If you need further help, contact the data.world support team.

  1. View the results of the Validation queries available in the DDW Organization_Name Profile Configuration (ddw-profile-configuration ) dataset.

  2. If you have a previous version of the browse card that was working, and your latest updates are not working properly, you can download the previous version (from the Dataset details page > Activity tab) and re-upload that to the dataset. Always make sure that you do not upload duplicate copies of the file to the dataset.

    download.png
  3. If you want to completely get rid of the browse card, delete the org-profile.ttl file from the dataset. This will remove the browse card from the organization profile page.