WorkSpace Manager Processes

Old Content - visit altium.com/documentation

Modified by Admin on Nov 6, 2013

The following content has been imported from Legacy Help systems and is in the process of being checked for accuracy.

This section covers the Work Space Manager processes and their parameters (if any).

ClipBoardAction process

Description
Execute a specified action for the clipboard, to cut, copy, paste or clear the contents from the Workspace manager clipboard. For example you are able to copy, cut, paste and clear different output jobs for each project.

Parameters

Parameter	Value	Description
Action	Cut, Copy, Paste, Clear
ObjectKind	OutputSingle

Example
Process: WorkSpaceManager:ClipBoardAction
Parameters : Action = Copy | ObjectKind = OutputSingle

ChangeObject process

Description
Change Output Generator properties for the Output jobs.

Parameters

Parameter	Value	Description
Action	Cut, Copy, Paste, Clear
ObjectKind	OutputSingle

Example
Process: WorkSpaceManager:ClipBoardAction
Parameters : Action = Copy | ObjectKind = OutputSingle

CloseObject process

Description
Close a document, focussed document, project, all documents in a project or all documents in the Altium Designer workspace.

Parameters

Parameter	Value	Description
ObjectKind	All, Document, FocusedDocument, FocusedCategory, ProjectAndDocuments, FocusedProjectAndDocument, FocusedProjectTree, ProjectDocuments, FocusedProjectDocuments, WorkspaceDocuments

Example
Process: WorkSpaceManager:CloseObject
Parameters : ObjectKind = All

Example 2: Close everything in Altium Designer in a script

Procedure CloseEverything; Begin   ResetParameters;   AddStringParameter('ObjectKind','All');   RunProcess('WorkspaceManager:CloseObject'); End;

Example 3 Close all the documents within the focussed project tree in a script

Procedure CloseProjectTree(ProjectName : String); Begin   ResetParameters;   AddStringParameter('ObjectKind','FocusedProjectTree');   RunProcess('WorkspaceManager:CloseObject'); End;

*Example 4 Close a Project *

AddStringParameter('ObjectKind','Project'); AddStringParameter('FileName', ProjectName); RunProcess('WorkspaceManager:CloseObject');

Compile process

Description
The Compile process is used to compile a document, project or open projects to refresh all the linking information and net information.

Parameters

Parameter	Value	Description
Action	Compile, Recompile	Set Action to Compile to compile the document, project etc only. Otherwise set it to Recompile to refresh all the linking information and net information.
ObjectKind	Document, Project, All, FocusedDocument, FocusedProject	Set ObjectKind to the scope required for the compiling process to act on.

Example
Process: WorkSpaceManager : Compile
Parameters: ObjectKind = Project

Compare process

Description
The Compare process is used to update or import source documents of a PCB project with respect to a reference project, such as comparing an active document against a parent project.

Parameters

Parameter	Value	Description
ObjectKind	Project,FocusedProject	Set ObjectKind to Project or FocusedProject for the compare process.
Action	UpdateOther, UpdateMe	UpdateOther updates other documents with respect to the reference source document, and UpdateMe updates the actual source document.
Index	1..9	Compare to the indexed project.

Example
Process: WorkSpaceManager : Compile
Parameter: Action = UpdateOther

DocumentOptions process

Description
Execute a specified configuration process to update a document or project such as updating search paths, difference level for the ERC, or configure the output jobs facility.

Parameters

Parameter	Value	Description
Action	ViewChannels, ComponentLinking, VariantManagement, OutputJobManagement, Options,ViolationLevels, ViolationMatrix, DifferenceLevels, ChangeOrderLevels, SearchPaths, Parameters, Annotate, Order, AnnotateReset, AnnotateQuiet, AnnotateAll, BackAnnotate, LibrarySynch, DatabaseUpdate
ObjectKind	Project, FocusedProject, FocusedDocument, Document, OutputSingle, Workspace, Databaselink	Set the ObjectKind
Mode	EditConnection

