Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Integration Service

TABLE OF CONTENTS

Integration Settings Editor

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedFeb 28, 2025
  • 5 minute read

The Integration Settings Editor provides a graphical interface for configuring AVEVA™ Integration Service (Service) to various Dabacon and non-Dabacon data sources. You can start Integration Settings Editor from Start > AVEVA > Integration > Integration Settings Editor. Alternatively, you can double-click AVEVA.IntegrationService.UX.exe from the installed location <installation location>\AVEVA\Shared\AVEVA Integration Service.

The screen shot highlights the various elements of the Integration Settings Editor dialog box.

The descriptions of the elements are as follows:

  1. Configuration API Endpoint: Specifies the URL for the Configuration API. You can edit this URL based on how you have configured your Configuration API. For information about Configuration API, see Configuration API and Data API.

  2. Data API Endpoint: Specifies the URL for the Data API. You can edit this URL based on how you have configured your Data API. For information about Data API, see Configuration API and Data API.

  3. REST API Endpoint: Specifies the URL for the REST API. You can edit this URL based on how you have configured your REST API.

  4. WebAdmin API Endpoint: Specifies the URL for the WebAdmin API. You can edit this URL based on how you have configured your WebAdmin API.

  5. Connect: Use to connect to the Configuration API and Data API.

  6. Port (WCF): The port number for the Service.

  7. Map Network Drive: Maps network drives with the Service. The mapping enables the Service to access Dabacon projects that are mapped in the server machine using a network drive. See Mapping Network Drives for more information.

  8. Start Service: Starts the Service. You must be connected to the Datasource Store URL (IntegrationServiceConfigAPI Endpoint), Data Store URL (IntegrationServiceDataAPI Endpoint), REST URL (IntegrationServiceRESTAPI Endpoint) and Webadmin URL (IntegrationServiceWebAdmin Endpoint).

  9. View Service Log: Displays the log file which contains the details of activities performed between the start and end of the Service. The log file is named as IntegrationService_MMDDYYYY.log (For example, IntegrationService_02122023.log).

  10. Exit: Exits the Integration Settings Editor dialog box.

  11. Enable WCF API: Default enabled. If unchecked, the WCF API is not exposed.

  12. Service Access Token: To configure and store the Service Access Token in AVEVA PCS for integrating with AVEVA Integration Service on CONNECT.

  13. Stop Service: Stops the Service.

  14. Clear Service Log: In earlier releases this cleared the service log file. This has changed. Selecting Clear Service Log now displays this warning dialog.

    To clear the log file:

    1. Go to C:\Program Files (x86)\AVEVA\Shared\Logs

    2. Using admin privileges, open the log file based on created date.

    3. Clear the log content from the file

  15. Save: Saves the configurations. On saving, the connection details for the data sources would be stored with encryption in the AISDataSource.db file.

  16. Select Product: Lists the installed Dabacon and non-Dabacon products. You need to select a product to communicate and retrieve the data through Service.

  17. Module Name: Lists the module names based on the product you selected in the Select Product list.

  18. Select Project: Lists the projects configured for the specific product. On selecting the required project from the list, the data sources configured for the project are displayed.

  19. Configure Units: Opens the Configure Units dialog box through which you can configure the units for the data from a Dabacon data source. For more information, see Configuring Units.

  20. Add Configuration: Used for configuring the data sources in the Service. For more information, see Configuring AVEVA Integration Service for Various Data Sources.

  21. Delete Configuration: Deletes the selected configuration.

  22. Data Grid: Consists of columns and rows describing the values of the data source such as Name, Project, Product, Server, Environment, Data Format, Database, UID and Authentication of the selected product. You can specify values for the following columns:

    • UseProjectUnits: Applicable only to Dabacon data sources. Select the check box if you want to use project units instead of the Dabacon units. Also, you need to select the check box if you want to configure the data source units to match those of the client. For more information about how to configure the units, see Configuring Units.

      The check box is selected by default for new configurations that have been added using version 1.5.1 or later.

    • Name: Lets you specify the name of the data source. The name of the data source must be unique and must not contain special characters other than _ (underscore), - (hyphen) and space.

    • UID: Displays the auto-generated ID of the configuration.

      The need to change the UID arises only when you want to add back a configuration that you have deleted. By changing the UID of the new configuration to the UID of the deleted configuration, you can use the Compare/Update feature of the AVEVA data sources without recreating the configurations in Compare/Update.

      Caution: Setting an incorrect UID to a configuration can lead to undesired consequences. Therefore, do not change the UID unless you know the UID of the deleted configuration.

    • Authentication: Editable only for Dabacon data sources. Through the value of the column, you can specify the type of authentication that needs to be performed while accessing data from the data source. The following points must be noted about this column:

      • By default, the value is set to No. This implies that the user will not be prompted for a password at the time of retrieving data. The credentials provided while configuring the data source are used for retrieving data. For more information about configuring data sources, see Configuring AVEVA Integration Service for Various Data Sources.

        Important: If Authentication is set to No, then users are not authenticated. As a result, any user who has access to your network can retrieve the data from the Service without being authenticated. Therefore, to ensure data security, Authentication must be set to User or Connect.

      • If you set the value to User, the credentials of the user logged on to the client product are used for authentication. If no user is currently logged on, then the user is prompted for a username and password. To change to this authentication type, the data source must have been created using a Free user account. Data sources created using a General user account cannot use this authentication type. For more information about the Free and General user accounts, see User Account Types in AVEVA Integration Service.

      • If you have added the data source using CONNECT, the value is set to Connect and is not editable. At the time of retrieving data from the data source, the CONNECT credentials of the user logged on to the client product or Integration Client are used. If no user is logged on, then the user is prompted to provide the CONNECT credentials. For the list of data sources you can configure using CONNECT authentication, see Data Sources Supporting CONNECT Authentication. For information on how to configure these data sources, see the section for your data source in Configuring AVEVA Integration Service for Various Data Sources.

    • KeepConnectionAlive: Enables you to keep the connection alive for Dabacon products. For more information about this functionality, see Keep Connection Alive for Dabacon Data Sources.

  23. Message area: Displays the status of the action performed.

TitleResults for “How to create a CRG?”Also Available in