Hide Table of Contents

Creating Dispatch Action Scripts

Dispatch action scripts let you configure one or more commands to be triggered by conditions you define. For example, you might trigger a check-in of files in a specified vault folder if a particular workflow state is entered.

To help create your Dispatch script, view script samples on the install CD under \Support\Dispatch\Dispatch Examples.

To create a Dispatch action script:

  1. In the Administration tool, expand the Add-ins node, right-click Dispatch.CAF, and select Administrate Actions.

    You must be logged in as a user with permission to administrate add-ins

  2. Click Add in the Administrate Actions dialog box.
  3. In the Edit Action dialog box, type a name for the Dispatch action in the Action name text box.
  4. Describe the Dispatch action in the Description text box.
  5. Select the activation method to trigger the Dispatch script by clicking Menu command, During state transition, During check out, or During add.

    See Edit Action Dialog Box.

  6. Add commands to the script by clicking Add.

    See Select Command Dialog Box.

  7. Define variables needed in your Dispatch script by clicking Variables.

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   Creating Dispatch Action Scripts
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: SOLIDWORKS PDM 2012 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.