Prev Next

WebConfig - Integration Plug-ins

The 'Integration Settings' page allows you to configure integration plug-ins to be used with Pro Cloud Models. These plug-ins enable data from external providers to be displayed within Enterprise Architect. This component is only available in the licensed editions of Sparx System Pro Cloud Server; that is, Token, Team and Enterprise editions.

The Integration Plug-ins component is also known as the Server Based Plug-in Interface (SBPI).

Integration Settings

The 'Integration Settings' section refers to the configuration of the Pro Cloud's Integration Server. The Integration Server communicates with one or more Integration Plug-ins, each of which provides the integration with a specific product such as Jira or Confluence.

Typically, if the Integration Server is run on the same machine as the Pro Cloud Server, and Port 8080 is not in use, then the default settings can be used.

To make the Integration Server configuration as easy as possible for the majority of users, version 4.1 of the Pro Cloud Server has introduce a simplified set of options, however if the default configuration does not suit your environment, check the 'Use Legacy Settings' option to show all the available options.

Item

Description

See also

Enable Integration

This checkbox enables (or disables) Integration Plug-ins for the current Pro Cloud Server installation.

Port

Default value:  8080

This option is only shown when the 'Use Legacy Settings' option is unchecked. It defines the Port the Integration Server is listening to for requests from the Pro Cloud Server.

SBPI Server URL

This option is only shown when the 'Use Legacy Settings' option is checked.

The SBPI Server URL consists of three components. When combined these settings form the Integration Server's URL that the Pro Cloud Server will send SBPI related requests to.

Note: The complete URL ({protocol}://{server-name}:{port} needs to be resolvable by the Pro Cloud Server machine.

  • Protocol
    This field defines the SBPI Server's Protocol.
  • Name/IP
    This field defines the SBPI Server's machine name or IP.
  • Port
    This field defines the SBPI Server's Port.

Use Legacy Settings

Default value:  Unchecked

This checkbox determines if the simplified or complex set of options should be shown.   The name refers to the fact that the earlier versions of the Pro Cloud Server required users to fill-in the complex set of options. In later versions of the Pro Cloud Server the set of options needed was greatly reduced by making some assumptions that will be true for the majority of environments.

Ignore SSL Errors

Default value:  unchecked

This option is only shown when the 'Use Legacy Settings' option is checked. 

This value defines if SSL related errors that occur while communicating with the Integration Server component should be ignored.  The most common SSL errors are related to self-signed certificates; by default a client does not treat self-signed certificates as being secure, therefore in order to connect to servers that use self-signed certificates this option should be checked.

Use Proxy

This value defines if the Integration Server is operating behind a proxy, and if Enterprise Architect clients are required to connect to one URL but the Integration Server is physically listening for requests on a completely different URL.  In most environments this option should be set to the default value of unchecked.

Attempt URL Auto Discovery

Default value:  checked

This option is only shown when the 'Use Legacy Settings' option is checked.

This option defines if the Pro Cloud Server should automatically attempt to determine the Enterprise Architect client's network address and supply that to the Integration Server. 

This option was introduced in Pro Cloud Server 4.1.40; earlier versions were not capable of discovering the client's network address.

When Auto Discovery is checked, the following setting is the 'Fallback URL', which will be used only if the Auto Discovery fails. When Auto Discovery is unchecked, the following setting is the 'Absolute URL' which will be used in all cases.

Absolute URL

The Absolute URL consists of three components. When combined these form the resolvable URL that Enterprise Architect clients can communicate to the SBPI server.

Note: The complete URL ({protocol}://{server-name}:{port} needs to be resolvable by the Pro Cloud Server machine.

In some environments server URLs are redirected to completely different locations, therefore to handle this situation the absolute URL is returned to Enterprise Architect clients so that they can communicate to the SBPI Server.

  • Protocol
    This field defines the URL's Protocol.
  • Name/IP
    This field defines the URL's machine name or IP.
  • Port
    This field defines the URL's Port.

Integration Providers

A single Pro Cloud Server can support any number of external Data Providers and, in turn, each of the external Data Providers can be available to as many models as are supported by the installation's license. Please note only Pro-enabled Model Connections can access external data providers. A Pro-enabled Model Connection is one that has the 'Enable Pro Features (OSLC, WebEA and Integration)' option checked.

The 'Integration Providers' section provides this information:

Item

Description

See also

Name

A friendly name that describes the provider; this value will be displayed within Enterprise Architect.

Provider

The type of external provider.

Prefix

A short, unique value for the provider. This value is added to each external link within Enterprise Architect.

Port

The Port the Integration Plug-in is configured to listen to.

Bindings

Bindings refer to the model connections that will have access to this Integration Plug-in. These can be configured via the 'Actions' column.

Actions

Provides options to either:

  • Edit the Integration Provider's settings
  • Configure Model Bindings, or
  • Delete the Integration Provider
WebConfig - Add or Edit an Integration Data Provider

Add a Provider

The final item is a link to add a new provider.

WebConfig - Add or Edit an Integration Data Provider

Learn more