Report Designer - User Documentation

Details

file

Name Description
Wex ID com.wincomplm.wex-report-designer
Name Report Designer
Version 1.4

Features

  • Designs a vertical pattern PDF report
  • Can include free formating of business data
  • Can include all types of media elements
  • Interface with Query Builder to include any data
  • Uses a object with a process objects as a source

Overview

This guide is to assist report designer in the use of the PDF report design tool. The designer is a GUI interface with drag and drop elements to create a PDF sheet that can be appended to an exising PDF within Windchill. It may also be downloaded separately

When designing contextual data can be added by using keys that are defined here

User Guide

Access

The designer can be accessed as follows:

file

Getting started

The extensions comes with a demo report that is available

It will loaded a new template and and associated query (QML)

To load the data access the load extensions

file

Then select the Test-Template and load it

file

The report will then appear and can be execute against any Change Notice

file

Design principals

The designer uses a vertical design pattern; elements will stack and be automatically pushed to additional pages as require. It is not possible to place elements on a horizontal access. The reason for this is it simplifies the UI and training required and also allows the design to scale on various page sizes.

Elements do have spacing and will appear with no gap. This is deliberate to allow a form structure to be built by combining elements to appear to the user a single element. Thus a spacer is used when separation is required.

Creating and Updating Templates

On the report designer, a user can create a new template or preview, edit or delete an existing template.

NOTE: Only admin users will have access to the templates and permission to create new templates.

The template name is unique and can be using in a workflow template or in the Windchill UI to add this template to a representation of a document or a CAD Drawing. It the reporting framework is used then reports for other business objects such as Change Notices or Promotions may be added.

file

Using the resource loader link, various extension may make default templates available.

Design Elements

On the report template, the user can add and configure Text, Image, Properties, Tasks, Spacer and Queries

file

*Note on borders: When elements are stacked the bottom element will overlap the top one. This is deliberate to avoid double borders. The top element will control the border so will need a bottom border to ensure the following element has a top border. *

Text Element

file

The text element is used for headings, sub heading and text blocks such as IP notices. It supports the data keys to inject data from the source object or business object

Image Element

file

The image does not scale and will need to be adjusted to the page size

Properties Element

file

This is a key value pair display to allow the design of a form. These elements can be stacked to design a complex form and can be displayed in multiple columns

Task Element

file

Task elements are used to display workflow task participants such as approvers and reviewer. It support the business object process and in the case of a change that includes the notice and the task.

Spacer Element

file

A spacer allows use to separate elements, note this is useful for also adding borders to elements that are below

Query Element

A query can be created in the Query Builder tool

file

The report should be created using the Report Manager

file

They should include the following parameters

Name Description
boid id of the business object
pboid id of the primary business object
mboid id of the business object master
mpboid id of the primary business object master

These ids are not the full oid but only the long number using in the db to identify an Windchill object (these are unique). It should be used as a foreign key in the query.

file

Adding Icons

And icon column can be added using the top entry in the query

file

This will show as an icon (use column widths to adjust size)

file

There are some icons images predetermined however more can be added in the configuration

file

Note: The images must exist in the windchill codebase, they can be deployed using an extension

Table properties

Two elements create tables Task and Query and these are configurable tables that may have 1 to n columns. These may have different sizes of data so it is useful to control the relatives size and this is done with the Column widths

file

These are percentages and if nothing is specified the table is equal width columns, if not the columns widths are used. In the case of more columns the remaining percentage is equally divided between them.

file

Template properties

Each template has a properties section that allows the designer to select the page size and orientation

file

Note Auto means the page will match exactly the PDF page size it is being appended to. In preview mode A4 is used.

Preview

Once the user has set up the template, it can be previewed to see how the configuration looks like:

file

Testing

Associating test data

For testing the designer can also associate a template to a document and a change or promotion by entering the numbers. It will always use the latest version and iterations for these objects.

file

If no document is specified the system will use the change or promotion also as the business object in addition to the same object being the primary business object.

Exporting and Importing Reports

To export a report between systems use the following procedure. You will need Site Admin access to your system

Exporting Reports

  1. Navigate to the following folder

file

  1. Select the reports to export and select the following action

file

  1. If your reports use any Query Builder reports ensure these are also exported

Importing Reports

  1. Access the ptc import/export tool from the site area

file

  1. Import the templates

file

.3 Import any supporting Query Builder Reports

Was this article helpful? Votes: -1
Article details:
Published date: 04/02/2021 8:28PM
Last updated: 07/06/2021 7:16PM (simonh@wincom-plm.com - simonh@wincom-plm.com)
Share article: 
Author: simonh@wincom-plm.com (simonh@wincom-plm.com)
Permalink: https://wex.wincom-plm.com/kb/articles/report-designer-guide