Hide Table of Contents

Creating Variables for Dispatch Scripts

Use the Set variables dialog to define Enterprise PDM Dispatch variables that evaluate when a Dispatch action runs.

You can create variables for use in your Dispatch scripts and in graphical elements you create for your scripts:

  1. Access the Set variables dialog by clicking Variables in the Edit Action dialog or by clicking right arrow in Dispatch dialogs.
  2. Click Add to create a new variable.
  3. From the Name field, select the newly added variable and type a name.
  4. From the Type drop-down field, select a data type:



    Current configuration


    Example: @

    Current folder path


    Example: C:\VaultProjA\FolderA

    Current revision of selected file(s)


    Example: A

    Current version of selected file(s)


    Example: 4

    Directory of selected file(s)


    Example: C:\VaultProjA\FolderA

    Name of current folder


    Example: FolderA

    Name of current vault


    Example: VaultProjA

    Name of logged-in user


    Example: Admin

    Name of selected file(s)


    Example: 89-NOAO-4200-1234.sldprt

    Name of user who created selected file(s)


    Example: Admin

    Path to selected file(s)


    Example: C:\VaultProjA\FolderA\89-NOAO-4200-1234.sldprt

    Path to SolidWorks Enterprise PDM root folder


    Example: C:\VaultProjA

    Runtime variable

    A runtime variable is a temporary container to store user input. You can then use the runtime variable in your action scripts.

    Example: UserState

    Selected file(s) current workflow state


    Example: Approved

    Static string

    Sets the variable to a static string you create using the Value field.

    Example: %Number%_%Rev%.pdf

    Time when selected file(s) was created


    Example: 20090726 14:44:1

    Time when selected file(s) was modified


    Example: 20090726 17:04:12

    Value of environmental variable

    Sets the variable to the value of an environmental variable you choose.

    Example: USERNAME

    Value of registry variable

    Sets the variable to the value of a registry variable you choose.

    Example: FileExtVer

    Variable value from selected file(s) datacard

    Sets the variable to the value of a datacard variable you choose.

    Example: Approved on

  5. Complete the conditional fields that display based on the selected Type:
    1. If Type is Static string - In the Value field, type a value or click right arrow to build the value from predefined variables, string functions, or arithmetic functions. See Functions for Variables.
    2. If Type is Value of environmental variable - In the Environmental variable field, type or click right arrow to select an environmental variable.
    3. If Type is Value of registry variable - In the Registry variable field, type a registry variable name.
    4. If Type is Variable value from selected file(s) datacard - In the Data card variable field, type or click right arrow to select a data card variable. Next, in the Configuration field, type the configuration.
  6. Continue to add variables (by clicking Add) or delete variables (by selecting a variable and clicking Remove).
  7. Click OK to save the 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 Variables for Dispatch 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.