Two of our users have recently completed projects that extend the functionality of Ardoq. We wanted to highlight their efforts and show off the results: a Python client for the Ardoq API, and a new Sunburst visualization.

Python Client for Ardoq API

Jason Baragry has been using the Ardoq API to automate documentation of the systems in his organization. The automation is powered by a combination of Python and Java scripts that pull updated systems data daily and update Ardoq through the API.

Because the scripts run daily and only look for changes in the source data, Jason also built a sync client that only pushes updated or new data into Ardoq. This is implemented using a cache containing the current state of Ardoq workspaces; when the script pulls the daily data, it’s checked against the workspace cache and added/updated in Ardoq if it’s new/changed. Voilà, automated Ardoq sync!

Jason posted about his client in the Ardoq user forum, and the source code and setup/usage instructions can be found on GitHub.

Sunburst Visualization

Richard Clark, an Enterprise Business Analyst at law firm RPC, created a custom zoomable sunburst visualization using Ardoq’s plugin editor. Richard was looking for a way to visualize how many components had been created in different workspaces to determine which areas needed more focus. Not satisfied with any of Ardoq’s out-of-the-box visualizations, he built the visualization below, based on the D3 Zoomable Sunburst diagram:

The visualization displays each open workspace as a single arc on the inside of the sunburst. Top-level components are then displayed as arcs on top of the workspace arc, 2nd-level components as arcs on top of those, and so on. The result is a quick, high-level view of both the breadth and depth of the current documentation.

Clicking on an individual component zooms into that area of the sunburst, and clicking on the center zooms out.

Richard also posted about this in the Ardoq user forum, where he adds: “If anyone is interested in using the plugin, please let me know in the comments below!”

You can also read more about how Richard and RPC are using Ardoq in our use case about business capability mapping.

Beers on Us

A huge thank you to both Jason and Richard for sharing the fruits of their labor with the whole Ardoq community. We really appreciate your efforts and involvement with making Ardoq a better tool!