Tekla EPM Plugin

Owned by Chris Randolph
Last updated: Apr 23, 2019
12 min read

General Description

The Tekla EPM Plugin (formerly FabSuite TME) allows for seamless communication between Tekla EPM and Tekla Structures. The Tekla EPM Plugin integrates with Tekla Structures allowing you to:

  1. Export the Tekla Structures model into a compressed EPM XML file. This single file contains the Drawings, Revisions, Bill of Materials, User-Defined Attributes, CNC Files, and Drawing Files.
  2. Import an EPM XML file into Tekla Structures to update the model with the current status information and colorize the model based on those statuses.

Installation

The Tekla EPM Plugin supports and is installed with Tekla Structures (including the Tekla EPM Modeler) 2019 and above. Periodic updates will be made available in the Tekla Warehouse.

Running the Tekla EPM Plugin

You can access the Tekla EPM Plugin from the Tekla Structures Applications and Components window. Click the icon to launch the Tekla EPM Plugin:

There are three tabs across the top of the Tekla EPM Plugin:

Export to Tekla EPM: Exporting from Tekla Structures into Tekla EPM XML

Import into Tekla Structures: Importing from Tekla EPM XML into Tekla Structures

About: Tekla EPM Plugin version information, Build Date, and link to the user manual

The Export to Tekla EPM tab has four sections where you can select the export settings:

Tekla EPM XML Filename

Export Settings

Drawing Files

CNC Files

Once you have established the desired export settings, click the Export to Tekla EPM button. This will begin the export and save the current settings. The next time you launch the plugin the same settings will be populated automatically.

As the export proceeds, the progress as well as any warning or error messages will be displayed in the Output area at the bottom of the screen. When the import completes, the full path of the export file will be shown, the destination folder will open, and you will be provided with a button to copy the file location to the clipboard – making it easier to add in EPM.

Tekla EPM XML Filename

The top section determines where the export file will be saved. By default, the Auto-Generate Filename option will be checked.


When the Auto-Generate Filename option is checked, the plugin will automatically save the export file in a Tekla EPM directory under the model path. The file will be named with the Project Number, followed by an underscore, followed by a number that will increment for each export.

For example, the model that is currently open has a Project Number of PROJ-NUM. When the export is performed it will be saved to:

TeklaStructuresModels\PowerFab-01\Tekla EPM\PROJ-NUM_1.zip

The next export will have the same path except the number will increment:

TeklaStructuresModels\PowerFab-01\Tekla EPM\PROJ-NUM_2.zip

TeklaStructuresModels\PowerFab-01\Tekla EPM\PROJ-NUM_3.zip

Since the Tekla EPM plugin is generating the filename automatically, the Filename input as well as the Browse button are disabled.


When the Auto-Generate Filename option is not checked, the Filename input and Browse button are enabled. You can enter or browse to any directory and filename that you wish.

Export Settings

The section on the left has options to determine the data that will be exported from the model.

Export All or Selected Drawings

All – Export data for all drawings.

Selected from Drawing List – Export only data for drawings currently selected in the Drawing List.

Selected from Model – Export only data for drawings currently selected in the Model.

The Tekla EPM Plugin will check each drawing included in the export to ensure that it is Up to Date. If any drawings are not Up to Date, you will receive a warning message and an option to continue with the export.

Include Assemblies

If unchecked, assembly data is omitted from the XML, and CNC is also omitted from the export.

Include Single Part Drawings

Include the single part drawings information and files (if drawing files are included in the export).

Include General Arrangement Drawings

Include the general arrangement drawing information and files (if drawing files are included in the export).

Include Multi-Drawings

Include multi-drawing information and files (if drawing files are included in the export).

Include Drawing UDAs

Include User-Defined fields for the drawings.
"From Report" includes data from your "450 TeklaEPM_Drawing_UserDefined_v1.rpt" report. By default: Drawn By, Checked By, and Checked Date.
"From Drawing (slow)" will include all drawing UDAs that are populated, but may take some time.
"From Both (slow)" combines the two above.

For information on how to customize the UserDefined fields that are included in the report, see Customizing User-Defined Export Fields.

Include Part UDAs

Include User-Defined fields for the parts.
"From Report" included data from your "450 TeklaEPM_Part_UserDefined_v1.rpt" report. By default: User Field 1, User Field 2, User Field 3, User Field 4, and Comment.
"From Model" generates data directly from the model. 
"From Both" combines the two above.

For information on how to customize the User-Defined fields that are included, see Customizing User-Defined Export Fields.

Include Bolts-Nuts-Washers

Include bolt/nut/washer information in the export

Include Bolt-Nut-Washer UDAs

