Create the configuration file for the browse card for organization profile page
Important
These instructions are specifically for adding browse card using the Metadata Profile files. If your system is setup with Catalog Toolkit, follow these instructions to set up browse card using the Catalog Toolkit.
The browse card is configured using the org-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.
For resource | Gather information | Sample values | Details |
|---|---|---|---|
Collections
|
|
| This opens the collection page. |
Business Term |
|
| This opens the business term page. |
Metadata resources |
|
| This opens the resource page. |
Organization |
|
| This opens the organization profile page. |
Datasets |
NOTE: Copy this information from the URL field of the browser window. |
| This opens the dataset page. |
Projects |
NOTE: Copy this information from the URL field of the browser window. |
| This opens the project page. |
Insights |
NOTE: Copy this information from the URL field of the browser window. |
| This opens the insight available in the project. |
External website links | The URL of the external resource. | This opens the external website. |
STEP 1: Add the prefixes for this configuration and declare the org profile
Use the following syntax to add the the prefixes for this configuration and declare the organization profile and define that this organization 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 and organization id in the first line. Do not change anything else.
Replace YourInstallationName with the name of the installation and Organizationid with the id of your organization.
For example, if your application URL is: https://8bank.app.data.world/ 8bank is the name of your installation, and ddw is the id of your organization.
The value will look like: <https://8bank-ddw.app.linked.data.world/d/ddw-profile-configuration/>.
If your organization lives in https://data.world/, you will only replace the Organizationid, which will result in: <https://ddw.app.linked.data.world/d/ddw-profile-configuration/>.
@prefix : <https://YourInstllationName-Organizationid.app.linked.data.world/d/ddw-org-profile/> . @prefix instance: <https://ontology.data.world/instance-profile#> . @prefix org: <https://ontology.data.world/org-profile#> . @prefix common: <https://ontology.data.world/common-components#> . @prefix kos: <https://open-kos.org/schema/> . : a org:OrgProfile ; kos:title "My Organization Profile" ; org:hasBrowseCardProfile :BrowseCardProfile ; . :BrowseCardProfile a instance:BrowseCardProfile . :BrowseCardPresentation a instance:TabbedBrowseCardPresentation . :BrowseCardProfile instance:hasBrowseCardPresentation :BrowseCardPresentation .
STEP 2: Define the tabs and add them to the 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 main collections of the organization
Use the following syntax to configure the first section. We are adding the most useful collections from the organization.
##SECTION 1 configuration- Add the link to the collection in the organization.
##adding collection1
:SupportKeyDataItemPresentation
a instance: instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334";
.
:SupportKeyDataItem
a common:Item ;
kos:sortOrder 2 ;
common:itemPresentation :SupportKeyDataItemPresentation ;
.
##adding collection2
:CustomerPlaybookItemPresentation
a instance:instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CustomerPlaybookItem
a common:Item ;
kos:sortOrder 4 ;
common:itemPresentation :CustomerPlaybookItemPresentation ;
.
##Define presentation of the section
:SupportSectionPresentation a common:SectionPresentation ;
kos:title "Customer Support key collections" ;
common:item :SupportKeyDataItem ;
common:item :CustomerPlaybookItem ;
.
:SupportSection
a common:Section ;
kos:sortOrder 1 ;
common:sectionPresentation :SupportSectionPresentation
.
STEP 4: Add a second section with links to more collections
##SECTION 2 configuration
##adding collection1
:CompetitiveAnalysisCollectionItemPresentation
a instance:instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CompetitiveAnalysisCollectionItem
a common:Item ;
kos:sortOrder 1 ;
common:itemPresentation :CompetitiveAnalysisCollectionItemPresentation ;
.
##Define presentation of the section
:OtherUsefulCollectionsSectionPresentation a common:SectionPresentation ;
kos:title "Other useful collections" ;
common:item :CompetitiveAnalysisCollectionItem;
.
:OtherUsefulCollectionsSection
a common:Section ;
kos:sortOrder 2 ;
common:sectionPresentation :OtherUsefulCollectionsSectionPresentation
.
STEP 5: Add link to datasets and projects from the organization
## SECTION 3 configuration
#Add link to an insight available in a project
#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 ;
.
: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
:KeyDatasetsProjectsSectionPresentation a common:SectionPresentation ;
kos:title "Key datasets and projects" ;
common:item :DatasetItem ;
common:item :ProjectItem ;
common:item :InsightItem ;
.
:KeyDatasetsProjectsSection a common:Section ;
kos:sortOrder 3 ;
common:sectionPresentation :KeyDatasetsProjectsSectionPresentation ;
.STEP 6: Add links to other organization profile pages
##SECTION -4 configuration
##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 ;
.
:SalesCatalogItemPresentation
a instance:BrowseCardAgentSearchResultPresentation ;
instance:agentid "sales-org" ;
.
:SalesCatalogItem
a common:Item ;
kos:sortOrder 3 ;
common:itemPresentation :SalesCatalogItemPresentation ;
.
:MarketingAndSalesSectionPresentation
a common:SectionPresentation ;
kos:title "Marketing and Sales" ;
common:item :MarketingCatalogItem ;
common:item :SalesCatalogItem ;
.
:MarketingAndSalesSection
a common:Section ;
kos:sortOrder 4 ;
common:sectionPresentation :MarketingAndSalesSectionPresentation ;
.
STEP 7: Add a section with external links
Use the following syntax to add links to external websites.
##Section 5 configuration
: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 ;
.
#Other section definition
:OtherSectionPresentation a common:SectionPresentation ;
kos:title "More useful resources" ;
common:item :ExternalLinkItem ;
.
:OtherSection a common:Section ;
kos:sortOrder 5 ;
common:sectionPresentation :OtherSectionPresentation ;
.
STEP 8: Add a section with section header linking to organization profile page
Use the following syntax to add a section with header that links to the organization profile page of another organization.
#Section 6
#Add a collection
:UsefulDocsCollectionItemPresentation
a instance:BrowseCardMetadataSearchResultPresentation ;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:UsefulDocsCollectionItem
a common:Item ;
kos:sortOrder 1 ;
common:itemPresentation :UsefulDocsCollectionItemPresentation ;
.
#Define the header of the section to point to the organization profile page of the Documentation organization
:SupportCatalogHeaderPresentation
a instance:BrowseCardAgentSearchResultPresentation ;
instance:agentid "documentation-org" ;
.
#Make the header of the section a clickable link.
:DocumentationSectionPresentation
a instance:BrowseCardLinkableSectionPresentation ;
instance:hasHeaderPresentation :SupportCatalogHeaderPresentation ;
common:item :UsefulDocsCollectionItem ;
.
:DocumentationSection
a common:Section ;
kos:sortOrder 6 ;
common:sectionPresentation :DocumentationSectionPresentation ;
.STEP 9: Add all 6 sections to the approriate tabs
Finally, add all sections to the appropriate tabs of the browse card.
#Add all sections to the appropriate tabs
:FeaturedTab common:section :SupportSection ;
common:section :OtherUsefulCollectionsSection ;
common:section :KeyDatasetsProjectsSection ;
common:section :MarketingAndSalesSection ;
.
:ExternalTab common:section :OtherSection;
common:section :DocumentationSection ;
.Complete syntax for this task
After you have completed this task, you will have the org-profile.ttl file ready with the following syntax.
Important
Please ensure that the file is saved as an RDF file type with the extension .ttl.
@prefix : <https://YourInstllationName-Organizationid.app.linked.data.world/d/ddw-org-profile/> .
@prefix instance: <https://ontology.data.world/instance-profile#> .
@prefix org: <https://ontology.data.world/org-profile#> .
@prefix common: <https://ontology.data.world/common-components#> .
@prefix kos: <https://open-kos.org/schema/> .
:
a org:OrgProfile ;
kos:title "My Organization Profile" ;
org: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 ;
.
##SECTION 1 configuration- Add the link to the collection in the organization.
##adding collection1
:SupportKeyDataItemPresentation
a instance: instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334";
.
:SupportKeyDataItem
a common:Item ;
kos:sortOrder 2 ;
common:itemPresentation :SupportKeyDataItemPresentation ;
.
##adding collection2
:CustomerPlaybookItemPresentation
a instance:instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CustomerPlaybookItem
a common:Item ;
kos:sortOrder 4 ;
common:itemPresentation :CustomerPlaybookItemPresentation ;
.
##Define presentation of the section
:SupportSectionPresentation a common:SectionPresentation ;
kos:title "Customer Support key collections" ;
common:item :SupportKeyDataItem ;
common:item :CustomerPlaybookItem ;
.
:SupportSection
a common:Section ;
kos:sortOrder 1 ;
common:sectionPresentation :SupportSectionPresentation
.
##SECTION 2 configuration
##adding collection1
:CompetitiveAnalysisCollectionItemPresentation
a instance:instance:BrowseCardMetadataSearchResultPresentation;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:CompetitiveAnalysisCollectionItem
a common:Item ;
kos:sortOrder 1 ;
common:itemPresentation :CompetitiveAnalysisCollectionItemPresentation ;
.
##Define presentation of the section
:OtherUsefulCollectionsSectionPresentation a common:SectionPresentation ;
kos:title "Other useful collections" ;
common:item :CompetitiveAnalysisCollectionItem;
.
:OtherUsefulCollectionsSection
a common:Section ;
kos:sortOrder 2 ;
common:sectionPresentation :OtherUsefulCollectionsSectionPresentation
.
## SECTION 3 configuration
#Add link to an insight available in a project
#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 ;
.
: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
:KeyDatasetsProjectsSectionPresentation a common:SectionPresentation ;
kos:title "Key datasets and projects" ;
common:item :DatasetItem ;
common:item :ProjectItem ;
common:item :InsightItem ;
.
:KeyDatasetsProjectsSection a common:Section ;
kos:sortOrder 3 ;
common:sectionPresentation :KeyDatasetsProjectsSectionPresentation ;
.
##SECTION -4 configuration
##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 ;
.
:SalesCatalogItemPresentation
a instance:BrowseCardAgentSearchResultPresentation ;
instance:agentid "sales-org" ;
.
:SalesCatalogItem
a common:Item ;
kos:sortOrder 3 ;
common:itemPresentation :SalesCatalogItemPresentation ;
.
:MarketingAndSalesSectionPresentation
a common:SectionPresentation ;
kos:title "Marketing and Sales" ;
common:item :MarketingCatalogItem ;
common:item :SalesCatalogItem ;
.
:MarketingAndSalesSection
a common:Section ;
kos:sortOrder 4 ;
common:sectionPresentation :MarketingAndSalesSectionPresentation ;
.
##Section 5 configuration
: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 ;
.
#Other section definition
:OtherSectionPresentation a common:SectionPresentation ;
kos:title "More useful resources" ;
common:item :ExternalLinkItem ;
.
:OtherSection a common:Section ;
kos:sortOrder 5 ;
common:sectionPresentation :OtherSectionPresentation ;
.
#Section 6
#Add a collection
:UsefulDocsCollectionItemPresentation
a instance:BrowseCardMetadataSearchResultPresentation ;
instance:agentid "democorp";
instance:referent "https://democorp.app.linked.data.world/d/ddw-catalogs/cat.0c6334" ;
.
:UsefulDocsCollectionItem
a common:Item ;
kos:sortOrder 1 ;
common:itemPresentation :UsefulDocsCollectionItemPresentation ;
.
#Define the header of the section to point to the organization profile page of the Documentation organization
:SupportCatalogHeaderPresentation
a instance:BrowseCardAgentSearchResultPresentation ;
instance:agentid "documentation-org" ;
.
#Make the header of the section a clickable link.
:DocumentationSectionPresentation
a instance:BrowseCardLinkableSectionPresentation ;
instance:hasHeaderPresentation :SupportCatalogHeaderPresentation ;
common:item :UsefulDocsCollectionItem ;
.
:DocumentationSection
a common:Section ;
kos:sortOrder 6 ;
common:sectionPresentation :DocumentationSectionPresentation ;
.
#Add all sections to the appropriate tabs
:FeaturedTab common:section :SupportSection ;
common:section :OtherUsefulCollectionsSection ;
common:section :KeyDatasetsProjectsSection ;
common:section :MarketingAndSalesSection ;
.
:ExternalTab common:section :OtherSection;
common:section :DocumentationSection ;
.