The purpose of Project Reporting is to give you:
- an overview of the work progress,
- detailed information related to inconsistencies and incompleteness within your arKItect project.
Throughout this documentation (Project Reporting and its related child pages), we:
- explain the result of Project Reporting through a set of "good" questions which aim to check the consistency and completeness of a model in arKItect. (These questions would be helpful for you to construct a "good" model in arKItect.),
- describe how to correct your project data,
- introduce some other scripts and arKItect projections which also allow you to check your project data.
Access to the Result of Project Reporting
In the drop-down list of projections, there is a projection called "Reporting" wherein the result of the Project Reporting is displayed:
Then, if "Project Tools" panel is not displayed on the right, you can click on its icon in the mail toolbar to display it. You can now click on "Analysis Tools/Update Reporting", to generate the result.
You can select the level of the reports that will be generated to avoid unnecessary reports and decrease generation time.
The Reporting is local by default.
This means that you launch the reporting only on your computer, a refresh or reopening of the project will remove these objects (not saved on the server).
By unchecking the "Run locally" option, a global Reporting will be launched, impacting all users (might be longer).
Making a Reporting global run
Launch the reporting on the server, it will be updated for all the users. When opening the project, the data gathered by a global Reporting will be provided by default.
In the Process view, go into "Systems Engineering Data Management Process"->"Tools" and find an Analysis script called "Global Project Reporting".
Right click on this object and select Analysis to launch the Reporting update for all the users.
Global Reporting is a task which put a heavy load on the server and can slow down other users, use it with care.
Update the Result of Project Reporting
You can complete your project and then update this result anytime you like by clicking again on "Update Reporting".
Structure of Project Reporting
This documentation as well as the Reporting results in arKItect has the following structure :
In each section, the inconsistencies and incompleteness of the objects and their relations are pointed out. In each section, we distinguish mainly the problems related to:
- structure (hierarchy, parent-child relations) of the objects such as objects with multiple parents,
- attributes such as mandatory attributes which are empty or the attributes that should be empty but they are not,
- allocation of objects such as not allocated objects, multiple allocated objects.
Other categories of problems might be added according to the topic of the section.
Each orange object has:
- a self-explanatory name which shows what objects it includes,
- a tag, put between parentheses, to explain the nature of the notification (it is called 'severity' and can be changed by the user):
- information: it is not a problem at all but an interesting information about the project data, such as the list of the obsolete requirements,
- warning: it might be a problem but it is not an error, for example if an enabling system does not have any requirements (because the project is not complete yet),
- error: it is an error because the conventions / good practices are not respected, for example a requirement is repeated inside and outside of the system.
Vocabulary Used in Project Reporting
A Project Reporting Glossary provides you by the definition of the key words used in Project Reporting.