Include User-Defined fields for bolts, nuts and washers.
"From Report" includes data from your "450 TeklaEPM_BoltNutWasher_UserDefined_v1.rpt" report. By default: GUID, IsBoltNutWasher and Comment.
"From Model" generates data directly from the model. 
"From Both" combines the two above.

For information on how to customize the User-Defined fields that are included, see Customizing User-Defined Export Fields.

Include Studs

Include stud information in the export

Include Stud User-Defined Fields

Include User-Defined fields for studs.
"From Report" includes data from your "450 TeklaEPM_Stud_UserDefined_v1.rpt" report. By default: GUID and Comment.
"From Model" generates data directly from the model. 
"From Both" combines the two above.

For information on how to customize the User-Defined fields that are included, see Customizing User-Defined Export Fields.

Drawing Files

The section on the top-right has options for including the drawing files with the export.

Do not Export Drawing Files

Drawing files will not be included in the export.

Use Drawing Files From Directory

Drawing files from the directory selected will be included in the export. The filenames must match the drawing #, excluding the file extension. For example, drawing # 200 -> 200.pdf

During export you will receive a warning if files are not found for all drawings included in the export, along with an option to continue:


CNC Files

The section on the bottom-right has options for including CNC files with the export.

Do not Export CNC Files

CNC files will not be included in the export.

Generate CNC Files

CNC files will be generated from the current model. Select the Tekla Structures NC export setting to use.

Use CNC Files From Directory

CNC files from the directory listed below will be included in the export. The filenames must match the piece mark, excluding the file extension. For example, piece mark w104 -> w104.nc1

During export you will receive a warning if files are not found for all piece marks included in the export, along with an option to continue.


Tekla EPM XML Import

To import the XML file into Tekla EPM, first open the EPM application and log in. Select the menu option File -> Import.

On the Import screen, select the Production Control (XML) import option. On the top right of the screen browse to the file that was exported using the Tekla EPM Plugin. Click the Import button to begin.

If user-defined fields have been included in the file, then a screen will appear to select the EPM field to map each of them to. For more information on including user-defined fields in the export file, see Customizing User-Defined Export Fields.

The Import Field Map screen will open first for the drawing user-defined fields. The display in the middle of the screen shows the user-defined fields in the current file along with example data in that field. On the right, there is a drop-down box to select the Tekla EPM Field to map to: 

Click on a field in the list, select the appropriate EPM field on the right, and click the Set button. When each field has been set, click OK on the bottom of the screen.

User-Defined fields with no data (all blank values) are ignored by the import and will not appear on the Import Field Map screen.

Tekla EPM has the ability to save the field mappings as a new Import Type. During an import the list of user-defined fields is compared against a previously saved Import Type. If a match is found you can proceed using that Import Type without re-entering the field mappings.

If you wish to save these settings for future use, click Yes. When prompted enter a name to describe the Import Type.

If another file with the same user-defined fields is imported, the match will be found. Click Yes to proceed using that saved Import Type.

After the drawing and part user-defined fields have been mapped to EPM fields the Production Control Job Edit screen will open. Enter the Job Number to use in EPM or select an existing job to import revisions into. Enter any desired settings and job information and click the Save button on the bottom of the screen.

If the job does not already exist in EPM then you will be prompted to add a Project Management job, click Yes.

The import will now proceed to validate and save the job into EPM. If CNC and/or Drawing Files were included in the file then they will automatically be added to EPM.

To view the bill of materials, click the Production Control button on the title bar of the Tekla EPM application. Select the job that was just imported and click the Open button on the bottom of the screen.


The Production Control Job screen lists the bill of materials and has options to track, process, and report on the job. See Tekla EPM User Assistance for more information on working with a Production Control job.

The right side of the screen shows the information of the line item currently selected. As you can see on the right, the values of the Part User-Defined have been saved to the Category and Sub-Category fields that were selected on the Import Field Map screen. The three columns on the right of the middle display show information from the CNC files now available in EPM.

To open the Drawing Log, select the menu option Production Control -> Drawing Log.

The Drawing Log shows each of the drawings that have been imported into EPM. The values from the Drawing User-Defined fields have been saved into the Checked By and Date Checked fields that were selected on the Import Field Map screen.

The left-most field in the main display shows an ‘F’ for each drawing that has a file associated with it in EPM.

When a drawing as an ‘F’ in that field, indicating that a file is available, you can double-click on the drawing in the list and the file will open. The drawing files can also be opened directly from the Production Control job screen by double-clicking on a line item in the bill of materials.

Export Status from Tekla EPM to XML

To open the job, click the Production Control button on the title bar of the EPM application. Select the job that you would like to export and click the Open button on the bottom of the screen.

To export the job, select the menu option Production Control -> Export -> Export Production Status to XML - Tekla Structures.

The status can also be exported from the Project Management module. Click the Project Management button on the title bar of the EPM application. Select the job that you would like to export and click the Open button on the bottom of the screen.

