如何配置WebEA模型

所有WebEA配置都由单个文件控制，该文件必须位于'\ includes \'文件夹中，并且必须具有名称'webea_config.ini'。

配置文件是纯文本文件。选项分组在节标题下，方括号括起来。每个选项必须在单独的行上定义，并遵循以下语法：

{option name} =“{option value}”

注意：

选项值用双引号括起来
配置文件支持注释; 分号字符开始发表评论
安装包中包含的默认“webea_config.ini”文件包含如何配置模型的示例

为什么有这么多选择？

为了在如何访问和使用WebEA模型方面提供最大程度的灵活性，Sparx Systems提供了大量配置选项，这在第一次查看完整列表时可能令人望而生畏。但是，为了最大限度地减少您理解和管理选项的工作量，大多数也按前缀（sscs，login，add，edit和wl）进行分组，这有助于您快速了解特定选项的用途。

型号清单

配置文件中的第一部分是'[model_list]'; 此部分定义将在“登录”页面上向WebEA用户显示的型号名称。可以定义的模型数量没有限制; 但是，当有超过十个型号时，登录屏幕将自动显示垂直滚动条。

模型名称没有直接链接到它们描述的模型的物理服务器或数据库名称，因此您可以自由使用任何有意义的名称。

例如：

[model_list]

model1 = "Model One (no updates)"

model2 = "Model One with discussions"

model3 = "Model Two with user login"

model4 = "Model Three with all options"

model5 = "Sparx Systems Sample Model"

注意：'模型x '定义是连续的很重要; 任何无序模型编号都将被忽略，并且不会在WebEA登录页面中添加更多模型。

型号选项

对于'[model_list]'部分中找到的每个编号模型，预期匹配的'[modelx：settings]'部分，在配置文件的下方。本节中的所有选项仅与该模型相关; 也就是说，模型之间不能共享选项。

例如：

[model1：settings]

sscs_protocol =“http”

sscs_server =“localhost”

sscs_port =“80”

sscs_db_alias =“model1”

auth_code =“”

login_prompt =“false”

default_diagram =“”

show_discuss =“false”

模型连接设置

对于任何模型，最重要的设置可能是与连接相关的设置，前缀为sscs_（代表'Sparx Systems Cloud Service'）。这组设置定义了WebEA如何与Cloud Service连接和通信以进行数据检索。

WebEA和Cloud Service之间的所有通信都是通过PHP cURL库执行的，因此某些连接设置直接与cURL选项相关。

选项	描述	请参阅
sscs_protocol	定义用于连接Sparx Systems Cloud Service的协议。选项： http或https 默认值： http 示例： sscs_protocol =“http” 注意：使用https协议时，配置还应包括sscs_user_ssl =“true”。如果您使用自签名证书，则还应包括sscs_enforce_certs =“false”。
sscs_port	定义用于连接Sparx Systems Cloud Service的TCP端口。此端口号必须与Sparx Systems Cloud Service正在侦听的其中一个端口匹配，或者在IIS设置的情况下，必须与为此存储库提供服务的IIS端口匹配。默认值： 80 示例： sscs_port =“804”	云服务器配置
sscs_server	定义托管Cloud Service的服务器的标准机器名称或IP地址。默认值： localhost 示例： sscs_server =“sparxpublic.com”或sscs_server =“197.168.0.10”
sscs_use_ssl	定义WebEA和云服务之间的所有通信是否应使用SSL（安全套接字层）。如果此值为true，则协议应设置为“https”。选项： true或false 默认值： false 示例： sscs_use_ssl =“false”
sscs_db_alias	定义Cloud Service上托管的模型存储库的数据库别名。这对应于云服务配置客户端中标识的“数据库别名”或Enterprise Architect的云连接屏幕上的“模型名称”。该值区分大小写。默认值： ea 示例： sscs_db_alias =“RepositoryName”	配置数据库
sscs_enforce_certs	当SSL设置为true时，此选项定义cURL是否将强制证书颁发机构正确签署Cloud Service中安装的证书。注意：如果您使用云服务的自签名证书，则必须将此选项设置为false。选项： true或false 默认值： true 示例： sscs_enforce_certs =“false”	云服务器配置
sscs_model_user	定义将组合使用与模型用户登录（如企业架构师用户安全定义）sscs_model_pwd选项登录时，启用安全保护login_prompt选项设置为false。注意：Sparx Systems建议仅在已配置为只读的模型上使用此选项，因为此配置中的WebEA用户所做的所有更新都将标识为同一用户。默认：示例： sscs_model_user =“webuser”	维护用户
sscs_model_pwd	定义将组合使用与密码（如企业架构师用户安全定义）sscs_model_user选项登录时，启用安全保护login_prompt选项设置为false。注意：Sparx Systems建议仅在已配置为只读的模型上使用此选项，因为此配置中的WebEA用户所做的所有更新都将标识为同一用户。默认：示例： sscs_model_pwd =“pwdxxx”

