YAML configuration reference（YAML 配置参考）¶
Carbon workspaces can be edited directly in YAML as well as with the graphical user interface. This page contains YAML examples of how to configure different parts of the Carbon workspace, using the Claims Portal as an example. The full YAML for the Claims Portal example can be found in the YAML code example.
Metadata & general configuration¶
Name and description of workspace¶
displayMetadata:
title: Claim Portal
description: Everything related to claim management
Setting custom icons¶
Blueprint icon¶
icon:
type: blueprintIcon
blueprintIcon:
iconName: music
color:
type: custom
custom: '#FF66A1'
Palantir application icon¶
icon:
type: applicationIcon
applicationIcon:
iconName: contour-app
color:
type: custom
custom: '#FF66A1'
Setting discoverable modules¶
discoverableModules:
- ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
- ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
Carbon Menu Bar¶
Anchor modules¶
Anchor modules: Workshop example¶
configuration:
moduleShortcuts:
primary:
- title: Alert Inbox
moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
parameterValues: {}
Anchor modules: Object View example¶
configuration:
moduleShortcuts:
primary:
- title: Order BF645S
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: eye-open
color:
type: custom
custom: '#FFC940'
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
Anchor modules: Object Explorer example¶
configuration:
moduleShortcuts:
primary:
- title: Cancelled Orders
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: clipboard
color:
type: custom
custom: '#2EE6D6'
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
Anchor modules: Search example¶
configuration:
moduleShortcuts:
primary:
- title: Search
moduleRid: ri.carbon..core-module.search
parameterValues: {}
Multi-tab modules¶
Multi-tab modules: Workshop example¶
configuration:
moduleShortcuts:
secondary:
- title: Alert Inbox
moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
parameterValues: {}
Multi-tab modules: Object View example¶
configuration:
moduleShortcuts:
secondary:
- title: Order BF645S
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: eye-open
color:
type: custom
custom: '#FFC940'
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
Multi-tab modules: Object Explorer example¶
configuration:
moduleShortcuts:
secondary:
- title: Cancelled Orders
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: clipboard
color:
type: custom
custom: '#2EE6D6'
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
Multi-tab modules: Search example¶
configuration:
moduleShortcuts:
secondary:
- title: Search
moduleRid: ri.carbon..core-module.search
parameterValues: {}
Homepage¶
Custom logo - optional¶
configuration:
homePage:
logo:
source:
type: compassResource
compassResource:
resourceRid: ri.blobster.main.image.50505d65-4001-4f55-8fda-669f52347745
maxWidth: 60
maxHeight: 60
Setting section title and description¶
Add title and description - optional¶
configuration:
homePage:
columns:
- sections:
- title: Triaging apps
description: All the apps you need to triage claims
displayAs: null
contents:
Change display type of section items¶
Display section items as list - optional¶
Note that list is the default option.
configuration:
homePage:
columns:
- sections:
- displayAs: LIST
contents:
Display section items as cards - optional¶
configuration:
homePage:
columns:
- sections:
- displayAs: CARD
contents:
Default section showing all modules¶
configuration:
homePage:
columns:
- sections:
- contents:
type: modules
modules: {}
Default section showing all saved explorations¶
configuration:
homePage:
columns:
- sections:
- contents:
type: savedExplorations
savedExplorations: {}
Default section showing all Prominent object types¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objectTypes
objectTypes: {}
Default section showing specific object types¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objectTypes
objectTypes:
objectTypes:
- objectTypeRid: ri.ontology.main.object-type.14014a36-91d6-45b7-a288-bda5f2881568
- objectTypeRid: ri.ontology.main.object-type.e5a5adea-cfa4-4a80-808b-3dbbe7e0bc4b
Default section showing specific Objects¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objects
objects:
objects:
- objectRid: ri.phonograph2-objects.main.object.17474c05-bfa3-4477-adc8-9c98e65b0269
- objectRid: ri.phonograph2-objects.main.object.048f39e4-10af-48be-9736-d24191242732
Custom section with module item - Workshop module¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.workshop.main.module.525ab70b-d24b-42f4-ad25-a407f0273b83
parameterValues: {}
Custom section with module item - Workshop module with module interface variables¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.workshop.main.module.525ab70b-d24b-42f4-ad25-a407f0273b83
parameterValues:
variable.status:
type: string
string:
string: Open
To pass in a module interface variable to a workshop module, add it to the parameterValues map with a variable. prefix. In the example above, a module interface string variable with external ID status, is passed to the workshop module with value Open.
Custom section with module item - Object View module - Object View¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
Custom section with module item - Object Explorer module - Object Set¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
Custom section with object type item¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: objectType
objectType:
objectTypeRid: ri.ontology.main.object-type.14014a36-91d6-45b7-a288-bda5f2881568
Custom section with Object item¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: object
object:
objectRid: ri.phonograph2-objects.main.object.17474c05-bfa3-4477-adc8-9c98e65b0269
Custom section with resource item¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: compassResource
compassResource:
displayMetadata:
title: Fusion Sheet
description: For spreadsheet use cases
targetResource:
resourceRid: ri.fusion.main.document.01eaf763-c721-4557-b368-42be112e40a3
Custom section with Palantir application item¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: foundryApplication
foundryApplication:
displayMetadata: {}
workspaceApplicationName: contour-app
relativeUrl: null
中文翻译¶
YAML 配置参考¶
Carbon 工作区既可以通过图形用户界面编辑，也可以直接通过 YAML 进行编辑。本页面以 Claims Portal（索赔门户）为例，提供了如何配置 Carbon 工作区不同部分的 YAML 示例。Claims Portal 示例的完整 YAML 可在 YAML 代码示例 中找到。
元数据与通用配置¶
工作区的名称和描述¶
displayMetadata:
title: Claim Portal
description: Everything related to claim management
设置自定义图标¶
蓝图图标（Blueprint icon）¶
icon:
type: blueprintIcon
blueprintIcon:
iconName: music
color:
type: custom
custom: '#FF66A1'
Palantir 应用图标（Application icon）¶
icon:
type: applicationIcon
applicationIcon:
iconName: contour-app
color:
type: custom
custom: '#FF66A1'
设置可发现模块（Discoverable modules）¶
discoverableModules:
- ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
- ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
Carbon 菜单栏（Carbon Menu Bar）¶
锚点模块（Anchor modules）¶
锚点模块：Workshop 示例¶
configuration:
moduleShortcuts:
primary:
- title: Alert Inbox
moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
parameterValues: {}
锚点模块：对象视图（Object View）示例¶
configuration:
moduleShortcuts:
primary:
- title: Order BF645S
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: eye-open
color:
type: custom
custom: '#FFC940'
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
锚点模块：对象浏览器（Object Explorer）示例¶
configuration:
moduleShortcuts:
primary:
- title: Cancelled Orders
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: clipboard
color:
type: custom
custom: '#2EE6D6'
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
锚点模块：搜索（Search）示例¶
configuration:
moduleShortcuts:
primary:
- title: Search
moduleRid: ri.carbon..core-module.search
parameterValues: {}
多标签模块（Multi-tab modules）¶
多标签模块：Workshop 示例¶
configuration:
moduleShortcuts:
secondary:
- title: Alert Inbox
moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
parameterValues: {}
多标签模块：对象视图（Object View）示例¶
configuration:
moduleShortcuts:
secondary:
- title: Order BF645S
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: eye-open
color:
type: custom
custom: '#FFC940'
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
多标签模块：对象浏览器（Object Explorer）示例¶
configuration:
moduleShortcuts:
secondary:
- title: Cancelled Orders
description: null
icon:
type: blueprintIcon
blueprintIcon:
iconName: clipboard
color:
type: custom
custom: '#2EE6D6'
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
多标签模块：搜索（Search）示例¶
configuration:
moduleShortcuts:
secondary:
- title: Search
moduleRid: ri.carbon..core-module.search
parameterValues: {}
首页（Homepage）¶
自定义徽标（Custom logo）- 可选¶
configuration:
homePage:
logo:
source:
type: compassResource
compassResource:
resourceRid: ri.blobster.main.image.50505d65-4001-4f55-8fda-669f52347745
maxWidth: 60
maxHeight: 60
设置分区标题和描述¶
添加标题和描述 - 可选¶
configuration:
homePage:
columns:
- sections:
- title: Triaging apps
description: All the apps you need to triage claims
displayAs: null
contents:
更改分区项目的显示类型¶
将分区项目显示为列表（List）- 可选¶
注意：列表为默认选项。
configuration:
homePage:
columns:
- sections:
- displayAs: LIST
contents:
将分区项目显示为卡片（Card）- 可选¶
configuration:
homePage:
columns:
- sections:
- displayAs: CARD
contents:
显示所有模块的默认分区¶
configuration:
homePage:
columns:
- sections:
- contents:
type: modules
modules: {}
显示所有已保存探索（Saved explorations）的默认分区¶
configuration:
homePage:
columns:
- sections:
- contents:
type: savedExplorations
savedExplorations: {}
显示所有突出对象类型（Prominent object types）的默认分区¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objectTypes
objectTypes: {}
显示特定对象类型的默认分区¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objectTypes
objectTypes:
objectTypes:
- objectTypeRid: ri.ontology.main.object-type.14014a36-91d6-45b7-a288-bda5f2881568
- objectTypeRid: ri.ontology.main.object-type.e5a5adea-cfa4-4a80-808b-3dbbe7e0bc4b
显示特定对象（Objects）的默认分区¶
configuration:
homePage:
columns:
- sections:
- contents:
type: objects
objects:
objects:
- objectRid: ri.phonograph2-objects.main.object.17474c05-bfa3-4477-adc8-9c98e65b0269
- objectRid: ri.phonograph2-objects.main.object.048f39e4-10af-48be-9736-d24191242732
包含模块项目的自定义分区 - Workshop 模块¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.workshop.main.module.525ab70b-d24b-42f4-ad25-a407f0273b83
parameterValues: {}
包含模块项目的自定义分区 - 带模块接口变量（Module interface variables）的 Workshop 模块¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.workshop.main.module.525ab70b-d24b-42f4-ad25-a407f0273b83
parameterValues:
variable.status:
type: string
string:
string: Open
要向 Workshop 模块传递模块接口变量，请将其添加到 parameterValues 映射中，并加上 variable. 前缀。在上述示例中，一个外部 ID 为 status 的模块接口字符串变量被传递给 Workshop 模块，其值为 Open。
包含模块项目的自定义分区 - 对象视图（Object View）模块¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.carbon..core-module.object-view
parameterValues:
objectRid:
type: object
object:
objectRid: ri.phonograph2-objects.main.object.ab863bd7-c82c-482f-9218-9ba1df79bd3c
包含模块项目的自定义分区 - 对象浏览器（Object Explorer）模块 - 对象集（Object Set）¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: module
module:
displayMetadata: {}
moduleRid: ri.carbon..core-module.exploration
parameterValues:
objectSetRid:
type: string
string:
string: ri.object-set.main.versioned-object-set.36824ec3-3746-4d74-9e96-5094b8c8630e
包含对象类型项目的自定义分区¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: objectType
objectType:
objectTypeRid: ri.ontology.main.object-type.14014a36-91d6-45b7-a288-bda5f2881568
包含对象项目的自定义分区¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: object
object:
objectRid: ri.phonograph2-objects.main.object.17474c05-bfa3-4477-adc8-9c98e65b0269
包含资源项目的自定义分区¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: compassResource
compassResource:
displayMetadata:
title: Fusion Sheet
description: For spreadsheet use cases
targetResource:
resourceRid: ri.fusion.main.document.01eaf763-c721-4557-b368-42be112e40a3
包含 Palantir 应用项目的自定义分区¶
configuration:
homePage:
columns:
- sections:
- title: null
description: null
contents:
type: custom
custom:
items:
- type: foundryApplication
foundryApplication:
displayMetadata: {}
workspaceApplicationName: contour-app
relativeUrl: null