will/pdm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial Commit of the PDM project (ready for DWS migration)

Browse Source
This commit is contained in:
will
2026-04-20 08:42:38 -05:00
commit dda7b664e7
2721 changed files with 442772 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
documentation/api_extracted/Tasks.htm Normal file
View File

@@ -0,0 +1,138 @@
<html xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns="http://www.w3.org/TR/REC-html40">
<head>
<title>Programming Tasks</title>
<meta name=MS-HKWD content="Tasks">
<meta name=MS-HKWD content="Add-ins, tasks">
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link rel="stylesheet" type="text/css" href="ApiHelp.css">
<style>
<!--
div.Section1
{page:Section1;}
-->
</style>
</head>
<body>
<h1><span style="font-weight: normal; font-size: 7.5pt;">SOLIDWORKS PDM Professional API Help</span></h1>
<h1>Programming Tasks</h1>
<body bgcolor=white lang=SV link=blue vlink=purple style='tab-interval:65.2pt'>
<p>
In
SOLIDWORKS PDM Professional 2009 and earlier, add-ins work only on single client machines:</p>
<ul>
<li class=kadov-p>A change-state hook calls the add-in on the machine where the change state command
is executed. </li>
</ul>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - or -</p>
<ul>
<li class=kadov-p>A menu
command executes the add-in on the computer where the menu command is selected.
</li>
</ul>
<p>
Although this is often desirable, there are times when you want to execute the add-in on different machines. SOLIDWORKS PDM
Professional and later allow you to program tasks to execute add-ins on other
machines.<br />
<br />
A task consists of:</p>
<div class=Section1>
<ul>
<li class=kadov-p> Add-in to execute.</li>
<li class=kadov-p>Card, if any, to show when the task is launched.</li>
<li class=kadov-p>User credentials to use to execute the add-in.</li>
<li class=kadov-p>Computers on which to execute the add-in.</li>
<li class=kadov-p>
Optional scheduling of the add-in.</li>
<li class=kadov-p>Credentials of users who have permission to run the add-in.</li>
<li class=kadov-p>Error and success notifications.</li>
</ul>
</div>
<p>
You can read more about
the task execution system in the SOLIDWORKS PDM Professional Help.<br />
<br />
To program your own task:</p>
<ol style="list-style: decimal;"
type=1>
<li class=kadov-p>Write an add-in DLL that supports
task execution.</li>
<li class=kadov-p>Add the add-in
to the vault using the Administration tool.</li>
<li class=kadov-p>Enable execution of the add-in on one or more servers by
selecting the Task Host Configuration command from the context-sensitive menu on the SOLIDWORKS PDM Professional icon in the task bar navigation area
(system tray).</li>
<li class=kadov-p>Right-click the tasks node in the Administration tool and select
<b>New Task</b> from the menu.</li>
<li class=kadov-p>Select your add-in
in the task wizard.</li>
<li class=kadov-p>Select other options in the task wizard.</li>
</ol>
<p>
The task is executed in one of the following ways:
</p>
<ul>
<li class=kadov-p>A task definition spawns task instances
according to a defined schedule.</li>
<li class=kadov-p>A workflow change
state action executes the task.</li>
<li class=kadov-p>Start the Administration tool, expland <b>Tasks</b>,
double-click <b>Task List</b>, and click <b>Add Task</b>.</span></li>
<li class=kadov-p>Right-click a file vault view and select the task on the
context-sensitive menu.</li>
</ul>
<h2>
<strong>Using the Standard Task Add-in</strong></h2>
<p>
You do not need to program your own task add-in if you only need to open files in SOLIDWORKS and execute scripts on them. To do
that, use the <a href="StandardTaskAddIn.htm">standard task add-in</a>
that is shipped with SOLIDWORKS PDM Professional.</p>
<h2><strong>Code
Samples</strong>&nbsp;</h2>
<ul>
<li class=kadov-p><a href="TaskSample.htm">Task Add-in Sample (VB.NET)</a></li>
<li class=kadov-p><a href="TaskSample_CSharp.htm">Task Add-in Sample (C#)</a></li>
</ul>
<h2><b style='mso-bidi-font-weight:
normal'>Interfaces</b></h2>
<ul>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5.html">IEdmAddIn5</a></li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTaskInstance.html">IEdmTaskInstance</a></li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTaskProperties.html">IEdmTaskProperties</a></li>
</ul>
<h2 style="background: white">
<strong>Structures and Constants</strong></h2>
<ul>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmTaskFlag.html">EdmTaskFlag</a>
</li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmTaskMenuCmd.html">EdmTaskMenuCmd</a>
</li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmTaskSel.html">EdmTaskSel</a>
</li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmTaskSetupPage.html">EdmTaskSetupPage</a>
</li>
<li class=kadov-p>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmTaskStatus.html">EdmTaskStatus</a><br />
</span></p></li>
</ul>
</body>
</html>