erpworks-sw-config.yml

SolidWorks configuration file

This configuration file changes how ERPWorks interacts with SolidWorks.

Dynamic Values

Some of the values in this configuration file can contain SolidWorks custom properties or other variables. Currently supported dynamic values are:

Dynamic Value Function
@FileName Replaced with the name of the current file. Useful for getting the parent item ID.
$PRPSHEET:"x" Replaced with the SolidWorks custom property called x.

SolidWorks Parent Item ID

Where can ERPWorks find the current parent item ID? May contain dynamic values.

Example

SolidWorks Parent Item ID: "@FileName"

SolidWorks Parent Description

Where can ERPWorks find the current parent item description? May contain dynamic values.

Example

SolidWorks Parent Description: $PRPSHEET:"Name"

SolidWorks BOM Table Fields

Contains a mapping from SolidWorks BOM column headers to their meaning to ERPWorks. Must contain one of each child element: Child ID, Child Description, Quantity, Dim1, Dim2, Dim3, Item Number. All of the child elements are configured identically.

Example

SolidWorks BOM Table Fields:
  # Column header of child component's balloon ID in SolidWorks BOM table
  Child ID:
    Name: Child ID
    Header:
      - PART NUMBER

  # Column header of child component's description in SolidWorks BOM table
  Child Description:
    Name: Child Description
    Header:
      - DESCRIPTION

  # Column header of child component's quantity in SolidWorks BOM table
  Quantity:
    Name: SW QTY
    Header:
      - QTY.
      - QUANTITY
      - Quantity

  # Column header of child component's DIM1 in SolidWorks BOM table
  Dim1:
    Name: SW DIM1
    Header:
      - DIM1
      - LENGTH
      - Length

  # Column header of child component's DIM2 in SolidWorks BOM table
  Dim2:
    Name: SW DIM2
    Header:
      - DIM2
      - WIDTH
      - Width

  # Column header of child component's DIM3 in SolidWorks BOM table
  Dim3:
    Name: SW DIM3
    Header:
      - DIM3
      - DEPTH
      - Depth
      - HEIGHT
      - Height

  # Column header of child component's item number in SolidWorks BOM table
  Item Number:
    Name: Item No.
    Header:
      - ITEM NO.
      - Item Number
      - "Item #"

Child Element → Name

The name of this column as displayed in ERPWorks.

Child Element → Header

A list of strings that may identify the column header in the SolidWorks BOM table.

SolidWorks Cut List Table Fields

Configured identically to SolidWorks BOM Table Fields, except this option identifies the same columns in cut list tables instead of bill of materials tables.

Example

SolidWorks Cut List Table Fields:
  # Column header of child component's balloon ID in SolidWorks weld table
  Child ID:
    Name: Child ID
    Header:
      - PART NUMBER

  # Column header of child component's description in SolidWorks weld table
  Child Description:
    Name: Child Description
    Header:
      - DESCRIPTION

  # Column header of child component's quantity in SolidWorks weld table
  Quantity:
    Name: SW QTY
    Header:
      - QTY.

  # Column header of child component's DIM1 in SolidWorks weld table
  Dim1:
    Name: SW DIM1
    Header:
      - DIM1
      - WELD LENGTH
      - SM Length

  # Column header of child component's DIM2 in SolidWorks weld table
  Dim2:
    Name: SW DIM2
    Header:
      - DIM2
      - Width

  # Column header of child component's DIM3 in SolidWorks weld table
  Dim3:
    Name: SW DIM3
    Header:
      - DIM3
      - Thickness

  # Column header of child component's item number in SolidWorks weld table
  Item Number:
    Name: Item No.
    Header:
      - ITEM NO.

Singleton Custom Properties

ERPWorks considers bill-of-materials tables that only contain one child row and do not contain columns for DIM1, DIM2, and DIM3 to be “singleton” items, and will read the dimensions from these settings instead. May contain dynamic values.

Example

Singleton Custom Properties:
  DIM1: $PRPSHEET:"DIM_1"
  DIM2: $PRPSHEET:"DIM_2"
  DIM3: $PRPSHEET:"DIM_3"
Last modified May 19, 2020