Prev Next

Configure WebEA models - via Text Editor

WebEA models can be configured by directly editing WebEA's  \includes\webea_config.ini file. For example: 

     C:\xampp\htdocs\webea\includes\webea_config.ini

Options are grouped under section headers, which are enclosed by square brackets. Each option must be defined on a separate line and follow the syntax:

   {option name} = "{option value}"

Note that:

  • Option values are enclosed by double quotes
  • The configuration file supports comments; the semi-colon character starts a comment
  • The default 'webea_config.ini' file included in the installation package contains samples of how models can be configured

Why are there so many options?

In order to offer the greatest level of flexibility in how WebEA models can be accessed and used, Sparx Systems provides a large number of configuration options, which can be daunting when the complete list is viewed for the first time. However, to minimize your effort in understanding and managing the options, most are also grouped by prefix (sscs, login, add, edit and wl), which helps you to quickly understand what a particular option is used for.

The Model List

The first section in the configuration file is '[model_list]'; this section defines the model names that will be displayed to WebEA users on the 'Login' page. There is no limit to the number of models that can be defined; however, when there are more than ten models the login screen will automatically show a vertical scroll bar.

The model names have no direct link to the physical server or database name of the models they are describing, so you are free to use any meaningful name.

For example:

     [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"

Note: It is important that the 'modelx' definitions are consecutive; any out-of-sequence model numbers will be ignored and no further models will be added to the WebEA Login page.

Model options

For each numbered model found in the '[model_list]' section a matching '[modelx : settings]' section is expected, further down the configuration file. All options within this section relate to that model only; that is, options cannot be shared between models.

For example:

     [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"

Model connection settings

Probably the most important settings for any model are the connection-related ones, prefixed with sscs_ (which stands for 'Sparx Systems Cloud Server'). This group of settings defines how WebEA will connect and communicate with the Pro Cloud Server for data retrieval.

All communication between WebEA and the Pro Cloud Server is performed via the PHP cURL library, therefore some of the connection settings relate directly to the cURL options.

Option

Description

See also

sscs_protocol

Defines the protocol to be used to connect to the Sparx Systems Pro Cloud Server.

Options: http or https

Default: http

Example: sscs_protocol = "http"

Note: When using the https protocol the configuration should also include 'sscs_use_ssl = "true"'. If you are using a self-signed certificate then 'sscs_enforce_certs = "false"' should also be included.

sscs_port

Defines the TCP Port used to connect to the Sparx Systems Pro Cloud Server. This Port number must match one of the Ports the Sparx Systems Pro Cloud Server is listening to or, in the case of an IIS setup, the IIS Port servicing this repository.

Default:     80

Example: sscs_port = "804"

Pro Cloud Server Configuration

sscs_server

Defines the fully qualified machine name or IP address of the server hosting the Pro Cloud Server.

Default: localhost

Example: sscs_server = "sparxpublic.com" or sscs_server = "197.168.0.10"

sscs_use_ssl

As of WebEA version 3.01.23.1690 (included in Pro Cloud Server 3.0.23) this option is no longer used. Instead WebEA determines this value dynamically based on the protocol in use:

HTTP - sscs_use_ssl="false"   and

HTTPS - sscs_use_ssl="true"

WebEA versions prior to 3.0.23.1690 use this value to define if all communications between WebEA and Pro Cloud Server should use SSL (Secure Socket Layer). When this value is "true", the protocol should be set to "https".

Options: true or false

Default: false

Example: sscs_use_ssl = "false"

sscs_db_alias

Defines the database alias name of the model repository hosted on the Pro Cloud Server. This corresponds to the 'Database Alias' identified in the Pro Cloud Server Configuration Client or the 'Model Name' on the Enterprise Architect 'Cloud Connection' screen. The value is case sensitive.

Default: ea

Example: sscs_db_alias = "RepositoryName"

Configure Database Manager

sscs_enforce_certs

When HTTPS is the protocol in use, this option defines whether or not cURL will enforce that the certificate installed in Pro Cloud Server is correctly signed by a Certificate Authority.

Note: If you are using a self-signed certificate for Pro Cloud Server, this option must be set to "false".

Options: true or false

Default: true

Example: sscs_enforce_certs = "false"

Pro Cloud Server Configuration

sscs_model_user

Defines the model user login (as defined in Enterprise Architect User Security) that will be used in combination with the 'sscs_model_pwd' option to log in to a security enabled model.

Note:

  • Starting in Pro Cloud Server version 3.0.23 - When set, all other authentication schemes are bypassed, including Windows Authentication, OpenID and basic username/password login
  • Sparx Systems recommend the use of this option only on a model that has been configured as read-only, since all updates made by WebEA users in this configuration will be identified as the same user.

Default:

Example: sscs_model_user = "webuser"

Maintain Users

sscs_model_pwd

Defines the password (as defined in Enterprise Architect User Security) that will be used in combination with the 'sscs_model_user' option to login to a security enabled model.

Note:

  • Starting in Pro Cloud Server version 3.0.23 - When set, all other authentication schemes are bypassed, including Windows Authentication, OpenID and basic username/password login
  • Sparx Systems recommend the use of this option only on a model that has been configured as read-only, since all updates made by WebEA users in this configuration will be identified as the same user

Default:

Example: sscs_model_pwd = "pwdxxx"

Model general settings

These options define how WebEA users can access and display objects within the model.

Option

Description

See also

auth_code

Defines the authorization code all WebEA users must enter before they can access the model. If this value is blank, WebEA users are not prompted to enter a code.

This option is only used for basic username/password authentication and is not used for Windows Authentication or OpenID.

It is possible to set this option and also set 'sscs_model_user'. In this case the user will be required to enter the access code only and will not be prompted for a username or password.

Options: text

Default: blank

Example: auth_code = "JWG478"

login_prompt

This option is no longer used as of WebEA version 3.0.23.1690 (included in Pro Cloud Server 3.0.23). Basic authentication username and password fields will show for models that allow basic authentication (that is, are not restricted to SSO logins).

The basic authentication (username/password) will show for security enabled models that have not set sscs_model_user.

Windows Authentication, if enabled for the model, will be attempted automatically when selecting the model.

OpenID authentication, if enabled in the model, will show above any basic authentication prompt.

For older versions of WebEA, the option is used to define whether or not all WebEA users must enter a model user/password before they can access the model.

Note: When this option is set to "false" and the model has security enabled, the 'sscs_model_user' and 'sscs_model_pwd' options must also be used to specify the logon credentials.

Options: true or false

Default: false

Example: login_prompt = "false"

Login

login_allow_blank_pwd

When the 'login_prompt' option is set to "true", this option defines whether or not WebEA will attempt to send blank passwords to the Pro Cloud Server for validation.

Options: true or false

Default: false

Example: login_allow_blank_pwd = "false"

miniprops_navigates

When the 'miniprops_navigates' option is set to "true", selecting certain 'navigable' elements will cause WebEA to navigate to the target of these elements. Examples of such 'navigable' elements are Hyperlinks and Navigation Cells.  For all other elements, selecting them will display the properties of the element in the Properties View.  This option has no effect when the Properties View is not shown.

Options: true or false

Default: true

Example: miniprops_navigates = "false"

navigate_to_diagram

As of WebEA version 3.01.23.1690 (included in Pro Cloud Server 3.0.23) the default selection of some objects on diagrams matches Enterprise Architect behavior. This applies to i) Composite elements and ii) Package elements that contain a diagram.

  • Composite Elements - A composite element on a diagram will navigate directly to its composite diagram.
  • Package Elements - A Package element on a diagram will navigate to the first child diagram contained within the selected Package; if the selected Package does not contain any diagrams then the Package's properties are displayed

When 'navigate_to_diagram' is set to "false", selecting either a composite element or Package element on a diagram will display the selected element's properties.

Options: true or false

Default: true

Example: navigate_to_diagram = "false"

show_discuss

Defines whether or not discussions on Packages and elements should be displayed within the WebEA interface.

Options: true or false

Default: false

Example: show_discuss = "true"

participate_in_reviews

When set to "true", 'participate_in_reviews' allows users of WebEA to Join reviews that will automatically assign all discussions to the joined review. In order to make full use of this option 'show_discuss' and 'add_discuss' would also have to be set to "true".

Options: true or false

Default: false

Example: participate_in_reviews = "false"

use_avatars

When the 'use_avatars' option is set to "true", all discussion messages are displayed with the creating user's avatar. When set to "false" a set of generic images representing discussions and replies is used instead.

Options:  true or false

Default:  true

Example:  use_avatars = "false"

show_search

Defines whether the 'Search' menu is visible and available.

Options: true or false

Default: true

Example: show_search = "false"

WebEA's layout

show_watchlist

Defines whether the 'Watchlist' menu item is visible and available.

Options: true or false

Default: true

Example: show_watchlist = "false"

WebEA's layout

recent_search_days

Defines the number of days the predefined 'Recent ...' searches should consider. For example if this value was set to "7" then whenever a user invokes the search for 'Recent elements', all elements modified in the previous 7 days will be returned.