Notes
If ObjectKind=DatabaseLink, and you need to change the database connection, assign mode=EditConnection.
Example
Process: WorkSpaceManager: DocumentOptions
Parameters : Action = Project | ObjectKind = AnnotateAll

DeleteObject process

Description
Execute a specified delete action.

Parameters

Parameter	Value	Description
ObjectKind	FocusedDocument, FocusedCategory, Document, Variant, OutputSingle	The FocusedCategory value is to remove all documents in a specified category from a parent project. The Document value is to remove the active document from the parent project. The OutputSingle value removes the specified output generator.

Example
Process: WorkSpaceManager: DeleteObject
Parameters : ObjectKind = FocusedDocument

ExploreTo process

Description
Opens Windows Explorer in the focussed documents, projects or design workspace folder.

Parameters

Parameter	Value	Description
ObjectKind	FocusedDocument, FocusedProject, Workspace	Set the ObjectKind to the scope for the Explorer to explore in.

Example
Process: WorkSpaceManager:Explore
Parameters : ObjectKind = Workspace

EmbeddedScanDependencies process

Description
Scan the dependencies for the entire project in Altium Designer.

Parameters

Parameter	Value	Description
ObjectKind	All

Example
Process: WorkSpaceManager:EmbeddedScanDependencies
Parameters : ObjectKind = All

FPGAPins process

Description
Runs the FPGA signal manager, configure the FPGA component for pin swapping, create a PCB project from a FPGA project or generate a FPGA project from a FPGA component.

Parameters

Parameter	Value	Description
Action	RunManager, RunPinSwapManager, GenerateFromFPGA, GenerateFromPCB

Example
Process: WorkSpaceManager:FGPAPins
Parameters : Action = RunManager

EmbeddedSelectToolChain process

Description
Select a new tool chain for your FPGA/Embedded project.
Parameters
N/A
Example
Process: WorkSpaceManager:EmbeddedSelectToolChain

EmbeddedOptions process

Description
Edit the embedded option settings for the active or focussed project or document.

Parameters

Parameter	Value	Description
ObjectKind	Project, FocusedProject, FocusedDocument

Example
Process: WorkSpaceManager:EmbeddedOptions
Parameters : ObjectKind = Project

FPGAWorkspace process

Description
Runs the FPGA workspace map.
Parameters
N/A

GenerateReport process

Description
Generate a specified report in Altium Designer.

Parameters

Parameter	Value	Description
Action	Run,Load
ObjectKind	Report,Netlist, OutputSingle,OutputBatch,OutputSelected,Fabrication, Assembly,Simulator	To generate a group of reports, specify the value (OutputSingle, OutputBatch or OutputSelected) for the ObjectKind parameter.
Kind	SimpleBOM, BOM, BOM_PartType, Violations, Hierarchy, Designators, Parameters, CrossReference, AdvSimNetlist
Target	Document
DoEditProperties	True,False
DefaultCaption	True,False
DoGenerate	True,False
Index	1..n	Choose one of the indexed generators to generate a report.

Notes

Using the XSPICE simulator, assign the values to the following parameters:

Example
Process: WorkSpaceManager:GenerateReport
Parameters : Action = Run | ObjectKind = OutputSelected

GenerateSymbol process

Description
Generate a schematic symbol in a library from the current document.
Parameters
N/A
See also
WorkSpaceManager processes

HideObject process

Description
Execute this process to hide current document, focused document, project or all documents in Altium Designer workspace.

Parameters

Parameter	Value	Description
ObjectKind	Document,FocusedDocument,FocusedCategory,FocusedProject, All

Example
Process: WorkSpaceManager:HideObject
Parameters : ObjectKind = FocusedDocument

InsertObject process

Description
The InsertObject process creates projects from a specified path, add a document to a project or add a free document to a focused project for example.

Parameters

Parameter	Value	Description
ObjectKind	CreateProjectsFromPath, Project, FocusedProject, FocusedDocument, Variant, Fabrication, Documentation, OtherOutput, Assembly, Netlist, Report, OtherOutputOutput, OutputSingle, OutputDuplicate	Fabrication, Documentation, OtherOutput, Assembly, Netlist, Report, OtherOutputOutput values for the ObjectKind parameter, you need to specify the Index value too.
Index	1..20

