FAQ

Q: How often should I run these configuration commands?

A: Configuration commands are lightweight read-only operations. Run them:

  • Before deployments: To validate infrastructure
  • During troubleshooting: To verify configuration availability
  • As needed in automation: For environment validation in CI/CD
  • For auditing: Weekly/monthly for infrastructure documentation

There's no need to run them continuously; configurations change infrequently.

Q: Can I run these commands without Platform running?

A: No. The CLI requires:

  1. Platform - For OAuth2 authentication and configuration storage
  2. Detect Backend - For API endpoints

Both must be running and accessible.

Q: What if I see "Found 0 datasources" but I know datasources exist?

A: This indicates a permission issue:

  1. The user specified in platform.userid lacks datasource read permissions
  2. Datasources exist but have ACLs restricting access
  3. Try with a Platform admin user to confirm datasources exist
  4. Grant appropriate permissions via Platform Security Manager

Q: Are Kafka cluster names case-sensitive?

A: Yes. Kafka cluster names are case-sensitive. When using a cluster name in a destination configuration, you must match the exact case:

  • " Correct: prod-kafka-cluster
  • - Wrong: Prod-Kafka-Cluster
  • - Wrong: PROD-KAFKA-CLUSTER

Q: Can I export the results to JSON or CSV format?

A: The CLI outputs Java List format by default. To convert:

To JSON (using jq):

./CliTool.sh get-all-kafka-cluster-names | \
  tail -1 | \
  tr -d '[]' | \
  tr ',' '\n' | \
  jq -R . | \
  jq -s '{clusters: .}'

To CSV:

./CliTool.sh get-all-datasource-names-for-logged-in-user | \
  tail -1 | \
  tr -d '[] ' | \
  tr ',' '\n' > datasources.csv

Q: How do I get the full Kafka cluster configuration (bootstrap servers, properties)?

A: The get-all-kafka-cluster-names command returns only cluster names. To get complete configurations:

  1. Platform UI: Settings ' Configuration ' Affinium ' UnicaDetect ' Kafka Clusters
  2. Direct REST API call (see section 10 above)
  3. Platform Configuration Manager API
  4. Wait for Detect UI (future release) which will show cluster details

Q: Can these commands modify configurations?

A: No. All configuration commands are read-only. They query existing settings but cannot:

  • Create new datasources or Kafka clusters
  • Modify existing configurations
  • Delete infrastructure settings

Configuration management is done via Unica Platform UI or Platform APIs.

Q: What's the difference between datasource and database?

A:

  • Datasource: A named connection configuration in Platform (e.g., CUSTOMER_DB)
  • Contains: hostname, port, credentials, JDBC driver, connection pool settings
  • Reusable across multiple Detect components
  • Database: The actual database instance (e.g., customer_prod database on MySQL server)
  • Datasource points to a database server
  • Specific database name specified when using the datasource

Example:

Datasource Name: MARKETING_DB
  " Configured with:
  - JDBC URL: jdbc:mariadb://dbserver.example.com:3306
  - Username: detect_user
  - Driver: org.mariadb.jdbc.Driver
  
When used in Profile:
  - Datasource: MARKETING_DB
  - Database: marketing_profiles
  - Table: CUSTOMER_PROFILE