模型一般设置

这些选项定义了WebEA用户如何访问和显示模型中的对象。

选项	描述
授权码	定义所有WebEA用户在访问模型之前必须输入的授权代码。如果此值为空，则不会提示WebEA用户输入代码。此选项的行为不依赖于“login_prompt”设置，这两个设置可以相互组合使用，也可以单独使用。最安全的方法是定义授权代码并将'login_prompt'设置为true。
login_prompt	定义所有WebEA用户在访问模型之前是否必须输入模型用户/密码。注意：如果将此选项设置为false并且模型已启用安全性，则还必须使用sscs_model_user和sscs_model_pwd选项指定登录凭据。选项： true或false 默认值： false 示例： login_prompt =“false”
login_allow_blank_pwd	当“login_prompt”选项设置为true时，此选项定义WebEA是否会尝试将空白密码发送到Cloud Services进行验证。选项： true或false 默认值： false 示例： login_allow_blank_pwd =“false”
participate_in_reviews	设置为true时，“participant_in_reviews”允许WebEA用户加入评论，这些评论会自动将所有讨论分配给已加入的评论。为了充分利用这个选项，show_discuss和add_discuss也必须设置为true。选项： true或false 默认值： false 示例： participant_in_reviews =“false”
recent_search_days	定义预定义的“最近......”搜索应考虑的天数。例如，如果此值设置为“7”，那么每当用户调用“最近元素”搜索时，将返回在前7天中修改的所有元素。选项：任何正整数值默认值： 3 示例： recent_search_days =“10”
use_avatars	当'use_avatars'选项设置为true时，将显示所有讨论消息以及创建用户的头像。设置为false时，将使用表示讨论和回复的一组通用图像。选项： true或false 默认值： true 示例： use_avatars =“false”
miniprops_navigates	当'miniprops_navigates'选项设置为true时，选择某些'navigatable'元素将导致WebEA导航到这些元素的目标。这种“可导航”元素的示例是超链接和导航单元。对于所有其他元素，选择它们将在“迷你属性”面板中显示元素的属性。未显示“迷你属性”面板时，此选项无效。选项： true或false 默认值： true 示例： miniprops_navigates =“false”
prop_sec_ <节> _visible	定义属性部分是否可见。属性视图包含可以选择隐藏的多个部分，如果为一组对元素或包的更精细细节不感兴趣的用户配置模型，这将特别有用。 <section>可以是以下之一：位置实例关系标记值测试资源分配属性操作运行状态变化缺陷问题任务事件决定工作风险指标选项： true或false 默认值： true 示例： prop_sec_testing_visible =“true”
prop_sec_ <节> _expanded	定义在打开模型时是否默认展开属性部分。属性视图包含许多可以选择展开或折叠的部分; 这些选项设置模型的默认值。 <section>可以是以下之一：信息位置实例关系标记值测试资源分配属性操作运行状态变化缺陷问题任务事件决定工作风险指标选项： true或false 默认值： false表示除“info”和“location”之外的所有部分，均为true 示例： prop_sec_testing_expanded =“true”
default_diagram	定义用户登录模型时应自动加载的图表的GUID。如果未定义此选项或指定了空值，则WebEA会假定不应加载任何图表，而是显示模型根。可以通过加载图属性从WebEA获取任何图的GUID。注意：必须使用整个GUID（包括{}）。示例： default_diagram =“{C89E174A-19B0-47c7-B4A8-8A98071CD838}”
default_main_layout	定义当前模型的容器项的默认布局。WebEA可以在三种布局之一中显示容器的子项。图标视图（默认），Notes视图（类似于Enterprise Architect规范管理器视图）或列表视图。选项：图标，备注或列表默认值：图标示例： default_main_layout =“list”
show_discuss	定义是否应在WebEA界面中显示有关包和元素的讨论。选项： true或false 默认值： false 示例： show_discuss =“true”

