As we have already mentioned, our programs, starting with DRAINS version 3, will include the Project Reports Designer Tool. A tool that will allow you to create, from the data contained in each hydraulic Project, engineering design reports in a simple way using templates defined by yourself, and which can be reused in the different projects that you create.
In this video we want to show you precisely how to convert these reference technical reports, which have created in previous projects, to project report template files within our designer tool.
With this template containing the desired technical report structure, you will be able to automatically generate the specific reports for each new Project you create with our software.
We have for this presentation, as reference data, those of the multi-family housing project that you will already know from the tutorials and videos available on our blog.
So, before we go to the Results tab to load the Project Reports Designer Tool, Let’s introduce you to the “external” process that you must previously do to perform the document conversion to project templates.
We have opened here Microsoft WORD, although you can use any word processor that can export documents to rich text format files, or, .RTF extension.
So, this is a document created in Microsoft Word format that corresponds to an engineering report used as an example, that we have written in the past, for some sanitary drainage project.
In the document, to facilitate your visualization, we have highlighted in red those properties that we consider to be particular for each and every Project we create, and which we wish, once converted to a project report template, to be automatically changed by replacing the results generated in the design and calculation with our program.
So, all we need to do here is save it as a Rich Text Format file that can then be imported by report designer tool.
So let’s go to File.
Save as.
Give it a name.
And most importantly, I select the Format RTF type from the list.
Click Save, and we are ready.
We can Close this program and go back to DRAINS.
Here it is crucial, before going to the designer tool, to click the calculation and design button to ensure that the results and values of your Project are up to date.
Also, be sure you have entered the Project’s general information in the FILE page, Configuration tab, Project’s Properties button.
In this case, since we have a sewage pumping system, I also click the respective calculation button.
Finally, we can go to the Reports Generator’s button in the Results tab.
Go to the File menu. Click Import RTF File.
And select the file that we have previously exported from Microsoft WORD.
Here it is, the text, keeping the format of the original document.
From this editor you can modify the format, to give it some final touches, if you deem it necessary.
So, the idea is that those values or properties that we had differentiated with red color are replaced here in the generator by The Sanitary Project’s Property Fields.
For example, the Project Name.
We want this text the template to be replaced by the value that we have specified for the Name property in the Project’s properties in DRAINS.
So I delete this text.
And I go to the Report menu to select the Insert Field option.
Remember that this dialog presents all the properties, general and specific, defined for the type of Project currently loaded in the program.
Here I am interested in inserting the first field in the document. The one with the Project Name.
When selected, I just need to click the Insert button or double click on it.
And there we have it, inserted in the document.
Let’s adjust the font color.
It’s time to do the same with the Project Date.
I delete the original text to leave only the title.
Note that the inserted fields can be easily identified in the document because, firstly, they will be enclosed between the less than and greater than signs.
And, secondly, because when you click on them, you realize that they are highlighted in gray, not allowing you to perform any type of editing on it.
In fact, the required way to delete or modify them is to double-click on it to present this floating menu.
If you click Replace here, you return to the list of available fields, so you can select the one to replace the current one.
If you do not select a different one and click de cancel button, it will be understood that you want to delete it and, therefore, it disappears from the document.
I will re-insert it.
The other thing we want you to notice is that the field takes the format you have defined in the cursor’s insert position. For example, note that it is underlined here.
This tells you that when the corresponding value replaces the field, it will be underlined as well.
So, what remains is to replace each of the texts with fields. So let’s get to it.
I take this opportunity to highlight that the fields that you have already inserted into the document will have this check symbol in gray. To realize, at any time, which ones you would need to insert and which ones you have already included in the document.
Some fields, such as the general properties ones, can be repeated at various positions in the document. For example, here, we choose to insert the project name again.
I change the color of the text since I am not interested they appear in red in our Engineering Design Reports.
I want all this text to be the same as the description we entered in the Project’s properties.
Later note that it is also possible to insert, through a field, the tables that are necessary, in this case, for the sanitary drainage project.
Here I want to insert the normative table with the fixture units for each sanitary fixture.
Although it is a table that is supposed to be in the current regulations, we consider that it is prudent that it appears in the specification.
So I go to the list of fields.
And I select the Public and Private Use Sanitary Fixture field.
Note that the fields associated with tables will have this prefix so that you can differentiate them in the document.
Additionally, it is essential to know that the table fields can only be inserted once in the document.
Let’s insert the normative diameters table at this position.
You will see that there are also fields that allow you to insert numeric values into the document.
In this position I want to show the Project’s total Fixture Units value.
So I go to the specific fields, at the bottom. In this case, the Maximum Fixture Units.
I select the Project’s sanitary network from the list since, remember, it is the one that captures all the fixture units of the Project.
Finally, click Insert.
Now I am going to insert the rest of the fields and will come back with the finished template document.
Here we have it. Look at all the fields already in place.
We have our new Engineering Project’s Report Template built.
From it, I will generate the final report.
First, let’s go to File and Save As a reports designer tool template.
Note that the previous job, in theory, it is required to be done just once because, having a template with the specified fields, all you need to do is to load it from each new Project you carry out.
Then, go to the Report menu to select the Generate document option.
After a while, the final report is created.
Notice that the texts, values , and, most importantly, the tables that make up this Project have been correctly inserted.
We inevitably have to make some additional editing or adjustment at the end. But you realize that this tool considerably reduces your work.
In fact, you only need to do the final reading of the document to detect and modify, if applicable, any other text.
In the end, you can export this generated document to a rich text format file so you can make more advanced customizations from other word processors.
Here you can see how I have loaded it to Microsoft WORD, with all its tables and values.
As I have mentioned, the advantage of having this template is that, now, I could change to a completely different project, recalculate it, and generate a report for it easily.
With this, I have saved, at least, a couple of days of work.
How many would you save?
So we have introduced you to the Project Reports Designer tool. A practical way to have various reference documents for each type of Project and from them, in just seconds, obtain fairly detailed engineering reports of your hydraulic projects.
We hope you find it useful.