Table of Contents
- 1. Using This Guide
- 1.1. Path Variables
- 2. Overview of Servers and Workspaces
- 2.1. Distributed Servers and Workspace Access
- 2.1.1. Caching Data when Transferring Files
- 2.1.2. Setting Up Caching
- 2.1.3. Running Jobs in a Distributed Environment
- 2.1.3.1. Slave Workspaces
- 2.1.3.2. Running Jobs in a Slave Workspace
- 2.1.3.3. Caching in a Master-Slave Configuration
- 2.1.3.4. Running Jobs on Slaves from a Master Server
- 2.1.3.5. Authentication in a Master/Slave Setup
- 2.1.3.6. Steps for Setting Up a Master/Slave Configuration
- 3. Setting Up Users and Groups
- 3.1. Introduction to Users and Groups
- 3.2. Automatic Creation of User Accounts
- 3.3. Filtering the User List
- 3.4. Searching for a User
- 3.5. Adding and Modifying Users
- 3.5.1. Adding a New User
- 3.5.2. Editing a User’s Profile
- 3.6. Forcing the Sign-out of a User
- 3.7. Designating a Root User
- 3.8. Accessing a User’s Data
- 3.9. Adding and Modifying Groups
- 3.9.1. Adding a New Group
- 3.9.2. Editing Group Membership
- 4. Creating and Managing Workspaces
- 4.1. Signing In and Out of EKM Server Administration
- 4.2. Changing the Superuser Password
- 4.3. Resetting a Lost Superuser Password
- 4.4. Cleaning Up Unused Files
- 4.5. Creating a New, Empty Workspace
- 4.6. Transferring a Workspace Between EKM Servers
- 4.6.1. Exporting a Workspace
- 4.6.2. Importing a Workspace
- 4.6.3. Converting an Exported Workspace into a Human-readable Format
- 4.7. Renaming Workspaces
- 4.8. Deleting Workspaces
- 4.9. Migrating Workspaces
- 5. Restricted and Unrestricted Configuration of Workspaces
- 5.1. Restricted Configuration
- 5.1.1. Starting Restricted Configuration
- 5.1.2. Applying the Configuration
- 5.1.3. Reverting to a Previous Configuration
- 5.1.4. Accepting the Configuration
- 5.2. Unrestricted Configuration
- 5.3. Configuring Workspace Settings
- 5.3.1. Schema Definition for Workspace Configuration
- 5.3.2. Configuration Settings in WorkspaceConfig.xml
- 5.3.2.1. Specifying Default Data Types for File Extensions
- 5.3.2.2. Specifying MIME Types for File Extensions
- 5.3.2.3. Specifying Settings for Built-In or Custom Types
- 5.3.2.4. Specifying Default Dashboard Settings
- 5.3.2.5. Specifying Default Values for Preferences
- 5.3.2.6. Specifying a Custom Download Message
- 5.3.2.7. Scheduling EKM Tasks
- 5.3.2.8. Creating User Accounts Automatically
- 5.3.2.9. Specifying the Default Access Level for Auto-Created Users
- 5.3.2.10. Designating a Root User for a Workspace
- 5.3.2.11. Creating a Job-Only View
- 5.3.2.12. Associating a Master Workspace with a Slave Workspace
- 6. Configuring EKM Server Settings
- 6.1. Schema Definition for an EKM Server
- 6.2. Specifying General Server Settings
- 6.3. Optional Settings
- 7. Defining Custom Types
- 7.1. Overview of Custom Types
- 7.1.1. About Built-in Types
- 7.2. Suggested Steps for Defining Custom Types
- 7.3. Defining Custom Types Directly in EKM
- 7.3.1. Defining a New Custom Type
- 7.3.1.1. Defining Properties for a Custom Type
- 7.3.1.2. Defining Children for a Custom Type
- 7.3.1.3. Defining Mixins for a Custom Type
- 7.3.1.4. Defining Type Attributes for a Custom Type
- 7.3.1.5. Defining Scripts for a Custom Type
- 7.3.1.6. Creating Actions for a Custom Type
- 7.3.1.7. Creating Custom Views for a Type
- 7.3.2. Editing a Custom Type
- 7.4. Defining Custom Types Using XML
- 7.4.1. Schema Definition for Custom Types
- 7.4.2. Defining Properties Using XML
- 7.4.3. Defining Actions Using XML
- 7.5. Custom Type Examples
- 7.5.1. Custom Folder Structures
- 7.5.2. Custom Analysis Projects
- 7.5.3. Custom File Formats
- 7.5.3.1. Extracting Metadata from Custom File Formats
- 7.5.3.2. Extracting Reports from Custom File Formats
- 7.6. Extending Built-in Types
- 7.6.1. Migrating Built-in extensions or Custom Types
- 8. Integrating EKM with Remote Solve Manager (RSM)
- 8.1. Supported Platforms
- 8.2. Steps for Setting Up Batch Job Submission
- 8.2.1. Required Steps
- 8.2.1.1. Required Configuration for Electronics Batch Jobs
- 8.2.1.2. Configuring RSM Using an Automated Script
- 8.2.2. Optional/Additional Steps
- 8.3. EKM and RSM Job Directories
- 8.3.1. How Job Data Files are Handled in EKM and RSM
- 8.3.1.1. The Data Management Process
- 8.3.1.2. The Creation and Structure of Job Directories
- 8.3.1.3. Access and Permission Requirements of the Job Data Directory
- 9. Defining EKM Servers, Queues, and External Applications
- 9.1. Adding EKM Servers
- 9.2. Defining EKM Cache Servers
- 9.2.1. Creating a New EKM Cache Server
- 9.2.2. Editing an Existing EKM Cache Server
- 9.3. Types of Queues
- 9.4. Managing Queues
- 9.4.1. Synchronizing Job Submission Queues
- 9.4.2. Creating a Batch Job Submission Queue in EKM
- 9.4.3. Editing Job Submission Queue Settings
- 9.4.4. Deleting Batch Job Submission Queues
- 9.5. Creating and Editing Cluster Configurations in EKM
- 9.6. Defining External Applications
- 9.6.1. Predefined External Applications
- 9.6.2. Defining External Applications Directly in EKM
- 9.6.2.1. Creating a New External Application
- 9.6.2.2. Editing an External Application Definition
- 9.6.2.3. Editing an External Application Using XML
- 9.6.3. Defining External Applications Using XML
- 9.6.3.1. Schema Definition for Applications
- 9.6.3.2. Defining External Applications Using XML
- 9.7. Running Interactive Jobs in EKM
- 9.7.1. Running Remote Desktop Sessions
- 10. Defining and Configuring Lifecycles
- 10.1. Introduction to Lifecycles
- 10.2. Lifecycle Terminology
- 10.3. Basic Steps for Creating, Configuring, and Managing Lifecycles
- 10.4. Defining Lifecycles in EKM Studio
- 10.4.1. Steps for Defining New Lifecycles
- 10.4.2. Defining and Editing Lifecycle Stages
- 10.4.2.1. Inserting New Stages
- 10.4.2.2. Editing Stages
- 10.4.2.3. Renaming Stages
- 10.4.2.4. Deleting Stages
- 10.4.3. Defining and Editing Lifecycle Transitions
- 10.4.3.1. Inserting New Transitions
- 10.4.3.2. Editing Transitions
- 10.4.3.3. Using Macros in Lifecycle Definitions
- 10.4.3.4. Deleting Transitions
- 10.4.4. Saving Lifecycle Files
- 10.4.5. Opening Lifecycle Files
- 10.4.6. Editing Lifecycle Attributes
- 10.5. Enabling Lifecycles
- 10.6. Displaying Lifecycles
- 10.7. Promoting a Lifecycle Stage
- 10.8. Demoting a Lifecycle Stage
- 10.9. Managing Lifecycle Signoff Requests
- 10.9.1. Approving a Lifecycle Signoff Request
- 10.9.2. Rejecting a Lifecycle Signoff Request
- 10.9.3. Cancelling a Lifecycle Signoff Request
- 10.10. Setting a Lifecycle Stage
- 10.11. Configuring Lifecycles for a Workspace
- 11. Scripts and Journals
- 11.1. Introduction to Scripts and Journals
- 11.2. Defining Scripts Using a Supported Scripting Language
- 11.3. Using EKM's Scripting Interface
- 11.4. Using Sample Scripts Supplied by EKM
- 11.4.1. Python Scripts
- 11.5. Scripting Actions
- 11.6. Recording Journal Scripts
- 11.6.1. Start Recording a Journal Script
- 11.6.2. Stop Recording a Journal Script
- 11.7. Running Journal Scripts
- 11.8. Example of Journal Recording and Execution
- 11.9. Running Python and BeanShell Scripts From a Command Window
- 11.10. Testing or Debugging a Process Template
- 11.11. Viewing a Script Error Log
- 12. Defining Custom Dialogs, Wizards and Applications
- 12.1. Defining Custom Dialog Boxes
- 12.1.1. Defining a Custom User Interface
- 12.1.1.1. XHTML Files
- 12.1.1.2. Sample XHTML Code for a Custom Dialog Box
- 12.1.1.3. User Interface Components
- 12.1.1.3.1. Layout and Style
- 12.1.1.3.2. Embedded Images
- 12.1.1.3.3. Linked Images
- 12.1.1.3.4. Object Links
- 12.1.1.3.5. User Inputs
- 12.1.1.3.6. Check Boxes
- 12.1.1.3.7. Radio Buttons
- 12.1.1.3.8. Selection Menu
- 12.1.1.3.9. List Box
- 12.1.1.4. Invoking Methods from UI Components
- 12.1.2. Defining Dialog Box Steps and Variables
- 12.1.3. Example: Creating a Custom Interface for Fluent Batch Jobs
- 12.2. Defining and Using Custom Applications
- 12.3. Creating a Custom Application
- 12.4. Executing a Custom Application
- 12.5. Modifying an EKM Application
- 13. EKM Client API
- 13.1. Installing the API Library
- 13.2. Using the Library in Client Applications
- 13.2.1. Opening and Closing a Connection
- 13.2.2. API Interfaces
- 13.2.3. Searching the EKM Repository
- 13.2.4. C.R.U.D.
- 13.2.5. Checking Permissions
- 13.2.6. Locking and Unlocking Objects
- 13.2.7. Version Control
- 13.2.8. Transferring Files
- 13.2.9. Managing Users and Groups
- 13.2.10. Miscellaneous Operations
- 13.3. Submitting and Monitoring Jobs
- 13.4. Building and Running a Java Application
- 13.5. Running a Python Script Using Jython
- 13.6. Writing and Running a Python Script Using IronPython
- 13.6.1. Accessing the JAR Files
- 13.6.2. Accessing the C# DLLs
- 13.6.3. Directory Structure for an IronPython Script without Workbench
- 13.6.4. Writing the Script
- 13.7. Building and Executing C# Sample
- 13.8. API Documentation
- 13.9. EKM REST API
- 14. Units: Defining and Configuring Using XML
- 14.1. Schema Definition for Units
- 14.2. Adding a New Unit
- 14.3. Adding a New Quantity
- 14.4. Adding a New Unit System
- 15. Miscellaneous Tasks
- 15.1. Configuring a Common Scripts Library
- 15.2. Gathering Usage Statistics
- 15.3. Connecting to Remote File Servers
- 15.3.1. Defining a New Remote File Server
- 15.3.2. Using Built-in Remote File Servers
- 15.4. Managing Logs
- 15.5. Using VCollab for 3D Visualization in EKM
- 15.6. Extracting Images from ANSYS Electronics Desktop (AEDT) Projects
- 15.7. Using the EKM Server Diagnostics Tool
- 15.8. Lifecycle Approval Process for Process Templates
- 15.9. Using a Custom Background Image on the EKM Sign-in Page
- 15.10. Adding Custom Text to the EKM Sign-in Box
- 15.11. Customizing the Heading on the EKM Title Bar
- 15.12. Tracking Cluster Usage Through a Cluster Job Name
- 16. Backing Up and Restoring EKM
- 16.1. Data Stored by EKM
- 16.1.1. The EKM Database
- 16.1.2. The EKM Data Directory
- 16.1.3. The EKM Root Directory
- 16.2. Backing Up EKM
- 16.2.1. Backup Procedure
- 16.2.1.1. Garbage Collection
- 16.2.1.2. Backing up the EKM Database
- 16.2.1.3. Backing up the EKM Data, Version Root, Job Data, and Repository
Directories
- 16.3. Restoring EKM
- 16.3.1. Restoring Procedure
- 16.3.1.1. Restoring the EKM Database
- 16.3.1.2. Restoring the EKM Data, Version Root, Job Data, and Repository
Directories
- 16.3.1.3. Clearing the Search Indices
- A. Java Security Manager and EKM Scripting
- B. Built-in Types - Reference
- B.1. Adobe Acrobat Document (AdobePdfFile)
- B.2. AIM System in Workbench
- B.3. Analysis Project (AnalysisContainer)
- B.4. Ansoft Designer File (AnsoftDesigner)
- B.5. ANSYS Database/Mechanical APDL Database (AnsysDatabase)
- B.6. ANSYS Electronics Desktop File (ElectronicsDesktop)
- B.7. ANSYS Electronics Desktop Archive File (ElectronicsDesktopArchive)
- B.8. ANSYS Input/Mechanical APDL Input (AnsysInput)
- B.9. ANSYS Output/Mechanical APDL Output (AnsysOutput)
- B.10. ANSYS Result/Mechanical APDL Result (AnsysResult)
- B.11. ANSYS Viewer File (AnsysViewerFile)
- B.12. Applications Grid (ApplicationsGrid)
- B.13. Approval Task (ApprovalWorkItem)
- B.14. Archive (Archive)
- B.15. AUTODYN Database (AutodynDatabase)
- B.16. Base Job (BaseJob)
- B.17. Batch Job Submission Queue (BatchQueue)
- B.18. Batch Task (BatchWorkItem)
- B.19. BladeGen Database (BladeGenDatabase)
- B.20. CAE Model File (CaeModelFile)
- B.21. Cache Server (CacheServer)
- B.22. Catalog (Catalog)
- B.23. CFX Definition (CfxDefinition)
- B.24. CFX Result (CfxResult)
- B.25. CFX Session File (CfxSessionFile)
- B.26. CFX Multi-Configuration Definition (CfxMultiConfigDefinition)
- B.27. CFX Multi-Configuration Result (CfxMultiConfigResult)
- B.28. CFX State File (CfxStateFile)
- B.29. Comparison Report (ComparisonReport)
- B.30. Container (Container)
- B.31. Data Extraction Monitor (DataExtractionMonitor)
- B.32. Data Extraction Monitor Container (DataExtractionMonitorContainer)
- B.33. Data Extraction Queue (DataExtractionQueue)
- B.34. DesignXplorer Database (R11) (DesignXplorerDatabase)
- B.35. DesignModeler Database (WorkBenchDesignModelerFile)
- B.36. Discussion Board (DiscussionBoard)
- B.37. EKM Application (Application)
- B.38. EKM Journal File (ScriptFile)
- B.39. EKM Object (Model)
- B.40. EKM Process Template (Workflow)
- B.41. EKM Server (Server)
- B.42. EKM Type (Type)
- B.43. Engineering Data Database (R11) (WorkBenchEngineeringData)
- B.44. ePhysics File (AnsoftEPhysics)
- B.45. External Application (ExternalApplication)
- B.46. FE Modeler Database (FeModelerDatabase)
- B.47. File (File)
- B.48. File Server (ExternalResourceFs)
- B.49. Fluent Case (FluentCase)
- B.50. Fluent Data (FluentData)
- B.51. Fluent Plot (FluentPlot)
- B.52. Folder (Folder)
- B.53. Group (Group)
- B.54. HFSS File (HfssProject)
- B.55. Icepak Packed Project (IcepakPackProject)
- B.56. Icepak Project Data (IcepakProjectData)
- B.57. Image (Image)
- B.58. Imported Report (ImportedReport)
- B.59. Interactive Job (InteractiveJob)
- B.60. Interactive Job Submission Queue (InteractiveQueue)
- B.61. Job (Job)
- B.62. Job Submission Queue (JobSubmissionQueue)
- B.63. Job Submission Server (JobSubmissionServer)
- B.64. Job Template (JobTemplate)
- B.65. Job Template Container (JobTemplateContainer)
- B.66. Lifecycle (Lifecycle)
- B.67. Maxwell File (AnsoftMaxwell)
- B.68. Meshing Database (MeshingDatabase)
- B.69. Microsoft Excel Worksheet (MSOfficeExcelFile)
- B.70. Microsoft Powerpoint Presentation (MSOfficePowerpointFile)
- B.71. Microsoft Word Document (MSOfficeDocumentFile)
- B.72. My Data (MyData)
- B.73. Polyflow Data (PolyflowData)
- B.74. Polyflow Export (UNS) (PolyflowExportFile)
- B.75. Process Container (ProcessContainer)
- B.76. Public Saved Query (PublicSavedQueryContainer)
- B.77. Q3D File (AnsoftQ3D)
- B.78. Queue (Queue)
- B.79. Remote Folder (RemoteFolder)
- B.80. Report (Report)
- B.81. Saved Query (SavedQuery)
- B.82. Saved Query Container (SavedQueryContainer)
- B.83. Search Results Report (SearchResultsReport)
- B.84. Shortcut (Link)
- B.85. Simplorer File (AnsoftSimplorer)
- B.86. Simulation Details Report (CaeModelSummaryReport)
- B.87. Siwave File (AnsoftSiwave)
- B.88. SpaceClaim Document (SpaceClaimDocument)
- B.89. Update Analysis Project Task (UpdateAnalysisProjectWorkItem)
- B.90. URL (Url)
- B.91. User (User)
- B.92. VCollab File (VcollabCompressedFile)
- B.93. VRML File (VrmlFile)
- B.94. Workbench Journal File (WorkBenchJournalFile)
- B.95. Workbench Design Point File (WorkBenchDesignPointFile)
- B.96. Workbench Project Archive File (WorkBenchProjectArchiveFile)
- B.97. Workbench Project File (WorkBenchProjectFile)
- B.98. Workbench Project File R11 (WorkBenchProjectFileR11)
- B.99. Workbench Simulation/Mechanical Database (WorkBenchSimulation)
- B.100. Process (Process)
- B.101. Task (WorkItem)
- C. Lifecycles: Defining and Configuring Using XML
- C.1. Defining Lifecycles Using XML
- C.1.1. Schema Definition for Lifecycles
- C.1.2. Defining a Lifecycle XML File
- C.1.2.1. Types
- C.1.2.2. Stages
- C.1.2.3. Transitions