High-level design documentation

Sep 15, 2021 DataAutomation, News, WhereScape

Have you ever needed to create high-level documents of your data automation that explains a project/sprint within your WhereScape Red repository? Maybe so it looks a little like the above?

We recently worked with a client who wanted to represent the amount of change undertaken within a single project. They required something simple yet demonstrated the amount of change within each layer of the data automation.

Instead of creating something new, we re-used the WhereScape RED Overview design, WhereScape used to illustrate the design of the architecture.

A sample data solution shaped into the high-level design.

Engaging Data consultants worked with the client to create a solid naming convention and development standards. With this foundation and the metadata repository, we developed a script that produced an HTML document with details the client was looking for.

The idea continued to develop and now has options to include the following details:

  • Number of Jobs, Procedures and Host Scripts that support each layer.
  • Data Volume per object and summarised per layer
  • Processing time for each layer, with avg completion time & avg time to run

WhereScape RED and 3D speeds up development & documentation of the technical design. This solution utilises the metadata to create support or narrative documents for other business areas.

Build re-usable scripts, dashboards or reports for non-technical business teams & provide clarity around the technical function of your automation.

If you are interested in receiving a copy of the script that produced this report, please email simon.meacher@engagingdata.co.uk