Example
Process: WorkspaceManager:InsertObject
Parameter: ObjectKind = Fabrication | Index = 4

Print process

Description
Execute a specified process to invoke the page setup for printing, preview documents, or setup the printer.

Parameters

Parameter	Value	Description
Action	PageSetup, Preview, PrintWithDialog, PrintDocument, PrintSelection, PrinterSetup
ObjectKind	OutputSingle,FocusedDocument

Example
Process: WorkSpaceManager: Print
Parameters : Action = Preview

OpenObject process

Description
Open a specific object in Altium Designer such as a document or a project.

Parameters

Parameter	Value	Description
ObjectKind	NewAnything, DocumentList, RecentDocument, RecentProject, RecentProjectGroup, Document, FocusedDocument, FocusedCategory, Variant, Project, FocusedProject, ProjectAndDocuments, FocusedProjectAndDocuments, ProjectDocuments, FocusedProjectDocuments, ProjectGroupDocuments, ProjectGroup, LastProjectGroup, PrimaryDocument, MessageView, MessageViewSelection, CreateProjectsFromPath, All,Assembly, Fabrication, Report, Netlist, Documentation, ,OtherOutput, OutputSingle, OutputBatch, OutputSelected, OutputDuplicate, DatabaseLink, OutputPreference, ControlPanel, FreeDocument, WorkSpaceDocuments, Workspace	If ObjectKind = NewAnything, you need to specify the Kind parameter as well.
OpenMode	Standard, NewFromExisting, NewFromTemplate, Project
Ext	.PCBDOC, .SCHDOC
DocumentType	PCB, SCH
Filename	String
Index	Integer	The position in the most recently used documents list.
Kind	EDIF, EDIFLIB, ProtelNetlist, PCB, SCH, SCHLIB, PCBLIB, PCB3DLIB, C, TEXT, CPP, CUPL, MDL, NSX, CKT, SIMDATA, EditScript, OutputJob, DatabaseLink, VHDL,VHDLIB, VHDMDL, VHDTST VHDL,PcbProject, CoreProject, FpgaProject, EmbeddedProject, IntegratedLibrary, ProjectGroup, CAM, WAVE, IntLibrary, ScriptProject, EditScriptUnit, EditScriptForm

Example
Process: WorkspaceManager:OpenObject
Parameter: ObjectKind = Project

Example 2: Open a project using the script

Procedure OpenProject(ProjectName : String); Begin   Result := True;   If Not FileExists(ProjectName) Then Result := False;   ResetParameters;   AddStringParameter('ObjectKind','Project');   AddStringParameter('FileName', ProjectName);   RunProcess('WorkspaceManager:OpenObject'); End;

Example 3: Open a Devices page in Altium Designer

Procedure OpenDevicesPage; Begin   ResetParameters;   AddStringParameter('ObjectKind','ControlPanel');   AddStringParameter('Index', '1');   RunProcess('WorkspaceManager:OpenObject'); End;

See also
CloseObject process
SaveObject process

SaveObject process

Description
Execute a specified save action to save a document as another document with a different filename, focussed document, all documents in the workspace, or documents of a project for example.

Parameters

Parameter	Value	Description
ObjectKind	Document, FocusedDocument, FocusedCategory, FocusedProject, ProjectDocuments, WorkspaceDocuments, Workspace, All	You can specify the scope of the save action, whether you wish to save a document, documents in a project, or all documents currently open in Altium Designer.
SaveMode	Standard, SaveAs, SaveCopyAs,	When SaveMode is set to Standard, the single document is saved normally. When SaveAs is set, the current document is saved and the filename for this document is replaced with the new filename in the associated project. When SaveCopyAs is set, the document is saved and you are prompted to save a copy of this document with a new filename. This copy is produced in the folder where the original document is.
ModifiedOnly	True, False	If ModifiedOnly parameter is set to true, then only modified documents are saved. If this parameter is set to anything else (empty etc) then all documents etc (depending on the ObjectKind parameter) are saved.
FileFormat	String

