How do I create a report?

In the 2c8 Modeling Tool, you can generate reports directly from the tool, but also choose to display reports in the published material. A report can be a PDF or Word file that displays information about models, objects, relationships, and more. The report is an alternative to the web publication on how to present material that you have created in 2c8 Apps.

To decide which content should be included in your report and how the report should look, you need to create and edit a report profile. Below we describe how you do it and how the report profile works.

1. Click "Tools" - "Publish" in the menu bar to open the publishing dialog.
2. When you have created a new repository, a standard report profile is available in the publishing dialog. If you don't have a report profile, you can create one by clicking the "plus", otherwise double-click the existing one to edit it.
3. The report profile consists of a left panel and the respective area for making settings. Below we will go through all parts of the report profile:

Profile

Here you make general settings regarding the report profile such as the title of the report profile, a description for the report profile and a starting model for the report. The starting model is the model that appears first in the report and can affect any filters, for example if you choose to publish only the starting model and then include breakdowns to other models. So that you publish models in the report based on a structure of breakdowns from the starting model.

Filter

Here you decide parts of what should be included in the published material, as well as the order in which the models should be displayed. "Filter" is built on 4 different tabs at the top:

The settings you make under each tab are described below:

Models: Here you choose which models to include in your report. You can either choose to include all models, to select models (tick), filter models to publish, or to start from a list you created in the 2c8 Modeling Tool. In this tab you can also choose whether you want to include breakdowns to other models. This can be convenient if, for example, you only want to publish the starting model and all decompositions derived from it. Then you only check the starting model to publish, but also "Include breakdowns to other models".

Under "Versions" you can also choose to only publish "Approved versions of models".

Model order: Here you choose the order in which the models should appear in your report. You can choose between "Reading order" or "Custom order". If you choose "Read Order", the models will be based on your starting model and how the models are read. If you choose "Custom order", you can use the arrows on the right to move models up and down in the order.

Layers: Here you select which layers of objects in which model types you want to include in your report.

Language: Here you choose which language you want to publish your report in.

Layout

Here you decide the layout of your report, as well as what information should be displayed about objects and models. "Layout" is made up of 6 different tabs at the top.

The settings you make under each tab are described below:

Page: Here you make all the settings regarding dimensions and orientation.

Models: Here you choose what information you want to show about models in your report. In the drop-down menu, you can choose which model types you want to make settings for. You can therefore choose to display different types of information for different model types in your report. All models in this list that are not in bold follow the default layout, meaning the information you chose to display when you selected "Default Layout" in the dropdown menu. The model types that are marked in bold follow a special layout with information, which you have selected only for that model type.

For example, in your standard layout you could choose to display this information:

But for Interested party models, for example, you can choose to show only this information:

Interested party model will then be highlighted in bold in the list. If you want to restore the Interested party model to the standard layout and that this model type therefore displays information you chose to display under "Standard layout", check "Standard".

To add information you want to display, you "drag-and-drop" the information from the left column to the information surface.

You can then choose to edit the information by clicking on the "editing pen". An important part of the information to edit is, for example, "Model content". Here you decide which object types you want to include to display information about in your report.

Symbols: Here you choose the type of information you want to display about objects in your report. Just as under "Models", we start from the same principle here. You can choose to display certain information for particular object types in your report, or start from a standard layout. Just as we explained above, the object types for which you have made special settings are highlighted in bold in the drop-down list. Make sure the items you are setting up are included in "Model Content" under the "Models" tab as we explain above, otherwise they will not be included in the report.

Header: Here you choose the type of information you want to display in the header of the report. Just like in other parts of the report profile, you "drag-and-drop" the information from the left panel to the information surface. You can also choose to have your own logo in the report by clicking on the text "Standard image".

Footer: Here you choose the type of information you want to display in the footer of your report.

Functions: Here you can choose which features you want to include in your report, such as showing prefixes on objects, models and document links, as well as whether you want to add models as attachments to the report.

Appearance

Here you can, among other things, choose the font, color and size of different types of text in your report.

Advanced

Here you can choose to name your report. If you do not choose to name your report, it will be named "Report profile + *datestamp* + *timestamp*".

4. When you have made all your settings in the report profile, click the "OK" button to save the changes.

5. Then click "Next" and select the location to which you want to publish the report. Then click "Next" again.

6. Now you choose whether you want to publish the report as a PDF file or Word file. When you have made your choice, click "Publish".

You have now published your report.