To export the job, select the menu option Project Management -> Data Exchange -> Export Production Status to XML - Tekla Structures.

Import Tekla EPM XML into Tekla Structures

In Tekla Structures, double-click the Tekla EPM Plugin icon in Applications & components:

Select the second tab – Import into Tekla Structures.

The Import into Tekla Structures tab has three sections where you can select the import settings:

Tekla EPM XML Filename

Import Settings

Display Settings

Once you have established the desired import settings, click the Import from EPM button. This will begin the import and save the current settings. The next time you launch the plugin, the same settings will be populated automatically.


As the import proceeds, the progress as well as any warning or error messages will be displayed in the Output area at the bottom of the screen. When the import completes, the Import Results screen will appear.

Import Results

The Import Results screen will open automatically when the import file has been read. The drawings are listed first, followed by the parts that have been imported. The fields in the table are the Drawing Number, Assembly Mark, Part Mark, Sequence, Lot #, followed by the Import Fields that were selected in the Import Settings area.

The information displayed was read from the Tekla EPM XML file. During the import it is compared against the existing data in the Tekla Structures model. When the imported data is different than the model, the field is highlighted in yellow.

So far, the model has not been updated. The Tekla EPM XML file has only been read and compared against the model.

The options across the top of the screen allow you interact with the model:

Select and Zoom

Select one or more parts in the list and click the Select and Zoom button. Those parts will be selected in the model and the view will Zoom to that area.


Refresh

Reloads the information from the model and refreshes the display. Use the following options to restrict the information that is displayed after the Refresh button is clicked.

Use Model Selection

Check Use Model Selection, then click Refresh to view only display the parts that are currently selected in the model.

Modified Objects Only

Check Modified Objects Only and click Refresh to view only drawings and parts that have information that is different than the model.

Update Model

Updates the model with the information displayed in the list. When the update has completed, the list will reload showing that the values are now the same as in the model (no longer highlighted in yellow).

Only the drawings and parts currently displayed in the list will be updated. For example, if Use Model Selection is checked, only objects selected in the model will be updated, no other parts will been affected.

To update all drawings and parts:

  1. Un-check the Use Model Selection option.
  2. Click the Refresh button.
  3. Click the Update Model button.

Object Representation

This option allows you to apply a representation to the model, colorizing the parts by status. Click here for more information on setting up object representation.

To add additional representations to the drop-down, enter them in the Display Settings area of the import tab.

To apply a representation to the model, select it in the drop-down and click the Set button.

The image above shows that Phase 1 has been erected (blue), while the other phases have last completed the paint station in the shop. 

For more information, select items in the model. On the Import Result screen in the Tekla EPM Plugin, select the Use Model Selection option and click Refresh.

Tekla EPM XML Filename

Enter or browse to the EPM XML file to import. The file could have the extension .XML or .ZIP if it is compressed.

Import Settings

Two sections have settings to determine the data that will be imported from the Tekla EPM XML file.

Read Status of:

Choose the option for the types of parts/drawings that should be imported.

Update Fields:

Select the individual fields that should be imported.

Import Results

The section on the right allows you to enter the Object Representations that will be available on the Import Results screen. The representations must exist in Tekla Structures.

Customizing User-Defined Export Fields

The User-Defined export fields come from two Tekla Structures reports that are installed with the Tekla EPM Plugin:

450 TeklaEPM_Drawing_UserDefined_v1.rpt

450 TeklaEPM_Part_UserDefined_v1.rpt

450 TeklaEPM_Stud_UserDefined_v1.rpt

450 TeklaEPM_BoltNutWasher_UserDefined_v1.rpt

Do not customize any of the other reports installed by the Tekla EPM Plugin.

These reports, along with several others, are installed in the folder for your environment :

Environments\USA\common\Steel\Reports (for TS 2019)

The UserDefined reports produce a tab-delimited text file. These reports can be customized to retrieve different information from the Tekla model, subject to the following restrictions:

  • The report fields must be separated by a tab character.
  • The report must have a single header line containing the name of each field. These names will be included in the export file. During the EPM import, the names will be displayed for the user to decide which Tekla EPM field to bring the data into.
  • The field names cannot be duplicated.
  • Part UserDefined report – The first field must be the part GUID. The name in the report header of the first field must be: GUID
  • Drawing UserDefined report – The first field must be the drawing ID. The name in the report header of the first field must be: ID
  • The report header must be a single line.
  • Each record in the report must be a single line.

After customizing a report, copy it into the appropriate directory and overwrite the existing file. 


Important: Keep extra copies of the customized reports in a directory other than the ones listed above. If you install a Tekla EPM Plugin upgrade in the future your reports will be overwritten. You will need extra copies to re-install.