Example 1: Save a document as a different document
Process: WorkSpaceManager:SaveObject
Parameters : ObjectKind = Document | SaveMode = SaveAs

Example 2 : Save all documents from a DelphiScript script

Procedure SaveAll; Begin   ResetParameters;   AddStringParameter('ObjectKind','All');    RunProcess('WorkspaceManager:SaveObject'); End;

Example 3 in Delphi Script script

Procedure SaveDocument(      Document   : IServerDocument;  const SaveFormat : TDynamicString); Begin  If Client = Nil Then  Exit;  Document.Modified := True;  Client.ShowDocument(Document);  Document.Focus;   ResetParameters;  AddStringParameter('SaveMode', 'Standard');  AddStringParameter('ObjectKind', 'Document');  AddStringParameter('FileFormat', SaveFormat);  RunProcess('WorkspaceManager:SaveObject'); End;

SetupPreferences process

Description
This SetUpPreferences process invokes the Preferences dialog for either Output Job or Database Link documents.

Parameters

Parameter	Value	Description
ObjectKind	OutputPreferences, DatabaseLink	When ObjectKind is set to OutputPreferences, the Output Job Options dialog is invoked for the Outjob File document. A Outjob File has to be open first in Altium Designer for this process to work.

Example
Process: WorkSpaceManager:SetupPreferences

SetCurrentProject process

Description
Make the current project the active project in Altium Designer.
Parameters
N/A
Example
Process: WorkSpaceManager:SetCurrentProject

SetSubProject process

Description
Set the embedded project for the nexus core, or the sub project for the FPGA component.

Parameters

Parameter	Value	Description
Target	Core, Component	Specify the Target parameter for the SubProject- Core or FPGA Component.

Example
Process: WorkSpaceManager:SetSubProject
Parameters : Target = Core

ShowHiddenDocument process

Description
Show an indexed hidden document in Altium Designer

Parameters

Parameter	Value	Description
Index	1..16	Show the indexed document in Altium Designer.

Example
Process: WorkSpaceManager:ShowHiddenDocument
Parameters : Index = 1

VersionControl process

Description
Execute a specified action for the version control software application. You can add/remove documents, projects to/from the version control, check in or out documents and projects, check out the history, differences and properties of the version control system.

Parameters

Parameter	Value	Description
Action	Get,Checkout, Checkin, UndoCheckout, History, Differences, Properties, Refresh, Run, Add, Remove	Specify the Action parameter to the value as required.
ObjectKind	FocusedProject, FocusedDocument	Set ObjectKind parameter to FocusedProject or FocusedDocument in Altium Designer with the specified Action parameter that defines the course of action on this object kind.

Example
Process: WorkSpaceManager:VersionControl
Parameters : ObjectKind = FocusedDocument | Action = Refersh

View process

Description
The View process can bring a Panel into view in Altium Designer. Navigator panel (two modes - flattened project or physical hierarchy), Projects panel, Messages panel, Differences panel and Browser panel for example.

Parameters

Parameter	Value	Description
ObjectKind	NewAnything, DocumentList, RecentDocument, RecentProject, RecentProjectGroup, Document, FocusedDocument, Variant, Project, FocusedProject, ProjectAndDocuments, FocusedProjectAndDocuments, ProjectDocuments, FocusedProjectDocuments, ProjectGroupDocuments, ProjectGroup, LastProjectGroup, PrimaryDocument, MessageView, MessageViewSelection, CreateProjectsFromPath, All, Assembly, Fabrication, Report, Netlist, Documentation, OtherOutput, OutputSingle, OutputBatch,OutputSelected, OutputDuplicate, DatabaseLink, OutputPreferences
ShowError	True, False	Locates the violation in the project.
ShowDifference	True, False	Locates the difference object in the project.
Action	ShowPhysicalHierarchy, ShowLogicalHierarchy, ShowDocuments, ShowLIbraries, ShowFlattened, ShowErrors, ShowDifferences, ToggleBrowser, ToggleProperties