Home
Home
German Version
Support
Impressum
22.3 Release ►

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JiveSoftware Jive Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Azure Principal Resolution Service
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SAP KMC Connector
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - SharePoint Online Connector
      • Configuration - Sitecore Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Configuration - Zoho Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Jive Sitemap Generator
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
    • Configuration
      • CAS_Authentication
      • Cognito JWT Authentication
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Notifications
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - QueryExpr Label Transformer Service
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • Non-Inverted Metadata Item Transformer
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - MMC_ Services
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • app.telemetry Statistics Regarding Search Queries
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • InSpire Support Documentation
      • Mindbreeze InSpire SFX Update
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Handbook

    Command Line Tools

    Copyright ©

    Mindbreeze GmbH, A-4020 Linz, 2022.

    All rights reserved. All hardware and software names used are trade names and/or trademarks of the respective manufacturers.

    These documents are strictly confidential. The transmission and presentation of these documents alone does not constitute any rights to our software, services and service results or other protected rights. The transmission, publication or reproduction is not permitted.

    For reasons of easier readability, gender-specific differentiation, e.g. users, is not used. Corresponding terms apply to both sexes in the sense of equal treatment.

    mesindexclientPermanent link for this heading

    IntroductionPermanent link for this heading

    With the mesindexclient command line tool, metadata in existing indices can be extended and completed from local data, and metadata from existing indices can be exported to local files.

    UsagePermanent link for this heading

    The following help can be called up in the inspire container using "mesindexclient --help".

    usage: mesindexclient [-h] --host HOST

                           [--auth-server-baseurl AUTH_SERVER_BASEURL]

                           [--client-id CLIENT_ID] [--client-secret CLIENT_SECRET]

                           [--realm REALM] [--username USERNAME]

                           [--password PASSWORD] [-v]

                           {update-metadata,fetch-metadata}

    Mindbreeze Index Client.

    positional arguments:

    {update-metadata,fetch-metadata}

                             Command

    optional arguments:

    -h, --help             show this help message and exit

    --host HOST            target host name

    --auth-server-baseurl AUTH_SERVER_BASEURL

                             auth server baseurl (in keycloak before

                             /auth/realms...)

    --client-id CLIENT_ID

    --client-secret CLIENT_SECRET

                             client secret

    --realm REALM          authentication realm

    --username USERNAME    user name

    --password PASSWORD    password

    -v, --verbose          verbose

    mesindexclient update-metadata -help

    mesindexclient fetch-metadata --help

    Detailed explanation of the argumentsPermanent link for this heading

    --host

    Inspire Server URL

    --auth-server-baseurl

    Authentication Server URL

    --client-id

    ID of the client

    --client-secret

    client secret if needed for authentication

    --realm

    Keycloak Realm

    --verbose

    Output of the individual steps

    --username

    Username of a user with the Role “InSpire Index Writer”

    --password

    Password of the user

    mesindexclient update-metadata -helpPermanent link for this heading

    --set

    To set individual metadata in the format „--set title titleToBeSet“

    --index-port

    The index port of the Index Service. Can be found at Configuration -> Indices -> [Index Name] -> Index Port (HTTP)

    --category

    Document Category

    --category-instance

    Document Category Instance

    --keys-file

    Path to the CSV document with the document keys to be changed

    --key

    Document Keys

    mesindexclient fetch-metadata -helpPermanent link for this heading

    --in-csv-file

    Path to the CSV file, with the search terms

    --out-csv-file

    Path to the CSV file in which the metadata of the found documents should be stored

    --key-column-name

    Column name in the file in-csv-file of the column containing the keys

    --fqcategory-column-name

    Column name in the in-csv-file of the column containing the fqcategories

    --add

    Column name in the out-csv-file of the column with the metadata to be stored

    --map

    Map for the assignment from fqcategory to index port

    ExamplesPermanent link for this heading

    mesindexclient \

    --host inspire.mycompany.com

    --username admin \

    --client-id mindbreeze-inspire \

    --client-secret xxxxxxxxxxxxxx \

    fetch-metadata \

    --in-csv-file=/data/top_100.csv \

    --key-column-name action_key \

    --fqcategory-column-name \

    action_fq_category \

    --out-csv-file=/tmp/top_100_2.csv \

    --add title \

    --add url \

    --map "Web:.*" 23444

    in-csv /data/top_100.csv

    action_key

    action_fq_category

    http://xx/file1

    Web: Default

    http://xx/file2

    Web: Default

    http://xx/file3

    Web: Default

    out-csv /tmp/top_100_2.csv

    title

    url

    Title 1

    http://xx/file1

    Title 2

    http://xx/file2

    Title 3

    http://xx/file3

    ….

    Download PDF

    • Handbook - Command Line Tools

    Content

    • mesindexclient

    Download PDF

    • Handbook - Command Line Tools