Configure WebEA models - via Text Editor

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: Using https requires you to have a Port configured for https access and an SSL certificate as described in the 'Add a Port Definition' topic. 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"

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"

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"

sscs_access_code

When configuring a Pro Cloud Server model connection / database manager an optional 'OSLC Access Code' can be defined.

If the model connection has an 'OSLC Access Code' assigned then it will need to be included in the WebEA configuration using the 'sscs_access_code' setting.

Example: sscs_access_code = "myoslcaccesscode"

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"

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"

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

auto_login_windows_auth

When set to "true", WebEA will automatically attempt to login using Windows authentication (bypassing the 'Login' screen). If the Windows login fails then the 'Login' screen will be displayed, allowing the user to manually enter credentials.

Options: true or false

Default: false

Example: auto_login_windows_auth = "true"

Note: This option only applies if the model has the user security 'Accept Windows Authentication' option enabled. See the 'Maintain Users' help topic for details.

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_search

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

Options: true or false

Default: true

Example: show_search = "false"

show_watchlist

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

Options: true or false

Default: true

Example: show_watchlist = "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"

prop_sec_<section>_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
• requirements
• constraints
• 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_<section>_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. The GUID of any diagram can be obtained from WebEA by loading the diagram properties.

If this option is not set then WebEA will load either:

• The user default diagram, as defined in Enterprise Architect
• The model default diagram, as defined in Enterprise Architect (if no user default is set), or
• The model root (if no user/model defaults are set)

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

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

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

show_diagram_objs

Defines the visibility of diagram-only objects such as Notes, Text and Boundaries in the Browser. Wehen displayed these objects are grouped in an collapsible [...] node.

Options: true or false

Default: false

Example: show_diagram_objs = "true"

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

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

show_breadcrumb

Defines the display of the full path (or 'breadcrumb') to the current object in WebEA's navbar. When set to false, the navbar will display the current object name only.

Options: true or false

Default: true

Example: show_diagram_objs = "true"

show_comments

Defines whether comments are accessible in WebEA. When set to 'true', comments will be accessible via the Discuss & Review window's 'Journal' tab.

Comments will also be accessible via the Object Properties View, if the object has any comments defined.

Options: true or false

Default: false

Example: show_comments = "true"

show_chat

Defines whether Model Chat is accessible in WebEA. When set to 'true', Model Chat will be accessible via the Chat & Mail View's 'Chat' tab.

Options: true or false

Default: false

Example: show_chat = "true"

Note: As with Enterprise Architect, Model Chat is not available in models which do not have user security enabled.

chat_notify_sec

Defines how frequently (in seconds) WebEA will check for new Chat messages and display/update the Chat Notification which appears in the WebEA status bar.

Default: 30

Example: chat_notify_sec = "30"

show_mail

Defines whether Model Mail is accessible in WebEA. When set to 'true', Model Mail will be accessible via the Collaboration View's 'Mail' tab.

Options: true or false

Default: false

Example: show_mail = "true"

Note: As with Enterprise Architect, Model Mail is not available in models which do not have user security enabled.

mail_days

Defines how many days worth of messages are displayed in the Model Mail Inbox and Sent Mail lists.

Default: 90

Example: mail_days = "90"

Note: Reducing this number can improve performance when loading the Inbox/Sent Mail.

show_discuss

Defines whether Discussions are accessible in WebEA. When set to 'true', Discussions will be accessible via the Collaboration View's 'Reviews' and 'Discussions' tabs.

Discussions and Reviews will also be accessible via the Main View - Object Properties, and the Properties View.

Options: true or false

Default: false

Example: show_discuss = "true"

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"

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"

add_objects

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

Options: true or false

Default: false

Example: add_objects = "true"

edit_object_notes

Defines whether or not the notes of elements can be edited. 

Options: true or false

Default: false

Example: edit_object_notes = "true"

edit_object_tags

Defines whether or not the tagged values of elements can be edited. 

Options: true or false

Default: false

Example: edit_object_tags = "true"

add_diagrams

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

Options: true or false

Default: false

Example: add_diagrams = "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".

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.

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

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.

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"

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