Sugarcrm支持产品指南糖版本10.010.0终极糖终极10.0管理指南开发者工具模块建设者

模块建设者

概述

模块建设者使管理员能够在Sugar中创建,部署和维护自定义模块。模块可以在模块构建器中创建,然后部署在糖的实例中,或导出其他开发和部署到其他糖的其他实例。这方便测试新模块并用于将模块分发到许多不同的实例。请注意,只有管理员或开发人员访问的用户只能通过管理员创建和管理自定义模块>模块建设者。本文档将介绍如何使用模块构建器以及模块构建器中提供的各种操作和选项。

导航

Sugar的Modul Builder分为三个主要部分,包括主面板,封装面板和页脚。您可以通过主面板和包装面板轻松创建,访问和管理自定义模块。模块构建器的页脚允许您通过单击页面底部的相应按钮访问开发人员工具部分的不同区域(例如Study,Dropdown Editor)。

主板

模块构建器中的主面板是您可以在其中创建新的软件包,访问现有包,部署包等,在包中创建和配置包中的模块,各个部分(例如布局,字段等)。 )您可以访问主面板上的选项卡。通过单击选项卡中的“x”,可以关闭打开的其他选项卡。
main_panel_tabs.
主面板还显示面包屑栏,显示您当前的模块构建器中的位置。您可以通过单击面包屑栏中的链接导航到特定部分。
main_panel_breadcrumb.
要返回您正在查看的上一页,请单击面包屑栏上的左箭头。单击主页图标将导航回Developer Tools主页。

包装面板

包面板位于主面板的左侧,并显示通过模块构建器可访问的现有包和关联的自定义模块列表。自定义模块将在包中分组,当您展开模块的树时,会显示对每个模块的特定于每个模块的字段,布局,子单位等。
packages_panel_expand.
在“包”面板中选择一个项目,将其加载到主面板中。请注意,我没有看到包装面板,它可能会崩溃。只需将灰杆定位到主面板左侧,然后单击右箭头以展开“包”面板。
包_Panel_Show.

页脚

页脚位于模块构建器的左下方,并显示按钮,使您能够导航到开发人员工具的不同区域(Studio,Dropdown Editor等)。
页脚_actions.
页脚中的选项允许您导航到以下位置:

菜单项 描述
首页 导航到开发人员工具的主页
工作室 导航到工作室的主页
模块建设者 打开模块构建器以创建和管理自定义模块
糖门户编辑器 打开Sugar Portal编辑器以配置门户
下拉编辑器 打开下拉编辑器以创建和编辑下拉列表

模块构建器中的包允许您创建和容纳多种不同类型的多个模块。请注意,必须首先创建一个包,以便通过模块构建器创建自定义模块。虽然包可以将类似或依赖模块组合在一起以确保它们部署在一起,但通常建议为每个模块创建单独的包。这有助于防止潜在的问题在路上,如果您需要卸载模块,并且它是较大包的一部分,那么必须卸载该包中的所有模块。将孤立的模块保留在其自身包中,如果不再需要模块,将来会更大的灵活性。

创建包

使用以下步骤通过模块构建器创建新包:

  1. 导航到Modul Builder的主面板,然后单击“新包”。
    new_package.
  2. 输入以下字段的适当值:
    • 包裹名字 :包的名称或名称。包名称是“在安装包时”包“面板和”模块加载程序“中的显示。
    • 作者 :创建包的作者。安装包时,作者在模块加载器中显示。
    • 钥匙 :密钥是字母数字文本,以区分具有类似名称的模块。系统将使用此键前缀所有类名称,目录和表名。
    • 描述 :关于包的描述或其他信息。
    • 自述 :单击“Readme”以显示一个打开的文本框,您可以在其中输入有关包中包含的包或模块的其他信息。
    • 笔记:所有必填字段都标有红色星号,必须在保存之前完成。
  3. 输入必要信息后,单击“保存”。
    create_new_package_details.

部署包

创建并保存包后,您可以通过单击新模块图标来创建自定义模块。请注意,包必须包含至少一个模块,以便正确发布和部署包,以及导出自定义。查看允许您执行各种操作时,有各种选项(例如部署,发布,导出等)可用。
deploy_packages_options.
包选项允许您执行以下操作:

行动 描述
保存 单击“保存”以保留对包裹详细信息(包名称,作者等)所做的任何更改。
部署 将包安装到当前实例中。包中的任何模块都将在当前实例中创建或更新。
笔记:不要重新部署从模块构建器部署的包作为任何工作流,代码级别自定义或通过工作室进行的更改为自定义模块,将丢失。建议在成功部署后从模块构建器中删除模块包,以避免意外重新部署。部署后请使用Studio将任何其他配置执行到模块。
发布

将包保存到包含所有自定义的可安装zip文件中。通过模块加载器上传文件以将包安装到其他实例中。

笔记:在糖最终开发的包装只能安装在运行相同版本的糖最终版本的实例上。

出口

将包保存到包含所有自定义的可进一步的zip文件中。通过模块加载器上传文件,以在不同的实例上查看模块构建器中的包,然后可以进一步开发和部署它。

笔记:在糖最终开发的包装只能安装在运行相同版本的糖最终版本的实例上。

删除包裹

如果包无效或不再出现在组织的Sugar实例中,则可能会从模块构建器中删除它。请注意,删除包将删除包中包含的所有文件,但不会从部署包的任何实例中删除包。有关如何从实例卸载已部署包的更多信息,请参阅 模块加载器 管理指南中的文档。

笔记:我们建议从模块构建器中删除软件包,然后在生产实例中部署以防止它意外重新部署。此规则唯一的例外在开发环境中,您可能希望继续工作和测试,直到您已准备好将模块移动到生产环境。

使用以下步骤通过模块构建器删除包:

  1. 从“包”面板或主面板中选择所需的包。
    deleting_packages
  2. 单击“删除”以删除包。
    package_actions_delete.
  3. 弹出消息将显示要确认。单击“确定”继续。

模块

可以在模块构建器中的包中创建和配置各种类型的模块。虽然可以在包中创建多个自定义模块,但通常建议每个包创建一个模块。这将有助于防止潜在的问题,如果不再需要模块,将来会在将来更大的灵活性。

笔记:Custom Modules不可用活动流。

模块类型

