Skip to main content

Documentation Portal

Listing Indexed Tags

list-tags lists all tags which have are fully or partially indexed in TrendMiner.

  1. Download the support script package from the download server.

    Log in using your TrendMiner file server credentials. If you don't know these or your credentials are not working, please contact your TrendMiner Customer Success Manager or send a support request to support@trendminer.com

    Scripts are executable from every installation that has access to the TrendMiner server. There are different scripts for different operating systems included in the downloadable file (Windows, Linux, MacOS).

    This article focuses on the Windows version: the list-tags.exe script which can be executed on Windows machines.

  2. Create a configuration file e.g. "config-list-index.json". The content of the config file should look like:

    {
    "TrendMinerSearch": "https://trendminer.example.org", 
    "ClientId": "listindexedtags",    
    "ClientSecret": "123e4567-e89b-12d3-a456-426614174099"
}

    • TrendMinerSearch: the URL of the TrendMiner installation.

    • ClientId: The clientid can be created in ConfigHub -> Security -> Clients

      Important

      It is important to set the correct data source access permissions before triggering the batch indexing script. The indexing script uses a separate login flow to generate a security token. Logging in and out on the application itself does not have an effect on the token.

      To set the permissions the clientid needs to be added to an ACL (Access Management => Select Datasource => Add client). For more information about on how to create the clients, please refer to the userguide.

    • ClientSecret: The secret for the corresponding client In ConfigHub => Clients => Select Client => Options => Show secret)

  3. Run the script.

    • -config string 

      Configuration file to use (optional) (default "config.json")

    • -out string 

      File to write tag names to, use - for stdout (optional) (default "tags.txt")

    • -batch (optional) 

      Run without expecting user input

    Make sure the config file is in the same windows folder as the list-tags.exe

    Open a command window and run the list-tags.exe script with the correct parameters.

    Example commands:

    list-tags.exe -config config-list-index.json -out taglist.txt 

    list-tags.exe -out - 

Dans cette section​: