前页 | 后页 |
配置WebEA - 通过文本编辑器
WebEA模型可以通过直接编辑WebEA的 \includes\webea_config.ini 文件来配置。例如:
C:\xampp\htdocs\webea \includes\webea_config.ini
选项被分组在用方括号括起来的部分标题下。每个选项必须在单独的行上定义并遵循以下语法:
{选项名称} = "{选项值}"
注记:
- 选项值用双引号括起来
- 配置文件支持注释;分号字符开始评论
- 安装包中包含的默认“webea_config.ini”文件包含如何配置模型的示例
为什么有这么多选择?
为了在如何访问和使用WebEA模型方面提供最大程度的灵活性, Sparx Systems提供了大量的配置选项,当第一次查看完成列表时可能会令人望而生畏。但是,为了最大限度地减少您在理解和管理选项方面的工作量,大多数选项还按前缀(sscs、登录、添加、编辑和 wl)分组,这有助于您快速了解特定选项的用途。
模型列表
配置文件的第一部分是'[model_list]';此部分定义将在“登录”页面上向WebEA用户显示的模型名称。可以定义的模型数量没有限制;但是,当有十多个模型时,登录屏幕会自动显示一个垂直滚动条。
模型名称与它们描述的模型的物理服务器或数据库名称没有直接链接,因此您可以自由使用任何有意义的名称。
例如:
[模型列表]
model1 = "模型(无更新)"
model2 = "模型One with Discussion"
model3 = "模型with user login"
model4 = "模型三,所有选项"
model5 = " Sparx Systems样本模型"
订购:从版本 4. 1 .44 开始,可以更改登录页面上显示的模型的显示顺序; model_list中的项目可以根据需要重新排序,登录页面将按定义显示它们。
此外,不再需要存在连续的模型编号;也就是说,可能会缺少模型编号。例如:
[模型列表]
model5 = "模型(无更新)"
model1 = "模型One with Discussion"
model21 = "具有用户登录的模型Two"
model32 = "模型三,所有选项"
model4 = " Sparx Systems样本模型"
Sparx Systems建议,一旦模型被分配了一个编号,它应该保留这个编号,以便任何保存的 URL 将继续工作,这现在可以通过 v4 中引入的更改来实现。 1 .44。
模型选项
对于在“[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云服务器”)。这组设置定义了WebEA如何与专业云服务器连接和通信以进行数据检索。
WebEA和专业云服务器之间的所有通信都是通过 PHP cURL 库执行的,因此某些连接设置直接与 cURL 选项相关。
选项 |
描述 |
也见 |
---|---|---|
sscs_protocol |
定义用于连接到Sparx Systems专业云服务器的协议。 选项: http 或https 默认值: http 示例sscs_protocol = "http" 注记:使用https要求您为https访问配置端口和 SSL 证书,如“添加端口定义”主题中所述。如果您使用的是自签名证书,则还应包括 'sscs_enforce_certs = " false "'。 |
添加端口定义 |
sscs_port |
定义用于连接到Sparx Systems专业云服务器的 TCP端口。此编号必须与端口Sparx Systems专业云服务器端口服务器正在侦听的端口之一匹配,或者在 IIS 设置的情况下,与此存储库提供服务的 IIS端口相匹配。 默认值: 80 示例sscs_port = "804" |
专业云服务器配置 |
sscs_server |
定义托管专业云服务器的服务器的完全限定机器名称或 IP 地址。 默认值: localhost 示例: sscs_server = "sparxpublic.com" 或 sscs_server = "197.168.0.10" |
|
sscs_use_ssl |
从WebEA版本 3.01.23.1690(包含在专业云服务器3.0.23 中)开始,不再使用此选项。相反WebEA根据使用的协议动态确定此值: HTTP - sscs_use_ssl=" false " 和 HTTPS - sscs_use_ssl="true" WebEA之前的 WebEA 版本使用此值来定义WebEA和专业云服务器之间的所有通信是否应使用 SSL(安全套接字层)。当此值为“true”时,协议应设置为“ https ”。 选项: true or false 默认值: false 示例sscs_use_ssl = " false " |
|
sscs_db_alias |
定义托管在专业云服务器上的模型库的数据库别名。这对应于专业云服务器配置客户端中标识的“数据库名称”或Enterprise Architect别名云连接”屏幕上的“模型名称”。该值区分大小写。 默认值: ea 示例sscs_db_alias = "RepositoryName" |
配置数据库管理员 |
sscs_enforce_certs |
当使用 HTTPS 协议时,此选项定义 cURL 是否强制安装在专业云服务器中的证书由证书颁发机构正确签名。 注记:如果您使用的是专业云服务器的自签名证书,该选项必须设置为“ false ”。 选项: true or false 默认值:真 示例sscs_enforce_certs = " false " |
专业云服务器配置 |
sscs_access_code |
配置专业云服务器模型连接/数据库管理器时,可以定义可选的“OSLC访问代码”。 如果模型连接分配了“OSLC访问代码”,则需要使用“sscs_access_code”设置将其包含在WebEA配置中。 示例: sscs_access_code = "myoslcaccesscode" |
配置数据库管理员 |
sscs_model_user |
定义将与“sscs_model_pwd”选项结合使用以log到启用安全性的模型的模型用户登录名(如Enterprise Architect用户安全中定义的)。 注记:
示例: sscs_model_user = "webuser" |
配置模型Users |
sscs_model_pwd |
定义将与 'sscs_model_user' 选项结合使用以登录到启用安全性的模型的密码(如Enterprise Architect用户安全中定义的)。 注记:
示例: sscs_model_pwd = "pwdxxx" |
一般模型设置
这些选项定义了WebEA用户如何访问和显示模型中的对象。
选项 |
描述 |
也见 |
---|---|---|
授权码 |
定义所有WebEA用户在访问模型之前必须输入的授权代码。如果此值为空白,则不会提示WebEA用户输入代码。 此选项仅用于基本用户名/密码身份验证,不用于窗口或OpenID 。 可以设置此选项并设置“sscs_model_user”。在这种情况下,用户只需要输入访问代码,不会提示输入用户名或密码。 选项:文本 默认值:空白 示例: auth_code = "JWG478" |
|
登录提示 |
从WebEA版本 3.0.23.1690(包含在专业云服务器3.0.23 中)开始不再使用此选项。对于允许基本身份验证的模型(即不限于 SSO 登录),将显示基本身份验证用户名和密码字段。 基本身份验证(用户名/密码)将显示未设置sscs_model_user的启用安全性的模型。 窗口如果为模型启用了身份验证,将在选择模型时自动尝试。 如果在模型中启用OpenID身份验证,将在任何基本身份验证提示上方显示。 对于旧版本的WebEA ,该选项用于定义是否所有WebEA用户都必须输入模型用户/密码才能访问模型。 注记:当此选项设置为“ false ”并且模型已启用安全性时,还必须使用“sscs_model_user”和“sscs_model_pwd”选项来指定登录凭据。 选项: true or false 默认值: false 示例login_prompt = " false " |
登录 |
login_allow_blank_pwd |
当 'login_prompt' 选项设置为“true”时,此选项定义WebEA是否会尝试向专业云服务器发送空白密码进行验证。 选项: true or false 默认值: false 示例login_allow_blank_pwd = " false " |
|
auto_login_windows_auth |
当设置为“true”时, WebEA将自动尝试使用窗口身份验证登录(绕过“登录”屏幕)。如果窗口登录失败,则会显示“登录”屏幕,允许用户手动输入凭据。 选项: true or false 默认值: false 示例auto_login_windows_auth = "true" 注记:此选项仅适用于模型启用了用户安全“接受窗口身份验证”选项的情况。有关详细信息,请参阅“维护用户”帮助主题。 |
配置模型Users |
miniprops_navigates |
当“miniprops_navigates”选项设置为“true”时,选择某些“可导航”元素将导致WebEA导航到这些元素的目标。这种“可导航”元素的示例是超链接和导航单元。对于所有其他元素视图属性属性当属性视图未显示时,此选项无效。 选项: true or false 默认值:真 示例miniprops_navigates = " false " |
|
导航到图表 |
从WebEA版本 3.01.23.1690(包含在专业云服务器3.0.23 中)开始,图表上某些对象的默认选择与Enterprise Architect行为相匹配。这适用于 i)复合元素和 ii) 包含图表的包元素。
选项: true or false 默认值:真 示例:navigation_to_diagram = " false " |
|
显示搜索 |
定义“搜索”菜单是否可见和可用。 选项: true or false 默认值:真 示例show_search = " false " |
WebEA的布局 |
show_watchlist |
定义“监视列表”菜单项是否可见和可用。 选项: true or false 默认值:真 示例show_watchlist = " false " |
WebEA的布局 |
最近的搜索天数 |
定义预定义的“最近的...”搜索应考虑的天数。例如,如果此值设置为“7”,那么每当用户调用搜索“最近的元素”时,将返回在前 7 天内修改的所有元素。 选项:任何正整数值 默认值: 3 示例recent_search_days = "10" |
|
prop_sec_<截面>_visible |
定义属性部分(或特征)是否可访问。 如果某个特征不可见,则显示该特征的按钮在“主视图”中将不可用,并且该特征将不会列在属性视图的“选择特征”菜单中。 <section> 可以是以下之一:
默认值:真 示例prop_sec_testing_visible = "true" |
|
prop_sec_<section>_expanded |
从WebEA版本 3.0.23.1690(包含在专业云服务器属性中的属性)开始不再使用此选项。部分不再显示为可展开/可折叠的面板。 定义打开模型时是否默认展开属性部分。 属性视图包括许多可以选择展开或折叠的部分;这些选项设置模型的默认值。 <section> 可以是以下之一:
默认值:除“信息”和“位置”之外的所有部分为false ,它们为真 示例prop_sec_testing_expanded = "true" |
|
默认图表 |
定义用户log模型时应自动加载的图表的GUID 。任何图表的GUID都可以通过加载图表属性从WebEA中获取。 如果未设置此选项,则WebEA将加载:
示例: default_diagram = "{C89E174A-19B0-47c7-B4A8-8A98071CD838}" |
用户和模型默认图表 |
default_main_layout |
定义当前模型的容器项的默认布局。 WebEA可以以三种布局之一显示容器的子项。 “图标”视图(默认)、“注记”视图(类似于Enterprise Architect规范管理器视图)或“列表”视图。 选项:图标、注记或列表 默认:图标 示例: default_main_layout = "icon" |
|
对象顺序 |
定义“浏览器”和“物件列表”视图中对象的顺序。存在三种不同的排序行为,由值1和 3 表示。
默认值: 3 示例object_order = "2" 注记:不管 'object_order' 设置如何, WebEA显示图表,然后是包,然后是元素; “object_order”适用于每个分组中的项目 |
常规选项 WebEA -浏览器 WebEA主视图-物件列表 |
收藏夹_as_home |
当设置为“true”时, WebEA “主页”页面将在“浏览器”或“包”视图中显示用户的“收藏夹”包。这是在第一次访问模型时加载的,并且在使用WebEA的主页按钮时也会加载。 浏览器的向上按钮也被隐藏,有助于在收藏包中保持导航。 选项: true or false 默认值:真 示例: favorites_as_home = " false " 注记:
|
优化浏览器内容 |
显示浏览器 |
定义“浏览器”的默认可见性。 选项: true or false 默认值:真 示例show_browser = " false " 注记:
|
登录 WebEA -浏览器 |
show_diagram_objs |
定义浏览器中仅图表对象(例如注记、文本和边界)的可见性。当显示时,这些对象被分组在一个可折叠的 [...] 节点中。 选项: true or false 默认值: false 示例:示例= "true" |
WebEA -浏览器 |
show_propertiesview |
定义“属性视图”的默认可见性。 选项: true or false 默认值:真 示例show_propertiesview =“ false ” 注记:
|
WebEA -属性视图 登录 |
显示路径按钮 |
定义物件路径按钮的可见性。当设置为 true 时,该按钮在WebEA的导航栏中可用。物件路径按钮用于显示从当前物件到模型根的包和对象列表。 选项: true or false 默认值:真 示例show_path_button =“ false ” 将此选项设置为“ false ”有助于使WebEA专注于模型的特定区域,尤其是与 'favorites_as_home = "true"' 结合使用时。 |
WebEA的布局 |
show_breadcrumb |
定义在WebEA的导航栏中显示当前object的完整路径(或“面包屑”)。当设置为false时,导航栏将仅显示当前object名称。 选项: true or false 默认值:真 示例:示例= "true" |
WebEA -模型视图 |
模型协作设置
显示评论 |
定义评论是否可以在WebEA中访问。当设置为“true”时,可以通过讨论和审阅窗口的“日志”选项卡访问评论。 如果object定义了任何评论,也可以通过物件属性视图访问评论。 选项: true or false 默认值: false 示例show_comments = "true" |
show_chat |
定义是否可以在WebEA中访问模型聊天。当设置为“true”时,模型聊天将可以通过聊天和邮件视图的“聊天”选项卡访问。 选项: true or false 默认值: false 示例show_chat = "true" 注记:与Enterprise Architect一样,模型聊天在未启用用户安全的模型中不可用。 |
聊天通知秒 |
定义WebEA检查新聊天消息并显示/更新出现在WebEA状态栏中的聊天通知的频率(以秒为单位)。 默认值: 30 示例chat_notify_sec = "30" |
显示邮件 |
定义是否可以在WebEA中访问模型邮件。当设置为“true”时,模型邮件将可以通过协作视图的“邮件”选项卡访问。 选项: true or false 默认值: false 示例show_mail = "true" 注记:与Enterprise Architect一样,模型邮件在未启用用户安全的模型中不可用。 |
mail_days |
定义在模型邮件收件箱和已发送邮件列表中显示多少天的邮件。 默认值: 90 示例mail_days = "90" 注记:减少这个数字可以提高加载收件箱/已发送邮件时的性能。 |
show_discuss |
定义是否可以在WebEA中访问讨论。当设置为“真实”时,可以通过协作的“视图”和“讨论”选项卡访问讨论。 还可以通过主视图-物件属性和属性视图访问讨论和评论。 选项: true or false 默认值: false 示例show_discuss = "true" |
add_discuss |
定义是否可以将关于包和元素的新讨论添加到模型中。注记:如果“show_discuss”已设置为“ false false 。 选项: true or false 默认值: false 示例add_discuss = "true" |
参与评论 |
当设置为“true”时,'participate_in_reviews' 允许WebEA的用户进行汇合评论,这些评论将自动将所有讨论分配给加入的审阅。为了充分利用这个选项“show_discuss”和“add_discuss”也必须设置为“true”。 选项: true or false 默认值: false 示例: particip_in_reviews = " false " |
使用头像 |
当 'use_avatars' 选项设置为“true”时,所有讨论消息都会与创建用户的头像一起显示。当设置为“ false ”时,将使用一组代表讨论和回复的通用图像。 选项: true or false 默认值:真 示例use_avatars = " false " |
模型更新设置
这组设置决定了WebEA用户可以使用哪些插入/编辑选项。
注记:在专业云服务器中,可以将模型配置为“只读”;专业云服务器中的此设置将覆盖任何WebEA更新设置,强制它们具有值“ false ”。
选项 |
描述 |
也见 |
---|---|---|
添加对象 |
定义是否可以将新对象添加到模型中。 选项: true or false 默认值: false 示例add_objects = "true" |
|
编辑对象注释 |
定义元素的注记是否可以编辑。 选项: true or false 默认值: false 示例: edit_object_notes = "true" |
|
编辑对象标签 |
定义是否可以编辑元素的标记值。 选项: true or false 默认值: false 示例: edit_object_tags = "true" |
|
添加图表 |
定义是否可以将新图表添加到模型中。 选项: true or false 默认值: false 示例add_diagrams = "true" |
|
add_objecttype_<类型> |
定义是否可以将给定object类型的元素添加到模型中。 如果 'add_objects' 已设置为“ false false 。 <type> 的值可以是以下之一:
默认值: false 示例add_objecttype_actor = "true" |
|
add_object_features |
定义是否可以将元素特征添加到模型中。 选项: true or false 默认值: false 示例add_object_features = "true" |
|
add_objectfeature_<类型> |
定义是否可以将给定类型的元素特征添加到模型中。 如果 'add_object_features' 已设置为“ false false 。 <type> 的值可以是以下之一:
默认值: false 示例: add_objectfeature_changes = "true" |
|
编辑对象特征资源 |
定义是否可以在模型中编辑元素资源分配的详细信息。 选项: true or false 默认值: false 示例edit_objectfeature_resources = "true" |
|
编辑对象特征测试 |
定义是否可以在模型中编辑元素测试的细节。 选项: true or 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 |
定义监视列表是否应显示在活动期间进行过讨论的元素的计数。 选项:真或false 默认值: false |
|
wl_recent_reviews |
定义监视列表是否应显示在活动期间添加或修改的审阅元素的计数。 选项: true or false 默认值: false |
|
wl_recent_diagram |
定义监视列表是否应显示活动期间已添加/修改的图表的计数。 选项: true or false 默认值: false |
|
wl_recent_element |
定义监视列表是否应显示活动期间已添加/修改的元素的计数。 选项: true or false 默认值: false |
|
wl_resalloc_active |
定义监视列表是否应显示活动期间具有活动资源分配的元素计数。 选项: true or false 默认值: false |
|
wl_resalloc_today |
定义监视列表是否应显示资源分配在活动期间结束的元素计数。 选项: true or false 默认值: false |
|
wl_resalloc_overdue |
定义监视列表是否应显示资源分配在活动期间过期的元素计数。 选项: true or false 默认值: false |
|
wl_test_recentpass |
定义监视列表是否应显示在活动期间通过测试的元素计数。 选项: true or false 默认值: false |
|
wl_test_recentfail |
定义监视列表是否应显示活动期间测试失败的元素计数。 选项: true or false 默认值: false |
|
wl_test_recentdefer |
定义监视列表是否应显示在活动期间推迟测试的元素计数。 选项:真或false 默认值: false |
|
wl_test_recentnotchk |
定义监视列表是否应显示活动期间未检查的测试元素的计数。 选项:真或false 默认值: false |
|
wl_test_notrun |
定义监视列表是否应显示在活动期间未运行的测试元素的计数。 选项: true or false 默认值: false |
|
wl_feature_verified |
定义监视列表是否应在活动期间显示具有已验证特征的元素计数。 选项: true or false 默认值: false |
|
wl_feature_requested |
定义监视列表是否应在活动期间显示具有请求特征的元素计数。 选项:真或false 默认值: false |
|
wl_feature_completed |
定义监视列表是否应显示活动期间特征已完成的元素计数。 选项:真或false 默认值: false |
|
wl_feature_new |
定义监视列表是否应显示在活动期间添加了新特征的元素计数。 选项:真或false 默认值: false |
|
wl_feature_incomplete |
定义监视列表是否应显示活动期间具有不完整特征的元素的计数。 选项:真或false 默认值: false |
|
wl_change_verified |
定义监视列表是否应显示活动期间经过验证的更改的元素计数。 选项: true or false 默认值: false |
|
wl_change_requested |
定义监视列表是否应显示活动期间请求更改的元素计数。 选项:真或false 默认值: false |
|
wl_change_completed |
定义监视列表是否应显示在活动期间完成更改的元素计数。 选项:真或false 默认值: false |
|
wl_change_new |
定义监视列表是否应显示在活动期间添加了新更改的元素计数。 选项:真或false 默认值: false |
|
wl_change_incomplete |
定义监视列表是否应显示活动期间更改不完整的元素的计数。 选项:真或false 默认值: false |
|
wl_document_verified |
定义监视列表是否应在活动期间显示具有已验证文档的元素计数。 选项: true or false 默认值: false |
|
wl_document_requested |
定义监视列表是否应在活动期间显示具有请求文档的元素计数。 选项:真或false 默认值: false |
|
wl_document_completed |
定义监视列表是否应显示活动期间已完成文档的元素计数。 选项:真或false 默认值: false |
|
wl_document_new |
定义监视列表是否应显示在活动期间添加了新文档的元素计数。 选项:真或false 默认值: false |
|
wl_document_incomplete |
定义监视列表是否应显示活动期间具有不完整文档的元素的计数。 选项:真或false 默认值: false |
|
wl_defect_verified |
定义监视列表是否应显示活动期间具有已验证缺陷的元素的计数。 选项:真或false 默认值: false |
|
wl_defect_requested |
定义监视列表是否应显示活动期间报告或“请求”缺陷的元素计数。 选项:真或false 默认值: false |
|
wl_defect_completed |
定义监视列表是否应显示活动期间完成的缺陷元素的计数。 选项:真或false 默认值: false |
|
wl_defect_new |
定义监视列表是否应显示活动期间添加的缺陷元素的计数。 选项: true or false 默认值: false |
|
wl_defect_incomplete |
定义监视列表是否应显示活动期间具有不完整缺陷的元素的计数。 选项: true or false 默认值: false |
|
wl_issue_verified |
定义监视列表是否应显示活动期间存在已验证问题的元素计数。 选项:真或false 默认值: false |
|
wl_issue_requested |
定义监视列表是否应显示活动期间报告或“请求”问题的元素计数。 选项: true or false 默认值: false |
|
wl_issue_completed |
定义监视列表是否应显示活动期间已完成问题的元素计数。 选项:真或false 默认值: false |
|
wl_issue_new |
定义监视列表是否应显示在活动期间添加的问题的元素计数。 选项: true or false 默认值: false |
|
wl_issue_incomplete |
定义监视列表是否应显示活动期间存在不完整问题的元素的计数。 选项:真或false 默认值: false |
|
wl_task_verified |
定义监视列表是否应显示活动期间具有已验证任务的元素计数。 选项: true or false 默认值: false |
|
wl_task_requested |
定义监视列表是否应显示活动期间具有请求任务的元素计数。 选项:真或false 默认值: false |
|
wl_task_completed |
定义监视列表是否应显示活动期间已完成任务的元素计数。 选项: true or false 默认值: false |
|
wl_task_new |
定义监视列表是否应显示在活动期间添加了任务的元素计数。 选项:真或false 默认值: false |
|
wl_task_incomplete |
定义监视列表是否应显示活动期间任务未完成的元素计数。 选项: true or false 默认值: false |
|
wl_event_requested |
定义监视列表是否应显示活动期间具有请求事件的元素计数。 选项:真或false 默认值: false |
|
wl_event_high |
定义监视列表是否应显示活动期间事件设置为高的元素计数。 选项:真或false 默认值: false |
|
wl_event_incomplete |
定义监视列表是否应显示具有不完整事件的元素的计数。 选项: true or false 默认值: false |
|
wl_decision_verified |
定义监视列表是否应显示活动期间具有经过验证的决策的元素计数。 选项: true or false 默认值: false |
|
wl_decision_requested |
定义监视列表是否应在活动期间显示具有请求决策的元素计数。 选项: true or false 默认值: false |
|
wl_decison_completed |
定义监视列表是否应显示在活动期间完成决策的元素计数。 选项: true or false 默认值: false |
|
wl_decision_new |
定义监视列表是否应显示在活动期间添加了决策的元素计数。 选项: true or false 默认值: false |
|
wl_decision_incomplete |
定义监视列表是否应显示活动期间决策不完整的元素计数。 选项:真或false 默认值: false |