Download as pdf or txt
Download as pdf or txt
You are on page 1of 82

TABLE OF CONTENTS

1.

Main Window

1.1. Menu

1.2. TreeView

1.3. PropertyView

1.3.1. Condition Editor

1.3.2. Path Editor

2.

Structure

2.1. Report

2.1.1. Project Variables

2.1.2.
Assembly Variables

2.1.3. Part Variables

2.1.4. Program Variables

2.1.5. Variable Properties

2.1.6. Variable Types


2.1.7. Typed Objects

2.2. Documents

2.2.1. Document Types

2.2.2. Process On

2.2.3. Image Attribute Viewer

2.2.4. CSV Document

2.3. Serial Numbers

2.3.1. Serial Number Types

2.3.2. Process On

2.4. Messages

2.4.1. Message Types

2.4.2. Process On

2.5. Transferts

2.5.1. Transfert Types

2.5.2. Document Transferts

2.6. Machines

2.6.1. Conditional Programs Path

 
Global Variables
 

Global Variables
Variable Description Type Modifiable Role
FORMATINFO Format Options   Yes  
ReportPath Report path Yes  
Program
ProgramsPath Yes  
directory
ProgramFile Program file Yes  
Program file if it
ProgramFileIfExist Yes  
already exists
READMESHES Read Meshes Yes  
Use SWOOD
USESWOODDESIGNDATA Yes  
DESIGN Data
Read WebGL
READWEBGLMESHES Yes  
meshes
Compute
SWOOD
COMPUTESWOODDESIGN2013DATA Yes  
DESIGN 2013
Data
Profiling
PROFILING_REPORTED Yes  
Reported
Ignore Excluded
IGNORE_EXCLUDED_FROM_BOM Yes  
From BOM
Process SWOOD
PROCESS_SWOODCAM_REPORT Yes  
CAM Report
Process SWOOD
PROCESS_SWOODCAM_CONDITION Yes  
CAM condition
Program Data in
PROGDATA_INDEBIT_PREFIX Yes  
Stock Prefix
Program Data in
PROGDATA_INDEBIT_SUFFIX Yes  
Stock Suffix
READEPDMIDS Read EPDM IDs Yes  
         
Application
APP No  
variables
DATE Date No  
HOUR Hour No  
NOW Now No  
SolidWorks SolidWorks
SW No
variables Variables
SolidWorks SolidWorks
SWCOMP component No Component
variables Variables
SolidWorks SolidWorks
SWCONF configuration No Configuration
variables Variables
SWCLP SolidWorks Cut No Custom
List Properties properties
associated
with cut lists

 
Project Variables
 

Project Variables
Variable Description Type Modifiable Role
PROJNAME Project name Yes  
Is a nesting
REPORT_ISNESTINGPROJECT Boolean No  
project
Report
REPORTCFGDIR Configuration No  
Directory
Report
REPORTCFGPATH Configuration No  
Path
REPORTCURRENCY Currency No  
Currency
REPORTCURRENCYSYMBOL No  
symbole
REPORTPATH Report path No  
Custom Variable Specifications
 

Custom Variable properties


Property name      Description
Name Name of the variable (can be used in expressions)
Description Description of the variable
Type Type of the variable
Value Forced value of the variable
Expression based on other variables, to return a
Evaluation
computed value

Variable types
Type      Description Image
String A string of characters
Real A real number
Integer An integer number
Boolean A boolean
A real number representing a
Mass
mass
Length/Distance A length in a given format
Angle An angle in a given format
Time A real representing time
DateTime A date
Assembly Variables
 

Assembly Variables
Variable Description Type Modifiable Role
Process SWOOD
PROCESS_SWOODCAM_CONDITION CAM Condition Yes  
for assemblies
DESC Description Yes  
         
CONF Configuration No  
Intege
EPDMFILEID EPDM File ID No  
r
Intege
EPDMFOLDERID EPDM Folder ID No  
r
EPDMVAULT EPDM Vault No  
Boole
ISEPDMFILE Is EPDM File an No  

NAME Name No  
Intege
NB Quantity No  
r
PATH File No  
Intege
PROGCOUNT Program count No  
r
SENSORS Alarms sensors No  
SOLIDWORKS Intege
SWMODELTYPE No  
model type r
TOTYPE Type No  
TOTYPES Object types No  
Boole
TYPED Typed assembly No  
an

 
Part Variables
 

Part Variables
Variable Description Type Modifiable Role
Process
SWOOD CAM
PROCESS_SWOODCAM_CONDITION Yes  
condition for
parts
Stock as Grain
STOK_AS_GRAINDIRECTION Yes  
Direction
Boole
ISDS Is saw stock Yes  
an
DESC Description Yes  
         
