Modifying Integration Name & Acronym

Change your Integration name, acronym, and description

You might want to change the name, acronym, or description of an integration that you already have installed. This is particularly useful when you're using an integration such as Splunk, Elasticsearch, PostgreSQL or any other integrations that connect to data sources that can store a wide range of data. By changing the name to something more specific, your users will be able to more easily identify the purpose and value of the integration.

If you are looking to install a second copy of an integration (which also involves changing the integration's name), see the below guide.

Install Multiple Copies of an Integration

Modify config.js

To change an existing integration's name, acronym, or description, you will need to modify the integration's config.js file which is located within the config directory of the integration's directory. Open it with a text editor on your server:

sudo vi /app/polarity-server/integrations/INTEGRATION_NAME/config/config.js

Once the config.js file is open you will see the name and acronym properties near the top of the file. As an example, the Splunk integration will look similar to this:

module.exports = {
  name: 'Splunk',
  acronym: 'SPLNK',
  description: 'Splunk allows you to aggregate, analyze and get answers from your machine data with the help of machine learning and real-time visibility.',
  ...
}

Modify the name, acronym, and optionally the description to your new values. For the name property we generally recommend appending a descriptor to the base name of the integration. For the acronym property we recommend using all caps and keeping it short. Here is an example of a modified config.js file:

module.exports = {
  name: 'Splunk - Firewall',
  acronym: 'SPLNK-FW',
  description: 'Search firewall logs in Splunk.',
  ...
}

Ensure the values you use remain enclosed within single quotes and that the end of each line maintains the trailing comma.

Once you've made your changes, save the file.

Increment Integration Version

In order for the Polarity Server to pick up the configuration changes, you will need to increment the integration's version. The version of the integration is located within the integration's package.json file. Open it with a text editor on your server:

sudo vi /app/polarity-server/integrations/INTEGRATION_NAME/package.json

Once open, find the version property and append a dash and a counter to signify that you have made a modification to the integration. In the example below the base version was 3.3.0 and we modified it to be 3.3.0-1

{
  "main": "./integrations.js",
  "name": "Splunk",
  "description": "Splunk Query Engine",
  "version": "3.3.0-1",
  ...
}

We leave the base version as is so that we still know what version of the official integration you are running.

Restart the Integration

Finally, you can restart the integration from the integration's settings page within the Polarity interface by clicking on the "Actions" drop down in the top right and selecting "Restart Integration"

Restart the integration for changes to take effect

After the integration restarts you should see your updated integration name, acronym, and description.