YAML configuration example

Carbon workspaces can be edited directly in YAML as well as with the graphical user interface. This page contains the YAML code for an example Carbon workspace. Details about this configuration can be found in the YAML configuration reference.

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
displayMetadata:
  title: Claim Portal
  description: Claim Department App
discoverableModules:
  - ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
  - ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
configuration:
  moduleShortcuts:
    primary:
      - title: Explore data
        description: ''
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: search
            color:
              type: custom
              custom: '#2965CC'
        moduleRid: ri.carbon..core-module.search
        parameterValues: {}
      - title: Alert Triaging
        description: Inbox for quantity alerts with all the data needed to make a decision
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: inbox
            color:
              type: custom
              custom: '#FFC940'
        moduleRid: ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
        parameterValues:
          autoRefreshOnDataChanges:
            type: string
            string:
              string: 'true'
      - title: Alert Investigator
        description: Shows all alerts connected to an order
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: badge
            color:
              type: custom
              custom: '#B6D94C'
        moduleRid: ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
        parameterValues:
          variable.priority:
            type: string
            string:
              string: P2
          autoRefreshOnDataChanges:
            type: string
            string:
              string: 'true'
      - title: Order View
        description: null
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: layers
            color:
              type: custom
              custom: '#FF66A1'
        moduleRid: ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
        parameterValues: {}
    secondary:
      - title: All Orders
        description: ''
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: clipboard
            color:
              type: custom
              custom: '#202b33'
        moduleRid: ri.carbon..core-module.exploration
        parameterValues:
          objectSetRid:
            type: string
            string:
              string: >-
                ri.object-set.main.versioned-object-set.d1e3f2e1-849e-4aaa-ae01-5c63e8771be7
  homePage:
    logo:
      source:
        type: compassResource
        compassResource:
          resourceRid: ri.blobster.main.image.77b48452-73e0-431a-909e-efa286a2d5e2
      maxWidth: 400
      maxHeight: 80
    welcomeText: null
    shouldHideSearchBar: false
    defaultObjectTypesFilter:
      specific:
        selectedObjectTypes:
          - ri.ontology.main.object-type.af927662-698b-42ab-8e91-5d67304b0e8f
      type: specific
    columns:
      - sections:
          - title: null
            description: null
            displayAs: CARD
            contents:
              type: custom
              custom:
                items:
                  - type: module
                    module:
                      displayMetadata:
                        thumbnail:
                          source:
                            type: compassResource
                            compassResource:
                              resourceRid: >-
                                ri.blobster.main.image.b551eeb1-ad11-4f19-b166-241a6463f096
                      moduleRid: >-
                        ri.workshop.main.module.a1838b32-448d-43f6-beff-3c9e40a34929
                      parameterValues: {}
                  - type: module
                    module:
                      displayMetadata:
                        thumbnail:
                          source:
                            type: compassResource
                            compassResource:
                              resourceRid: >-
                                ri.blobster.main.image.545f9fb8-14dc-4b3b-a823-e57492e502d5
                      moduleRid: >-
                        ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
                      parameterValues: {}
          - contents:
              custom:
                items: []
              type: custom
      - sections:
          - title: null
            description: null
            displayAs: CARD
            contents:
              type: custom
              custom:
                items:
                  - type: module
                    module:
                      displayMetadata:
                        title: Order View
                        description: '360 order view '
                        icon:
                          type: blueprintIcon
                          blueprintIcon:
                            iconName: layers
                            color:
                              type: custom
                              custom: '#FF66A1'
                        thumbnail:
                          source:
                            type: compassResource
                            compassResource:
                              resourceRid: >-
                                ri.blobster.main.image.46edffad-903f-4434-84f0-f0892d861ae4
                          position: TOP
                      moduleRid: >-
                        ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
                      parameterValues: {}
      - sections:
          - title: null
            description: null
            displayAs: null
            contents:
              type: custom
              custom:
                items:
                  - type: module
                    module:
                      displayMetadata:
                        title: Explore all data
                        description: Search objects and links
                        icon:
                          type: blueprintIcon
                          blueprintIcon:
                            iconName: search
                            color:
                              type: custom
                              custom: '#2965CC'
                        thumbnail: null
                      moduleRid: ri.carbon..core-module.search
                      parameterValues: {}
                  - type: module
                    module:
                      displayMetadata:
                        title: Dispatch Alert
                        description: ''
                        icon:
                          type: blueprintIcon
                          blueprintIcon:
                            iconName: warning-sign
                            color:
                              type: custom
                              custom: '#ff7373'
                        thumbnail: null
                      moduleRid: ri.carbon..core-module.exploration
                      parameterValues:
                        objectSetRid:
                          type: string
                          string:
                            string: >-
                              ri.object-set.main.object-set.3f583a3e-5847-447e-8184-a56fef9a1ccc
                  - type: objectType
                    objectType:
                      objectTypeRid: >-
                        ri.ontology.main.object-type.14014a36-91d6-45b7-a288-bda5f2881568
                  - type: objectType
                    objectType:
                      objectTypeRid: >-
                        ri.ontology.main.object-type.fec52161-983f-40cc-8233-f73112c3850c
                  - type: objectType
                    objectType:
                      objectTypeRid: >-
                        ri.ontology.main.object-type.e5a5adea-cfa4-4a80-808b-3dbbe7e0bc4b
          - title: Top Accounts
            description: null
            displayAs: null
            contents:
              type: objects
              objects:
                objects:
                  - objectRid: >-
                      ri.phonograph2-objects.main.object.fea24c1e-582d-40ab-85a4-423a523cfb7f
                  - objectRid: >-
                      ri.phonograph2-objects.main.object.9c145afd-baa3-4734-a76d-f5f15f77899d