Documentation

Use case developmentCarbonEditing with codeYAML configuration reference

YAML configuration reference

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

Copied!1
2
3
displayMetadata:
  title: Claim Portal
  description: Everything related to claim management

Setting custom icons

Blueprint icon

Copied!1
2
3
4
5
6
7
        icon: 
          type: blueprintIcon
          blueprintIcon: 
            iconName: music
            color: 
              type: custom
              custom: '#FF66A1'

Palantir application icon

Copied!1
2
3
4
5
6
7
        icon: 
          type: applicationIcon
          applicationIcon: 
            iconName: contour-app
            color: 
              type: custom
              custom: '#FF66A1'

Setting discoverable modules

Copied!1
2
3
discoverableModules:
  - ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
  - ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e

Anchor modules

Anchor modules: Workshop example

Copied!1
2
3
4
5
6
configuration:
  moduleShortcuts:
    primary:
      - title: Alert Inbox
        moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
        parameterValues: {}

Anchor modules: Object View example

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

Copied!1
2
3
4
5
6
configuration:
  moduleShortcuts:
    primary:
      - title: Search
        moduleRid: ri.carbon..core-module.search
        parameterValues: {}

Multi-tab modules

Multi-tab modules: Workshop example

Copied!1
2
3
4
5
6
configuration:
  moduleShortcuts:
    secondary:
      - title: Alert Inbox
        moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
        parameterValues: {}

Multi-tab modules: Object View example

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

Copied!1
2
3
4
5
6
configuration:
  moduleShortcuts:
    secondary:
      - title: Search
        moduleRid: ri.carbon..core-module.search
        parameterValues: {}

Homepage

Custom logo - optional

Copied!1
2
3
4
5
6
7
8
9
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

Copied!1
2
3
4
5
6
7
8
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.

Copied!1
2
3
4
5
6
configuration:
  homePage:    
    columns:
      - sections:
          - displayAs: LIST
            contents:

Display section items as cards - optional

Copied!1
2
3
4
5
6
configuration:
  homePage:    
    columns:
      - sections:
          - displayAs: CARD
            contents:

Default section showing all modules

Copied!1
2
3
4
5
6
7
configuration:
  homePage:      
    columns:
      - sections:
          - contents: 
              type: modules
              modules: {}

Default section showing all saved explorations

Copied!1
2
3
4
5
6
7
configuration:
  homePage:      
    columns:
      - sections:
          - contents: 
              type: savedExplorations
              savedExplorations: {}

Default section showing all Prominent object types

Copied!1
2
3
4
5
6
7
configuration:
  homePage:      
    columns:
      - sections:
          - contents: 
              type: objectTypes
              objectTypes: {}

Default section showing specific object types

Copied!1
2
3
4
5
6
7
8
9
10
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

Copied!1
2
3
4
5
6
7
8
9
10
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
configuration:
  homePage:      
    columns:      
      - sections:
          - title: null
            description: null
            contents:
              type: custom
              custom:
                items:
                  - type: foundryApplication
                    foundryApplication:
                      displayMetadata: {}
                      workspaceApplicationName: contour-app
                      relativeUrl: null