Back edgeband
CCHAR No  
code
Front edgeband
CCHAV No  
code
Right edgeband
CCHD No  
code
Left edgeband
CCHG No  
code
With back Boole
CHAR No  
edgeband an
With front Boole
CHAV No  
edgeband an
With right Boole
CHD No  
edgeband an
With left Boole
CHG No  
edgeband an
CMAT Material code No  
Back edgeband
COCHAR No  
color
Front edgeband
COCHAV No  
color
Right edgeband
COCHD No  
color
Left edgeband
COCHG No  
color
CONF Configuration No  
Back edgeband
DCHAR No  
description
Front edgeband
DCHAV No  
description
Right edgeband
DCHD No  
description
Left edgeband
DCHG No  
description
Grain direction Angle No  
DFIL
Grain direction
DFILD Angle No  
/ stock
EdgeBand
EBO_B Back edgeband No
Variables
EdgeBand
EBO_F Front edgeband No
Variables
EdgeBand
EBO_L Left edgeband No
Variables
EdgeBand
EBO_R Right edgeband No
Variables
EP Thickness No  
Back edgeband
EPCHAR No  
thickness
Front edgeband
EPCHAV No  
thickness
Right edgeband
EPCHD No  
thickness
Left edgeband
EPCHG No  
thickness
Rough
EPD No  
thickness
Intege
EPDMFILEID EPDM File ID No  
r
EPDM Folder Intege
EPDMFOLDERID No  
ID r
EPDMVAULT EPDM Vault No  
Boole
FIL Grain No  
an
Boole
ISEPDMFILE Is EPDM File No  
an
LA Width No  
Width without
LAAC No  
edgebands
LAD Rough width No  
Width without
LASC No  
edgebands
Back edgeband
LCHAR No  
length
Front edgeband
LCHAV No  
length
Right edgeband
LCHD No  
length
Left edgeband
LCHG No  
length
LO Length No  
Length with
LOAC No  
edgebands
LOD Rough length No  
Length without
LOSC No  
edgebands
Machining cost
MACCOSTFACTOR Float No  
factor
MASS Weight Float No  
MAT Materials No  
MATCOST Material cost Float No  
Material costing Intege
MATCOSTTYPE No  
type r
Material
MATDESC No  
description
MultiBodyPart
MULTIBODYPART Multi-body part No
Variables
NAME Name No  
Intege
NB Quantity No  
r
Panel
PANEL Panel No
variables
PATH File No  
Back edgeband Intege
PCHAR No  
order r
Front edgeband Intege
PCHAV No  
order r
Right edgeband Intege
PCHD No  
order r
Left edgeband Intege
PCHG No  
order r
Intege
PROGCOUNT Program count No  
r
Back edgeband
RCHAR No  
reference
Front edgeband
RCHAV No  
reference
Right edgeband
RCHD No  
reference
Left edgeband
RCHG No  
reference
SENSORS Alarms sensors No  
SOLIDWORKS Intege
SWMODELTYPE No  
model type r
Variables of the
<TYPEDOBJECT> typed object No  
"TypedObject"
TOTYPE Type No  
TOTYPES Object types No  
Boole
TYPED Typed part No  
an

 
Program Variables
Program Variables
Variable Description Type Modifiable Role
Update Stock
UPDATE_DEBIT_WITH_FIRST_PROGRAM_DATA with First Yes  
Program Data
         
Machine
Inte
INCRA Alphabetical No  
ger
Increment
Machine
Inte
INCRN Numerical No  
ger
Increment
PROG File No  
Program angle Angl
PROG_ANGLE_OP0X_PANELX No  
OP0.X/Panel.X e
PROG_NAME Name No  
Nesti
PROG_NBOARDO Nesting board No Boar
Varia
Nesting sheet Inte
PROG_NSHEETQTY No  
quantity ger
Nesting sheet
PROG_NSHEETSCRAPX No  
scrap X
Nesting sheet
PROG_NSHEETSCRAPY No  
scrap Y
Program Floa
PROG_OP0ZXPANELZ No  
OP0.Z*Panel.Z t
Inte
PROG_PARTCOUNT Part count No  
ger
PROGBX Rough length No  
PROGBY Rough width No  
Rough
PROGBZ No  
thickness
PROGCB Barcode No  
PROGCFGFILE Program file No  
Program
PROGCFGPATH No  
directory
PROGDIR Folder No  
Inte
PROGID Program ID No  
ger
PROGMAC Machine No  
Floa
PROGMAC_HOURCOST Hour cost No  
t
File name
PROGNAME without No  
extension
Full program
PROGPATH No  
file name
PROGTPS Time Tim No  
e
Unproductive Tim
PROGTPSIMPRO No  
time e
Productive Tim
PROGTPSPRO No  
time e
Inte
PROGTYPE Program type No  
ger

 
Typed Object
 

Typed Object Variable Format


Variable Description Type Role
OBJECTVARIABLEFORMAT Typed Object Variable Format  
Typed Object Properties
Variable Description Type Role
NAME Name  
DESCRIPTION Description  
CHECKPART Check Parts  
ISPART Condition Is Part  
IGNOREPART Condition Ignore Part  
ISDEBITSCIEPART Condition Is Saw Stock  
CHECKASSEMBLY Check Assemblies  
ISASSEMBLY Condition Is Assembly  
Condition Ignore
IGNOREASSEMBLY  
Assemblies
ASSEMBLYPROCESSCHILD Process Assembly Child  
ASSEMBLYREADMESHES Read Assembly Meshes  
COST Cost  
Propagate Variable on
PROPAGATEVARIABLEONPART  
Part
Propagate Variable on
PROPAGATEVARIABLEONASSEMBLY  
Assembly
Assembly Children Lock
ASSEMBLYCHILDRENLOCKCOUNTING  
Counting
List of
Custom
variables
VARIABLES Typed Object Variables associated
to the
Typed
Object
Documents
 

Global Document Properties


Property Description Type Role
RESOURCESOURCE
Resource Source path, generally relative to <APP.USERPATH>
Source = User Directory
Resource
RESOURCETARGET  
Target
 
Document Properties
Property Description Type Role
DESIGNATION Name  
TYPEDOCUMENT Type  
PROCESSON Process On  
Evaluable Path of the source file
PATH Path
template
TOTYPE Type of Typed Object  
CONDITION Condition  
HIDDEN Hide Document  
AUTOPROCESS Process Automatically  
File forced type of storage

FORCED_STORAGE_TYPE Forced Storage Type


