Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Blog
  • Questions
  • Learning
    • E-learning Courses
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Tutorials
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • DataMiner Insights
      • Security
      • Integration Studio
      • System Architecture
      • DataMiner Releases & Updates
      • DataMiner Apps
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
  • Downloads
  • More
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
      • General Inquiries
      • DataMiner DevOps Support
      • Commercial Requests
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

Kata #2: User-Defined APIs

Solved19.57K views11th November 2023Kata script User Defined APIs User-Defined
3
David Merrifield [DevOps Advocate]626 18th October 2023 1 Comment

Hi All,

I've completed the Kata #2: User-Defined APIs but after I upload the automation script, I don't get the click box to create User-Defined API. The window where you add your URL and select a token. Are User-Defined APIs only available as an added feature or version of DataMiner? or am I doing something wrong?

Note - I can't see User-Defined APIs in System Center...

Thanks

Dave

Edib Šupić [SLC] [DevOps Catalyst] Answered question 11th November 2023
Miguel Obregon [SLC] [DevOps Catalyst] commented 18th October 2023

Hi Dave,
Just double checking, what DMA version are you running?
You need to run at least 10.3.6 to have this feature:
https://docs.dataminer.services/user-guide/Advanced_Modules/UserDefinedAPIs/UD_APIs.html

2 Answers

  • Active
  • Voted
  • Newest
  • Oldest
9
Wouter Van Robays [SLC] [DevOps Enabler]1.10K Posted 18th October 2023 1 Comment

Hi Dave, there could be multiple reasons why the UI is not showing correctly, these are the requirements:

  • Minimum DataMiner version for the feature to be available is 10.3.6
  • An indexing engine (ElasticSearch, OpenSearch or SaaS) is required
  • The user logged in into DataMiner Cube needs the following user permissions: https://docs.dataminer.services/user-guide/Advanced_Functionality/Security/DataMiner_user_permissions.html#modules--user-defined-apis

Hope this helps you further!

Marieke Goethals [SLC] [DevOps Catalyst] Selected answer as best 20th October 2023
David Merrifield [DevOps Advocate] commented 18th October 2023

Running later version so it must be due to us not using those indexing engines. Thank you for your help.

1
Edib Šupić [SLC] [DevOps Catalyst]2.06K Posted 11th November 2023 0 Comments

Hi David,

I would like to help you get the points for Kata #2. Since you are running version of DM that has user defined APIs and you think the issue is lack of indexing engine I will go through steps to install Elasticsearch locally.

First download the Elasticsearch installer from here.
Unzip the content and open the folder.
Run run_localhost_configuration.bat (you may need to run this as admin).
Open CMD and navigate to the extracted folder and run the following command:

SLDataGateway.Installers.Elastic.Runner.exe run-stand-alone -c localhost_configuration.xml

After installation finishes you will need to configure DM to use Elastic. Stop the DataMiner and navigate to Skyline DataMiner installation folder and open db.xml.

Add the following XML under existing one for Cassandra:

<DataBase search="true" active="true" local="true" type="Elasticsearch">
<ConnectString />
<DBServer>localhost</DBServer>
<DSN />
<DB>SLDMADB</DB>
<UID>elastic</UID>
<PWD></PWD>
</DataBase>

Lastly you will need to configure Elasticsearch, technically you may not need to do this step, but it could save you some trouble in the future.
Navigate to Elasticsearch installation folder and open config folder. Open elasticsearch.yml and change network.publish_host: 0.0.0.0 to network.publish_host: _local_.
Next you need to restart Elasticsearch service for changes to take effect.
Open start menu and type Service. Find Elasticsearch 6.8.23(elasticsearch-service-x64) and click Restart on the left side.
That should be it, start DM and enjoy your points.

Do note that this is just for local configuration. I know DM complains if you try to install Elastic through Cube if you have only one drive on your machine, but that warning is only valid in production environment. Locally you shouldn't have any issues with Elastic and Cassandra sharing the drive. You can find more information on Elastic installation process here

Let me know if you have any further questions or issues.

Edib Šupić [SLC] [DevOps Catalyst] Edited answer 11th November 2023
Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas

Recent questions

Web Applications exception in Cube due to invalid certificate 0 Answers | 0 Votes
Redundancy Groups and Alarming – Duplicate Alarms 0 Answers | 0 Votes
Correlation Engine: “Test rule” doesn’t result in a hit, despite functional rule 1 Answer | 3 Votes

Question Tags

adl2099 (115) alarm (62) Alarm Console (82) alarms (100) alarm template (83) Automation (223) automation scipt (111) Automation script (167) backup (71) Cassandra (180) Connector (109) Correlation (69) Correlation rule (52) Cube (151) Dashboard (194) Dashboards (188) database (83) DataMiner Cube (57) DIS (81) DMS (71) DOM (140) driver (65) DVE (56) Elastic (83) Elasticsearch (115) elements (80) Failover (104) GQI (159) HTTP (76) IDP (74) LCA (152) low code app (166) low code apps (93) lowcodeapps (75) MySQL (53) protocol (203) QAction (83) security (88) SNMP (86) SRM (337) table (54) trending (87) upgrade (62) Visio (539) Visual Overview (345)
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs

[ Placeholder content for popup link ] WordPress Download Manager - Best Download Management Plugin