模块建设者附带了一些预定义的模块模板,用于创建模块。选择最适合您组织使用新模块的模块类型,然后自定义模块以进一步满足您的需求。
默认情况下,默认情况下可以使用以下模块类型:

类型 描述
基本的 vensic模块只有默认定义的最基本的字段。所有其他模块类型在基本模块类型的顶部构建。
公司 包含为公司,帐户或组织类型记录设计的字段。包括结算和送货地址,电子邮件地址,电话号码,行业,网站等。
文件 包含为文件上传或文档记录设计的字段。包括类别,到期日期,状态,文件名等。
问题 包含用于错误,问题或案例记录类型的字段。包括发行号码,状态,优先级,工作日志等。
包含为人员,联系人或领导记录设计的字段。包括名字和姓氏,主要和备用地址,电子邮件地址,电话号码等。
销售 包含用于销售,交易或机会的字段。包括,金额,货币,概率,销售阶段等。

模块选项

在模块构建器中创建模块时,将在设置时可用以下选项完成:

  • 模块名称 :模块的名称(例如帮助台)或指定。模块名称是Packages面板中的显示以及部署后的Studio中显示。
  • 复数标签 :模块名称的复数标签(例如帮助台)。标签是在糖中使用模块时的显示。
  • 奇异标签 :模块名称的奇异标签(例如帮助台)。标签是在糖中使用模块时的显示。
  • 输入 :选择此选项以启用模块的导入。
  • 团队安全 :选择此选项以启用模块的团队安全性。如果未选中此选项,则不会将此模块中的记录分配给团队,并将仅受角色限制。有关团队和角色的更多信息,请参阅 团队管理角色管理 管理指南中的文档。
  • 导航选项卡 :选择此选项可将模块和模块操作添加到导航栏。
  • 类型 :在构建模块时,选择要用作模板的模块类型。每个模块类型都包含默认情况下的库存字段列表,如有必要,可以在布局中添加和删除。请注意,只有在最初创建模块时才能选择模块类型。有关模块类型的更多信息,请参阅 模块类型 本页的一部分。

创建模块

虽然您可以选择在包中创建多种类型的模块,但通常建议每个包创建一个模块。这样做会有助于防止道路上的潜在问题,并在未来允许更大的灵活性,如果不再需要模块。

通过包创建模块

模块创建最常用的方法之一是通过包中的新模块选项。选择新模块图标时,它会打开新的模块屏幕,允许您在模块的详细信息中输入(例如,名称,标签等),以及选择要用作模板的模块类型。
使用以下步骤在包中创建自定义模块:

  1. 从“包”面板中选择一个包以创建一个新模块。
    create_module.
  2. 在主面板中选择“新模块”。
    create_module_new_module.
  3. 输入适当的值 模块选项。所有必填字段都标有红色星号,必须在保存之前完成。
  4. 在配置模块时,选择要用作模板的模块类型(例如文件)。
  5. 输入必要信息后,单击“保存”。
    create_module_new_module_save.

通过复制创建模块

您还可以通过在包中重复现有模块来创建新模块。如果您正在创建的模块具有与现有模块的模块具有类似的信息或结构,则重复选项非常有用。
通过重复现有模块,使用以下步骤创建模块:

  1. 从“包”面板中选择一个包以创建一个新模块。
    create_module.
  2. 在主面板中,选择要复制的模块。
    create_module_select_module.
  3. 单击“重复”以创建模块的副本。
    create_module_duplicate.
  4. 所选模块将复制到新模块,其中包含在模块名称的末尾附加的“1”。更新必要的字段,然后单击“保存”。
    create_module_duplate_save.

修改模块

可以在每个包中修改每个模块的相关字段,标签,布局,子壳等。单击模块名称前面的加号(+)以展开模块并查看关联的项目(例如布局,字段等)。从“包”面板中选择“模块”面板将将视图加载到主面板中。你可以修改 模块选项 通过此页面的选定模块。
packages_panel_expand.

修改标签

在糖中使用标签,用于按钮,现场标题,子主题,错误消息等项目。要修改模块的标签,请从“所需模块”下的“包”面板中选择“标签”。
packages_panel_labels.
标签选项卡将在主面板中打开,您可以在其中更改与模块关联的特定标签的名称。请注意,您还可以在更改标签时定义当前安装在糖中的语言包的主要语言。从下拉列表中选择所需的语言以查看和修改该语言的标签。
modify_labels_language.
修改所选语言的标签,然后单击“保存”以保留更改。
modify_labels_save.

领域

Modul Builder中的字段部分允许管理员创建新字段以及模块中现有字段的更改属性。要访问“模块构建器”中的“字段”部分,请从“所需模块”下的“字段”中选择“字段”,视图将在右侧的主面板中打开。
packages_panel_fields.

现场类型

每个模块的字段部分包含许多储存字段,其中包含糖的盒子。请注意,每个数据类型都有各种选项和可用于配置的属性。

可以将以下数据类型添加到模块构建器中的模块中:

数据类型 描述
地址 为街道,城市,邮政编码,州和国家创建字段。
笔记:自定义地址字段不能像库存地址字段一样分组。
复选框 使用yes / no操作创建数据字段的复选框。
货币 创建一个字段以输入货币值。如果该模块中尚不存在,系统会自动创建货币类型的下拉列表。
日期 创建一个字段以输入日期。包含日历弹出窗口的按钮。
约会时间 创建一个字段以输入日期和时间。包括日历弹出窗口的按钮以及时间下降。
十进制 创建一个字段,以将一个数字舍入为指定的小数精度。糖存储数据库中的数量的确切表示(例如,为2:1.236的精度存储为1.24)。
落下 创建一个字段,您可以与下拉列表相关联。
加密 为敏感信息创建一个字段,例如社会安全号码,其值将在糖数据库中加密。该值在数据库中加密,但在用户界面中可见到用户。
漂浮 创建一个字段,以将一个数字舍入为指定的小数精度。 Sugar基于数据库平台糖在运行的数据库平台糖的不同方式存储值。
HTML. 创建静态HTML格式的文本以在记录视图中显示。
iframe. 创建一个字段以存储或生成一个URL以在记录视图中显示iframe。
图像 创建一个图像字段以上传要在记录上显示的图像。
整数 创建一个字段以指定没有小数位的正数或负数。
多选 创建一个数据下拉列表,其中可以一次选择多个值。
Flex相关 创建一个下拉列表,您可以从中输入从各种模块中的单个记录。每个模块只允许一个Flex相关字段。如果模块已有Flex相关字段,则此选项不会在数据类型下拉列表中显示。
电话 创建一个字段以输入电话号码。
收音机 为用户创建单选按钮以从下拉列表中选择一个值。
涉及 创建一个字段,以将记录与另一个模块的记录相关联作为单向关系。您可以将多个相关字段添加到模块中。
笔记:相关领域和自定义关系彼此独立。对任何一个的变化都没有反映在另一个。可以将相关字段添加到报告中,但在报告中无法访问相关记录上的任何数据。要在报告中访问相关的记录数据,您需要创建自定义关系。
textarea. 为多行文本创建一个打开的文本区域字段。
文本域 为单行文本创建一个字段。
URL. 创建一个字段以存储或生成URL并显示为链接。
现场选项

