Welcome to our Quick User Guide
Organise your technical doKumentation and review your level of Customisation with our ServiceNow Application.
DoKuments is a compact and easy to use application that facilitates maintenance and monitoring of your ServiceNow Instance. It’s main qualities are being able to quantify and organise all of your technical documentation. It also allows you to monitor the level of customization of your Instance with help of it’s completely personisable dashboard with many types of graphs and charts.
Our application is as easy as any other in the ServiceNow store, just simply activate it in the plugin menu bar once installed.
To see the DoKuments menu type “Dokument” into the Application Navigator search bar on your ServiceNow instance.
- DoKument sets are a list of technical DoKumentation and Requirements generated from your installed Update sets. By going to DoKument>DoKument Sets in the menu you will get a list of the ones that have already been generated.
- A Requirement is a summary of the business needs described in your instance.
- Instead of using the keywords Incident, Change, Problem, Request etc we created the keyword Requirement to simplify things.
- Here you will find a list of all of the Requirements generated from the tasks linked to your dokuments (story, change, incident, task…).
View from Requirements menu:
- This is where we store the technical documentation or DoKuments for every single change that has been done on your instance. The Dokuments are linked to Requirements and are grouped by DoKument Set.
- You can also review Dokuments by clicking on a DoKument set in the Dokument Sets menu tab or by opening a Requirement.
View from DoKuments menu:
Dokument>Administration>Generate Dokument Sets
- This is where we generate our Dokument Sets from our current Update Sets, you can either generate them one by one or all at the same time by clicking on the “Generate all” button.
- The Dashboard is where you can quickly access all different types of easy to read information. You can see the total amount of customizations but also the different types. This gives you detailed insight into the current health of your instance. These tables and charts are all fully customisable and you can also create your own.
- In this menu tab you can change various settings.
- By default, the property « auto_generate_dokumentation » is set to true so the application will automatically generate the dokumentation when committing an update set.
If you need to contact us for support or if you have any questions you can find our details here.
- As an administrator, you have full access to the DoKument application
- You can grant various roles to users, depending on the rights/permissions you want to give them:
- dokument_admin: for full administration (allows to delete dokument sets and related records)
- dokument_user: can generate dokument sets, create and update dokuments and requirements, can access the homepage and reports
- dokument_read: can only read (or export) dokument sets, requirement and dokument records
However, some information may not be available to certain roles, such as the update set reference number since it’s only visible to the admin.
Get the most out of your App
The Dashboard is made up of fully customisable Widgets, you can create as many as you like and place them where you want.
- Widgets are simply reports of data put into charts, graphs, heat maps etc…, they are used to help make this data easier to work with and understand.
- To create a report or learn more about Widgets click the following link here
- To move them around you can either drag and drop them or select the “change layout” button on the top right hand corner on the dashboard screen.
- To add a report to the dashboard all you need to do is click on the “Add Content button”, select the type “Report” and then the table, for example “Dokument” and then the name of the name of the report.
Using the referencing tags
- In order to tie up your Dokuments to the correct business Requirements we have put in place these 3 tags :
- @description = Simple description
- @author = who was working on the script
- @link = Task Table record
- You can automatically generate these tags buy typing “Dok” and pressing the tab button.
- These tags are to be put in the headers of your scripts that you include in your Update Sets so that they can be automatically linked together by Dokuments.
Manually updating the links after generation
- This method is for all of the customisations that do not include scripts.
- You can manually add the task table record into the corresponding field to link the Dokuments
- This will then automatically generate the Requirement.
Code Version Control
- Dokuments also allows you to compare code versions. At the moment, Dokuments are generated for each Update Set, so you could potentially have more than one Dokument with the same tags, so all you need to do is search for Dokuments with the same name, type, etc and compare them.
- We are currently working on a tool to do this automatically.