Options: any positive integer value

Default: 3

Example: recent_search_days = "10"

prop_sec_

_visible

Defines whether or not a property section (or feature) is accessible.

If a feature is not visible then the button to display that feature will not be available in the 'Main View', and the Feature will not be listed in the 'Select Feature' menu in the Properties View.

<section> can be one of:

  • location
  • instances
  • relationships
  • taggedvalues
  • testing
  • resourcealloc
  • attributes
  • operations
  • files
  • runstates
  • features
  • changes
  • documents
  • defects
  • issues
  • tasks
  • events
  • decisions
  • efforts
  • risks
  • metrics

Options: true or false

Default: true

Example: prop_sec_testing_visible = "true"

prop_sec_

_expanded

This option is no longer used as of WebEA version 3.0.23.1690 (included in Pro Cloud Server 3.0.23). Property sections are no longer displayed as expandable/collapsible panels.

Defines whether or not a property section is expanded by default when the model is opened.

The property view includes numerous sections that can be optionally expanded or collapsed; these options set the default values for the model.

<section> can be one of:

  • info
  • location
  • instances
  • relationships
  • taggedvalues
  • testing
  • resourcealloc
  • attributes
  • operations
  • runstates
  • changes
  • defects
  • issues
  • tasks
  • events
  • decisions
  • efforts
  • risks
  • metrics

Options: true or false

Default: false for all sections except 'info' and 'location', which are true

Example: prop_sec_testing_expanded = "true"

default_diagram

Defines the GUID of the diagram that should be automatically loaded when users log onto the model. If this option is not defined or an empty value is specified, WebEA assumes that no diagram should be loaded and displays the model root instead. The GUID of any diagram can be obtained from WebEA by loading the diagram properties.

Note: The entire GUID (including {}) must be used.

Example: default_diagram = "{C89E174A-19B0-47c7-B4A8-8A98071CD838}"

default_main_layout

Defines the default layout of container items for the current model. WebEA can display child items of a container in one of three layouts. Either "icon" view (the default), "notes" view (resembling the Enterprise Architect Specification Manager view) or "list" view.

Options: icon, notes or list

Default: icon

Example: default_main_layout = "icon"

object_order

Defines the order of objects in the 'Browser' and 'Object List' views. There are three different ordering behaviors, represented by values 1,2, and 3.

  • "1" = Alphabetical - Objects are sorted alphabetically (by name)
  • "2" = Free Sort - Objects are sorted based on their 'Set Position' (manual sorting which is applied in Enterprise Architect), then alphabetically; this reflects Enterprise Architect's sorting when the 'Allow Free Sorting' option is enabled
  • "3" = Object Type - Objects are sorted by type, then set position, then alphabetically; this reflects Enterprise Architect's sorting when the 'Allow Free Sorting' option is disabled

Options: 1, 2 or 3

Default: 3

Example: object_order = "2"

Note: Regardless of the 'object_order' setting, WebEA displays diagrams, then Packages, then elements; the 'object_order' applies to the items within each of these groupings

General Options WebEA - Browser Main View - Object List

favorites_as_home

When set to "true", the WebEA 'Home' page will display the user's 'Favorites' Packages in the 'Browser' or 'Package' view. This is loaded when first accessing the model, and also when using WebEA's Home button.

The Browser's Up button is also hidden, helping to keep navigation within the Favorites Package(s).

Options: true or false

Default: true

Example: favorites_as_home = "false"

Notes:

  • When set to true, this overrides the 'default_diagram' setting
  • Favorites are defined using Enterprise Architect; refer to the link in the See Also column for details
  • If a user has no Favorites defined then the Model Root or Default diagram (if one is defined) will be loaded instead
Refine Browser Content

show_browser

Defines the default visibility of the 'Browser'.

Options: true or false

Default: true

Example: show_browser = "false"

Notes:

  • If a user selects the 'Mobile' option when logging in to WebEA then this overrides the 'show_browser' option and the 'Browser' will be hidden
  • This behavior can be overridden, depending on the screen resolution; for example, on a low resolution screen such as a mobile phone, the 'Browser' will be hidden regardless of the 'show_browser' option setting
Login WebEA - Browser

show_propertiesview

Defines the default visibility of the 'Properties View'.

Options: true or false

Default: true

Example: show_propertiesview = "false"

Notes:

  • If a user selects the 'Mobile' or 'Tablet' option when logging in to WebEA, this overrides the 'show_propertiesview' option and the Properties View will be hidden
  • This behavior could be overridden depending on the screen resolution; for example, on a low resolution screen such as a mobile phone, the Properties View will be hidden regardless of the 'show_propertiesview' option setting
WebEA - Properties View Login

show_path_button

Defines the visibility of the Object Path button. When set to true, the button is available in WebEA's Navigation Bar. The Object Path button is used to display a list of Packages and Objects from the current Object up to the Model Root.

Options: true or false

Default: true

Example: show_path_button = "false"

Setting this option to "false" can help in keeping WebEA focused on a specific area of your model, especially when used in conjunction with 'favorites_as_home = "true"'.

WebEA's layout

Model update settings

This group of settings determine what insert/edit options are available to WebEA users.

Note: Within the Pro Cloud Server it is possible to configure a model as 'Read-only'; this setting in the Pro Cloud Server will override any WebEA update setting, forcing them to have the value "false".

Option

Description

See also

add_discuss

Defines whether or not new discussions on Packages and elements can be added to the model. Note: This option is forced to "false" if 'show_discuss' has been set to "false".

Options: true or false

Default: false

Example: add_discuss = "true"

add_objects

Defines whether or not new objects can be added to the model. 

Note: This option will be internally set and restricted to "false" for Pro Cloud Server Express installations.

Options: true or false

Default: false

Example: add_objects = "true"

add_diagrams

Defines whether or not new diagrams can be added to the model.

Note: this option will be internally set and restricted to "false" for Pro Cloud Server Express installations.

Options: true or false

Default: false

Example: add_diagrams = "true"

add_objecttype_

Defines whether or not elements of the given object type can be added to the model.

These options are forced to "false" if 'add_objects' has been set to "false".

The value of <type> can be one of:

  • package
  • review
  • actor
  • change
  • component
  • feature
  • issue
  • node
  • requirement
  • task
  • usecase

Options: true or false

Default: false

Example: add_objecttype_actor = "true"

add_object_features

Defines whether or not element features can be added to the model.

Note: this option will be internally set and restricted to "false" for Pro Cloud Server Express installations.

Options: true or false

Default: false

Example: add_object_features = "true"

add_objectfeature_

Defines whether or not element features of the given type can be added to the model.

These options are forced to "false"  if 'add_object_features' has been set to "false".

The value of <type> can be one of:

  • tests
  • resources
  • features
  • changes
  • documents
  • defects
  • issues
  • tasks
  • risks

Options: true or false

Default: false

