Topics
Prev Next

How to configure WebEA models

All WebEA configuration is controlled by a single file, which must reside in the '\includes\' folder and which must have the name 'webea_config.ini'.

The configuration file is a plain text file. 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 can not 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 Service'). This group of settings defines how WebEA will connect and communicate with the Cloud Service for data retrieval.

All communication between WebEA and the Cloud Service 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 Cloud Service.

Options: http or https

Default: http

Example: sscs_protocol = "http"

sscs_port

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

Default: 80

Example: sscs_port = "804"

Cloud Server Configuration

sscs_server

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

Default: localhost

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

sscs_use_ssl

Defines if all communications between WebEA and Cloud Services 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_user_ssl = "false"

sscs_db_alias

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

Default: ea

Example: sscs_db_alias = "RepositoryName"

Configure Database

sscs_enforce_certs

When SSL is set to true this option defines whether or not cURL will enforce that the certificate installed in Cloud Services is correctly signed by a Certificate Authority.

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

Options: true or false

Default: true

Example: sscs_enforce_certs = "false"

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 validate if the user/password combination can access the model on the Cloud Server.

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 validate if the user/password combination can access the model on the Cloud Server.

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 behavior is not dependant on the 'login_prompt' setting, the two settings can be used in combination with each other or independently. The most secure method would be to define an authorization code and set 'login_prompt' to true.

login_prompt

Defines whether or not all WebEA users must enter a model user/password before they can access the model.

Options:  true or false

Default: false

Example:  login_prompt = "false"

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 Cloud Services for validation.

Options: true or false

Default: false

Example: login_allow_blank_pwd = "false"

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"

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"

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"

prop_sec_<section>_visible

Defines whether or not a property section is visible.

The property view includes numerous sections that can be optionally hidden, which is particular useful if a model is being configured for a group of users that are not interested in the finer details of elements or Packages.

<section> can be one of:

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

Options: true or false

Default: true

Example: prop_sec_testing_visible = "true"

prop_sec_<section>_expanded

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
  • 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 two layouts. Either Icon view (the default) or List view.

Options: icon or list

Default: icon

Example: default_main_layout = "list"

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"

Model update settings

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

Note: Within the Cloud Service it is possible to configure a model as 'Read-only'; this setting in the Cloud Service will override any WebEA update setting, forcing them to 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.

Options: true or false

Default: false

Example: add_objects = "true"

add_objecttype_<type>

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.

<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.

Options: true or false

Default: false

Example: add_object_features = "true"

add_objectfeature_<type>

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.

<type> can be one of:

  • tests
  • resources
  • changes
  • 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.

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.

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 Watch list 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 watch list 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 watch list 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 watch list should display a count of added/modified diagrams during the activity period.

Options: true or false

Default: false

wl_recent_element

Define whether or not the watch list should display a count of added/modified elements during the activity period.

Options: true or false

Default: false

wl_resalloc_active

Define whether or not the watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list should display a count of elements with tests that were not run during the activity period.

Options: true or false

Default: false

wl_change_verified

Define whether or not the watch list 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 watch list 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 watch list 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 watch list 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 watch list should display a count of elements with incomplete changes during the activity period.

Options: true or false

Default: false

wl_defect_verified

Define whether or not the watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list 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 watch list should display a count of elements with requested events during the activity period.

Options: true or false

Default: false

wl_event_completed

Define whether or not the watch list should display a count of elements with events completed during the activity period.

Options: true or false

Default: false

wl_event_high

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

Options: true or false

Default: false

wl_decision_verified

Define whether or not the watch list 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 watch list 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 watch list 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 watch list 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 watch list should display a count of elements with incomplete decisions during the activity period.

Options: true or false

Default: false