Coversheet - User Documentation

Details

file

Name Description
Wex ID com.wincomplm.wex-coversheet
Name Coversheet
Version 1.9

Overview

This extension allows to add cover sheet at the beginning of a an PDF document. This is often required when your PDF are distributed outside of your organization, as a typical use case consists in sending documents to regulation organizations: adding a cover sheet provides an audit trail of approval on a specific date for the PDF.

The sheet is designed with a GUI based tool, called the Report Designer and requires minimal training


Features

  • Adds a cover Sheet to a PDF
  • Generic template with configurable fields
  • Available on demand or configurable on a workflow
  • Multiple pages possible
  • Standard page formats available
  • Can be tailored to company standard
  • Includes data from the object, business process or system information
  • Example Demo templates to help start using the tool quickly
  • Trailing or coversheet

User Guide

Introduction

The coversheet tools supports documents and can append and remove coversheets.

It requires the following

  • Promotion Request or Change - Required if approval information is shown on the sheet
  • Document - To add the coversheet

Quick Start

Go to the Report Designer under the Quick Links menu

file

Go to the Resource Loader and load the coversheet demo

file

Go to a document associated to a change and access the menu (you need to be wex admin)

file

The new UI allows you to download a coversheet

file

User interface

The administrator have access to the following interface

file

The Persisted Data shows if this document has an existing coversheet added

Workflow Robots

Once created the templates can be added and removed using the following workflow robots

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover", self, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover", self, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail", self, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail", self, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover-rep", self, businessObject,representable, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover-rep", self, businessObject,representable, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail-rep", self, businessObject,representable, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail-rep", self, businessObject,representable, templateName);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover-change-object", self, businessObject,representable, templateName,includeAffected,includeResulting);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover-change-object", self,  templateName,includeAffected,includeResulting);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail-change-object", self, businessObject,representable, templateName,includeAffected,includeResulting);

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail-change-object", self,  templateName,includeAffected,includeResulting);

Here is a short description of what each of the workflow parameters means:

  • self - the workflow process object variable,
  • templateName - to be replaced by the name of the template to be added or removed,
  • businessObject - workflow variable that stores the primary business object (promotion request, change notice or change task)
  • representable - the workflow variable that stores the busines object (Document which holds the PDF)
  • includeAffected - to be replaced by true or false, denotes whether to use the documents found in the affected list of objects of a change object
  • includeResulting - to be replaced by true or false, denotes whether to use the documents found in the resulting list of objects of a change object

Designer tool

Various templates may be created using the Report Designer

The templates are stored in Windchill here

file


Admin Guide

Testing and admin operation

A UI is added to both documents and CAD elements so that the admin can manually add a coversheet and test the template

Note: From 1.2 the diagnostic screen has been removed as this replaces this function.

Configuration

The coversheet may render dates and these can be configured in the configuration screen of the extension

file


Release Notes

1.9

  • Fixed user data issue on update content
  • Added user data map to workflow
  • Improvements to documentation

1.8

  • Fixed vault issue
  • Added new UI user data option
  • Support for multi-line

1.7

  • Added new font feature
  • Added Google Noto and Liberation fonts
  • Support of additional languages including Japanese, Korean, Chinese

1.6

  • Fixed minor build issue

1.5

  • Fixed vault issues

1.4

  • Fixed security issues

1.3

  • Improved performance
  • New Report Designer
  • New data stored on coversheet actions
  • Trailing sheet option

1.2

New features

  • Added new UI menu on parts and documents
  • Added context keys for container name and description
  • Support for dynamic paper size (matching the source)
  • Allow border on entire properties or task block
  • Improve preview exception handling
  • Allow enable/disable headers in tasks to allow join of seamless tables
  • Allow IBAs to be added as a data source
  • Support task processes and notice processes for task block

Issues fixed

  • Properties and Task alignment not working
  • Approvers in task list only show 1st entry
  • Coversheet Drawings not working
  • Fill color overflowed on tasks

1.1

  • Change Support
  • Improved designer

1.0

  • Initial Release
Was this article helpful? Votes: 0
Article details:
Published date: 08/11/2020 7:26PM
Last updated: 20/10/2021 2:39PM (druiz@wincom-plm.com - druiz@wincom-plm.com)
Share article: 
Author: author@wincom-plm.com (author@wincom-plm.com)
Permalink: https://wex.wincom-plm.com/kb/articles/coversheet-user-documentation