(File, Binary, Text)
POSTPROCESS Post Process  
POSTPROCESSARGS Post Process Arguments  
Specific properties (if any) based
<TYPEDOCUMENT> <Document Type Name>
on the selected document type
Document Types

 3D PDF (No specific properties)


 Auto Drawing
 CSV
 DGX  (No specific properties)
 Drawing to DXF
 Drawing to eDrawing  (No specific properties)
 Drawing to Image
 Drawing to PDF
 eDrawing  (No specific properties)
 HTML
 Image
 URI
 User Module
 WebGL  (No specific properties)
      Not Specified (When you don't want to specify a type)
Process On

You have to select a type of item to process on:

 Report
 Document
 Assembly
 Part
 Panel
 Stock
 Typed Object
 Program
 Program part
 EdgeBand
 Profiling
 
Auto Drawing

Property Description Type Role


FORMATINFO Format Options  
DRWDOTPATH Drawing dot path  
BOMPATH BOM Path  
AUTOBALLON Auto Bubble  
AUTOBOMTABLE Auto BOM Table  
AUTODIMENSION Auto Dimension  
AUTOBOMTABLEFORPART Auto BOM Table For Part  
CSV

Property Description Type Role


FORMATINFO Format Options  
SEPARATOR Separator Character to separate CSV columns
NBEXPECTEDVALUES Number of Expected Values  
RETURN End Line Return Type CR, CRLF, LF
KEY Key Index  
UPDATE Update  
CREATE Create  
CREATESRC Creation Source  
LOOPON Loop On Item type to loop on
LOOPONTO_TYPE Typed Object to loop on Typed Object Type to loop on
LOOPONCONDITION Loop on Condition  
WITHHEADERS With Headers  
ENCODING Encoding Default, ASCII, UTF8
CSVFIELDS CSV Fields List of defined CSV Fields
Separator:
Right click +   Add Tabulation:
adds a tabulation character in the field, because the "Tab" key is a
special key.
CSV Fields
You can reorder CSV fields by dragging one Field on another, to place it after the one you dropped it on.

If you drop field A on field B, field A will be placed after field B.

Property Description Type Role


FORMATINFO Format Options  
DESIGNATION Name  
VALUE Value  
CONDITIONALVALUE Conditional Values List of conditional values
CSV Conditional Values
Property Description Type Role
CONDITIONNAME Name Name of the conditional value
CONDITION Condition Condition to test
VALUE Value Value if the condition is true
Drawing to DXF

Property Description Type Role


SHEETNAME Sheet Name  
SHEETSFILTER Sheets Filter  
Drawing to Image

Property Description Type Role


SHEETSFILTER Sheets Filter  
DPI DPI Resolution (Dots Per Inch)  
SCALETOFIT Scale to Fit  
SCALEFACTOR Scale Factor  
USESHEETSIZE Use Sheet Size  
IMAGETYPE Image Type  
TIFFCOMPRESSIONSCHEME Tiff Compression Scheme  
JPEGCOMPRESSION JPEG compression (%)  
PADTEXT Pad Text  
INCLUDELAYERSNOTTOPRINT Include non Printed Layers  
PAPERSIZE Paper Size  
PAPERWIDTH Paper Width  
PAPERHEIGHT Paper Height  
 
Image Type:
Black & White
RGB        (Red, Green & Blue)
Gray Scale
RGBA      (Red, Green, Blue & Alpha)

TIFF Compression Scheme:


Uncompressed
Pack Bits
Group For Fax

Paper Size:
A
AV
B
C
D
E
A4
A4V
A3
A2
A1
A0
User Defined
Drawing to PDF

Property Description Type Role


SHEETSFILTER Sheets Filter  
ONEPERSHEET One Per Sheet  
HTML

Property Description Type Role


FORMATINFO Format Options  
Source path, generally relative to

HTMLSRC Source <APP.USERPATH> = User


Directory
ENCODINGTYPE Encoding  
URITYPE URI Type  
Empty Value
EMPTYVALUEREPLACEMENT  
Replacement
Encoding:
      Unknown
      None
 HTML
 JavaScript
 XML
 JSON

URI Type:
Absolute
None
Relative
Relative to Report
Relative to Resource
Relative to Source
Unknown

Right Click  for options:

 Select Source : open the explorer to choose a source directory


 Open File : open the file in the default software (or in the software defined in the settings)
 Check Source File Syntax : go through the source file template to check if the variables used exist
Image

Property Description Type Role


FORMATINFO Format Options  
File format of the image

FORMAT Image Format


(EMF, EXIF, JPEG, PNG, TIFF, WMF)
Size unit for the width and height of the
SIZEUNIT Size Unit image

(cm, in, m, mm, px)


WIDTH Width Width of the image
HEIGHT Height Height of the image
JPGQUALITY JPEG compression (%)  
Rotation of the the image

ROTATION Rotation
(0°, 90°, 180°, 270°)
DPI Resolution (Dots Per
DPI  
Inch)

 Open Image Attribute Viewer

 
URI

Property Description Type Role


ADRESSTEMPLATE Address Template  
QUERYTEMPLATE Query Template  
User Module

Property Description Type Role


USERMODULENAME User Module Name  
USERMODULEDOCUMENTNAME User Module Document Name  
Image Attributes Viewer
 
Process On

You have to select a type of item to process on:

 Report  |   Assembly  |   Part  |   Typed Object

Property Description Type Role


Switch from "Unic view" to "View
UNICVIEW Unic view
multiple"
Only shown if "Unic view" is set to
Unic View    
TRUE
UNICVIEWDM Display style (OA, O, A, AC, F)
(Front, Back, Right, Left, Top, Bottom,
UNICVIEWORIANTATION View
Isometric, Dimetric, Trimetric, Custom)
SECTIONVIEW Section view  
Only shown if "Unic view" is set to
View multiple    
FALSE
VIEWSPROJECTION Views projection (Europe, USA)
FRONTVIEW Front view  
BACKVIEW Back view  
RIGHTVIEW Right view  
LEFTVIEW Left view  
TOPVIEW Top view  
BOTTOMVIEW Bottom view  
3DVIEW 3D view  
Default view display
VIEWSDM (OA, O, A, AC, F)
style
Front view display
FRONTVIEWDM (OA, O, A, AC, F)
style
Back view display
BACKVIEWDM (OA, O, A, AC, F)
style
Right view display
RIGHTVIEWDM (OA, O, A, AC, F)
style
Left view display
LEFTVIEWDM (OA, O, A, AC, F)
style
TOPVIEWDM Top view display style (OA, O, A, AC, F)
Bottom view display
BOTTOMVIEWDM (OA, O, A, AC, F)
style
3DVIEWDM 3D view display style (OA, O, A, AC, F)
(Isometric, Dimetric, Trimetric, Custom
3DVIEWORIENTATION 3D view orientation
View)
Colors      
MESHESCOLOR Meshes color  
EDGESCOLOR Edges color  
EDGESWIDTH Edges width  
HIDDENEDGESCOLOR Hidden edges color  
HIDDENEDGESWIDTH Hidden edges width  
Hidden edges stipple
HIDDENEDGESSTIPPLEFACTOR  
factor
Hidden edges stipple
HIDDENEDGESSTIPPLEPATTERN  
pattern (Hexa value)

 Panel
Property Description Type Role
(Standard, Section view X,
VIEWTYPE View type
Section view Y)
Behavior      
FOCUSONPROGRAM Program focus  
Stock      
PANELBOXVISIBLE Show panel box  
ROUGHVISIBLE Show stock  
ROUGHDISPLAYMODE Stock display style (OA, O, A)
ROUGHCOLOR Stock color  
ROUGHLINETHICKNESSMM Stock line thickness  
ROUGHDIMENSIONSVISIBLE Show dimensions  
ROUGHDIMENSIONSUNITVISIBLE Show dimensions unit  
ROUGHDIMENSIONSHEIGHT Dimensions height  
ROUGHDIMENSIONSCOLOR Dimensions color  
Parts      
PARTVISIBLE Show part  
PARTDISPLAYMODE Part display style (OA, O, A, AC, F)
PARTCOLOR Part color  
PARTGRAINVISIBLE Show grain  
PARTEDGESWIDTH Part edges linewidth  
PARTHIDDENEDGESCOLOR Part hidden edges color  
Part hidden edges
PARTHIDDENEDGESWIDTH  
linewidth
Part hidden edges stipple
PARTHIDDENEDGESSTIPPLEFACTOR  
factor
Part hidden edges stipple
PARTHIDDENEDGESSTIPPLEPATTERN  
pattern (Hexa value)
Edgebands      
EBVISIBLE Show edgebands  
ALLEBVISIBLE Show all edgebands  
EBORDERVISIBLE Edgeband order  
EBCOLOR Edgeband color  
EBDISPLAYMODE Edgeband display style (OA, O, A)
EBNOTEVISIBLE Edgeband note  
EBNOTEHEIGHT Edgeband note height  
(Reference [R], Name [N],
EBNOTESRC Source
Description [D], Evaluated [E])
Section      
FLAT Section always flat  
REDUCE Reduce flat section  
 Stock

Property Description Type Role


ROUGHVISIBLE Show stock  
Stock display
ROUGHDISPLAYMODE (OA, O, A)
style
ROUGHCOLOR Stock color  
Stock line
ROUGHLINETHICKNESSMM  
thickness
Show
ROUGHDIMENSIONSVISIBLE  
dimensions
ROUGHDIMENSIONSUNITVISIBLE Show  
dimensions
unit
Dimensions
ROUGHDIMENSIONSHEIGHT  
height
Dimensions
ROUGHDIMENSIONSCOLOR  
color
SHOWGRAIN Show grain  
       
Show
EBVISIBLE  
edgeband
Show
EBORDERVISIBLE edgeband  
order
Edgeband
EBCOLOR  
color
Edgeban
EBDISPLAYMODE (OA, O, A)
display style
EBNOTEVISIBLE Edgeband note  
Edgeband not
EBNOTEHEIGHT  
height
EBNOTESRC
Edgeband (Reference [R], Name [N], Description
Source [D], Evaluated [E])
EBNOTEVALUE Value  

 Program
Assembly
Property Description Type Role
Program      
APOP0VISIBLE Show OP0  
APOP0PICTUREPATH Picture for OP0  
Worktable      
APMACHINEVISIBLE Show work table  
APZOOMMACHINE Worktable zoom  
Components      
APCOMPSVISIBLE Show components  
(OA, O, A,
APCOMPSDISPLAYMODE Components display style
AC, F)
APCOMPSCOLOR Components color  
APCOMPSHIDDENEDGESCOLOR Components hidden edges color  
APCOMPSEDGESWIDTH Components edges linewidth  
APCOMPSHIDDENEDGESWIDTH Components hidden edges linewidth  
APCOMPSHIDDENEDGESSTIPPLEFACTOR Components hidden edges stipple factor  
Components hidden edges stipple pattern
APCOMPSHIDDENEDGESSTIPPLEPATTERN  
(Hexa value)
Clamping devices      
APCLAMPINGVISIBLE Show clamping devices  
(OA, O, A,
APCLAMPINGDISPLAYMODE Clamping devices display style
AC, F)
APCLAMPINGCOLOR Clamping devices color  
Part
Property Description Type Role
Program      
PPOP0VISIBLE Show OP0  
PPOP0PICTUREPATH Picture for OP0  
Stop      
PPSTOPVISIBLE Show stop  
PPOP0PICTUREPATH Stop picture  
PPSTOPPICTUREORIGX X Stop picture  
PPSTOPPICTUREORIGY Y Stop picture  
Rough      
PPROUGHVISIBLE Show rough  
PPROUGHDISPLAYMODE Rough display style (OA, O, A)
PPROUGHCOLOR Rough color  
PPROUGHDIMENSIONSVISIBLE Show dimensions  
PPROUGHDIMENSIONSUNITVISIBLE Show dimensions unit  
PPROUGHDIMENSIONSHEIGHT Dimensions height  
PPROUGHDIMENSIONSCOLOR Dimensions color  
Worktable      
PPMACHINEVISIBLE Show worktable  
PPZOOMMACHINE Worktable zoom  
Parts      
PPPARTFACESVISIBLE Show faces  
PPPARTDISPLAYMODE Part display style (OA, O, A, AC, F)
PPPARTCOLOR Part color  
PPPARTHIDDENEDGESCOLOR Part hidden edges color  
PPPARTEDGESWIDTH Part edges linewidth  
Part hidden edges
PPPARTHIDDENEDGESWIDTH  
linewidth
Part hidden edges stipple
PPPARTHIDDENEDGESSTIPPLEFACTOR  
factor
Part hidden edges stipple
PPPARTHIDDENEDGESSTIPPLEPATTERN  
pattern (Hexa value)
PPPARTGRAINVISIBLE Show grain  
Edgebands      
PPEBVISIBLE Show edgebands  
PPALLEBVISIBLE Show all edgebands  
PPEBORDERVISIBLE Show edgeband order  
PPEBDISPLAYMODE Edgeband display style (OA, O, A)
PPEBCOLOR Edgeband color  
PPEBNOTEVISIBLE Edgeband note  
PPEBNOTEHEIGHT Edgeband note height  
(Reference [R], Name [N],
PPEBNOTESRC Edgeband source Description [D], Evaluated
[E])
PPEBNOTEVALUE Value  
       
       
       
       
Nesting
Property Description Type Role
Program      
NPOP0VISIBLE Show OP0  
NPOP0PICTUREPATH Picture for OP0  
Worktable      
NPMACHINEVISIBLE Show work table  
NPZOOMMACHINE Worktable zoom  
Board      
NPBOARDVISIBLE Show panel  
NPBOARDDISPLAYMODE Board display style (OA, O, A)
NPBOARDCOLOR Board color  
NPBOARDDIMENSIONSVISIBLE Board display dimensions  
NPBOARDDIMENSIONSUNITVISIBLE Board display dimensions units  
NPBOARDDIMENSIONSHEIGHT Board display dimensions height  
NPBOARDDIMENSIONSCOLOR Board display dimensions color  
Components      
(OA, O, A,
NPCOMPSDISPLAYMODE Components display style
AC, F)
NPCOMPSCOLOR Components color  
NPCOMPSHIDDENEDGESCOLOR Components hidden edges color  
NPCOMPSEDGESWIDTH Components edges linewidth  
NPCOMPSHIDDENEDGESWIDTH Components hidden edges linewidth  
NPCOMPSHIDDENEDGESSTIPPLEFACTOR Components hidden edges stipple factor  
Components hidden edges stipple pattern
NPCOMPSHIDDENEDGESSTIPPLEPATTERN  
(Hex value)
NPCOMPSNOTEVISIBLE Components note  
NPCOMPSNOTESRC Components note content  
NPCOMPSNOTEHEIGHT Components note height  
NPCOMPSNOTECOLOR Components note color  
 Program part
Property Description Type Role
VIEWDM Display style (OA, O, A, AC, F)
MESHESCOLOR Meshes color  
EDGESCOLOR Edges color  
EDGESWIDTH Edges linewidth  
HIDDENEDGESCOLOR Hidden edges color  
 EdgeBand  |   Profiling  |   Document  |   Multi-body part
No image generated yet

Display styles

Name Description
OA Shaded with edges
O Shaded
A Hidden lines removed
AC Hidden lines visible
F Wireframe
Serial Numbers
Serial Number Properties
Property Description Type Role
DESIGNATION Name  
SNTYPE Type of Serial Number  
PROCESSON Process On  
TOTYPE Type of Typed Object  
CONDITION Condition  
SWCP_SOURCE SolidWorks Custom Properties  
SWCP_SOURCE_USEFILEPROPERTY Custom Properties Source, Use File Properties  
NEVEROVERWRITE Never Overwrite  
OVERWRITEVALUES Values for Overwrite  
Serial Number Types

 Report

Property Description Type Role


INITAL_VALUE Initial Value  
INCREMENT Increment  
FORMAT_TEMPLATE Format Template  
KEY_TEMPLATE Key Template  

 User Module

Property Description Type Role


USERMODULENAME User Module Name  
USERMODULETRANSFERTNAME User Module Transfert Name  

 Shared

Property Description Type Role


INITAL_VALUE Initial Value  
INCREMENT Increment  
FORMAT_TEMPLATE Format Template  
KEY_TEMPLATE Key Template  
Process On

You have to select a type of item to process on:

 Report
 Document
 Assembly
 Part
 Panel
 Stock
 Typed Object
 Program
 Program part
 EdgeBand
 Profiling
Messages
 

Message Properties
Variable Description Type Role
DESIGNATION Name  
PROCESSON Process On  
TOTYPE Typed Object Type  
CONDITION Condition List  
TYPE Message Type  
MESSAGE Message  
DESCRIPTION Description Boolean  
Message Types

 Error
 Warning
 Information
Process On

You have to select a type of item to process on:

 Report
 Document
 Assembly
 Part
 Panel
 Stock
 Typed Object
 Program
 Program part
 EdgeBand
 Profiling
Transfert
 

Transfert Properties
Property Description Type Role
DESIGNATION Name  
TYPE Tranfert Type  

 
Transfert Types

 Copy

Property Description Type Role


TARGET_DIRECTORY Target Directory  
OVERWRITE Overwrite  
FILTER Filter  
NEWEXTENSION New Extension  
TOPDIRECTORYONLY Top Directory Only  
FLATTEN Flatten  

 FTP

Property Description Type Role


SERVER Server  
USER User  
PASSWORD Password  
REMOTE_DIRECTORY Remote Directory  
USEPASSIVE Use Passive  

 Mail

Property Description Type Role


MAIL Mail A summary of the eMail to send (from -> to : subject)

 User Module

Property Description Type Role


USERMODULENAME User Module Name  
USERMODULETRANSFERTNAME User Module Transfert Name  

 
Mail Interface

Clik on  

Property Description Type Role


FROM From eMail address of the sender
TO To eMail address of the recipient
CC Cc Carbon Copy
SUBJECT Subject Subject of the mail
BODY Body Content body of the mail
SERVER Server Server to send mail
PORT Port Port for the mail server
USER User Username of the mail account
PASSWORD Password Password of the mail account
Documents Transfert
 

Document Transfert Properties


Property Description Type Role
DESIGNATION Name  
DOCUMENT Document Choose a document
TRANSFERT Transfert Choose a transfert
SOURCEDIRECTORY Source Directory  
AUTOPROCESS Process Automatically  

 
Machine

Global Machine Properties


Property Description Type Role
ProgramsPath Program directory  
ProgramFile Program file  
ProgramFileIfExist Program File if it already exists  
 
Machine Properties
Property Description Type Role
MACNAME Name  
CHECKEXTENSION Check Extension  
PROGRAMSPATH Program directory  
ADDITIONALPROGRAMSPATH Additional Programs Path  
PROGRAMFILE Program file  
Program File if it already
PROGRAMFILEIFEXIST  
exists
PROGRAMFILEMAXLENGTH Program File Max Length  
PROGRAMFILECUTSTART Program File Cut Start  
OVERWRITEEXISTING Overwrite Existing File  
HOURCOST Hour Cost  
CONDITIONAL_PATH
Conditional Programs List of Conditional Programs
Path Path
Conditional Programs Path

Conditional Programs Paths are evaluated in order. If the condition is true, the programs path is set and the
remaining Conditional Programs Paths are ignored.

Property Description Type Role


NAME Name  
CONDITION Condition  
PROGRAMSPATH Program directory  
ADDITIONALPROGRAMSPATH Additional Programs Path  
PROGRAMFILE Program file  
PROGRAMFILEIFEXIST Program File if it already exists  
OVERWRITEEXISTING Overwrite Existing File  
CONDITIONS
Double click on a variable to add it in the editor, at the cursor position.

Accessible variables

Accessible variables
Variable
Description Type
ROOT Project variables
GLOBAL Global variables
DOCUMENTS Document variables
REPORT_SERIALNUMBERS Serial Numbers
ASSEMBLY Assembly variables
COMP Component variables
PRODUCTION Production variables
PART Part variables
PROGRAM Program variables
EDGEBAND EdgeBand variables
STOCK Stock variables
MultiBodyStock
MULTIBODYSTOCK
variables (custom)
PANEL Panel variables
MultiBodyPart
MULTIBODYPART
variables
PROFILING Profiling variables
PROGRAMPART ProgramPart Variables
FUNCTIONS Functions

 Expand condition on multiple lines


Functions
 

Functions table

FUNCTIONS
 

= : Egal = : Equals

> : Supérieur > : Greater than

< : Inférieur < : Less than 

>= : Supérieur ou égal >= : Greater or equal

<= : Inférieur ou égal <= : Less or equal

Arithmetical /= : Différent /= : Different


operators <> : Différent <> : Different

+ : Addition + : Addition

- : Soustraction - : Substraction

* : Multiplication * : Multiplication

/ : Division / : Division

^ : Puissance ^ : Power
Mathematical PI : Nombre pi PI : Pi number
operations
SIN : Sinus SIN : Sine

COS : Cosinus COS : Cosine

TAN : Tangente TAN : Tangent

ATAN : Arctangente ATAN : Arctangent

FIX : Fixer FIX : Fix

SQR : Racine carrée SQR : Square root

ABS : Valeur absolue ABS : Absolute value

MOD : Modulo MOD : Modulo

ET AND

OU OR

NON(ET) NOT(AND)
Boolean
operator
NON(OU) NOT(OR)

VRAI TRUE

FAUX FALSE

CONTIENT CONTAINS

Comparison COMMENCE PAR STARTSWITH


operator
FINIPAR ENDSWITH

MAJ (alias de la variable) UCASE


Fonctions STR : Convertit la variable STR : Converts the
texte en chaîne de caractère. variable to a string.

TRIM : Supprime tous les TRIM : Removes all


espaces du texte sauf spaces from text except for
les espaces entre les single spaces between
mots. (exemple) words. (example)

MID : Renvoie une chaîne MID : Returns a string


de caractères depuis une from a string. (example)
chaîne de caractères.
(exemple) RIGHT : Returns a
specified number of
RIGHT : Renvoie un characters from the right
nombre de caractères side of a string. (example)
spécifié depuis la
droite d'une chaîne de LEFT : Returns a specified
caractères. (exemple) number of characters from
the left side of a
LEFT : Renvoie un strin. (example)
nombre de caractères
spécifié depuis la gauche REPLACE : Returns a
d'une chaîne de caractères. string, which is a substring
(exemple) of a string
expression. (example)
REPLACE : Renvoie une
chaîne de caractères qui est INSTR : Returns the
une "sous-chaîne de position of the first
caractère" d'une chaîne de occurrence of one string
caractère (exemple) within another. (example)

INSTR : Renvoie la INSTRREV : Returns the


position (nombre) de la position of the last
première occurrence d'une occurrence of one string
chaîne de caractères dans within another. (example)
une autre. (exemple)
VAL : Returns the numbers
contained in a string as a
INSTRREV : Renvoie la numeric value. (example)
position (nombre) de la
dernière occurrence d'une LEN : Returns the number
chaîne de caractères dans of characters in a
une autre. (exemple) string. (example)

VAL : Renvoie les


nombres contenues dans
une chaîne de caractères
comme une valeur
numérique. (exemple)

LEN : Renvoie le nombre


de caractère dans une
chaîne de caractères.
(exemple)

TEXT FUNCTIONS EXAMPLES: 

TRIM : 

Format : Trim(text)

Example :

StringTest with a value of " 2019 SWOOD "

Trim(StringTest) will give "2019 SWOOD" without leading nor trailing


spaces

MID : 

Format : Mid(Text, Start Number [, Length Number] )

Example :
StringTest with a value of  "2019 SWOOD"

Mid(StringTest, 5)        gives        "SWOOD"

Mid(StringTest, 5, 2)    gives        "SW"

RIGHT : 

Format : Right(Text, Length Number )

Example :

StringTest with a value of "2019 SWOOD"

Right(StringTest, 4)       gives        "WOOD"

LEFT : 

Format : Left(Text, Length Number )

Example :

StringTest with a value of "2019 SWOOD"

Left(StringTest, 4)          gives        "2019"

REPLACE : 

Format : Replace(Expression Text,  Find Text, ReplaceWith Text, [


Start Number, Count Number ])

Example :

StringTest with a value "2019 SWOOD et SOLIDWORKS"

Replace(StringTest, "O", "I")                  gives        "2019 SWIID et


SILIDWIRKS"

Replace(StringTest, "O", "I", 10, 1)   gives


      "2019 SWOOD
et SILIDWORKS"

INSTR : 

Format :  InStr(Start Number, Input Text, Verification Text )

Example :

StringTest with a value of "2019 SWOOD"

InStr(StringTest, "O")       gives     8

InStr(5, StringTest, "O")   gives     3

INSTRREV : 

Format : InStrRev(Input Text, Verification Text, Start Number )

Example :

StringTest with a value of "XXpXXpXXPXXP"

InStr(StringTest,"P")           gives  12

InStr(StringTest,"P",10)     gives   9

VAL : 

Format : Val(Expression Text)

Example :

StringTest with a value of "2019 SWOOD"

Val(StringTest)     gives   2019

StringTest with a value of "SWOOD 2019"

Val(StringTest)     gives   0

LEN :

Format : Len(Expression Text)

Example :

StringTest with a value of "2019 SWOOD"

Len(StringTest)    gives   10

 
PATHS
Double click on a variable to add it in the editor, at the cursor position.

Accessible variables

Accessible variables
Variable
Description Type
ROOT Project variables
GLOBAL Global variables
DOCUMENTS Document variables
REPORT_SERIALNUMBERS Serial Numbers
ASSEMBLY Assembly variables
COMP Component variables
PRODUCTION Production variables
PART Part variables
PROGRAM Program variables
EDGEBAND EdgeBand variables
STOCK Stock variables
MultiBodyStock
MULTIBODYSTOCK
variables (custom)
PANEL Panel variables
MultiBodyPart
MULTIBODYPART
variables
PROFILING Profiling variables
PROGRAMPART ProgramPart Variables

 
Main Window
 
Menu

Create new report configuration


 Open report configuration
 Save current configuration
 Save current configuration as
Lancer Launch report with current configuration
 Reload SolidWorks project variables
 Settings
 Show error list

 Validate and save modifications, then close the window


 Cancel modifications and close the window

Settings

 Choose a text editor or piece of software to open text sources


(XML, HTML, JS, JSON...)
 Check expression validity (if the checkbox is not checked, only
syntax will be verified)

PropertyView

 Add an element to the list (CSV Fields, Conditional Programs


Path...)
 Open the string editor (condition editor  or paths editor)
Right Click  on a variable for options:
 Open the string editor (condition editor  or paths editor)
 Check string syntax (conditions and paths)
 Delete variable
TreeView
 
Structure

 Report
 Project Variables
 Assembly Variables
 Part Variables
 Panel Variables
 Multibody Stock Variables
 Program Variables
 Typed Objects
 Documents
 Serial Numbers
 Messages
 Transferts
 Transferts
 Document Transferts
 Machines

Click:

On a set node: show the global properties for the selected set
On an element node: show the properties of the selected item

Options

Right Click:

On a set node
 Add an element to the set
 Check if the set children have errors
On an element node
 Delete the element from its parent set
 Check if the element has errors

 Settings

 Choose a text editor or piece of software to open text sources


(XML, HTML, JS, JSON...)
 Check expression validity (if the checkbox is not checked, only
syntax will be verified)
Application Variables
 

Application Variables
Variable Description Type Role
Application Installation
APPPATH  
Path
Report Configuration
REPORTCFGDIR  
Directory
USERNAME Username  
USERPATH User Directory  
Component Variables
 

Component Variables
Variable Description Type Role
Boole
COMP_COUNTED Counted  
an
Exclude Boole
COMP_EXCLUDEFROMSWBOM  
from BOM an
SolidWorks
Intege
COMP_SWID component  
r
ID
Boole
COMP_VISIBLE Visible  
an
Component
COMPCONF  
configuration
Component
COMPNAME  
name

 
Document Variables
 

Document Variables
Variable Description Type Role
DOC_ABSOLUTEURI Document absolute URI  
Document Base64
DOC_B64  
conversion
DOC_DIRECTORY Document directory  
DOC_DOCTYPE Document type  
DOC_EXTENSION Document extension  
Boole
DOC_FILEEXISTS File exists  
an
DOC_FILENAME File name  
DOC_FILENAME

WITHOUTEXTENSION File name without extension  

Boole
DOC_ISBINARY Is binary  
an
Boole
DOC_ISFILE Is file  
an
Boole
DOC_ISTEXT Is text  
an
DOC_OBJECT Reference to a document  
Type of document
DOC_OBJECTTYPE  
referenced
Path to the file associated
DOC_PATH  
with the document
Intege
DOC_PROCESSINGSTATUS Document processing status  
r
Document path relative to
DOC_REPORTRELATIVEPATH  
the report path
Document URI relative to
DOC_REPORTRELATIVEURI  
the report URI
Text content of the
DOC_TEXT  
document
DOC_TYPE File type associated with the  
document

 
Edgeband Variables
 

Edgeband Variables
Variable Description Type Role
EB_C Name  
EB_CO Color  
EB_COST Cost Float  
EB_D Description  
EdgeBand Shape
EB_EBSHAPEO EdgeBand Shape
Variables
EdgeBand
EdgeBand Additional
EB_EBADDSHAPEO Additional Shape
Shape
Variables
EdgeBand (Left)
EB_EBLEFTENDSHAPEO Left End Shape End Shape
Variables
EdgeBand (Right)
EB_EBRIGHTENDSHAPEO Right End Shape End Shape
Variables
EdgeBand Material
EB_EBMATO Material
Variables
Boole
EB_FORCESTOCKEXCLUSION Force stock exclusion  
an
Boole
EB_ISCURVED Is curved  
an
EB_L Length  
EB_LMCOST Cost/Meter Float  
EB_LSTOCK Length (stock)  
EB_N Feature name  
Intege
EB_P Edgeband order  
r
EB_R Reference  
EB_STOCKPOSITION Stock position  
EB_T Thickness  

 
 
EdgeBand Additional Shape
Variables
 

EdgeBand Additional Shape Variables


Variable Description Type Role
EBADDSHAPE_D Description  
Inte
EBADDSHAPE_ID ID  
ger
EBADDSHAPE_N Name  

 
Edgeband End Shape Variables
 

Edgeband End Shape Variables


Variable Description Type Role
EBENDSHAPE_D Description  
Inte
EBENDSHAPE_ID ID  
ger
EBENDSHAPE_N Name  

 
EdgeBand Material Variables
 

EdgeBand Material Variables
Variable Description Type Role
EBMAT_C Name  
EBMAT_CO Color  
EBMAT_D Description  
Intege
EBMAT_ID ID  
r
EBMAT_R Reference  
EBMAT_STO Stock Offset  
EBMAT_T Thickness  
EBMAT_UCOST Cost/Meter Float  
Supplier Supplier  
EdgeBand Shape Variables
 

EdgeBand Shape Variables
Variable Description Type Role
EBSHAPE_D Description  
EBSHAPE_ID ID Integer  
EBSHAPE_N Name  

 
Material Variables
 

Material Variables
Variable Description Type Role
MAT_NAME Name  
MAT_T Thickness  
MAT_CUTREF Code  
MAT_DESC Description  
MAT_WITHGRAIN With grain  
Material
MAT_TYPE  
type
MAT_UCOST Unit cost  
Costing
MAT_COSTTYPE  
type
MAT_DENSITY Density  
MAT_ISFORSAW Is for saw  
Machining
MAT_MACHININGCOSTFACTOR  
cost factor
Layers
MAT_LAYERSCOUNT  
count
Multi-Body Part Variables

Multi-Body Part Variables


Variable Description Type Role
Inte
MBPART_BODYCOUNT Body count  
ger

 
Nesting Board Variables

Nesting Board Variables


Variable Description Type Role
Floa
NBOARD_COST Price  
t
NBOARD_DESC Description  
Inte
NBOARD_ID ID  
ger
NBOARD_L Length  
NBOARD_LamBot Bottom laminate stock  
NBOARD_LamTop Top laminate stock  
NBOARD_MATNAME Material name  
Material
NBOARD_MATO Material
variables
NBOARD_NAME Nom  
NBOARD_R Reference  
NBOARD_S Supplier  
NBOARD_SR Supplier reference  
NBOARD_T Thickness  
Inte
NBOARD_TYPE Type  
ger
NBOARD_W Width  
Panel Variables
 

Panel Variables
Variable Description Type Role
PAN_ANGLEINPART Angle/Part Angle  
Stock
PAN_CORESTOCK Core Stock
Variables
Bottom laminate Stock
PAN_LAMBOT
stock Variables
Stock
PAN_LAMTOP Top laminate stock
Variables
Edgeband corner Intege
PAN_EBC_BL  
Back/Left r
Edgeband corner Intege
PAN_EBC_FR  
Front/Right r
Edgeband corner Intege
PAN_EBC_LF  
Left/Front r
Edgeband corner Intege
PAN_EBC_RB  
Right/Back r
EdgeBand
PAN_EBB Back edgeband
Variables
EdgeBand
PAN_EBF Front edgeband
Variables
EdgeBand
PAN_EBL Left edgeband
Variables
EdgeBand
PAN_EBR Right edgeband
Variables
Boole
PAN_GRAINISVERTICAL Grain is vertical  
an
Boole
PAN_ISSS Is saw stock  
an
PAN_L Length  
Length with
PAN_LWEB  
edgebands
Length without
PAN_LWOEB  
edgebands
PAN_STL Rough length  
PAN_STT Rough thickness  
PAN_STW Rough width  
PAN_T Thickness  
Thickness with
PAN_TWL  
laminate
Thickness without
PAN_TWOL  
laminate
PAN_W Width  
Width with
PAN_WWEB  
edgebands
Width without
PAN_WWOEB  
edgebands

 
Production Variables
 

Production Variables
Variable Description Type Role
PROD_PATH Production path  
Profiling Variables
 

Profiling Variables
Variable Description Type Role
PRF_EEXT End extension  
PRF_L Length  
PRF_N Name  
PRF_OXY XY Offset  
PRF_OZ Z Offset  
Profiling Shape
PRF_PRFSHO Shape
Variables
PRF_SEXT Start extension  

 
Profiling Shape Variables
 

Profiling Shape Variables


Variable Description Type Role
PRFSH_D Description  
PRFSH_ID ID Integer  
PRFSH_N Name  

 
Program Part Variables
Program Part Variables
Variable Description Type Role
Biesse Nesting
PROGPART_BIESSENESTINGBPGR  
BPGR
PROGPART_
Biesse Nesting
 
BIESSENESTINGDRWCONTENT DRW Content
Inte
PROGPART_ID Program part ID  
ger
Angl
PROGPART_LABELANG Angle label  
e
PROGPART_LABELX X Label  
PROGPART_LABELY Y Label  
Angl
PROGPART_NANGLE Lasting angle  
e
Part
PROGPART_PARTO Part
variables

 
SolidWorks Variables
 

SolidWorks Variables
Variable Description Type Role
CONF Configuration  
DESCRIPTION Description  
DIRECTORY Directory  
IDMATERIAL Material ID  
MATERIAL Material  
PATH Path  
REVISIONNUMBER Revision Number  
Summary
SUMMINFOAUTHOR  
Information Author
Summary
SUMMINFOCOMMENT Information  
Comments
Summary
SUMMINFOCREATEDATE  
Information Created
Summary
SUMMINFOCREATEDATE2 Information Created  
2
Summary
SUMMINFOKEYWORDS Information  
Keywords
Summary
SUMMINFOSAVEDATE Information Last  
Saved
Summary
SUMMINFOSAVEDATE2 Information Last  
Saved 2
SUMMINFOSAVEDBY Summary  
Information Last
Saved By
Summary
SUMMINFOSUBJECT  
Information Subjet
Summary
SUMMINFOTITLE  
Information Title
TITLE Title  
WEIGHT Weight, mass  

 
Stock Variables
 

Stock Variables
Variable Description Type Role
ST_ANGLEINPANEL Angle/Panel Angle  
ST_CMAT Material code  
ST_COST Stock cost Float  
ST_DESC Stock description  
ST_DFIL Grain direction Angle  
Boole
ST_FIL Grain  
an
Boole
ST_GRAINISVERTICAL Grain is vertical  
an
Boole
ST_ISCURVED Is cruved stock  
an
Boole
ST_ISDS Is saw stock  
an
ST_MAT Material  
ST_MATCOST Material cost Float  
ST_MATDESC Material description  
Edgeband
ST_REB Right edgeband
variables
Edgeband
ST_LEB Left edgeband
variable
Edgeband
ST_FEB Front edgeband
variable
Edgeband
ST_BEB Back edgeband
variable
Material
ST_MATO Material
variables
ST_MATTYPE Material type  
ST_N Name  
ST_L Rough length  
ST_T Rough thickness  
ST_W Rough width  

 
SolidWorks Component Variables
 

SolidWorks Component Variables
Variable Description Type Role
CONF Configuration  
Exclude from Boole
EXCLUDE_FROM_BOM  
BOM an
Name of
NAME  
configuration
REFERENCE Reference  
Boole
VISIBLE Visible  
an

 
SolidWorks Configuration Variables
 

SolidWorks Configuration Variables
Variable Description Type Role
ALTERNATENAME Alternate name  
COMMENT Comment  
DESCRIPTION Description  
Name Name  

You might also like