Product Features
Integration

Manage Connectors

11min

After you add connectors to Litmus Edge, you can navigate to the Integration pane to manage them.

Filter and Search Connectors

You can filter and search for connectors from the Integration pane by clicking the Toggle Connector Filter icon.

Document image


Manage Individual Connectors

Refer to the image and callouts below for management options for connectors.

Management options for connectors
Management options for connectors


[1] Logs Enabled: Indicates that logging is enabled for the connector.

[2] Enable/Disable connector: Use the toggle to enable or disable the connector. The status will update to one of the following: Connected, Failed, or Disabled.

[3] Copy the Instance, Provider Identifier, and Instance Identifier.

[4] Edit connector: Update the fields for the connector.

[5] Purge connector: In the course of its operation, a connector persists inbound and outbound data. You might need to periodically purge the connector's data storage to avoid excessive use of disk space. Select this option to empty the connector's data storage.

[6] Remove connector: Remove the connector from the Integration pane.

[7] Manage Topics: Navigate to the Topics tab for the connector.

Enable Logging

When you enable logging for a connector, the log displays connection and publish-based error messages. This can increase CPU usage. Therefore, it is preferable to use logging only for debugging.

Notes:

  • The connector must be added and connected before logging can be enabled.
  • With the exception of the default connector, all connectors have logging capability.
  • Clicking the connector tile shows the details of the connector. You can view the logs section from there.
  • You can download and refresh log files from the Details pane.

To enable logging:

  1. From a connector tile within an Integration pane, click the Edit icon. The Edit Connector dialog box appears.
  2. Select the Enable logging check box, and then click Update. The Logging icon appears on the connector tile indicating that logging is active.
The enable logging icon
The enable logging icon


Access Connector Information

You can access device information and edit options by clicking the connector tile.

Connector Dashboard

After clicking a connector tile, the dashboard for the connector displays.

The connector dashboard
The connector dashboard


The dashboard displays the following information for the connector:

  • Size on Disk
  • Disk Usage
  • Persistence Size

For Disk Usage and Persistence Size, you can use the icons to manipulate the charts and also download the charts in SVG, PNG, or CSV format.

Connector Configuration

The Configuration tab allows you to review and update the fields for the connector.

Make updates as needed and click Update.

Connector Topics

The Topics tab allows you to add and manage topics for the connector.

Refer to the image and callouts below for options in the Topics tab.

Connector Topic options
Connector Topic options


[1] Show filter: Search for topics.

[2] The Add icon allows you to add topics individually or by CSV upload (as of Litmus Edge 3.11.0).

  • Add a new subscription: Add a topic to the connector. See the "Add a Topic to a Connector" section below to learn more.
  • Upload CSV: You can upload a csv file of topics.

[3] The Download icon allows you to download a CSV file of current topics in the connector or a sample of a CSV file you can use to upload.

  • Download a sample: Download a sample file that you can use to upload a number of topics for the connector.
  • Download CSV: Download a file of current topics in the connector.

[4] Import from DeviceHub tags: Import outbound topics to a connector from the DeviceHub tags. If you import DeviceHub tags for a CONNECTED connector, the connector will need to restart. All topics will be disabled upon initial import.

[5] Enable all topics: Enable all topics listed in the pane.

[6] Disable all topics: Disable all topics listed in the pane.

[7] Delete all topics: Delete all tags in the pane.

Connector Logs

To view the Logs tab, you must enable logging for the connector. To enable logging, edit the connector and select the Enable logging checkbox.

Refer to the following actions you can take from the Logs tab.

Document image


[1] Filter log messages by the last 24 hours, last 4 hours, last hour, and last 10 minutes.

[2] Download a file of the log.

[3] Refresh the log messages window.

[4] Delete all the current messages from the log message window.

Add a Topic to a Connector

See Add Topics to Connectors to learn about the different ways to add topics.

Manage Connector Topics

You can manage connector topics from the Topics tab.

To manage a topic, click the Action menu for the topic.

The action menu for a connector topic
The action menu for a connector topic

  • Edit: Update the parameters for the topic. You can also click the topic name to update parameters.
  • Remove: Remove the topic from the connector.
  • Enable/Disable: Enable or disable the topic for the connector.