Skip to main content

Download and Installation (PDM)

EddyPiper
  • Updated

Before using the add-in, configure the MaXXlink web application as follows:

BOM Template Setup:

  1. Go to MaXXlink Web.
  2. Navigate to:
    Settings → Templates → BOM Templates
  3. Click Create New BOM Template .
  4. Fill in the following:
    • Template Name: (enter a name of your choice)
    • Template Type: Select External Source Template
    • External Source: Select SolidWorks PDM
  5. Click Save.

Item Template Setup

  1. Go to MaXXlink Web.
  2. Login as an Administrator.
  3. Navigate to:
    Settings → Templates → Item Templates
  4. Click Create New Item Template.
  5. Fill in the following:
    • Template Name: (enter a name of your choice)
    • Template Type: Select External Source Template
    • External Source: Select SolidWorks PDM
  6. Click Save.

Data Card Setup

  1. Open SOLIDWORKS PDM Administration and access your vault.
  2. In the left pane, find the Cards (File Cards) and locate the card that your assemblies are typically pushed via.
  3. Right-click the Assembly card and choose Edit (or double-click to open it in the Card Editor).
  4. In the Card Editor, add a new control of type Button.
  5. Set the Button properties as follows to add a button with 'Send to MaXXlink' capabilities: 
    • Label: This can be done as you please (example: Send to MaXXlink). 
    • Command Type: Run add-in.

    • Name of Add-in: MLSend This must be set to MLSend as required by the add-in config.

  6. Proceed to do the same so your card has a button with 'Sync Custom Properties' capabilities:
    • Label: This can be done as you please (example: Send to MaXXlink). 
    • Command Type: Run add-in.
    • Name of Add-in: MLCustomSync This must be set to MLCustomSync as required by the add-in config.

  7. Save the card changes.

 

Installation & Setup

Prerequisites

  • SolidWorks PDM installed
  • Administrator privileges
  • Internet connection (for login & web integration)

Local Setup Steps

  1. If you have a previous version installed, please uninstall it before proceeding.

  2. Before extracting the zip file you've been provided with, ensure you unblock it. To do so, right-click the item and select 'properties', then navigate to the bottom right to make sure 'Unblock' is ticked.

  3. Copy and extract the MaXXlink_Solidworks_PDM_Addin.zip file to any location on your local machine.
  4. Open PDM Administration and log in to your vault.
  5. Right-click on “Add-ins” → select “New Add-in". In the browser window that appears, navigate to the extracted folder and select the files EPDM.Interop.epdm.dll and MaXXlinkPDM.

Uninstalling the Add-In

In the instance the add-in is having issues, this may warrant a reinstallation.

  1. Open SOLIDWORKS PDM Administration and login to your vault.
  2. Expand “Add-ins”, right-click on “MaXXlinkPDM", and select Remove.

Send Assembly to MaXXlink (New BOM)

This operation sends your assembly and all child components to MaXXlink as a new BOM entry.

Steps:

  1. Open SolidWorks PDM.
  2. Open the Assembly file (.SLDASM) you want to send.
  3. Select the assembly and click the Check In button on the toolbar. Ensure the parent-child relations also exist under the 'Bill of Materials' tab.
  4. Click the "Send to MaXXlink" button on the SolidWorks PDM Data card.
  5. Enter your MaXXlink credentials and click Login.

  6. If the assembly doesn't already exist in MaXXlink:

    A new BOM will be created automatically using the assembly filename.

    The BOM will include the assembly and all child components.

    Custom properties (quantities, part numbers, etc.) will be populated based on your template configuration.

    A success message will confirm the BOM has been sent.

  7. If the assembly already exists in MaXXlink:

    You will see the Merge Preferences window with options to Merge, Clone, or Compare (see Operations with Existing BOMs section below).

Note: The "Send to MaXXlink" button sends BOM structure and metadata. The "Sync Custom Fields" button must be used first to make custom property columns available in MaXXlink Web.

Syncing SolidWorks PDM Custom Fields with MaXXlink

Step 1: Sync Custom Fields from SolidWorks PDM

  1. Open your vault.
  2. Open the Assembly file (.SLDASM) you want to send.
  3. Select the assembly and click the 'Check In' button on the toolbar.
  4. Click the Sync Custom Fields". Button on the Solidworks PDM Data card.
  5. Enter your MaXXlink credentials and click Login.
  6. Wait for a success message confirming the sync is complete.

Step 2: Configure External Properties in MaXXlink

  1. Log in to the MaXXlink web application.
  2. Navigate to Settings → Template → External Properties tab.
  3. Under External Source, select SolidWorks PDM.
  4. Choose the necessary custom fields you want to use.
  5. Click Save.

Step 3: Add Custom Fields to BOM Template

  1. Go to the BOM Template tab.
  2. Edit your SolidWorks PDM BOM template.
  3. Expand the BOM Line section.
  4. Select Custom as the field type.
  5. Add the new field and configure it as per your preferences, but ensure that under 'External Property' your custom field is added. 

  6. This will now carry the custom field metadata over to the BOM line whenever you select your 'Send to MaXXlink' button.

     

Operations with Existing BOMs (Merge, Clone, Compare):

Sync BOM – New BOM

  1. Open SolidWorks PDM.
  2. Open an Assembly file (.SLDASM) that you want to process.
  3. Select the assembly and click the Check In button on the toolbar.
  4. Click the "Send to MaXXlink Web" button on the SolidWorks PDM Data card.
  5. Enter your MaXXlink credentials and click Login.
  6. A success message will confirm the BOM has been sent as a new entry.

Sync BOM – Existing BOM (Merge, Clone or Compare)

  1. Open SolidWorks PDM.
  2. Open an Assembly file (.SLDASM) that you want to process.
  3. Select the assembly and click the Check In button on the toolbar.
  4. Click the "Send to MaXXlink Web" button on the SolidWorks PDM Data card.
  5. Enter your MaXXlink credentials and click Login.

  6. In the Merge Preferences window:

    If you choose Clone BOM (requires new revision)

    Update the revision in PDM:

    1. Check Out the assembly: Right-click on the assembly → Check Out.
    2. Change the Revision: Select the Assembly → open the Data Card → find Revision → set the next revision (e.g., A → B or 1 → 2) → Save the data card.
    3. Check In the assembly: Right-click → Check In (add a note like "Revision updated for BOM clone").
    4. Complete the Clone:
      • In Merge Preferences, ensure Clone BOM is selected.
      • Enter the new BOM name.
      • Click OK to sync.

    If you choose Merge BOM (no revision change required)

    • Select Merge BOM.
    • Choose the existing BOM from the dropdown.
    • Click OK to sync.

    If you choose Compare BOM (no revision change required)

    • Select Merge BOM.
    • Choose the existing BOM from the dropdown.
    • Click Compare Button.
    • You will navigate to the BOM Compare Page.
  7. Click the OK button to complete the sync.
  8. A success message will confirm that the BOM has been changed/sent to MaXXlink successfully. 

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk