Skip to main content

Create the configuration file for the browse card

The browse card is configured using the instance-profile.ttl file. Use the syntax explained in this section to create your configuration file.

Important

Before you begin setting up the ttl 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 or the Overview page of the resource.

browse_card_resource_info.png
Table 1.

For resource

Gather information

Sample values

Details

Collections

 

  • The ID of the organization. Copy this information from the URL field of the browser window.

  • Resource IRI: Copy this URL from the Overview page > Technical details section of the resource.

  • sales-engineering

  • https://sales-engineering.app.linked.data.world/d/ddw-catalogs/cat.0c6334

This opens the collection page.

Business Term

  • The ID of the organization. Copy this information from the URL field of the browser window.

  • Resource IRI: Copy this URL from the Overview page > Technical details section of the resource.

  • sales-engineering

  • https://sales-engineering.app.linked.data.world/d/ddw-catalogs/businessTerm-c6115fd5-123

This opens the business term page.

Metadata resources

  • The ID of the organization. Copy this information from the URL field of the browser window.

  • Resource IRI: Copy this URL from the Overview page > Technical details section of the resource.

  • sales-engineering

  • https://sales-engineering.linked.data.world/d/ddw-catalogs/dashboard-ad9fc869-d2f3

This opens the resource page.

Organization

  • The ID of the organization. Copy this information from the URL field of the browser window.

  • sales-engineering

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.

  • sales-engineering

  • sales-reports

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.

  • sales-engineering

  • 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.

  • sales-engineering

  • sales-project

  • zJk2JSwgifVx3jl

This opens the insight available in the project.

External website links

The URL of the external resource.

https://data.world/ai/

This opens the external website.



STEP 1: Add the prefixes for this configuration and declare the instance profile

Use the following syntax to add the the prefixes for this configuration and declare the instance profile and define that this instance profile includes a browse card.

In this section, we are also declaring the Browse Card Profile and creating a presentation for this browse card. We are using a tabbed presentation format.

  • In these configurations, only change the URL of your installation in the first line. Do not change anything else.

    • Replace YourInstllationName with the name of the installation.

      For example, if your application URL is: https://8bank.app.data.world/ 8bank is the name of your installation.

    • The value will look like: <https://8bank-ddw.app.linked.data.world/d/ddw-instance-profile/>.

@prefix :         <https://YourInstllationName-ddw.app.linked.data.world/d/ddw-instance-profile/> .
@prefix instance: <https://ontology.data.world/instance-profile#> .
@prefix common:   <https://ontology.data.world/common-components#> .
@prefix kos:      <https://open-kos.org/schema/> .
:
  a                             instance:InstanceProfile ;
  kos:title                     "My Instance Profile" ;
  instance:hasBrowseCardProfile :BrowseCardProfile ;
.

:BrowseCardProfile a instance:BrowseCardProfile .
:BrowseCardPresentation a instance:TabbedBrowseCardPresentation .

:BrowseCardProfile instance:hasBrowseCardPresentation :BrowseCardPresentation .

STEP 2: Define the tabs and add tabs to browse card

Now, use the following syntax to define the title and subtitle of the tabs and add the tabs to the browse card.

# Featured Resources tab configuration
:FeaturedTab a common:Tab ;
    kos:title           "Featured resources" ;
    common:subTitle     "Find the right starting point in the Customer Support organization. Explore important collections, datasets, and projects." ;
    kos:sortOrder       1;
.

## External Resources tab configuration
:ExternalTab a common:Tab ;
    kos:title           "External resources" ;
    common:subTitle     "Documentation and other helpful sources of information outside the platform." ;
    kos:sortOrder       2;
.

## Add all tabs to the browse card
:BrowseCardPresentation common:tab :FeaturedTab ;
                        common:tab :ExternalTab ;
.

STEP 3: Add a section with links to organization profile pages and collections

Use the following syntax to configure the first section.

  1. First, we are adding a link to the organization profile page of the Marketing organization.

  2. Next, we are adding the collection Competitive Analysis.

  3. Similarly, add the organization profile page for Sales organization and a collection from it.

  4. Next, define the MarketingAndSales section where we will add all these resources and define their order.

##Add the link to the marketing organization profile page.
:MarketingCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "marketing-org" ;
.
:MarketingCatalogItem
    a common:Item ;
    kos:sortOrder 1 ;
    common:itemPresentation :MarketingCatalogItemPresentation ;
.

##Add the link to a collection in the organization.
:CompetitiveAnalysisItemPresentation
    a instance:BrowseCardMetadataSearchResultPresentation ;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CompetitiveAnalysisItem
    a common:Item ;
    kos:sortOrder 2 ;
    common:itemPresentation :CompetitiveAnalysisItemPresentation ;
.

##Add the link to the sales organization profile page.
:SalesCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "Sales-org" ;
.
:SalesCatalogItem
    a common:Item ;
    kos:sortOrder 3 ;
    common:itemPresentation :SalesCatalogItemPresentation ;
.

##Add the link to a collection in the organization.

:SalesPlaybookItemPresentation
   a instance:BrowseCardMetadataSearchResultPresentation;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.6334". ;
.
:SalesPlaybookItem
    a common:Item ;
    kos:sortOrder 4 ;
    common:itemPresentation :SalesPlaybookItemPresentation     ;
.

##Configure the presentation of the Marketing and Sales section.

:MarketingAndSalesSectionPresentation
    a common:SectionPresentation ;
    kos:title "Marketing and Sales" ;
    common:item :MarketingCatalogItem ;
    common:item :CompetitiveAnalysisItem ;
    common:item :SalesCatalogItem ;
    common:item :SalesPlaybookItem ;
.

:MarketingAndSalesSection
    a common:Section ;
    kos:sortOrder 1 ;
    common:sectionPresentation :MarketingAndSalesSectionPresentation ;
.

STEP 4: Add a new type of section with a header that is a link to an organization profile page

In this task, we are defining the header of the section as a clickable link. We will also add a few items in the Customer Support section.

Use the following syntax to configure the second section.

# Support Section

#Add a collection
:CusomerSupportCollectionItemPresentation
    a instance:BrowseCardMetadataSearchResultPresentation ;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CusomerSupportCollectionItem
    a common:Item ;
    kos:sortOrder 1 ;
    common:itemPresentation :CusomerSupportCollectionItemPresentation ;
.

#Add link to the organization profile page for another organization.

:DocsCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "Documentation-org" ;
.
:SupportDocsCatalogItem
    a common:Item ;
    kos:sortOrder 2 ;
    common:itemPresentation :DocsCatalogItemPresentation ;
.

#Define the header of the section to point to the organization profile page of the support organization
:SupportCatalogHeaderPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "customer-support-org" ;
.

#Make the header of the section a clickable link.

:SupportSectionPresentation
    a instance:BrowseCardLinkableSectionPresentation ;
    instance:hasHeaderPresentation :SupportCatalogHeaderPresentation ;
    common:item :CusomerSupportCollectionItem;
    common:item :SupportDocsCatalogItem ;
.

:SupportSection
    a common:Section ;
    kos:sortOrder 2 ;
    common:sectionPresentation :SupportSectionPresentation
.

Step 5: Add a section with external links, dataset, project, insights

Use the following syntax to add links to variety of resources - datasets, projects, insights in projects, and external websites.

#Other Section
#Add a link to a dataset
:DatasetLinkPresentation
    a instance:BrowseCardDatasetSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:datasetid "sales" ;
.
    :DatasetItem a common:Item ;
                           kos:sortOrder 1 ;
                           common:itemPresentation :DatasetLinkPresentation ;
.

#Add a link to a Project
:ProjectLinkPresentation
    a instance:BrowseCardProjectSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:projectid "sales-project" ;
.

:ProjectItem a common:Item;
                           kos:sortOrder 4 ;
                           common:itemPresentation :ProjectLinkPresentation ;
.

#Add link to an external website
:OtherExternalLinkPresentation
    a instance:BrowseCardExternalLinkPresentation ;
    instance:path "https://podcasts.apple.com/us/podcast/catalog-cocktails/id1524652737" ;
    kos:title "Catalog and cocktails" ;
.
:ExternalLinkItem a common:Item ;
                           kos:sortOrder 2 ;
                           common:itemPresentation :OtherExternalLinkPresentation ;
.

#Add link to an insight available in a project

:InsightLinkPresentation
    a instance:BrowseCardInsightSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:projectid "sales-project" ;
    instance:insightid "f3034782-b34e-4558-8719-cc762d6bf8ea" ;
  .
  
  :InsightItem a common:Item ;
                           kos:sortOrder 3 ;
                           common:itemPresentation :InsightLinkPresentation ;
.
   
#Configure the section to display all these links
:OtherSectionPresentation a common:SectionPresentation ;
                                 kos:title "Other useful resources" ;
                                 common:item :DatasetItem ;
                                 common:item :ExternalLinkItem ;
                                 common:item :ProjectItem ;
                                 common:item :InsightItem ;
.

:OtherSection a common:Section ;
                    kos:sortOrder 1 ;
                    common:sectionPresentation  :OtherSectionPresentation ;
                    

.

STEP 6: Add all sections to the appropriate tabs

Finally, add all sections to the appropriate tabs of the browse card.

#Add all sections to the appropriate tabs
:FeaturedTab common:section :MarketingAndSalesSection ;
             common:section :SupportSection ;
.

:ExternalTab common:section :OtherSection;
.

Complete syntax for this task

After you have completed this task, you will have the instance-profile.ttl file ready with the following syntax.

Important

Please ensure that is the is saved as an RDF file type with the extension .ttl.

@prefix :         <https://YourInstllationName-ddw.app.linked.data.world/d/ddw-instance-profile/> .
@prefix instance: <https://ontology.data.world/instance-profile#> .
@prefix common:   <https://ontology.data.world/common-components#> .
@prefix kos:      <https://open-kos.org/schema/> .
:
  a                             instance:InstanceProfile ;
  kos:title                     "My Instance Profile" ;
  instance:hasBrowseCardProfile :BrowseCardProfile ;
.

:BrowseCardProfile a instance:BrowseCardProfile .
:BrowseCardPresentation a instance:TabbedBrowseCardPresentation .

:BrowseCardProfile instance:hasBrowseCardPresentation :BrowseCardPresentation .


## Featured Resources tab configuration
:FeaturedTab a common:Tab ;
    kos:title           "Featured resources" ;
    common:subTitle     "Find the right starting point in the Customer Support organization. Explore important collections, datasets, and projects." ;
    kos:sortOrder       1;
.

## External Resources tab configuration
:ExternalTab a common:Tab ;
    kos:title           "External resources" ;
    common:subTitle     "Documentation and other helpful sources of information outside the platform." ;
    kos:sortOrder       2;
.

## Add all tabs to the browse card
:BrowseCardPresentation common:tab :FeaturedTab ;
                        common:tab :ExternalTab ;
.

##Add the link to the organization profile page.
:MarketingCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "marketing-org" ;
.
:MarketingCatalogItem
    a common:Item ;
    kos:sortOrder 1 ;
    common:itemPresentation :MarketingCatalogItemPresentation ;
.

##Add the link to the collection in the organization.
:CompetitiveAnalysisItemPresentation
    a instance:BrowseCardMetadataSearchResultPresentation ;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CompetitiveAnalysisItem
    a common:Item ;
    kos:sortOrder 2 ;
    common:itemPresentation :CompetitiveAnalysisItemPresentation ;
.

##Add the link to the organization profile page.
:SalesCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "sales-org" ;
    
.
:SalesCatalogItem
    a common:Item ;
    kos:sortOrder 3 ;
    common:itemPresentation :SalesCatalogItemPresentation  ;
.


##Add the link to the collection in the organization.

:SalesPlaybookItemPresentation
   a instance:BrowseCardMetadataSearchResultPresentation;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.6334". ;
.
:SalesPlaybookItem
    a common:Item ;
    kos:sortOrder 4 ;
    common:itemPresentation :SalesPlaybookItemPresentation     ;
.

##Configure the presentation of the Marketing and Sales section.

:MarketingAndSalesSectionPresentation
    a common:SectionPresentation ;
    kos:title "Marketing and Sales" ;
    common:item :MarketingCatalogItem ;
    common:item :CompetitiveAnalysisItem ;
    common:item :SalesCatalogItem ;
    common:item :SalesPlaybookItem ;
.

:MarketingAndSalesSection
    a common:Section ;
    kos:sortOrder 1 ;
    common:sectionPresentation :MarketingAndSalesSectionPresentation ;
.


# Support Section
:CusomerSupportCollectionItemPresentation
    a instance:BrowseCardMetadataSearchResultPresentation ;
    instance:agentid "democorp";
    instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CusomerSupportCollectionItem
    a common:Item ;
    kos:sortOrder 1 ;
    common:itemPresentation :CusomerSupportCollectionItemPresentation ;
.

:DocsCatalogItemPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "Documentation-org" ;
.
:SupportDocsCatalogItem
    a common:Item ;
    kos:sortOrder 2 ;
    common:itemPresentation :DocsCatalogItemPresentation ;
.

:SupportCatalogHeaderPresentation
    a instance:BrowseCardAgentSearchResultPresentation ;
    instance:agentid "customer-support-org" ;
   
.

:SupportSectionPresentation
    a instance:BrowseCardLinkableSectionPresentation ;
    instance:hasHeaderPresentation :SupportCatalogHeaderPresentation ;
    common:item :CusomerSupportCollectionItem;
    common:item :SupportDocsCatalogItem ;
.

:SupportSection
    a common:Section ;
    kos:sortOrder 2 ;
    common:sectionPresentation :SupportSectionPresentation
.

#Other Section

#Add a link to a dataset
:DatasetLinkPresentation
    a instance:BrowseCardDatasetSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:datasetid "sales" ;
.
    :DatasetItem a common:Item ;
                           kos:sortOrder 1 ;
                           common:itemPresentation :DatasetLinkPresentation ;
.

#Add a link to a Project
:ProjectLinkPresentation
    a instance:BrowseCardProjectSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:projectid "sales-project" ;
.

:ProjectItem a common:Item;
                           kos:sortOrder 4 ;
                           common:itemPresentation :ProjectLinkPresentation ;
.

#Add link to an external website
:OtherExternalLinkPresentation
    a instance:BrowseCardExternalLinkPresentation ;
    instance:path "https://podcasts.apple.com/us/podcast/catalog-cocktails/id1524652737" ;
    kos:title "Catalog and cocktails" ;
.
:ExternalLinkItem a common:Item ;
                           kos:sortOrder 2 ;
                           common:itemPresentation :OtherExternalLinkPresentation ;
.

#Add link to an insight available in a project

:InsightLinkPresentation
    a instance:BrowseCardInsightSearchResultPresentation ;
    instance:agentid "sales-org" ;
    instance:projectid "sales-project" ;
    instance:insightid "f3034782-b34e-4558-8719-cc762d6bf8ea" ;
  .
  
  :InsightItem a common:Item ;
                           kos:sortOrder 3 ;
                           common:itemPresentation :InsightLinkPresentation ;
.
   
#Configure the section to display all these links
:OtherSectionPresentation a common:SectionPresentation ;
                                 kos:title "Other useful resources" ;
                                 common:item :DatasetItem ;
                                 common:item :ExternalLinkItem ;
                                 common:item :ProjectItem ;
                                 common:item :InsightItem ;
.

:OtherSection a common:Section ;
                    kos:sortOrder 1 ;
                    common:sectionPresentation  :OtherSectionPresentation ;
                    

.

#Add all sections to the appropriate tabs
:FeaturedTab common:section :MarketingAndSalesSection ;
             common:section :SupportSection ;
.

:ExternalTab common:section :OtherSection;
.