Examples: add_objectfeature_changes = "true"

edit_objectfeature_resources

Defines whether or not the details of element resource allocations can be edited in the model.

Note: this option will be internally set and restricted to "false" for Pro Cloud Server Express installations.

Options: true or false

Default: false

Example: edit_objectfeature_resources = "true"

edit_objectfeature_tests

Defines whether or not the details of element tests can be edited in the model.

Note: this option will be internally set and restricted to "false" for Pro Cloud Server Express installations.

Options: true or false

Default: false

Example: edit_objectfeature_tests = "true"

Model watchlist settings

The watchlist functionality allows users to quickly see a wide variety of objects that have changed recently in the model. WebEA users can configure their personal preferences to control what sort of objects they are interested in 'watching'.

All watchlist settings are prefixed by 'wl_' and represent the default value for the model. However, once a user saves their own watchlist settings the model defaults will no longer be used.

In order to persist the watchlist preferences across sessions, WebEA saves them in a browser cookie. If the user's browser does not allow the saving of cookies, personal watchlist settings can not be persisted across sessions.

Option

Description

See also

cookie_retention

Defines the period over which a WebEA user's set of watchlist options are stored. The value is the number of days that the cookies will be retained for.

Options: any positive integer value

Default: 365

Example:  cookie_retention = "180"

wl_period

Defines the default activity period of the model watchlist. The value is a number of days; for example, look for activity in the last 10 days.

Options: any positive integer value

Default: 0

Example : wl_period = "10"

wl_recent_discuss

Define whether or not the watchlist should display a count of elements that have had discussions during the activity period.

Options: true or false

Default: false

wl_recent_reviews

Define whether or not the watchlist should display a count of review elements that have been added or modified during the activity period.

Options: true or false

Default: false

wl_recent_diagram

Define whether or not the watchlist should display a count of the diagrams that have been added/modified during the activity period.

Options: true or false

Default: false

wl_recent_element

Define whether or not the watchlist should display a count of the elements that have been added/modified during the activity period.

Options: true or false

Default: false

wl_resalloc_active

Define whether or not the watchlist should display a count of elements with active resource allocations during the activity period.

Options: true or false

Default: false

wl_resalloc_today

Define whether or not the watchlist should display a count of elements with resource allocations ending during the activity period.

Options: true or false

Default: false                         

wl_resalloc_overdue

Define whether or not the watchlist should display a count of elements with resource allocations that fall overdue during the activity period.

Options: true or false

Default: false

wl_test_recentpass

Define whether or not the watchlist should display a count of elements with tests that passed during the activity period.

Options: true or false

Default: false

wl_test_recentfail

Define whether or not the watchlist should display a count of elements with tests that failed during the activity period.

Options: true or false

Default: false

wl_test_recentdefer

Define whether or not the watchlist should display a count of elements with tests that were deferred during the activity period.

Options: true or false

Default: false

wl_test_recentnotchk

Define whether or not the watchlist should display a count of elements with tests that were not checked during the activity period.

Options: true or false

Default: false

wl_test_notrun

Define whether or not the watchlist should display a count of elements with tests that were not run during the activity period.

Options: true or false

Default: false

wl_feature_verified

Define whether or not the watchlist should display a count of elements with verified features during the activity period.

Options: true or false

Default: false

wl_feature_requested

Define whether or not the watchlist should display a count of elements with requested features during the activity period.

Options: true or false

Default: false

wl_feature_completed

Define whether or not the watchlist should display a count of elements with features completed during the activity period.

Options: true or false

Default: false

wl_feature_new

Define whether or not the watchlist should display a count of elements with new features added during the activity period.

Options: true or false

Default: false

wl_feature_incomplete

Define whether or not the watchlist should display a count of elements with incomplete features during the activity period.

Options: true or false

Default: false

wl_change_verified

Define whether or not the watchlist should display a count of elements with verified changes during the activity period.

Options: true or false

Default: false

wl_change_requested

Define whether or not the watchlist should display a count of elements with requested changes during the activity period.

Options: true or false

Default: false

