Web & Data Adapters

edgeCore ships with a base set of adapters as part of edgeData and edgeWeb however additional integrations with 3rd party applications can also be loaded onto the system. Contact Edge Support or your representative to obtain a list of adapters and the applications and versions supported.

  • Data Adapters: provide new data connection and feed types for a specific application. These may also contain content bundles with pre-configured feeds, transforms, visualizations, and pages to provide a way to get up and running fast.
  • Web Adapters: provide new web-content connection and feed types for a specific application.

Adapter Management & Installation #

To see the currently installed adapters, load or upgrade adapters, and check licensing status browse to the System Menu → Manage → Adapters as an administrator. This will launch the Adapters management page as shown below.

The Status column will display a Update Available button for any adapters that have newer versions available for install. Clicking the button will launch the install dialog.

New or updated adapters need to be obtained from Edge (contact Support) and are ZIP files with the format: vendor.product-x.y.z.zip where the x.y.z represents the version of the adapter. An adapter may support multiple versions of a specific application, refer to the compatibility matrix for more information. To install or upgrade an adapter:

  1. Place the adapter on the edgeCore server. There are two ways to do this:

    1. If you have permission to access the file system on the server, you can go directly on the server and drop the adapter package ZIP file into the [INSTALL_HOME]/modules/ directory on the server running edgeCore .
    2. [Recommended] On the Manage/Adapters page in the admin UI, you can click the “Upload Adapter” button while the Available Adapters tab is active. This will copy the adapter package ZIP file from your local machine to the [INSTALL_HOME]/modules/ directory on the server running edgeCore.

      All used adapter ZIP must remain in the [INSTALL_HOME]/modules/ directory as long as they are used on the system (until all content is removed or until after the adapter is upgraded to a newer version).

  2. Browse to the Adapters management page, or reload the page if the ZIP was only just added onto the server filesystem manually outside the UI (otherwise it will not be visible).
  3. Use the Available Adapters tab to view all of the installable adapters:

  1. Select an adapter and click the Activate Adapter button. A confirmation dialog will be shown if only one version is available, otherwise a list of versions (only newer if upgrading) is shown and a selection can be made as to which version to install.
  2. Note the installation process can take a few moments and when complete a notification will be shown:

  1. Closing this dialog the Installed Adapter list will updated to reflect the change.

Adapter Licensing #

Adapters must be licensed in order to use them and the licensing is based on the number of connections for connection types provided by that adapter. The current licensing status is reflected in the Installed Adapters list in the Connections column. This presents a count of (enabled) connections against the number of licensed connections. If any adapter exceeds the number of licensed connections the background color will change to red. Please contact Support or your account representative if additional licenses are required.

For convenience selecting an adapter and the edit (pencil) button, or double-clicking the row will open a dialog with a list of connections for that adapter. From here it’s possible to see the enabled state and whether sufficient licenses are available and how they are allocated.

See the License Management page for more information on licensing and how to update the license.

Content Bundles #

Some Adapters may include Content Bundles to provide out-of-the-box pipeline configuration and pages to get up and running fast. Note that there could be multiple content bundles if needed to support different version of an application, or simply to break up content into different groupings.

For convenience when install or upgrading an Adapter the Deploy Content Bundle button will be active if content bundles are available. Otherwise to deploy a bundle after installation:

  1. Browse to the Adapters management page.
  2. Select an adapter that contains content bundles. The Installed Adapters list includes a column Content Bundles to indicate whether an adapter includes any bundles.
  3. Click the Deploy Content Bundle button at the bottom left to start the process:
  4. Complete the form:
    1. Select the version of the application, this may further restrict the list of available Content Bundles to only those that apply.
    2. Select the Content Bundle.
    3. Using a Deployment Prefix is optional. When content is added to the system many elements may need unique names, if a collision is detected during deployment it will fail and roll back the change. The Deployment Prefix is appended to places that require unique names and is especially useful if deploying the same content bundle multiple times.
    4. Click the Deploy button.
  5. Upon completion there will be new connection(s), feeds, transforms, visualizations, pages, and menu items. Note that new connections will require configuration, and other configuration may also be needed for the new content to work correctly. Refer to the adapter documentation for more information.