Skip to main content

Create the excel file for the browse card for organization profile page

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.

The browse card is configured using the Browse_Card.xlsx file. Use the details explained in this section to create your configuration file.

Important

Before you begin setting up the Browse_Card.xlsx file, gather the values for the different data.world objects (collections, insights, datasets, etc) you plan to add to the browse card.

Collect configuration details

After you have decided the resources you want to add to your browse card, note down the following information about the resources:

You will capture this information from the URL field of the browser window.

copy_url_from_browser.png
Table 1.

For resource

Gather information

Sample values

Details

Collection

 

  • Collection URL: Copy this URL from the URL field of the browser window.

  • Name of the collection: This is the name of the collection that will appear on the card. If the name changes, you'll have to manually update this value in the configuration.

  • Example URL: https://demo.app.data.world/catalog-sandbox/catalog/collection/ collection/vtUzJk2JSwgifVx3jlNt

  • CollectionURL: /catalog-sandbox/catalog/collection/vtUzJk2JSwgifVx3jlNt

  • Title: Competitive Analysis

This opens the collection page.

Organization

  • The ID of the organization.

  • Example URL: https://demo.app.data.world/catalog-sandbox

  • Org ID: catalog-sandbox

This opens the organization profile page.

Datasets

  • The ID of the organization.

  • The ID of the dataset.

NOTE: Copy this information from the URL field of the browser window.

  • Example URL: https://demo.app.data.world/catalog-sandbox/sales-reports-dataset

  • Org ID: catalog-sandbox

  • Resource ID: sales-reports-dataset

This opens the dataset page.

Projects

  • The ID of the organization.

  • The ID of the project.

NOTE: Copy this information from the URL field of the browser window.

  • Example URL: https://demo.app.data.world/catalog-sandbox/sales-project

  • Org ID: catalog-sandbox

  • Resource ID: sales-project

This opens the project page.

Insights

  • The ID of the organization.

  • The ID of the project.

  • The ID of the insight.

NOTE: Copy this information from the URL field of the browser window.

  • Example URL: https://demo.app.data.world/catalog-sandbox/sales-project/zJk2JSwgifVx3jl

  • Org ID: catalog-sandbox

  • Resource ID: sales-project

  • Insight ID: zJk2JSwgifVx3jl

This opens the insight available in the project.



STEP 1: Download the Browse_Card.xlsx file

  1. In the Catalog configuration organization, browse to the DDW Template Files (ddw-template-files) dataset.

  2. Download the Browse_Card.xlsx file.

    ctk_browse_card03.png

STEP 2: Update the Browse_Card.xlsx file

  1. Open the template excel sheet. Check the sheet names to make sure the names match the ID of the organization for which you want to create the browse card. For example, if the ID of the organization is 8bank-catalog-sandbox, the sheet name in the file should be 8bank-catalog-sandbox.

    Let us start editing the sheet for the organization.

  2. First, define the title and sub title of the section. You can change the values for title and subtitle Find the right starting point on data.world. and Explore important organizations and collections. to be what you want.

  3. Next, start adding rows for the different items you want to present in the browse card.

    • When dealing with numerous sections that contain multiple resources, consider creating individual excel files for each section. You can then reference them from this file using the Items from file field. For instance, if you have an excel file with a sheet named external_docs, you would set external_docs as the value in this column.

      In such cases, you should only provide values for Browse Card Title, Browse Card Subtitle, Section Title, Section Order, and Items from file. All the remaining values should be defined in the separate file you are referencing.

    • If you want the section title to be linked to a resource, leave the Item title and Item order columns empty and fill the other fields, as required.

    Table 2.

    Item

    Details

    Browse Card Title

    The title of the browse card. This text will be common for all rows and must be repeated in all rows.

    Browse Card Subtitle

    Subtitle of the browse card. This text will be common for all rows and must be repeated in all rows.

    Section Title

    A title for the section.

    Section Order

    The order of the section.

    Item title

    A title for the item. Leave this empty if you want the section title to be linked to a resource.

    Item order

    The order of the item in the section. Leave this empty if you want the section title to be linked to a resource.

    Link type

    Options available are: Collection, Dataset, Project, Insight, External URL.

    Collection URL

    Required only for collection links.

    External URL

    Required only for external links.

    Org ID

    Required for Dataset, Project, Insight.

    Resource ID

    Required for Dataset, Project, Insight. For insights, provide the ID of the project to which the insight belongs.

    Insight ID

    Required only for Insights.

    Items from file

    When dealing with numerous sections that contain multiple resources, consider creating individual excel files for each section. You can then reference them from this file using the Items from file field. For instance, if you have an excel file with a sheet named external_docs, you would set external_docs as the value in this column.

    In such cases, you should only provide values for Browse Card Title, Browse Card Subtitle, Section Title, Section Order, and Items from file. All the remaining values should be defined in the separate file you are referencing.



Sample browse card excel file.

ctk_browse_card_sample_file.png

Sample file referred from the browse card excel file.

ctk_browse_card_sample_file02.png