字段提供了在糖中存储不同数据类型的方法。虽然许多字段默认出现框外,但默认情况下,可以有实例化组织需要存储其他数据的情况。

通过模块构建器创建或修改字段时,所有字段类型都存在一些属性,并且有些属于少数类型的唯一属性。

Sugar提供以下字段属性和选项:

  • 审计 :选中此复选框以审核糖类更改的字段。
    • 用户可以通过模块记录视图中的View更改日志选项查看对审计字段所做的更改(对于Sidecar模块)。
    • 笔记:审计选项可用于所有数据类型字段。
  • 提升价值 :输入字段的增强值,以增强字段的相关性以获取完整文本搜索。 
    • 默认增强值为1.0,表示中性提升。要应用正升压,请将升压值设置为高于1以申请负升压,使用低于1的值。例如,值为1.35将呈现135%的字段。但是使用0.60的值将应用负面提升。
    • 笔记:当为字段更改升压值时,不必执行完整的系统索引。
  • 边界 :选中此复选框以在此字段周围添加边框。
    • 笔记:边框选项仅适用于图像数据类型字段。
  • 计算价值 :选择此复选框以将此字段指定为计算字段。
    • 这会打开“公式”选项,并禁用默认值和可进度选项。有关输入计算值的公式的更多信息,请参阅本节中列出的公式选项。
    fields_calculated
    • 公式的结果将被输入到现场以进行任何新的或修改的记录。选择此选项时,用户无法修改字段值。
    • 笔记:计算值选项仅适用于以下数据类型字段:
      复选框 货币
      日期 约会时间
      十进制 加密
      漂浮 整数
      电话 textarea.
      文本域  
  • :输入列数以指定TextArea数据类型字段的宽度。
    • 笔记:列选项仅适用于TextArea数据类型字段。
  • 评论文本 :输入有关该字段的评论或描述。评论文本仅通过模块构建器和Studio查看。
    • 笔记:“注释文本”选项可用于除Flex相关之外的所有数据类型字段。
  • 默认值 :在创建记录时指定或选择此字段的默认值。默认情况下,记录的默认值填充记录视图布局,但可以由用户修改。
    • 笔记:默认值选项可用于HTML,图像,Flex相关和相关的所有数据类型字段。
  • 依赖 :选择此选项可将此字段指定为依赖于公式或父数据下降。
    • 对于下拉数据类型字段,您可以为依赖项选择“父数据下拉”或“公式”。
    fields_dd_dependent.
    • 选择“父数据下降”将打开父数据放样选项,如下所示。选择“公式”将打开可见的IF选项以创建依赖性公式。有关其他字段数据类型(例如日期),请选择“从属复选框”以打开可见可见的选项。有关输入公式的更多信息要使依赖字段可见,请参阅本节中列出的选项。
      fields_dependent.
    • 笔记:除了地址之外的所有数据类型字段都可以使用依赖选项。
  • 禁用格式 :选择此复选框以禁用数千名分隔符等数字格式。
    • 笔记:禁用格式选项仅适用于整数数据类型字段。
  • 显示标签 :输入值以显示为字段标签和布局中的标题。通常默认为创建字段时输入的字段名称。
    • 该值也在包装面板下可修改 标签.
    • 笔记:除Flex相关之外的所有数据类型字段都可以使用“显示标签”选项。 Flex相关使用标签值选项。
  • 下拉列表 :选择要关联的值列表。
    fields_dropdown_list.
    • 只有所选列表中的值将可用于在该字段中选择。单击“编辑”以更改当前所选列表的值,或单击“添加”以创建新列表。
    • 笔记:下拉列表选项仅适用于下拉,多元化和无线数据类型字段。有关通过下拉编辑器编辑下拉值值的更多信息,请参阅 编辑下拉列表 开发人员工具文档的一部分。
  • 重复合并 :选择以下选项之一以确定当录制合并时的字段的功能:
    • 禁用 :默认选择。该字段不会出现在合并重复功能中,并且无法用于查找重复功能中的过滤条件。
    • 启用 :该字段将出现在合并重复功能中,但不可用于查找重复功能中的过滤条件。
    • 在过滤器 :该字段将出现在合并重复功能中,也将在“查找重复”功能中提供。
    • 默认选择过滤器 :默认情况下,该字段将用于默认情况下的“查找重复”页面中的筛选条件,并且还将显示在合并重复功能中。
    • 仅限滤波器 :该字段不会出现在合并重复功能中,但将在“查找重复”功能中提供。
    • 笔记:重复的合并选项可用于除映像之外的所有数据类型字段。
  • 字段名称 :输入正在创建的字段的名称。创建一个字段后,将无法更改字段名称。
    • 字段名称只能包含字母数字字符以及下划线字符。
    • 笔记:所有数据类型字段都需要字段名称选项。
  • 全文可搜索 :指定字段是否应影响全局搜索结果。
    • 禁用 :如果在数据库被索引以进行搜索时,请选择“已禁用”字段。搜索指数通过全局搜索收集可搜索字段的值以进行评估。
    • 可搜索 :选择“可搜索”以在搜索索引中包含此字段的值。
      • 选择“可搜索”将显示“升压值”字段,允许您为搜索设置相关权重。
        当用户的搜索查询与具有更高升压级别的字段的值匹配时,搜索结果中的记录将显示出更高。有关完整文本搜索中提升值的更多信息,请参阅 搜索 应用指南中的文档。
      • 笔记:完整文本可搜索选项仅适用于以下数据类型字段:
        电话 textarea.
        文本域 URL.
  • 公式 :包含返回计算值的当前公式。
    • 单击“编辑公式”以启动公式构建器并更改公式。有关如何使用公式构建器构建公式的更多信息,请参阅 使用糖逻辑 本页的一部分。
    fields_calculd_formula.
    • 笔记:公式选项仅在选择计算值选项时可用。
  • 生成URL. :选中此复选框以允许从当前模块中的变量放入默认值选项以创建动态URL。
    fields_generate_url.
    • 这对于为ERP或外部系统(如Google Maps等外部系统提供链接或IFRame是有用的。
    • 选择所需的字段以从下拉列表添加,然后单击“插入字段”以将字段添加到默认值。选择此选项时,用户无法修改字段值。
    • 笔记:生成的URL选项仅适用于iframe和URL数据类型字段。
  • 高度 :输入以垂直缩放此字段的像素数。仅输入宽度或高度选项以保留图像的宽高比。
    • 笔记:高度选项仅适用于图像数据类型字段。
  • 帮助文本 :输入填充此字段的基本说明。当用户在记录视图中将鼠标悬停在字段上时,将显示此处的文本。
    • 笔记:帮助文本选项可用于所有数据类型字段。
  • HTML. :在静态丰富的文本中输入具有格式或HTML代码以在记录上显示。有关如何使用文本编辑器的更多信息,请参阅 Tinymce. 应用指南中的用户界面文档的部分。
    fields_html.
    • 笔记:HTML选项仅适用于HTML数据类型字段。
  • iframe height. :输入iframe字段的高度的像素数。 iframe字段的宽度始终是字段容器的宽度。
    • 笔记:iframe高度选项仅适用于iframe数据类型字段。
  • 可进展 :选择以下选项之一,以确定导入记录时的字段的功能:
    • 是的 :该字段可以包含在导入操作中。
    • :该字段不能包含在导入中。
    • 必需的 :必须在任何导入中提供该字段的值。
  • 标签值 :输入值以显示为字段标签和布局中的标题。该值也在包装面板下可修改 标签。默认为“Flex相关”。
    • 笔记:标签值选项仅适用于Flex相关数据类型字段。
  • 大众更新 :选中此复选框以将此字段添加为批量更新的选项。
    • 笔记:Match Update选项仅适用于以下数据类型字段:
      日期 约会时间
      落下 多选
      收音机  
  • 最大尺寸 :输入此字段允许的最大字符量。默认为255。
    • 笔记:最大大小选项仅适用于以下数据类型字段:
      地址 十进制
      漂浮 iframe.
      整数 电话
      URL. 文本域
  • 最大值 :输入此字段允许的最高值。如果用户在字段中输入比指定值更高的值,则保存通知它们设置最大值时将出现通知。
    • 笔记:最大值选项仅适用于整数数据类型字段。
  • 最小值: 输入此字段允许的最低值。如果用户在低于指定值的字段中输入值,则保存将它们通知设置最小值时会出现通知。
    • 笔记:MIN值选项仅适用于整数数据类型字段。
  • 模块 :从下拉列表中选择模块以与当前模块相关联。
    • 模块可以返回自身,一个很好的例子是触点上的相关领域,以返回由字段所引用的触点。这将允许用户选择哪个联系人引用不同的联系人。一旦创建字段,就无法修改所选模块。
    领域_Module.
    • 笔记:模块选项仅适用于相关数据类型字段。
  • 打开链接 :选择以下选项之一以确定URL如何打开:
    • 新窗户 :根据您的浏览器和设置打开新选项卡或窗口中的URL。
    • 同一个窗口 :在与您当前浏览的记录相同的窗口中打开URL。
    • 笔记:选项中的打开链接仅适用于URL数据类型字段。
  • 父级下拉 :从下拉列表中选择一个选项,以指定控制此下拉字段的可见性的父级。
    • 父数据流选项将填充当前模块中的其他下拉数据类型字段。
    fields_parent_dropdown.
    • 笔记:父Dropdown选项仅在所选依赖选项“父数据下拉”时可用。
    • 单击“编辑可见性”以指定父数据下拉列表的每个值的当前下拉列表中提供的选项。在“可见性编辑器”窗口中,将当前下拉列表中的值拖动到父数据下拉列表的值部分。
      fields_parent_dropdown_visibility_1.
    • 当父下拉列表设置为指定值时,这将确定下拉列表中的哪些选项可用。在此示例中,如果父下拉列表设置为“服装”,则当前下拉将具有选项1,2和3,其中如果父下拉列表设置为“银行”,则当前下拉只会有选项2和3个可用。如果父数据下拉值值没有可用选项,则不会显示依赖下拉目。要从列表中删除项目,只需单击并将值拖动到左侧的垃圾桶。设置值后,单击“保存”以保留更改。
      fields_parent_dropdown_visibility_save.
  • 精确 :输入一个数字,以指定十进制点右侧的数字数量,该值应存储为糖。
    • 笔记:Precision选项仅适用于十进制和浮点数据类型字段。
  • 可报告 :选择此复选框以允许在报告中使用该字段。
    • 笔记:除了加密,Flex相关,HTML,IFRAME和IMAL和IF帧中的所有数据类型字段都提供了可报告选项。
  • 必填项目 :选择此复选框以根据糖中的要求标记字段。在保存记录之前,将需要用户输入字段的值。
    • 笔记:除复选框和HTML之外,所有数据类型字段都可以使用所需的选项。
  • :输入行数以指定TextArea数据类型字段的高度。
    • 笔记:行选项仅适用于TextArea数据类型字段。
  • 系统标签 :输入存储字段标签的系统值。默认为“LBL”之前的字段的名称。保存时,输入的任何小写字符将被转换为大写。创建字段后,无法更改系统标签。
    • 建议管理员避免使用相同的系统标签命名字段,以防止系统中存在的相同标签和标题值。
    • 笔记:系统标签选项可用于所有数据类型字段。
  • 可见if. :包含当前公式,以确定是否在布局上可见字段。
    • 单击“编辑公式”以启动公式构建器以更改公式。
    fields_visible_if.
    • 公式必须导致布尔(真/假)响应。有关如何使用公式构建器构建公式的更多信息,请参阅 使用糖逻辑 本页的一部分。
    • 笔记:可见可见如果选项仅在选中依赖选项或“公式”下拉列表中时可用。
  • 宽度 :输入以水平缩放此字段的像素数。仅输入宽度或高度选项以保留图像的宽高比。
    • 笔记:宽度选项仅适用于图像数据类型字段。
创建字段

使用以下步骤通过模块构建器创建新字段:

  1. 在“包”面板中的所需模块下展开树,然后选择“字段”。
    packages_panel_fields.
  2. 在主面板中,单击“添加字段”。
    fields_add_field.
  3. 输入适当的值 现场选项。请注意,需要字段名称。
  4. 输入必要信息后,单击“保存”。
    fields_add_field_save.
  5. 创建一个字段后,必须放在记录视图布局上,以便用户将数据输入该字段。有关编辑布局的更多信息,请参阅 编辑布局 本页的一部分。
编辑字段

使用以下步骤通过模块构建器编辑现有字段:

  1. 在“包”面板中的所需模块下展开树,然后选择“字段”。
    packages_panel_fields.
  2. 在主面板中,选择要编辑的字段。按列标题排序字段将有助于更快地定位字段。
    • 笔记:通过模块生成器创建的字段将在名称前面显示星号(*)。
    fields_edit_field.
  3. 更新必要的 现场选项 然后单击“保存”一次完成。
    fields_edit_field_save.
删除字段

使用以下步骤通过模块构建器删除现有字段:

  1. 在“包”面板中的所需模块下展开树,然后选择“字段”。
    packages_panel_fields.
  2. 在主面板中,选择要删除的字段。按列标题排序字段将有助于更快地定位字段。
    • 通过模块生成器创建的字段将在其名称前显示一个星号。
    • 笔记:无法删除通过模块类型模板添加的字段。
    fields_edit_field.
  3. 选择“删除”以删除该字段。
    fields_edit_field_delete.
  4. 弹出消息将显示要确认。单击“确定”继续。
    • 在删除字段之前,请验证并解决以下问题:
      1. 必须从任何报告过滤器或显示器中删除字段。
      2. 必须从过滤或显示字段的任何工作流程中删除字段。
      3. 必须从过滤或显示字段的任何dashlet中删除字段。
      4. 字段必须从任何糖逻辑公式中删除。
      5. 必须从任何电子邮件模板中删除字段。
      6. 必须从任何已保存的搜索中删除字段。
  5. 删除时,该字段将自动从任何模块布局中删除。
    • 笔记:删除模块中的字段并重新部署包时,不会删除与数据库中的字段相关的数据。
克隆领域

使用以下步骤通过模块构建器克隆现有字段:

  1. 在“包”面板中的所需模块下展开树,然后选择“字段”。
    packages_panel_fields.
  2. 在主面板中,选择要删除的字段。按列标题排序字段将有助于更快地定位字段。
    • 笔记:通过模块构建器创建的字段将在名称前面显示星号(*)。
    fields_edit_field.
  3. 选择“克隆”以复制该字段。
    • 笔记:一些非标准的股票字段(例如,名称)没有克隆的能力。
    fields_edit_field_clone.
  4. 输入适当的值 现场选项.
  5. 输入必要信息后,单击“保存”。
    fields_clone_save.

关系

关系定义了糖中不同模块之间的链接,并允许这些模块之间的记录相关。相关记录根据关系类型,模块详细信息页面上的字段或子单位中显示。当您在两个模块之间创建新关系时,系统会自动创建必要的子网站,相关字段和元数据关系。关系在报告中提供了添加的益处,以允许除基本模块的字段之外还允许访问相关的记录字段。
Modul Builder中的关系部分允许管理员在自定义和库存模块之间创建新的关系,以及更改现有关系的某些属性。要访问Module Builder中的关系部分,请从所需模块下从包面板中选择“关系”。
packages_panel_relationship.
笔记:通过模块构建器创建的关系在部署后无法在Studio中删除。因此,建议在部署模块而不是Via Modul Builder后在Studio中创建关系。作为最佳实践,切勿将模块从模块构建器重新部署,因为它将通过Studio,代码自定义等删除对模块所做的所有自定义。

关系类型

Sugar包含一些不同类型的关系,您可以在模块之间创建。关系类型将确定将在数据库中创建哪些字段或表以及用户将看到以管理关系的接口。
模块构建器中提供以下关系类型:

  • 一对一 :主模块中的记录和相关模块彼此无关。对于帐户和联系人之间的一对一关系,一个帐户可以只与一个联系人关联,并且联系人可以只与一个帐户关联。该关系将显示为每个模块的记录视图中的字段,其中改变了从任一模块的关系也将改变其他模块中的值。
    • 从主要帐户模块中:
      1to1-联系
    • 来自相关联系人模块:
      1to1账户
      笔记:您可以使用相关字段创建模块之间的一种方式关系。有关相关领域的更多信息,请参阅 现场类型 本页的一部分。
  • 一对多 :主模块中的记录可以与相关模块中的许多记录具有关系。对于帐户和联系人之间的一对多关系,一个帐户可以与许多联系人相关联,但每个联系人都可以仅与一个帐户相关联。主模块的记录视图将为相关模块显示子Panel,相关模块的详细视图将显示包含与相关记录的链接的字段。
    • 从主要帐户模块中:
      M2M-SubPanel.
    • 来自相关联系人模块:
      M2M记录
      笔记:除了主要和相关模块颠倒外,一对多关系与众多关系相同。添加与“活动”的自定义一对多关系将添加定制关系,以便调用,会议,备注,任务和电子邮件。这也将自动将这些子板添加到记录视图中。
  • 多对多 :主模块和相关模块中的记录可以在每个模块中具有多个相关的记录。对于帐户和联系人之间的多对多关系,一个帐户可以与许多联系人相关联,并且联系人可以与许多帐户相关联。两个模块的记录视图都将为相反模块显示一个子板。
    • 从主要帐户模块中:
      M2M潜艇
    • 来自相关联系人模块:
      M2M接触
      笔记:只有带有子板的模块可以在关系的“许多”方面。例如,产品目录模块缺少子蛋白;因此,产品目录只能在关系的“一个”侧面上选择。

当您为模块创建关系时,所选模块被认为是主模块和您将其与之相关的模块是相关模块。
您还可以在模块和本身之间创建关系。在这种情况下,关系成为父子关系。例如,您可以从帐户创建关系到帐户,以便在主帐户中创建子帐户。

创造关系

使用以下步骤通过模块构建器创建新关系:

  1. 在“包装”面板中的所需模块下展开树,然后选择“关系”。
    packages_panel_relationship.
  2. 在主面板中,单击“添加关系”。
    关系_add_relationship.
  3. 输入以下选项的适当值:
    类型 :从选项中选择关系类型以创建 关系类型 部分。
    模块 :主模块设置为您添加关系的模块。从下拉列表中选择相关模块。主要和相关模块可以是相同的,以便创建父子关系。
    标签 :输入标签以引用此关系的主模块或相关模块的子网站。此选项仅适用于关系的“许多”方面。
    来自。的子蛋白 :选择子phanel选项以显示主或相关模块的记录。这将决定子网站中显示的字段。此选项仅适用于关系的“许多”方面。
  4. 输入必要信息后,单击“保存”。
    关系_dd_relationsh_save.
  5. 立即创建并保存在包中所需的字段和子单位。
编辑关系

使用以下步骤通过模块构建器编辑关系:

  1. 在“包装”面板中的所需模块下展开树,然后选择“关系”。
    packages_panel_relationship.
  2. 在主面板中,选择要编辑的关系。单击列标题以按不同的列对网格进行排序,以帮助定位关系。
    关系_select_relationship.
  3. 关系上唯一的可编辑字段是命名主或相关模块子平板的标签字段。请注意,此选项仅适用于关系的“许多”方面。
  4. 输入标签字段的必要信息后,单击“保存”。
    关系_edit_relationsh_save.
删除关系

使用以下步骤通过模块构建器删除关系:

  1. 在“包装”面板中的所需模块下展开树,然后选择“关系”。
    packages_panel_relationship.
  2. 选择要在主面板中删除的关系。单击列标题以按不同的列对网格进行排序,以帮助定位关系。
    关系_select_relationship.
  3. 单击“删除”以删除关系。
    关系_edit_relationship_delete.
  4. 弹出消息将显示要确认。单击“是”继续。
    模块Builder_DeleterElationShip_ConfirmationPopup.  
    笔记:如果要保留当前存在的数据和表结构,请选择“不删除表”选项。离开“请勿删除表”未选中将删除关系数据并在安装包时从数据库中删除关系表。
    在删除关系之前,请验证并解决以下问题:
    • 必须从任何报告过滤器或显示器中删除关系。
    • 必须从任何工作流中删除关系,从而从关系中显示或显示字段。
    • 必须从引用关系的任何糖逻辑公式中删除关系。

布局

布局用于代表糖中的许多屏幕。 Modul Builder中的布局部分允许管理员添加字段并配置布局。要访问“布局”部分,请从所需模块下的“布局”展开“布局”。所选模块的可用布局将显示在下面。
modulebuilder_layouts.

布局类型

糖配有不同类型的布局,以代表不同的糖部分。请注意,每个模块都不提供所有布局。
以下布局可在模块构建器中配置:

  • 记录视图 :记录视图布局用于修改,创建或查看指定模块中的记录。请注意,使用Sidecar用户界面,此布局特定于模块。
  • 列表显示 :列表视图布局用于在指定模块中查看多个记录,并显示满足当前搜索条件的所有结果。
  • 弹出列表视图 :弹出列表视图布局用于通过用于查找和选择指定模块中的记录的弹出窗口来查看多个记录。
    对于Sidecar模块:
    pop_up_listview_newui.
  • 弹出搜索 :弹出窗口搜索布局用于允许用户通过用于在指定模块中选择记录的弹出窗口执行搜索。
    对于Sidecar模块:
    pop_up_search_newui.
布局选项

管理员能够通过模块构建器配置各种布局(例如记录视图,列表视图等)。请注意,可以通过管理员配置布局>一旦部署了模块,工作室也是如此。有关配置布局的详细信息,请参阅 工作室 documentation.

以下是管理员通过模块构建器配置布局时提供的部分选项:

  • 面板 :布局上的每个字段都包含在面板内。默认情况下可以打开或折叠面板,并具有定义面板的标题。可以组织面板以包含相似或相关领域的组,以协助组织。
    选择面板标题旁边的铅笔图标以修改标题。选择折叠?复选框默认面板折叠。用户可以根据愿望打开和关闭面板。
    layout_panel_options.
    笔记:无法在模块构建器中修改默认面板名称。
  • 查看历史 :Sugar保留对每个布局所做的更改的历史。单击“查看历史记录”,历史记录对话框将显示发生更改时的时间戳并允许您预览布局,然后如果您愿意,请恢复。有关查看布局历史的更多信息,请参阅 查看布局历史记录 本页的一部分。
  • 恢复默认值 :Sugar提供了将布局恢复到原始默认配置的选项。有关如何还原默认布局的详细信息,请参阅 恢复布局默认值 本页的一部分。
编辑布局

您可以通过在要编辑的Packages Panel下选择特定布局来添加,删除,隐藏等模块中可用布局的字段。请注意,列表视图和弹出窗口视图布局有列可以指定用户可以且无法看到的字段。

部署模块后,可以在Studio中配置记录视图以不同地显示 基于观看用户的角色.

编辑记录视图布局

以下步骤介绍编辑记录视图布局:

  1. 从所需模块下的“布局”展开“布局”,然后选择要编辑的布局(例如记录视图)。记录视图布局将在右侧的主面板中显示。
    modulebuilder_layouts.
  2. 要将字段添加到“记录视图布局”,将字段从工具箱中的字段列表拖动到“(Filler)”位置按您的首选项的布局上的位置。
    • 您还可以将字段拖到已经具有字段的布局上的位置。新添加的字段和布局上的现有字段将交换位置。
    add_field_edit_layout.
  3. 要从布局中删除字段,将字段从布局拖放到工具箱中的垃圾箱,以从布局中删除字段。您可以使用相同的方法删除布局中的整个行。
    delete_field_from_layout.
  4. 要展开或最小化布局中的字段列,请单击加号图标(+)以在两列上拉伸字段,或单击“减号”( - )将字段放入一列。
    • 笔记:如果该位置没有字段,则布局将显示“(填充)”。
    plus_minus_icon_editlayout.
  5. 要添加一个新行,请将工具箱中的“新行”项拖动到布局以允许添加其他字段或空格。
    add_row_edit_layout.
  6. 要添加新面板,请将工具箱中的“新面板”项拖动到布局,以在记录视图布局中一起将不同的字段组组合在一起。
    add_panel_edit_layout.
  7. 完成布局后,单击“保存”以保留更改。
    editlayout_save.

笔记:建议将依赖的字段放在独立字段下方和/或右侧,以便在布局上保留正确的字段显示。

编辑列表视图布局

与记录视图布局不同,列表视图布局有列,您可以在其中指定用户可以且无法看到的字段。配置列表视图布局时,您将看到三列(默认,可用,隐藏),其中可以拖动字段并删除。

请注意,编辑列表视图布局会影响模块列表视图Dashlet的可用字段列表,因为两者都由相同的布局控制(列表视图)。部署自定义模块后,模块构建器中的列表视图布局所做的配置将反映在相应模块Dashlet的配置选项页面的“列”字段中。部署自定义模块后,可以通过所有成功的更改列表视图布局进行 工作室。请记住,自定义模块Dashlet不会自动反映工作室更改,用户必须编辑Dashlet才能查看更改,为布局添加新字段等。

在配置列表视图布局时,管理员可以轻松设置特定字段的列宽度。您可以从预定义的宽度尺寸列表(例如,小,中,大等)中进行选择,该列表可在盒子外提供,或者在Sidecar模块中输入像素(例如200)的自定义宽度值。

笔记:定义货币字段的列宽时(例如,最佳等),只应用“大”及更高版本,因为该字段类型的糖有最小的宽度要求。此外,在为货币字段定义自定义宽度时,该值必须为141px或更广泛。

下表列出了糖中的可用列宽度尺寸以及以像素为单位的相应宽度:工作室_TableColumnWidths_Chart.

  • 默认 :此列包含布局中显示的字段。
  • 可用的 :可用字段是在布局中默认情况下不会显示的字段,但如果布局可以是个性化的,则用户可以将这些字段添加到他们的“布局”视图中。并非所有列表类型布局都有可用的字段部分。
  • :此列包含将在布局中显示的字段。

以下步骤介绍了列表视图布局作为示例:

  1. 在所需模块下的“包装”面板中展开“布局”,然后选择“列表视图”。
  2. 要将字段添加到列表视图布局,请从隐藏列拖放到默认列的字段。
    • 笔记:默认列中的字段将可用以在相应的自定义模块Dashlet(例如我的帮助台)中添加为显示列。
    add_field_defaultcolumn_listview2.
  3. 要从布局中删除字段,请从默认列拖放到隐藏列的字段。
  4. 要更改列表视图上显示的字段的左右顺序,请在默认列表中向上或向下拖放字段。
    • 笔记:为列表视图布局指定的字段顺序也会影响相应的自定义模块Dashlet(例如我的帮助台)中的可用字段列表的顺序。
  5. 要修改字段的标签,以及字段的宽度,请单击每个字段旁边的铅笔图标.
  6. 输入新标签或选择宽度(例如,小,媒体,大等),然后单击“保存”。请注意,修改后的标签将显示此模块的所有列表视图布局。
    • 笔记:管理员可以从预定义的宽度大小列表中进行选择(例如,默认,小,中等等)。请注意,选择默认宽度会将列表视图列设置为等于中宽大小。从列表中选择“自定义”将允许您在打开框中输入自定义宽度值。自定义宽度值应输入字段的像素(例如200)。
    listview_layout_labelwidth1.
  7. 完成布局后,单击“保存”以保留更改。
    listview_layout_edit_save2.

移动布局

管理员还可以通过从封装面板扩展所需模块的“移动布局”来配置糖移动的移动布局。可用移动布局列表将在下面显示,您可以选择要配置的特定布局(例如移动编辑,移动列表视图等)。
packagespanel_mobilelayouts.
移动布局类型

糖中有各种移动布局来代表糖移动应用的不同区域。请注意,每个模块都没有使用所有布局,并且不同的移动应用程序将使用此处定义的信息不同。

糖类提供以下移动布局:

  • 编辑视图 :编辑视图布局用于SOUL以修改或创建指定模块中的记录。
  • 详细视图 :详细视图用于糖以查看指定模块中的记录的当前数据。某些字段被翻译为糖移动为按钮而不是数据。例如,代替看到电话号码,有一个电话图标可以在记录上调用数字。
  • 列表显示 :列表视图布局用于糖,以在指定模块中查看多个记录。只有列表视图部分中的前两个字段将显示在Sugar Mobile中。
移动布局选项

管理员能够配置通过模块构建器可用的各种布局。请注意,可以通过管理员配置移动布局>一旦部署了模块,工作室也是如此。有关配置布局的详细信息,请参阅 工作室 documentation.

以下是通过模块构建器配置移动布局时的一些可用选项:

  • 查看历史 :Sugar保留对每个布局所做的更改的历史。单击“查看历史记录”,历史记录对话框将显示发生更改时的时间戳并允许您预览布局,然后如果您愿意,请恢复。有关查看布局历史的更多信息,请参阅 查看布局历史记录 本页的一部分。
  • 恢复默认值 :Sugar提供了将布局恢复到原始默认配置的选项。有关如何还原默认布局的详细信息,请参阅 恢复布局默认值 本页的一部分。
编辑移动布局

您可以通过在要编辑的Packages面板下选择特定布局来添加,删除,隐藏等,以“移动布局”中的可用布局。请注意,移动编辑查看和DetailView布局以类似的方式修改。移动ListView布局有列,您可以在其中指定字段用户且无法看到的字段。

以下步骤介绍了编辑移动编辑查看布局:

  1. 在所需模块下的“移动布局”面板中展开“移动布局”,然后选择“Mobile EditView”。所选布局将在主面板上显示右侧。
    packagespanel_mobilelayouts.
  2. 要将字段添加到Mobile EditView布局,请从工具箱中的字段列表中拖动字段,以根据您的喜好的布局上的“(填充)”位置。
    • 您还可以将字段拖到已经具有字段的布局上的位置。新添加的字段和布局上的现有字段将交换位置。
    add_field_mobileditview1.
  3. 要从布局中删除字段,将字段从布局拖放到工具箱中的垃圾箱,以从布局中删除字段。您可以使用相同的方法删除布局中的整个行。
    remove_field_mobile_editview1.
  4. 要添加一个新行,请将工具箱中的“新行”项拖动到布局以允许添加其他字段或空格。
    new_row_mobile_editview1.
  5. 完成布局后,单击“保存”以保留更改。
    mobile_editview_layout_saved1.

与移动编辑浏览布局不同,移动ListView布局有列您是否可以指定用户可以且无法看到的字段。配置移动ListView布局时,您将看到三列(默认,可用,隐藏),其中可以拖动字段并删除。

  • 默认 :此列包含列表视图上显示的字段。
  • 可用的 :可用字段是在布局中默认情况下不会显示的字段,但如果布局可以是个性化的,则用户可以将这些字段添加到他们的“布局”视图中。并非所有列表类型布局都有可用的字段部分。
  • :此列包含将在列表视图上显示的字段。

以下步骤介绍了移动ListView布局作为示例:

  1. 在所需模块下的“包装”面板中展开“布局”,然后选择“Mobile ListView”。
  2. 要将字段添加到Mobile ListView布局,请将字段从隐藏列拖放到默认列。
    mobile_listview_layout_edit1.
  3. 单击铅笔图标以修改字段的标签以及宽度百分比,字段将在列表视图中占用。请注意,修改后的标签将在Sugar Mobile中的所有列表视图布局中显示。
  4. 完成布局后,单击“保存”以保留更改。

可用子板

糖中的模块之间的相关记录通常在子平板中显示。类似于列表类型布局,管理员可以修改可用的子PALPEL布局以更改模块的子网站中显示的字段。您可以根据要显示给用户的信息,为这些子单位添加或删除字段。要访问“模块构建器”中的“子单位”部分,请从所需模块下的“可用子板”展开“可用子板”。所选模块的可用子链块将显示在屏幕的右侧。
packages_panel_available_subpanels.

子蛋白选项

在“模块构建器”中配置子网格布局时,有一些可用选项允许您查看历史布局更改,以及还原默认布局。请注意,可以通过admin配置SubPanel布局>一旦部署了模块,工作室也是如此。有关配置布局的详细信息,请参阅 子单板 工作室文档的一部分。

  • 查看历史 :糖会保留对每个子蛋白的变化的历史。这些更改和发生后可以通过“查看历史”来查看和恢复。有关查看子板历史的更多信息,请参阅 查看布局历史记录 本页的一部分。
  • 恢复默认值 :Sugar还包含将子网站恢复到其原始默认配置的能力。有关如何重置子网站默认的更多信息,请参阅 恢复布局默认值 本页的一部分。

modules_panel_subpanels.

编辑子素布局

使用以下步骤通过模块构建器修改子网格:

  1. 从“所需模块”下的“可用子单位”展开“可用子板”,然后选择要编辑的子板。选定的子网站布局将显示在主面板的右侧。
    packages_panel_available_subpanels.
  2. 要将字段添加到子网格布局,请从隐藏的列拖放到默认列的字段。
    • 您可以向上和向下拖动字段,以更改子板中字段的位置。
    mb_subpanels_edit_addfield2.
  3. 要删除字段,请从默认列拖放到隐藏列的字段。
    mb_subpanels_edit_removefield2.
  4. 单击铅笔图标以更改子板中字段的列宽度。
    • 笔记:管理员可以从预定义的宽度大小列表中进行选择(例如,默认,小,中等等)。请注意,选择默认宽度会将列表视图列设置为等于中宽大小。从列表中选择“自定义”将允许您在打开框中输入自定义宽度值。自定义宽度值应输入字段的像素(例如200)。
    • 当定义货币字段的列宽时(例如,可能,最佳等),仅适用“大”及更高版本,因为该字段类型的糖中有最小宽度要求。此外,在为货币字段定义自定义宽度时,该值必须为141px或更广泛。
    mb_subpanels_edit_fieldwidth.
  5. 最终确定子板布局后,单击“保存”以保留更改。
    mb_subpanels_edit_save1.

使用糖逻辑

糖逻辑允许管理员编写简单的公式和逻辑检查,以便为字段提供计算或设置字段的可见性。公式指定一个或多个字段值以及具有数学或逻辑的运算符和函数。执行公式时,Sugar执行计算以导出该值。当在公式中使用字段时,糖重新计算值,只要用户更新它并保存记录时都会重新计算值并保存记录。同样,如果更新公式,Sugar基于更新的公式重新计算字段值。有关糖逻辑功能的完整列表以及如何使用它们,请参阅 工作室 documentation.

有关支持使用糖逻辑的字段类型的更多信息,请参阅 现场选项 本页的一部分。

查看布局历史记录

布局,子板和移动布局保留对每个布局所做的最后十个变化的历史。要查看任何这些布局的历史记录,只需在模块构建器中的布局编辑器视图上单击“查看历史记录”。
查看_History_Button1.
“历史记录”对话框将打开显示发生更改时的时间戳并允许您通过单击“预览”按钮预览布局。
时间戳_preview_historybox.
预览将显示截至保存的特定时间的布局的详细信息。要将布局恢复为您正在查看的特定版本,只需单击“预览”选项卡或“历史”对话框中的“还原”按钮。恢复的布局将加载到布局编辑器中,允许您根据需要进行任何其他更改。单击“保存”以保留更改。
restore_button_historydialog.

恢复布局默认值

许多布局,子单位和移动布局可以恢复到其原始默认配置。要恢复任何这些布局的默认值,只需在模块构建器中的“编辑布局”屏幕中选择“恢复默认值”。
恢复默认

默认布局将加载到编辑器中,允许您根据需要进行更改。单击“保存”以保留更改。

删除模块

如果模块无效或不再出现在包中,则可能会从模块构建器中删除它。请注意,从程序包中删除模块不会从部署包的任何实例中删除模块。有关如何从实例卸载已部署包的更多信息,请参阅 模块加载器 文档。
使用以下步骤通过模块构建器从包中删除模块:

  1. 从封装面板或主面板中选择所需的包和模块。
    delete_modules_select.
  2. 单击“删除”以删除模块。
    deleting_modules_delete.
  3. 弹出消息将显示要确认。单击“确定”继续。

最后修改:2020-03-10 03:28:28