Hello!

Did you know that logged in users can see a lot more content?

Reports Side Pane

Last updated November 10, 2016 by Tekla Structures Extensions USA solutions.us@tekla.com

Software version: 
Not version-specific
Environment: 
United States (Imperial)
United States (Metric)

Reports Side Pane

1. Purpose and description

The Reports Side Pane tool allows the user to select multiple reports and generate them at the same time.  The reports can quickly be filtered and organized into folders using this new interface making it easier and faster to generate reports.  The file path for where the reports will be generated can also be defined.

2. System requirements

Environments: Default
Languages: English

3. Installation

To install the application:

  1. Make sure Tekla Structures is closed.
  2. Run the installation package. Download from the Tekla Warehouseservice for collaboration and for storing and sharing Tekla Structures content

    In Tekla Warehouse the content items are stored in collections. Tekla Warehouse includes the Tekla Warehouse Service and the Tekla Warehouse web site.

    Tekla Warehouse is one of the Tekla online services.

    .
  3. Reopen Tekla Structures once installation is complete and you will see:

  4. A new "Reports" icon will appear on the main user interface side pane.
  5. To open the tool, click the "Reports" icon

4. Interface

4.1 Main Interface

  1. Use this load saved attributes.  To create new attributes, click in this box and type a new name.  Then click Save.
  2. Use this to save new attributes.  When attributes are saved, a *.rsbo will be created in the attributes folder of the model folderfolder that is used for storing files associated with a model

    Tekla Structures stores all files associated with a model in a folder it creates with the same name as the model database (.db1).

    In multi-user mode all users access the same model folder.

    .  This can be placed in a firm or project folderfolder that is used for storing Tekla Structures-related files customized for a particular project

    .
  3. To filter the list of reports, start typing in this field and then press enter when finished.  To remove the filtered infomration click the gray 'X' in the search field.
  4. Click this to open the Options Dialog.  See section 5 for more detailed information.
  5. Once the reports have been selected, click this to create the reports from all the objects in the model.
  6. Once the reports have been selected, click this to create the reports from the selected objects in the model.
  7. Click this to show any highlighted reports in the list.  These reports will appear if they have been previously created.
  8. Click this to print the selected reports.  Note: If your default printer is a PDF printer this will not work.

4.2 Addtional Features

  1. By clicking on the triangle to the left of the folder you can expand or collapse the tree view.  By right clicking on the "Ungrouped Items" folder you can: 
  • Expand All
  • Collapse All
  1. By right clicking in the white background space you can:
  • Expand All - This will expand the tree view to show all the reports available.
  • Collapse All   - This will collapse all the reports in the tree view so that you only see the main groups.
  • Create a New Group - This will allow you to create new groups to organize your reports.

  1. If a new group has been created you can click on the name of the new group to edit the name.  You can also right click on the any created group to create a New sub-group, Delete group, Expand all, or Collapse all.  You can then drag an drop any reports from the list into the desired group or sub-group.
  • If the tree view is customized, a ReportsTreeView.rsbtg will be created in the attributes folder of the model folder.  This can be placed in a firm or project folder.

    Note: You can drag a sub-grouped folder to the white space to the left of the folder in order to ungroup it from the parent folder.

  1.  By right clicking on any report in the list you will have the option to:
  • Show Report - If the report has been created, the report will be opened with the defined report viewer.
  • Edit Report Templatetemplate that is used for creating a report

    - This will open the report in the Template Editortool in Tekla Structures used for creating and modifying templates to be used in drawings and reports

    .  Please note that this may take a few extra seconds to open.
  • Delete Report Template - This will delete this report from your computer.  i.e. Sent to the Recycle Bin.
  • Hide Report - This will hide reports from the list.  A ReportsExcludeList.xml will be created in the attributes folder of the model folder.  This can be placed in a firm or project folder.  Note: The reports visible have already been pre-filtered from the variable XS_ATTRIBUTE_FILE_EXCLUDE_LIST.  These reports are excluded and are different from 'hidden' because the only way to turn them on to to remove them from this advanced option.  For more information regarding this Advanced Option please click here.

5. Options Dialog

  1. Use this load saved attributes.  To create new attributes, click in this box and type a new name.  Then click Save.
  2. Use this to save new attributes.  When attributes are saved, a *.rsbo will be created in the attributes folder of the model folder.  This can be placed in a firm or project folder
  3. Title 1 - Use this value field to include the text for Title 1.  Some reports use these fields to hide/show additional information in the output of the report.
  4. Title 2 - Use this value field to include the text for Title 1.  Some reports use these fields to hide/show additional information in the output of the report.
  5. Title 3 - Use this value field to include the text for Title 1.  Some reports use these fields to hide/show additional information in the output of the report.
  6. Prefix - The text added here will be used as a prefix to the report name when the report is generated.
  7. Suffix - The text added here will be used as a suffix to the report name when the report is generated.
  8. Show Hidden Reports - Check this option to view the reports that have been hidden from the tree view.  When reports are hidden, a ReportsExcludeList.xml will be created in the attributes folder of the model folder.
  9. Append Date - If you wish the date/time to be included in the report name when it is being generated check this option.  If the option is checked you can edit the value field to the right to determine the date/time formatting.  See this website for further details and a list of the options available. https://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx
    • For example:
      • "{0:g}" will output 6-21-2016 8_16 AM
      • "{0:MMMM dd, yyyy}" will output June 21, 2016
      • "{0:ddd d MMM}" will output Tue 21 Jun
  10. Overwrite Report - Check this option if you wish to overwrite an existing report that has already been created.
  11. Display Report - Check this option if you want to display the reports once they have been generated.
  12. External Viewer - When this option is checked it will open the generated reports with an external viewer instead of using Tekla's internal report viewer.  For example, if your default program to open a .csv file is Microsoft Excel and you generated a .csv report with this option checked, the report would open in Micrsoft Excel.
  13. Output Option - Use this to defined where the reports should be stored once they are generated.  You can click the the dots to the right to browse to a folder location.  The Folder icon will open the currently selected file path.  The default location for reports to be stored is in the Reports folder in the current modelmodel that is active in Tekla Structures

    The current model can be a single-user model, a shared model or a working model.

    folder.

 

Quick feedback

The feedback you give here is not visible to other users. We use your comments to improve our documentation.
We use this to prevent automated spam submissions.
Content rating: 
No votes yet

Comments

by Rasmus Palm Vestergaard

Hi
Is it possible to make the filename include the Cast_unit_number. And make batch report from selection of multiple cast-units

by Lee Snyder

Hello,

Currently it's not possible to add a report property syntax (Cast_unit_number) as an automated prefix/suffix in this tool. I can add that as a feature request. As far as a batch report is concerned you still only have the same functionality to run reports from selected or from all just like you do in the current reports dialog box. I can also add this as a feature request.

Thanks!

by Elwanda Klucik

Additional inquiries should be submitted through the Tekla Extensions Discussion Forum using the extension's name in the thread title.