CSV On-Prem plugin

The CSV plugin allows you to visualize CSV data, which can be either read from a CSV file or entered manually.

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Before you start

The CSV plugin is a "hybrid" plugin, meaning it is available in both cloud and on-prem versions. If you wish to use the cloud version of the plugin which does not require a relay agent to be configured, see CSV plugin.

For guidance on deploying relay agents, see the following depending on your platform type:

Configuring an agent for a CSV data source

When configuring the data source, there are certain CSV locations you can specify (such as the Windows Folder option) that use Access Control Lists (ACLs) to determine which identities can access the files.

By default, the Relay agent service utilizes your local system identity, meaning you must ensure that your system identity can access your CSV files via an appropriate ACL. For example, if you want to read a CSV from a Windows Folder, you must ensure that the system identity used by the Relay agent is contained in the ACL of your specified Directory location.

CSV ACL permission
In the more complex scenario of remote UNC paths this may require you to use an account capable of accessing the network and network share, and ensuring that it the account is present in the remote ACL. This could also include configuring the identity as the Network Service account or as a specific Domain User account.

Configuring the data source

  1. Display Name:
    Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

  2. Agent Group:
    Select the Agent Group that contains the agent(s) you want to use.

    When selecting an agent group, be careful about mixing agent types. If you have a group composed of Linux and Windows agents, there could be potential issues when attempting to read a CSV file from a Windows based location on Linux, and vice versa.

  3. Restrict access to this data source:
    You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

  4. Click Update to add the plugin.

Next steps

Once you've added the plugin, you can start using the following data streams to create dashboards to visualize your data.

Data streams

Data stream
Description
Parameters
File
Allows you to visualize data imported from a CSV file. You must specify the location of the file you want to read data from.
  1. CSV location:
    Select the location of the CSV file you want to read. Choose from:
    • Web URL:
      Specify the URL of the CSV file.
    • Windows File (Windows Relay agent):
      Specify the Directory and File location of the CSV.
    • Windows Folder (Windows Relay agent):
      Specify the Directory location to get the most recently created CSV from.
    • Linux File (Linux Relay agent):
      Specify the Directory and File location of the CSV.
    • Linux Folder (Linux Relay agent):
      Specify the Directory location to get the most recently created CSV from.
  2. Has Header Row:
    Select this checkbox if the file you are reading treats the first row as a header. If left unchecked, then numbers are used to represent the data column headers.
  3. Advanced Options:
    Click to display the following additional configuration options:
    • Delimeter:
      Enter an alternative delimiter for the data in the CSV file. For example, a semicolon ";".
    • Skip Lines:
      Enter the number of lines in the file to skip before importing CSV data. This is useful in circumstances where the file includes some sort of intro text.

    • Ignore Certificate errors:

      If you activate this checkbox the data source will ignore certificate errors when accessing the server. This is useful if you have self-signed certificates.

Raw Text
Allows you to manually specify CSV data to visualize.
  1. CSV Text:
    Enter or paste the CSV data that you want to visualize.
  2. Has Header Row:
    Select this checkbox if the file you are reading treats the first row as a header. If left unchecked, then numbers are used to represent the data column headers.
  3. Advanced Options:
    Click to display the following additional configuration options:
    • Delimeter:
      Enter an alternative delimiter for the data in the CSV file. For example, a semicolon ";".

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket