Packaging Tool

8/9/2019 Packaging Tool

1/44

Copyright 2013 Tekla Corporation January 2013

TitlePackaging Tool

1. Purpose and descriptionThe Packaging Tool automates the process of creating, sending and tracking responses topackages of drawings, NC files, reports, and other model output files. The toolsmainfeatures are as follows:

Wizard-based user interface leads the user step-by-step through the packagecreation process

Automatically selects drawings for packaging based on a selection filter, or allowsmanual selection of drawings from a Drawing List-style grid

Automatically converts the selected drawings to a portable format, suitable forpackaging (PDF, DXF or DWG)

Automatically generates and packages NC files for the selected drawings, or for theparts selected in the model

Automatically generates and packages reports for the selected objects, or all objects

Allows any additional files to be manually added to the package (e.g. MIS lists)

Automatically creates a coversheet for the package, detailing the purpose andoptionally the contents of the package

Automatically emails the package (and coversheet) to recipients selected from thetools built-in contacts database, or allows the package to be sent manually later

Manages sent packages, maintains the transmittal history, and tracks the responsestatus of each package (response not required / awaiting / overdue / received)

Creates revised packages, automatically identifying the previously packaged files,and the files modified or deleted since previously packaged

Maintains the revision history and manages oldversions of packages

2. System requirements

Tekla Structures Version: Any supported version

Environments: Default

3. Installation

To install the extension:

1. Run the installer provided, which will lead you through the steps required to installthe Packaging Tool.


2/44


4. Usage

4.1. Starting the Packaging Tool

The Packaging Tool works in conjunction with the matching version of Tekla Structures. So before starting the Packaging Tool, you need to startthe matching version of Tekla Structures and open the model you want to create packages for.

Once Tekla Structures is running and you have a model open, you can start the Packaging Tool by double-clicking its desktop shortcut.

While the Packaging Tool is in-use, Tekla Structures must be left running, with the relevant model open. Tekla Structures must not be minimised

during drawing conversion (see Converting the Drawings) as drawings are automatically opened and closed by the Packaging Tool during theconversion process.


3/44


4.2. The Main Window

The Packaging Tools main window consists of a grid, showing all the packages for the current model, and a toolbar for creating, sending, viewing anddeleting packages, managing contacts, etc. The packages grid will be initially empty, as shown here.


4/44


4.3. Creating a Package

To create a package, click the Create New Packagebutton. This will launch the Package Creation Wizard.

On the first page of the wizard, enter a package title and optionally a package description and then click Next.


5/44


4.4. Choosing a Selection Filter

Before you begin to create your new package, you can choose a selection filter to apply to the model.

The filtered parts can then be used indrawing selection (see Auto-SelectingDrawings) and NC file generation(see Packaging NC Files).

If you prefer, you can also pick , which then gives you theoption of manually selecting parts inTekla Structures, or simply selectingdrawings by-hand via the DrawingSelectionpage of the wizard.

If in future you create a new versionof your package, the filter you selectwill be automatically re-selected asthe default filter for the package. Thiscan be a useful aid in identifyingchanges that have occurred since theoriginal package was created.


6/44


4.5. Selecting the Drawings

The Drawing Selectionpage allows you to select the drawings you want to include in your package. It will automatically convert the selected drawings to aportable format, suitable for packaging (PDF, DXF or DWG).

The grid shows all the drawingsavailable for packaging in the currentmodel.

You can sort on any column in thegrid by clicking on its header. Thedrawings shown here are sorted onName.

You can select drawings manually byplacing ticks against drawings in theSelectcolumn

Drawings will be greyed-out and notselectable if they are locked or out-of-date. If you need to update certaindrawings before continuing, exit thewizard by clicking the Cancelbutton,perform the required updates in TeklaStructures, then restart the wizard torefresh the drawings grid.

The wizard can also automatically

select drawings for the parts youhave selected in the model.


7/44


4.6. Auto-Selecting Drawings

The Auto-Select Drawingsbutton allows you to automatically select the drawings for the parts currently selected in the model.

Here, the columns have been selected in themodel via the Columns selection filter, andthe assembly and single-part drawings for thecolumns have been automatically selected inthe grid.

If necessary, you can also manually select afew extra drawings, like the GA shown tickedhere.

When youve selected all the drawings youwant to package, choose the format you wantto convert them to (by default PDF), and thenclick Next.


8/44


4.7. Converting the Drawings

As your drawings are converted to PDF (or DXF/DWG) format, you can monitor the conversion process via the Drawing Conversionpage. In TeklaStructures, you will see each drawing being briefly opened, exported in the relevant format and then closed again.

Note that no PDF printer driver needsto be installed. The Packaging Toolhas built-in PDF creationfunctionality.

The Embed fonts in PDFsoption (atthe bottom of the Drawing Selectionpage) allows you to embed drawingfont information within the PDF filesthemselves. Embedding fontsincreases file size somewhat, butmeans that the fonts do not have tobe present on the recipients machinein order to view the PDFs accurately.

Tip: If your drawings only usecommon Windows fonts, like Arial orTimes New Roman, you can reduceyour overall package size, byswitching off the Embed fonts inPDFsoption.

The file names of the converteddrawings will be in the followingformat:

Mark-Name-Type-Revision.pdf

e.g. C.1-COLUMN-A-1.pdf


9/44


4.8. Packaging NC Files

The NC File Generationpage allows you to automatically generate NC files for the package.

The grid shows all the NC file settingsconfigured for the current model (anyproject, firm or system settings willalso be included).

You can select the settings you want

to use by placing ticks in the Selectcolumn.

If necessary, you can edit the outputfolder for any of the selected settingsby double-clicking in the PackageFoldercolumn.

You then have the option to generateNC files for the drawings packaged inthe previous step, or for the parts youcurrently have selected in the model.

If you opt to generate NC files foryour drawings, you can then furtherspecify whether to use the single-partdrawings, the assembly drawings, orboth of them (and whether to use thesecondary parts in assemblydrawings as well as the main part).


10/44


4.9. Generating NC Files

You can monitor the NC f ile generation process via a scrolling progress window.


11/44


4.10. Packaging Reports

The Report Generationpage allows you to automatically generate reports for the package.

All the available reports (in the model,project, firm or system folders) areshown in the list.

Select the reports you want togenerate by placing ticks against therequired reports in the list. Click theSelect Allor Deselect Allbuttons toautomatically select or deselect allreports.

Some reports have user-definedtitles. You can enter the title text forthese reports in the three Titleboxesprovided.

You then have the option to generatereports for the objects currentlyselected in the model (SelectedObjects), or for All Objects. TheSelected Objectsoption will use theobjects selected by your selectionfilter (if you chose to apply a selectionfilter earlier, via the Selection Filterpage).


12/44


4.11. Generating Reports

You can monitor the report generation process via a scrolling progress window.

The output files will have the samenames as their respective reports.

Output files for reports which donthave an extension, will be given a

default extension of .xsr.

For example, the Material_Fittingsreport produces an output file named,Material_Fittings.xsr.


13/44


4.12. Selecting Additional Files

Once youve packaged all your drawings, NC files and reports, the Select Additional Filespage allows you to select any other files you might want to includein your package.


14/44


4.13. Adding MIS Lists to the Package

If for example, you want to add some MIS lists to the package, first its a good idea to create a separate folder for them byclicking the Create New Folderbutton.

Enter a name for the new folder (e.g. MIS) and then click the Add Files to the Selected Folderbutton.


15/44


When the Select Filesdialog appears, select the MIS lists you want to add to the package.

The selected files will be added to the package and immediately appear in the packaging list at the bottom of the page. Note that you can remove anyunwanted files from the packaging list, by simply selecting them and pressing the Deletekey.


16/44


4.14. Entering Transmittal Details

The Enter Transmittal Detailspage allows you to enter information about the packages recipients, its purpose, if and when a response is required, etc.


17/44


4.15. Selecting Recipients

In the Recipientsbox, you can manually enter email addresses separated by a semi-colon (;) or you can click the browse button (...) to select addresses fromthe Packaging Tools contacts database.

Simply select the required contacts,and click OK.

If necessary, you can create newcontacts using the buttons at the top

of the Contactsdialog. You cancreate both individual contacts anddistribution lists (see Editing Contactsfor details).

Another way to create new contactsis to manually enter new emailaddresses directly into theRecipientsbox. These will beautomatically added to the contactsdatabase and appear in theContactsdialog next time you createa package.


18/44


4.16. Wizard Input Form History

As packages are created, certain fields in the wizard input forms automatically build up a history of the values you entered for previous packages. Thesepreviously entered values can be instantly retrieved via the drop-down lists provided.

4.17. Requesting a Response

You can let your recipients know if/when a response is required by ticking the Response Requiredcheck box and selecting a Response Required Bydate.

The input form history can becleared via the Packaging ToolsSettingsdialog (see Editing Settingsfor details).

The Packaging Tools main windowallows you to track the ResponseStatusof your packages (seeTracking Responses for details).


19/44


4.18. Reviewing the Coversheet

The Packaging Tool automatically creates a coversheet containing all the details about your package and its contents.

The coversheet is a PDF f ile, whichaccompanies your package, and tellsyour recipients all they need to knowabout the package, its purpose, itscontents, and if and when a responseis required.

For multi-page coversheets, use theNext Pageand Previous Pagebuttons to display the next andprevious pages of the coversheet.

Note that you can set the SenderAddressfor the coversheet via thePackaging Tool Settingsdialog

(see Editing Settings for details).


20/44


4.19. Reviewing the Package Contents

The Generate Contents Tableand Generate Drawings Tableoptions (at the bottom of the Transmittal Detailspage) allow you to add a full table ofcontents and/or a table of drawing details to the coversheet.

When youve finished reviewing the coversheet, click Nextto create the package.


21/44


4.20. New Package Created

The wizards final page reports that your package has been created, gives the package size, and provides the option to send the package via your emailapplication.

The Tekla Structures Package (TSP)file is a zip file with a f ile name in thefollowing format:

ModelName-Date-Time.tsp

Tick the checkbox if you want to sendthe package immediately, via yourdefault email application (e.g.Microsoft Outlook). You can alwayssend the package later if you prefer,via the Send/Resend Packagedialog (see Sending and ResendingPackages for details).

A permanent copy of the package willbe stored in the Packagesfolder ofyour model (as shown in thePackage Fileand Package Folderfields). So at any time, you also havethe option to copy it manually to aDVD, memory stick, shared folder,etc.

Click Finishto close the Package

Creation Wizard.When youve finished reviewing the coversheet, click Nextto create the


22/44


4.21. Sending the Package

If you opt to send the package via your default email application, the Packaging Tool will automatically create a new email message, addressed to yourselected recipients, and with both the package and coversheet attached. The example below shows a message created in Microsoft Outlook.

The Package Titleappears in the subject line, and the Package Descriptionappears in the body of the message. You can add any additional comments,just as you would a normal message, before sending it in the normal way.

As noted at the foot of the message, Tekla Structures Package (.tsp) files are in standard zip format and can be opened by your recipients with any third-partyzip file tool.


23/44


4.22. Tracking Responses

Once youve finished creating your package, it will appear in the packages grid, in the Packaging Tools main window. From here, you can use the last threecolumns of the grid to track the responses to this and other packages. By sorting on the Response Statuscolumn for example, you can instantly see whichpackages are awaiting responses, which responses are overdue, and which responses have been received.

For a new package, the Response Statuscolumn will initially be set to Awaitingand the Response Receivedcolumn will be un-ticked as shown.

If no response is received by the Response Required Bydate, the Response Statuswill change to Overdue(and be highlighted in bold).

If you receive a response, click the Response Receivedcheckbox to change the Response Statusto Received.


24/44


4.23. Viewing a Package

To view the contents of a package, select it in the packages grid, and click the View Selected Packagebutton. This will bring up the View Packagedialog.

On the left is a list of all the packaged files. Selecting one of the files on the left will display a preview of it on the right. A preview of a PDF file (a GA drawing)is shown. (Note that PDF previewing requires Adobe Reader to be installed on the host machine).


25/44


Text files or files in HTML format can also be previewed in the View Packagedialog (e.g. reports, NC files, etc). A preview of a material assembly report isshown.

You can also double-click a file to open it in the application associated with its file type. Double-clicking a .xls file, for example, will typically open it inMicrosoft Excel.


26/44


You can display additional information about the drawings in your package, by selecting the Show drawing details in gridoption.


27/44


As well as viewing the packaged files, the View Packagedialog also allows you to view the packages header details and coversheet, by clicking the ViewHeader Detailsand View Coversheetbuttons respectively. (Again Adobe Reader needs to be installed on the host machine to view the PDF formatcoversheet).


28/44


4.24. Viewing an External Package

The Packaging Tool also allows you to view external packages, i.e. packages outside the current model, which dont currently appear in the packages grid(for example, a package that has been emailed to you by another Packaging Tool user).

To view an external package, click the View External Packagebutton on the main toolbar. This will bring up the Open External Packagedialog.

Browse to the package file you want to view, and click Open. The View Packagedialog will then appear, displaying the contents of the external package,just as it did the contents of the internal package described earlier.


29/44


4.25. Creating a Revised Package

The real power of the Packaging Tool starts to be seen in its ability to take an existing package, analyse the changes that have occurred in the model sincethe package was created, then create a revised package containing the required mix of old f iles, new files, and modified/updated files.

To create a revised package, select an existing package in the packages grid, and click the Create Revised Packagebutton. This will launch the PackageCreation Wizard, but this time it will be pre-populated with the contents of the previous package.

On the first page of thewizard, you can use the samepackage title and descriptionas before, or you can editthem as required, and click

Next.


30/44


4.26. Previously Packaged Drawings

In the Drawing Selectionpage, three new columns will appear in the grid. The Previously Packagedcolumn indicates whether a drawing was included inthe previous package; the Modified Since Previously Packagedand Deleted Since Previously Packaged columns indicate whether the drawing has beenmodified or deleted since the previous package was created.

In this example, the Previously Packagedcolumn is ticked for all f ive drawings that were

present in the original package.

One of the drawings has a tick in the ModifiedSince Previously Packagedcolumn, indicatingthat it has been changed since it was originallypackaged. (Note: because Tekla Structuresdrawings only have a modified date, not a dateand time, it is not possible to detect more thanone modification per day).

One of the drawings has a tick in the DeletedSince Previously Packagedcolumn, indicatingthat it has been deleted since it was originallypackaged. The deleted drawing has also beengiven a grey background to help it stand out.

All the previously packaged drawings, with the

exception of the deleted one, have beenautomatically pre-selected for the new package,

and have ticks in the Selectcolumn.


31/44


4.27. Changing the Default Selections

You may decide to accept the drawings pre-selected by the wizard, and repackage updated versions of all the drawings that were previously packaged (withthe exception of any deleted ones) or you can add and remove drawings from the selection set however you see fit, by ticking and un-ticking the checkboxesin the Selectcolumn.

In this example, two previously packagedcolumn drawings have been removed from theselection set and one new rafter assemblydrawing has been added.

The greyed-out, deleted drawing, which was un-ticked by default, has now been ticked to forceits inclusion in the package.

If you decide to include drawings like this, whichhave been deleted from the model, a copy of thedeleted drawing will be taken as-is from thesource package.


32/44


4.28. Repackaging NC Files and Reports

The NC File Generationand Report Generationpages will be automatically initialised with all the settings/selections that were previously used for thesource package. You can opt to accept these default settings/selections, and regenerate updated versions of all the previously packaged files, or you can editthe NC generation settings, add or remove reports, in whatever way you require.


33/44


4.29. Additional Previously Packaged Files

The Select Additional Filespage will be pre-populated with all the files from the source package, and again the three Previously Packagedcolumns willappear in the grid.

In this example, one of the MIS lists has beenmodified since it was previously packaged.

Again, you can opt to simply accept the wizardsdefault selections, and repackage updatedversions of all the previously packaged files, oryou can add and remove files from thepackaging list as required, in the usual way.


34/44


4.30. Updating the Transmittal Details

In the Enter Transmittal Detailspage, you can keep the details the same as the original package, or you can modify them in any way you require. Here, twonew recipients have been added, and a new response date has been entered.


35/44


4.31. Reviewing the Updated Coversheet

All the new transmittal details will appear at the top of the coversheet, and because the package was created from another package, the source packagename will appear in the coversheets Source Packagefield.


36/44


4.32. Packaging Status Information

The coversheets Status column indicates the differences between the new package and the original source package.

Identicalthe file is identical to the version inthe previous package.

Modifiedthe file has been modified since itwas previously packaged.

Newthe file is new to this package; it wasnt

present in the previous package.

Deletedthe file was present in the previouspackage, but it has been removed from thecurrent package.

Repackagedan NC file or report which waspresent in the previous package, and has beenregenerated for inclusion in the current package.


37/44


4.33. Identifying Related Packages

In the Packaging Tools main window, related packages can be grouped and identified in a number of ways.

Related packages all have the same packageID, so they can be grouped together in the gridby sorting on ID. The package ID is a uniqueidentifier (GUID), generated automatically whena package is created by the Packaging Tool.

If you select a package in the grid, all relatedpackages will be highlighted in purple, and thename of the actual source package will behighlighted in bold.

In this example, Package 1bis selected, whichcauses the name of the source package(Package 1a) to be highlighted in bold, and allrelated packages (Package 1aand Package 1)to be highlighted in purple.


38/44


4.34. Sending and Resending Packages

When you create a package, you have the option to send it immediately (by ticking the checkbox on the last page of the Package Creation Wizard) or youmay decide to send it later via the Send Packagedialog. The Send Package dialog can also be used to resend a previously sent package, to the same ordifferent recipients.

To send or resend a package, select it in the packages grid, and click the Send/Resend Selected Packagebutton on the main toolbar.

Simply edit any of the transmittal details as required, then click the Sendbutton to send the package via your default email application (e.g. MicrosoftOutlook).


39/44


Manually Sending Packages

If you prefer to send your package manually, rather than using the Package Creation Wizardor the Send Packagedialog to automatically send it for you, orif you want to copy your package to a DVD, memory stick or shared folder, etc, you can use the Explore Packages Folderoption on the main toolbar.

Simply select your package inthe packages grid, and click theExplore Packages Folderbutton.

The Packagesfolder will thenbe opened in WindowsExplorer, with the relevantpackage file (.tsp file) alreadyselected, and ready for copying,emailing, etc.


40/44


4.35. Deleting Packages

To delete a package, select it in the packages grid, then click the Delete Selected Packagebutton on the main toolbar. This will bring up the DeletePackagedialog.

Three options are available:

Select the first option if you just want to delete the selected package and nothing else.

The second option allows you to delete the selected package, plus any earlier versions of the package.

Choose option three if you want to delete all versions of the selected package (i.e. all packages with the same ID as the selected package).


41/44


4.36. Editing Contacts

Click the Edit Contactsbutton on the main toolbar to bring up the Contactsdialog.


42/44


4.37. Creating Individual Contacts and Distribution Lists

To create an individual contact, click the Create New Contactbutton, then enter the required contact name, company and email address into the grid.

To create a distribution list, first select the individual contacts you want to include in the list, then click the Create Distribution List From Selectedbutton,and enter a name and description for the new distribution list into the grid.

Existing contact details can also be edited by double-clicking the relevant cells in the grid, and unwanted contacts can be deleted by selecting them in the gridand pressing the Deletekey.


43/44


4.38. Editing Settings

Click the Edit Settingsbutton on the main toolbar to bring up the Packaging Tool Settingsdialog.

In the Address For Coversheet section of the dialog,enter the company name and address details you wantto appear in the Sender Addresssection of yourcoversheets.

As packages are created, certain fields in the wizardinput forms automatically build up a history of thevalues you entered for previous packages. This inputform history can be cleared by clicking the Clearbutton.


44/44

5. Additional information

When drawings are converted for packaging (to PDF, DXF or DWG format) eachdrawing will be opened in turn, exported in the relevant format, and closed again. Youwill see the drawings flickering in and out of view, as they rapidly open and close in

succession. For this reason, if you have a drawing open, it is important to close itbefore starting to create a new package.

It is also important to have Tekla Structures running un-minimised during theconversion process. If Tekla Structures is minimised then the Packaging Tool will issuea warning and refuse to convert the drawings until you have un-minimised TeklaStructures.

The Packaging Tool is dependent on the x86 version of the Microsoft Visual C++ 2008SP1 ATL Security Update redistributable components. These components are installedautomatically on the target machine by the Packaging Tool installer.

Packaging Tool

Documents

Transcript of Packaging Tool