型号更新设置

这组设置确定WebEA用户可以使用哪些插入/编辑选项。

注意：在Cloud Service中，可以将模型配置为“只读”; Cloud Service中的此设置将覆盖任何WebEA更新设置，强制它们为false。

选项	描述
add_discuss	定义是否可以将关于包和元素的新讨论添加到模型中。注意：如果'show_discuss'已设置为false，则此选项强制为false。选项： true或false 默认值： false 示例： add_discuss =“true”
add_objects	定义是否可以将新对象添加到模型中。注意：对于Pro Cloud Server Express安装，此选项将在内部设置并限制为“false”。选项： true或false 默认值： false 示例： add_objects =“true”
add_diagrams	定义是否可以将新图表添加到模型中。注意：对于Pro Cloud Server Express安装，此选项将在内部设置并限制为“false”。选项： true或false 默认值： false 示例： add_diagrams =“true”
add_objecttype_ <类型>	定义是否可以将给定对象类型的元素添加到模型中。如果'add_objects'已设置为false，则强制这些选项为false。 <type>可以是以下之一：包评论行动更改零件特征问题节点需求任务用例选项： true或false 默认值： false 示例： add_objecttype_actor =“true”
add_object_features	定义是否可以将元素要素添加到模型中。注意：对于Pro Cloud Server Express安装，此选项将在内部设置并限制为“false”。选项： true或false 默认值： false 示例： add_object_features =“true”
add_objectfeature_ <类型>	定义是否可以将给定类型的元素要素添加到模型中。如果'add_object_features'已设置为false，则强制这些选项为false。 <type>可以是以下之一：测试资源变化缺陷问题任务风险选项： true或false 默认值： false 示例： add_objectfeature_changes =“true”
edit_objectfeature_resources	定义是否可以在模型中编辑元素资源分配的详细信息。注意：对于Pro Cloud Server Express安装，此选项将在内部设置并限制为“false”。选项： true或false 默认值： false 示例： edit_objectfeature_resources =“true”
edit_objectfeature_tests	定义是否可以在模型中编辑元素测试的详细信息。注意：对于Pro Cloud Server Express安装，此选项将在内部设置并限制为“false”。选项： true或false 默认值： false 示例： edit_objectfeature_tests =“true”

模型监视列表设置

监视列表功能允许用户快速查看模型中最近更改的各种对象。WebEA用户可以配置他们的个人偏好来控制他们对“观看”感兴趣的对象类型。

所有监视列表设置都以'wl_'为前缀，表示模型的默认值。但是，一旦用户保存自己的监视列表设置，将不再使用模型默认值。

为了在会话中保持监视列表首选项，WebEA将它们保存在浏览器cookie中。如果用户的浏览器不允许保存cookie，则不能跨会话保持个人监视列表设置。

