| Prev | Next |
WebConfig - Add or Edit an Integration Data Provider
The 'Add Data Provider' and 'Edit Data Provider' screens allow you to configure an Integration Data Provider. The options provided are the same in both cases, except that when editing you cannot modify the Provider and Prefix.
Wherever possible the Add/Edit Data Provider screen will fill each field with a default value in order to make it easier for you; if the default values are not correct, simply overwrite them.
The Integration settings are broken up into a number of groupings.
Data Provider
This group of settings contains the basic information to identify the Data Provider and determine how the Plug-in communicates with the Provider Server.
Item |
Description |
See also |
|---|---|---|
|
Enabled |
This value controls if the Integration Server (SBPI.exe) should allow communications to be forwarded to this Data Provider. |
|
|
Name |
This value represents the friendly name for the current Data Provider, it will be shown to users of Enterprise Architect. |
|
|
Provider |
This value specifies the Provider type of the current Data Provider. When this value is changed a number of other fields could be automatically updated. |
|
|
Group |
This field is available only when the 'Custom Integration' provider type is selected. Typically in Enterprise Architect, integrations are grouped by the Provider type (such as 'Jira' or 'Dropbox'). For Custom Integrations, the Grouping is applied based on the value entered in this field. |
|
|
Prefix |
This value represents a short unique name to identify the current Data Provider. This value will be saved against every Enterprise Architect element that is linked to an external element. |
|
|
Auto Start |
This value controls if the Integration Server (SBPI.exe) should maintain a running process (*sbpi.exe) for this Data Provider. For standard Integration Plug-ins we would expect this value to be checked; however, for custom ones it might be useful to not auto-start the Plug-in and instead manually control when it is running, particularly while developing it. |
|
|
Port |
This value represents the Port that the Integration Server should use to communicate with the Integration Plug-in. The Integration Server assumes the Port is relative to the current machine (or http://localhost:{port}). Each Integration Plug-in requires a unique Port number, which will be checked when an attempt is made to save the Plug-in's settings. However the Pro Cloud Server can only check what Ports are in use by the Pro Cloud Server itself and its components, there is still a possibility of a Port clash with other applications. |
|
|
DLL Path |
This field is only available for 'Custom Service' and 'Custom Integration' provider types. This value represents the physical path to the custom DLL, that will be called by the CustomService.exe or CustomIntegration.exe Data Provider processes. |
Custom Properties
The Custom Properties section is only shown for Data Providers of type 'Custom Service'. This table allows you to define Item/Value pairs that can be used by the Custom Service.
Item |
Description |
See also |
|---|---|---|
|
Item |
The 'name' of the custom property. |
|
|
Value |
The value of the custom property. |
|
|
Actions |
This column provides Action buttons which apply to the property in this row. Accept New Custom Property - This appears when adding or editing a property. Click this button to save the Item/Value. Edit Custom Property - Click this button to allow editing of the property's item/value. Delete Custom Property - Click this button to delete the property. |
Provider Server
This group of settings relates to the details of the external data provider, such as Dropbox or Jira. The Integration Plug-in will use the defined details to connect to the remote system and retrieve data from it so that it can be sent back to Enterprise Architect. The combination of Protocol, Server Name and Port must be resolvable by the server hosting the Integration Plug-in, which in the simplest case is the Pro Cloud Server.
Item |
Description |
See also |
|---|---|---|
|
Provider URL |
The Provider URL consists of these four fields, which make up the URL that the Plug-in will use to access the external data.
For example, it is possible to use another Enterprise Architect model as an external data source; in this case the 'Protocol', 'Server' and 'Port' determine the Pro Cloud Server (for example, http://myEAServer:804) while the 'URL Folder' is the DB Alias of the repository (myModel). Thus: http://myEAServer:804/myModel Below these fields is a label showing the full URL that will be used by the Plug-in (based on the values that have been entered). |
|
|
Ignore SSL Errors |
This option is only displayed if the protocol 'HTTPS' has been selected. This checkbox controls if the Integration Plug-in should ignore SSL related errors that occur as a result of communicating with the external system. |
|
|
Authentication |
Default Value: Credentials This value allows the selection of the type of Authentication that should be used for the Provider, the valid options are Credentials and OAuth. When 'Credentials' is selected it would be expected that a User Name and Password would be entered. When 'OAuth' is selected and additional five fields are displayed (Client ID, Client Secret, etc). For details on using these fields, refer to the Data Provider Advanced Authentication topic (this describes the equivalent fields in the PCS Configuration Application). Note 1: this option is only available if the selected Provider supports multiple forms of authentication, for example: Dropbox, Jira, Salesforce, ServiceNow, SharePoint and Wrike Note 2: this option was introduced in Pro Cloud Server v5.0 build 100, prior releases only support credential based authentication. |
|
|
Username |
This value represents the user name that should be used (in combination with the password) to access the data within the external system. If a value is defined in this field all Enterprise Architect users of the current Data Provider will use the same set of credentials to read the external system. Otherwise if the user name field is left empty, Enterprise Architect will prompt each user independently for their credentials. |
|
|
Password |
This value represents the matching password for the specified user name. |
|
|
Create Items |
This checkbox controls if Enterprise Architect users are able to create new items within the external system. |
|
|
Modify Items |
This checkbox controls if Enterprise Architect users are able to modify the details of external items within the external system. |
|
|
Post Discussions |
This checkbox controls if Enterprise Architect users are able to create discussions against elements within the external system. |
|
|
Maximum Request Time (sec) |
This value represents the maximum amount of time (in seconds) that calls to the Provider system will wait before timing out. Increasing this value is particularly useful when the Provider systems are remote or have slow performance. The default value is 60 seconds. Note: This is a new setting introduced in Pro Cloud Server v4.2 build 65. |
Logging
This group of settings relates to how the Integration Plug-in will create entries in its log file(s). Since the Integration Plug-ins run without user intervention, it is important for them to be able to write any messages or potential problems to a log file. However, special consideration must be given to ensuring that performance isn't impacted by writing to such files, which is possible if the log file continually grows without limits. It is also unreasonable to expect that manual intervention should be required to ensure that the size and number of log files don't impact performance. For these reasons each Integration Plug-in has its own set of log files and configuration options to manage its log files.
The current log file will always include a '1' on the end of its filename. A new log file will be created whenever the Integration Plug-in is started or the physical size of the current log file reaches the Max File Size. When this occurs all existing files will be 'rolled over', meaning their file numbers will be incremented and a new '{filename}1.log' created. If the roll over process causes more files to exist than the 'File Count' setting allows, these additional files will be deleted.
Item |
Description |
See also |
|---|---|---|
|
File Count |
Default value: 3 This value represents the 'rolling' number of log files that should be retained for the current Integration Plug-in. |
|
|
Max File Size |
Default value: 1048576 This value represents the maximum number of bytes a log file can be before a new one is created. |
|
|
Level |
Default value: WARNING This value represents the maximum level of messages that should be written to the log file. The levels are: OFF, FATAL, WARNING, INFO and SYSTEM. A defined log level is inclusive of all lower levels, therefore if a Plug-in is set to a log level of INFO then all FATAL, WARNING and INFO messages will be written to its log file. |
|
|
Directory |
(READ-ONLY) This field displays the physically location of where the log files for the current Data Provider will be saved. |
Proxy
This group of settings relate to how the Integration Plug-in should communicate with the External Data Provider when they are separated by a Proxy Server.
Item |
Description |
See also |
|---|---|---|
|
Server Name/IP |
The server name (or IP) and Port number of the Proxy Server. For example, proxyserver.com:3131 |
|
|
Bypass |
This field provides a mechanism for certain addresses to bypass the proxy; it accepts multiple values separated by semi-colons (;). For example, 192.168.*;*.localdomain.com;www.mydomain.com |
|
|
User Name |
If the Proxy Server requires credentials, then enter the user name into this field. |
|
|
Password |
If the Proxy Server requires credentials, then enter the password into this field. |