wl_change_completed

Define whether or not the watchlist should display a count of elements with changes completed during the activity period.

Options: true or false

Default: false

wl_change_new

Define whether or not the watchlist should display a count of elements with new changes added during the activity period.

Options: true or false

Default: false

wl_change_incomplete

Define whether or not the watchlist should display a count of elements with incomplete changes during the activity period.

Options: true or false

Default: false

wl_document_verified

Define whether or not the watchlist should display a count of elements with verified documents during the activity period.

Options: true or false

Default: false

wl_document_requested

Define whether or not the watchlist should display a count of elements with requested documents during the activity period.

Options: true or false

Default: false

wl_document_completed

Define whether or not the watchlist should display a count of elements with documents completed during the activity period.

Options: true or false

Default: false

wl_document_new

Define whether or not the watchlist should display a count of elements with new documents added during the activity period.

Options: true or false

Default: false

wl_document_incomplete

Define whether or not the watchlist should display a count of elements with incomplete documents during the activity period.

Options: true or false

Default: false

wl_defect_verified

Define whether or not the watchlist should display a count of elements with verified defects during the activity period.

Options: true or false

Default: false

wl_defect_requested

Define whether or not the watchlist should display a count of elements with defects reported or 'requested' during the activity period.

Options: true or false

Default: false

wl_defect_completed

Define whether or not the watchlist should display a count of elements with defects completed during the activity period.

Options: true or false

Default: false

wl_defect_new

Define whether or not the watchlist should display a count of elements with defects added during the activity period.

Options: true or false

Default: false

wl_defect_incomplete

Define whether or not the watchlist should display a count of elements with incomplete defects during the activity period.

Options: true or false

Default: false

wl_issue_verified

Define whether or not the watchlist should display a count of elements with verified issues during the activity period.

Options: true or false

Default: false

wl_issue_requested

Define whether or not the watchlist should display a count of elements with issues reported or 'requested' during the activity period.

Options: true or false

Default: false

wl_issue_completed

Define whether or not the watchlist should display a count of elements with issues completed during the activity period.

Options: true or false

Default: false

wl_issue_new

Define whether or not the watchlist should display a count of elements with issues added during the activity period.

Options: true or false

Default: false

wl_issue_incomplete

Define whether or not the watchlist should display a count of elements with incomplete issues during the activity period.

Options: true or false

Default: false

wl_task_verified

Define whether or not the Watchlist should display a count of elements with verified tasks during the activity period.

Options: true or false

Default: false

wl_task_requested

Define whether or not the watchlist should display a count of elements with requested tasks during the activity period.

Options: true or false

Default: false

wl_task_completed

Define whether or not the watchlist should display a count of elements with tasks completed during the activity period.

Options: true or false

Default: false

wl_task_new

Define whether or not the watchlist should display a count of elements with tasks added during the activity period.

Options: true or false

Default: false

wl_task_incomplete

Define whether or not the watchlist should display a count of elements with incomplete tasks during the activity period.

Options: true or false

Default: false

wl_event_requested

Define whether or not the watchlist should display a count of elements with requested events during the activity period.

Options: true or false

Default: false

wl_event_high

Define whether or not the watchlist should display a count of elements with events set to high during the activity period.

Options: true or false

Default: false

wl_event_incomplete

Define whether or not the watchlist should display a count of elements with incomplete events.

Options: true or false

Default: false

wl_decision_verified

Define whether or not the watchlist should display a count of elements with verified decisions during the activity period.

Options: true or false

Default: false

wl_decision_requested

Define whether or not the watchlist should display a count of elements with requested decisions during the activity period.

Options: true or false

Default: false

wl_decison_completed

Define whether or not the watchlist should display a count of elements with decisions completed during the activity period.

Options: true or false

Default: false

wl_decision_new

Define whether or not the watchlist should display a count of elements with decisions added during the activity period.

Options: true or false

Default: false

wl_decision_incomplete

Define whether or not the watchlist should display a count of elements with incomplete decisions during the activity period.

Options: true or false

Default: false