Coversheet - User Documentation

Details

file

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

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 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

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

Adding a coversheet

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-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-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);

The robot may be added in the promotion, change notice or change task workflow. It is typical to add the workflow as the last item before the workflow completes to ensure the approvals and reviews are complete.

Designer tool

Various templates may be created using the designer tool

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

file

Note: From 1.2 the diagnositic 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.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: 03/03/2021 1:30PM (Sabrina Senouci - ssenouci@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