This community post has been set up to give users information on how to access and use the Advanced Review Tool, and to help us gather feedback on how this beta app can be improved before we roll it into production for all users.
As this is still in beta, there may be frequent improvements as this feature grows - and we aren’t changing any of the old review functionality, so business critical functions won’t be impacted. Additionally, we’ve made sure that all access is done using secure API authentication and no information about your metadata is store outside of your registry.
Below is a screenshot of the new Advanced Review Tool we are building to make metadata quality controls easier. Previously, for a user reviewing a large data dictionary would need to find and review every component across the registry - a dictionary with 20 data element, each with their own components could require over 100 different pages to be loaded.
The Advanced Review Tool is designed to fix that - by loading all items and components on a signle page, as well as giving users the ability to view and create issues and integrating automated quality control checks in the single view shown below.
You can access the Advanced Review Tool from our beta page here: https://aristotle-pro-reviews.netlify.app/
When you load this page, you will see 3 fields that need to be entered to load a review (Once this is fully integrated into Aristotle, this step won’t be required).
To authenticate, you need 3 things:
Registry URL: This is the URL of your Aristotle Metadata Registry (for example
metadata.mycompany.com). Remember to not add ‘/’ after your URL
- API Token: This is a special string used to authenticate you to your registry, so the ART can load your reviews. We will show you how to get one below.
ID of Review: This is the identifier for the Review, and can be found in the URL of a review page or when viewing a list of reviews.
Go to your Profile Page from the Dashboard
a. Find the “API Token Management” option
Generate a token for the review tool
a. Click on Generate New Token
b. Select the ‘Metadata’, ‘Issues’ and ‘Review’ permissions (You can also change name and expiry date as you want)
c. Tick Read and Write for each of these three permissions - this will allow the ART to load the metadata, create issues and access reviews.
d. Click on Create Token and the token will be generated successfully.
- Now you have generated the token used for review successfully. Remember to copy your new token to use it in the ART.
Against every metadata item, the issues and validations show up in the left hand column as you scroll through.
a. Viewing issues in the Issue pane
On the left-grid, it will list all the open issues relevant to its metadata shown on the right.
You can see more information about an issue by clicking on this issue name
It also allows you to create new issue by clicking on New Issue
After clicking on ‘Create’, the newly created issue will show up on the left side in the Issues list.
b. Metadata validation pane
Name pattern check will automatically check whether the associated data element’s name follows its naming pattern.
Reviewing metadata content
a. Showing selected items and all its child items (if it’s enabled in review) in the same page
- The selected items in review is categorised as ‘items in review’ here
- All its child items (if it’s enabled in review) are rendered beneath ‘items in review’ as ‘cascaded items’
b. Show or hide empty value by clicking on the button next to ‘Review’ by toggling the “Show/Hide Empty Values” option at the top.
A metadata item showing empty values (with a
A metadata item hiding empty values
c. Viewing links to other metadata
- If the metadata isn’t in this page, you can go to its item page by clicking on it
- If the metadata is included in the review, you can hovering your mouse over the name to open it in Aristotle or jump to the item in the review.
We will also be releasing a screencast of the launch presentation for users to follow along with.