选项	描述
cookie_retention	定义存储WebEA用户的监视列表选项集的时间段。该值是Cookie将保留的天数。选项：任何正整数值默认值： 365 示例： cookie_retention =“180”
wl_period	定义模型监视列表的默认活动期间。价值是天数; 例如，查找过去10天内的活动。选项：任何正整数值默认值： 0 示例： wl_period =“10”
wl_recent_discuss	定义监视列表是否应显示在活动期间进行过讨论的元素计数。选项： true或false 默认值： false
wl_recent_reviews	定义监视列表是否应显示在活动期间添加或修改的评论元素的计数。选项： true或false 默认值： false
wl_recent_diagram	定义监视列表是否应在活动期间显示添加/修改的图表计数。选项： true或false 默认值： false
wl_recent_element	定义监视列表是否应在活动期间显示已添加/已修改元素的计数。选项： true或false 默认值： false
wl_resalloc_active	定义监视列表是否应显示活动期间具有活动资源分配的元素计数。选项： true或false 默认值： false
wl_resalloc_today	定义监视列表是否应显示资源分配在活动期间结束的元素计数。选项： true或false 默认值： false
wl_resalloc_overdue	定义监视列表是否应显示在活动期间资源分配过期的元素计数。选项： true或false 默认值： false
wl_test_recentpass	定义监视列表是否应显示在活动期间通过测试的元素计数。选项： true或false 默认值： false
wl_test_recentfail	定义监视列表是否应显示在活动期间测试失败的元素计数。选项： true或false 默认值： false
wl_test_recentdefer	定义监视列表是否应显示在活动期间延迟测试的元素计数。选项： true或false 默认值： false
wl_test_recentnotchk	定义监视列表是否应显示具有在活动期间未检查的测试的元素计数。选项： true或false 默认值： false
wl_test_notrun	定义监视列表是否应显示在活动期间未运行的测试的元素计数。选项： true或false 默认值： false
wl_change_verified	定义监视列表是否应显示活动期间已验证更改的元素计数。选项： true或false 默认值： false
wl_change_requested	定义监视列表是否应显示活动期间请求更改的元素计数。选项： true或false 默认值： false
wl_change_completed	定义监视列表是否应显示在活动期间完成更改的元素计数。选项： true或false 默认值： false
wl_change_new	定义监视列表是否应显示在活动期间添加了新更改的元素计数。选项： true或false 默认值： false
wl_change_incomplete	定义监视列表是否应显示活动期间未完成更改的元素计数。选项： true或false 默认值： false
wl_defect_verified	定义监视列表是否应显示活动期间已验证缺陷的元素计数。选项： true或false 默认值： false
wl_defect_requested	定义监视列表是否应显示在活动期间报告或“请求”缺陷的元素计数。选项： true或false 默认值： false
wl_defect_completed	定义监视列表是否应显示活动期间已完成缺陷的元素计数。选项： true或false 默认值： false
wl_defect_new	定义监视列表是否应显示在活动期间添加缺陷的元素计数。选项： true或false 默认值： false
wl_defect_incomplete	定义监视列表是否应显示活动期间缺陷不完整的元素计数。选项： true或false 默认值： false
wl_issue_verified	定义监视列表是否应显示活动期间已验证问题的元素计数。选项： true或false 默认值： false
wl_issue_requested	定义监视列表是否应显示在活动期间报告或“请求”的问题的元素计数。选项： true或false 默认值： false
wl_issue_completed	定义监视列表是否应显示活动期间已完成问题的元素计数。选项： true或false 默认值： false
wl_issue_new	定义监视列表是否应显示在活动期间添加了问题的元素计数。选项： true或false 默认值： false
wl_issue_incomplete	定义监视列表是否应显示活动期间未完成问题的元素计数。选项： true或false 默认值： false
wl_task_verified	定义监视列表是否应显示活动期间已验证任务的元素计数。选项： true或false 默认值： false
wl_task_requested	定义监视列表是否应显示活动期间所请求任务的元素计数。选项： true或false 默认值： false
wl_task_completed	定义监视列表是否应显示在活动期间完成任务的元素计数。选项： true或false 默认值： false
wl_task_new	定义监视列表是否应显示在活动期间添加任务的元素计数。选项： true或false 默认值： false
wl_task_incomplete	定义监视列表是否应显示活动期间任务不完整的元素计数。选项： true或false 默认值： false
wl_event_requested	定义监视列表是否应显示活动期间所请求事件的元素计数。选项： true或false 默认值： false
wl_event_completed	定义监视列表是否应显示活动期间已完成事件的元素计数。选项： true或false 默认值： false
wl_event_high	定义监视列表是否应显示活动期间事件设置为高的元素计数。选项： true或false 默认值： false
wl_decision_verified	定义监视列表是否应显示活动期间已验证决策的元素计数。选项： true或false 默认值： false
wl_decision_requested	定义监视列表是否应显示活动期间所请求决策的元素计数。选项： true或false 默认值： false
wl_decison_completed	定义监视列表是否应显示在活动期间完成决策的元素计数。选项： true或false 默认值： false
wl_decision_new	定义监视列表是否应显示在活动期间添加决策的元素计数。选项： true或false 默认值： false
wl_decision_incomplete	定义监视列表是否应显示活动期间未完成决策的元素计数。选项： true或false 默认值： false