1. 元数据
  2. 界面元数据

概览

  • 应用
  • 选项卡
  • 列表视图
  • 页面布局
  • 自定义按钮

应用

应用.app.yml
可以设置应用的名称、显示名称、应用图标,以及在应用中显示的对象、选项卡清单。

name: 合同
code: contracts
description: 管理合同及收付款。
icon_slds: contract_line_item
mobile: true
mobile_objects:
    - contracts
    - finance_invoice
    - finance_receive
    - finance_receipt
    - finance_payment
    - contract_types
oauth2_enabled: false
oauth2_logout_enabled: false
objects:
    - contracts
    - finance_invoice
    - finance_receive
    - finance_receipt
    - finance_payment
    - contract_types
saml_enabled: false
saml_logout_enabled: false
sort: 50
tabs:
    - contract_analysis
visible: true
属性名属性类型属性含义
nametext名称
codetextAPI 名称
icon_sldslookup图标
visibleboolean启用
descriptiontextarea描述
tabslookup选项卡
objectslookup桌面主菜单
mobile_objectslookup手机主菜单
is_creatorboolean显示在桌面菜单中
mobileboolean显示在手机菜单中
icontext旧版图标
sortnumber排序
urlurl外部链接
is_use_ieboolean使用IE打开(需使用Steedos桌面客户端)
is_use_iframeboolean使用iframe打开
is_new_windowboolean在新窗口打开
on_clicktextarea链接脚本
auth_nametext验证域名
secrettextAPI 密钥
oauth2_enabledboolean启用 OAuth2
oauth2_callback_urltext回调 URL
oauth2_scopesselect范围
oauth2_logout_enabledboolean启用单点注销
oauth2_logout_urlurl单点注销 URL
oauth2_home_urlurl应用首页
oauth2_logoimage应用 Logo
oauth2_client_secrettext应用密钥
saml_enabledboolean启用 SAML
saml_entity_idtextEntity Id
saml_issuertextIssuer
saml_idp_certtextIDP Cert
saml_acs_urlurlACS Url
saml_name_id_formattext名称
saml_logout_enabledboolean启用单点注销
saml_logout_urlurl单点注销 URL
saml_logout_blockselect单点注销绑定
is_systemboolean系统
from_code_idtextfrom_code_id

选项卡

选项卡.tab.yml
选项卡可以绑定到一个对象,也可以绑定到一个网址或是自定义页面。

name: contract_analysis
desktop: true
icon: dashboard
label: 合同分析
mobile: true
page: contract_analysis
type: page
属性名属性类型属性含义
labeltext显示名称
nametextAPI 名称
iconlookup图标
parentlookup上级选项卡
typeselect类型
mobileboolean显示在手机菜单中
desktopboolean显示在桌面菜单中
frame_heightnumber选项卡框架的高度
has_sidebarboolean显示侧边栏面板
objectlookup对象
urlurl外部链接
is_new_windowboolean在新窗口打开
pagelookup页面
action_overridestext分配给选项卡的操作替代列表
descriptiontextarea描述
is_systemboolean系统

列表视图

列表视图.listview.yml
定义对象的列表显示,包括:显示的列、过滤条件、排序规则、默认搜索字段。

name: all
label: 所有合同
columns:
  - field: 'no'
    width: '150'
    wrap: true
  - field: name
    width: '220'
    wrap: true
  - field: contract_type
    width: '150'
    wrap: true
  - field: amount
    width: '150'
    wrap: true
  - field: signed_date
    width: '150'
    wrap: false
  - field: owner
    width: '150'
    wrap: false
  - field: created
    width: '150'
    wrap: false
filter_fields:
  - contract_type
  - signed_date
  - othercompany
  - instance_state
  - owner
filter_scope: space
filters:
  - is_default: true
    field: instance_state
    operation: <>
    value:
      - terminated
    is_required: false
shared: true
show_count: false
sort:
  - field_name: 'no'
    order: desc
属性名属性类型属性含义
labeltext显示名称
nametextAPI 名称
object_namemaster_detail对象
filter_scopelookup过滤范围
sharedboolean共享视图到工作区
show_countboolean显示条目数
typeselect视图类型
scrolling_modeselect滚动条样式
columnsgrid显示的列
columns.$object显示的列
columns.$.fieldlookup字段
columns.$.widthtext宽度
filter_fieldslookup默认过滤字段
sortgrid默认排序规则
sort.$objectOrder
sort.$.field_namelookup排序字段
sort.$.orderselect排序方式
filtersgrid过滤器
filters.$objectFilter
filters.$.fieldlookup字段
filters.$.operationlookup运算符
filters.$.value
filter_logictext过滤逻辑
mobile_columnsgrid手机端显示的列
mobile_columns.$object手机端显示的列
mobile_columns.$.fieldlookup字段
sort_nonumber排序号

页面布局

对象名.页面布局.layout.yml
定义对象的记录显示,包括:所属简档、操作按钮、显示的字段、相关子表。

name: customer
buttons:
  - button_name: standard_new
  - button_name: standard_edit
  - button_name: standard_delete
fields:
  - field_name: name
    is_required: true
  - field_name: start
  - field_name: end
label: 客户
object_name: events
profiles:
  - customer
related_lists:
  - related_field_fullname: tasks.related_to
    field_names:
      - name
      - due_date
      - state
      - priority
      - assignees
      - related_to
    sort_order: asc
    page_size: 5
type: record
属性名属性类型属性含义
nametextApi Name
labeltext页面布局名
object_namemaster_detail对象
typeselect类型
profileslookup简档
buttonsgrid操作
buttons.$.button_namelookup名称
buttons.$.visible_ontextarea显示条件
fieldsgrid字段
fields.$objectField
fields.$.field_namelookup字段
fields.$.is_readonlyboolean只读
fields.$.is_requiredboolean必填
fields.$.grouptext分组
fields.$.visible_ontextarea显示条件
related_listsgrid相关子表
related_lists.$.related_field_fullnamelookup子表名称
related_lists.$.labeltext显示标题
related_lists.$.field_nameslookup显示的字段
related_lists.$.sort_field_namelookup排序字段
related_lists.$.sort_orderselect排序方式
related_lists.$.filterstextarea过滤规则
related_lists.$.visible_ontextarea显示条件
related_lists.$.page_sizenumber每页显示数量

自定义按钮

自定义按钮分为 按钮.button.js 和 按钮.button.yml 两个文件。

buttons
├── 按钮.button.js
└── 按钮.button.yml

示例:详细记录页”确认“按钮,在指定条件下显示此按钮,点击此按钮新建指定对象的一条记录。
sure.button.js 文件

module.exports = {
    sure: function(object_name, record_id) {
        var record = this.record;
        var initialValues = {
            name: record.name,
            state: '试用'
        }
        SteedosUI.showModal(stores.ComponentRegistry.components.ObjectForm, {
            name: `standard_new_form`,
            objectApiName: 'hmc__c',
            title: '确认',
            initialValues
        }, null, {
            iconPath: '/assets/icons'
        });
    },
    sureVisible: function(object_name, record_id, permissions, record) {
        if (record.rz_state === "待入职" && record.instance_state === 'approved') {
            return true;
        } else {
            return false;
        }
    }
}

sure.button.yml 文件

name: sure
is_enable: true
label: 确认
'on': record_only
type: script
visible: true
属性名属性类型属性含义
nametextAPI 名称
labeltext显示名称
objectmaster_detail所属对象
is_enableboolean启用
visibleboolean可见
‘on’lookup显示位置
typeselect类型
todocode执行的脚本