跳转至

YAML configuration example(YAML 配置示例)

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.

Example Carbon workspace

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

中文翻译

YAML 配置示例

Carbon 工作区既可以通过图形用户界面编辑,也可以直接通过 YAML 进行编辑。本页面包含一个示例 Carbon 工作区的 YAML 代码。有关此配置的详细信息,请参阅 YAML 配置参考

示例 Carbon 工作区

displayMetadata:
  title: 索赔门户
  description: 索赔部门应用
discoverableModules:
  - ri.workshop.main.module.25b772f5-a095-48c6-a889-a960eeb93ce1
  - ri.workshop.main.module.6e10d8bb-90a4-47d2-86e3-3f10bfca0a1e
configuration:
  moduleShortcuts:
    primary:
      - title: 探索数据
        description: ''
        icon:
          type: blueprintIcon
          blueprintIcon:
            iconName: search
            color:
              type: custom
              custom: '#2965CC'
        moduleRid: ri.carbon..core-module.search
        parameterValues: {}
      - title: 警报分类
        description: 数量警报收件箱,包含做出决策所需的所有数据
        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: 警报调查员
        description: 显示与订单相关的所有警报
        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: 订单视图
        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: 所有订单
        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: 订单视图
                        description: '360度订单视图 '
                        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: 探索所有数据
                        description: 搜索对象和链接
                        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: 派发警报
                        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: 顶级账户
            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