Custom Property Worker Documentation

1.Welcome


Welcome to the help page of the CustomPropertyWorker Addin for SOLIDWORKS.
CustomPropertyWorker is a powerful tool that creates, edit and delete general and configuration-specific custom properties in SOLIDWORKS part and assembly documents.

Here’s an non-exhaustive list of the features:

  • Create, update and delete, custom properties general and configuration specific
  • Smart search capabilites include:
    • Searching all open documents
    • Search at component-level inside assembly document with filtering
    • Search directories and sub-directories for SOLIDWORKS parts and documents
    • Target files based on their extension
  • Powerful text search replace capability through regular expressions
  • Ability to save custom properties in a project file
  • Edit component document properties from within the context of an assembly
  • Real-time reporting and error handling
  • PDM support for checking in and checking out files (coming soon)
  • Date and Time job scheduling for time-consuming project (coming soon)

2.System Requirements

  • Windows 7 or later, 64x.
  • SOLIDOWRKS 2014 64x or later.
  • Microsoft .NET Framework 4.0 or later.
  • Internet connection (activation).
  • A disk space of 10 mb.

3.Quick Walkthrough of the CustomPropertyWorkerAddin

4.How to install the CustomPropertyWorker Addin

To install the addin:

  • Make sure that all SOLIDWORKS sessions are closed.
  • Launch the installer and follow the wizard.
    • By default, the addin will install in the Program Data folder. Pleasr sure that if you chose another directory that the latter does not require read-and-write permissions. The Addin may be perform some disk reading and write operations that necessary to its normal functioning.
  • Launch SOLIDWORKS and activate the Addin from the Addins window.

5.How to activate the addin?

Whether you’re purchasing any version of the addin or you’re trying a trial version for the time, all installs of the CustomPropertyWorker addin require online activation.

To activate your license, please go to the Help group box.

  • Click on Activate your license: 
    • You’ll be prompted your activation key.
  •  Click on Activate to activate your license.

By activation, you gain access to the full functionalities of the premium version of the AddIn. 

6.How to work with projects

Projects are files with the extension cpwp (CustomPropertyWorkerProject).

a cpwp file contains:

  • a list of custom properties and their data
  • smart search settings

By default, the Addin creates a new project everytime you start it.
You can load an existing project by:

  • Clicking on the Open button in the dashboard
  • Choosing a cpwp files
  • Cliking open in the open dialog box

You can also save projects with new names or save changes by clicking the respective buttons “Save As” and “Save” in your dashboard.

Every time you may make changes, please make sure to save your project so not lose your progress.

 

7.Working with custom properties

You can add custom properties to your project by clicking on the “Add/Edit” button in your dashboard.

If you have a preselected custom property in the dashboard then you’ll be prompted to edit, otherwise, the addin will prompt you to create a new one:

  1. Name:
    Name of the custom property. This field supports regular expressions. 
  2. Activate regular expressions (Name):
    You can enable regular expressions to make advanced search patterns.
  3. Value:
    Value of the custom property. Not to be confused with the resolved value.
  4. To be replaced:
    The portion of the value to be replaced. This field supports regular expressions.
  5. Replace with:
    The value to replace the to be replaced field in the custom property’s value.
  6. File Type
    Target Part or Assembly
  7. Type
    The type answers the question: where does this custom property in exists? Is it at the document level or is configuration-specific? If you check configuration specific, then you need to provide configuration names in the field 10.
  8. Actions
    The actions to be taken with processing files. The priority will be giving in the following order when multiple actions are checked: Delete, Create and then Update. 
  9. Apply to
    You can apply actions to either the active configuration, all configurations or a specific ones.
  10. Configurations:
    Names of target configurations seperated by a ‘;’.

 

NOTA: The Addin automatically detects the SOLIDWORKS type of the custom property. At this moment, the addin supports: Text, Number and Date types.

9.Employing regular expressions to use advanced matching techniques

Regular expressions are a powerful tool to parse text using complicated patterns.
For a full reference to how to use regex, we kindly advise to check the following references:

  • Regular-Expressions.info: contains wholistic overview of regular expressions.
  • Regex101.com: a Tool to test your regular expressions online.
    • Example: Matching an entire text
      Use the ^$ to delimit the entire search query.
      For example, a regular expression of  “Description” will match “Description” and also “Description-Configuration”. Using “^Description$” will only match “Description” and not “Description-Configuration”.
    • Example: Matching a start of a text
      To match a component name that start with “D1000”. Use the following regular expressions
      “^D1000”. This ensure that the matching occurs from the start of the target text only. Matches that in the middle of or the end of the target string will be ignored.

If you’re looking into getting started with regex, please send a message and we can help you with the patterns.

10.Using special sequences to dynamically create custom properties

The CustomPropertyWorkerAddin reserves special sequence of caracters and words to allow user to dynamically create custom properties.

If you’re creating custom properties inside components and you’d like to use the component’s document name in the custom property value, you can use “$$Document_Title” to reference the document’s title.

A list of the special sequences are listed below:

Special Sequence Evaluation
$$_Document_Title Will evaluate to the document’s title. The document must be saved.
$$_Configuration_Name Will evaluate to the processed configuration name.

 

11.Editing component properties

This video is a demonstration of CustomPropertyWorker component properties editor starting from version 1.2.0


If you are unable to view this content, please report it.

12.Tutorials

How to add custom properties to assembly components?