Creating Live Connectors - EcoSys - Help - Hexagon

EcoSys Live Connectors

Search by Category
EcoSys Version

To create a Live Connector in EcoSys, follow the steps below:

  1. From the EcoSys application, navigate to Integration > External Data Sources.

  2. Click Edit > Create New

  3. Enter the value in the Data Source Name field and select the System Type value as OData.

    Additional values are added to the System Type selection box to support more web services formats.

  4. Click SAVE. After the Live Connector is created, you can define the data source.

  5. To define a Data source, perform the following steps:

    1. Subject Area Caption – Enter a value that is used to identify and work with EcoSys configuration elements related to the Live Connector.

    2. Use Authentication – If authentication is used while connecting to the external web service, check the Use Authentication check box and enter the appropriate values. The supported authentication types are:

      • OAuth2 Client Credentials

      • OAuth2 Password

        If authentication is used and the application server running EcoSys has been configured to use Java 8, you must download and install the Java 8 unlimited strength policy JAR files from the Java 8 JRE \lib\security directory.

        When using OAuth2, EcoSys will authenticate once and then cache the OAuth2 authorization tokens. To refresh the cache, navigate to System Information > Cache > Specify a Data Cache to Refresh > OAuth2 Token > click Refresh Enterprise Data Cache.

    3. Service Root URL – Enter the OData Service Root URL and click Get Schema to populate the available Entity Set(s). By default, EcoSys will cache the OData endpoint metadata, but this can be disabled by selecting the Bypass cache option.

    4. Entity Set – This drop-down contains all Entity Sets defined at the Service Root URL provided. Select the Entity Set that is used for the data source.

    5. Fields – Click the plus (+) and minus (-) buttons to determine which fields/properties from the Entity Set will be included in the data source for use within the EcoSys application. The details of the fields as defined in the Odata metadata will be displayed in a table with the following columns:

      • Field Name

      • Default Caption

      • Field Type

      • Data Type

      • Property Path

      • Is Collection

  • A field of type Internal ID must be added to each data source definition.

  • For each data source, fields must be designated to be used as EcoSys ID and EcoSys Name columns similar to those in the standard static subject areas in EcoSys.

    • The same field can be used for both ID and Name or two different fields can be used.

    • To set these, select a field and check the ‘Use as EcoSys ID/Name’ boxes to the right.

  • For fields of Data Type Enum, the items are displayed in a separate table to the right when the field is selected. You can change the Caption value for Enum items in this table if necessary.

  • To identify any properties in the Entity Set that are Collections, use the Is Collection option.

    • This option allows multiple values to be stored in a single property.

    • EcoSys accesses these Collection properties in a restricted fashion. An entire Collection is represented as a JSON string and stored as a string attribute.

  • For Joined Object field types, select the field and use the Join Subject Area option at the right to define which previously created OData data source the join will be made to.

    • This join relationship must already exist in the metadata for the underlying entity sets.