Table of Contents

Getting Started Guide
Using This Guide
1. Introduction to EKM
1.1. What is EKM?
1.2. How Does EKM Work?
1.2.1. Data Management
1.2.2. Collaboration
1.2.3. Knowledge Capture and Reuse
1.2.4. Remote Simulation and Visualization
1.3. New and Improved Features in Release 18
2. Installing and Setting Up EKM
3. Configuring and Initializing EKM
3.1. Initialization Options
3.2. Configuration Options
4. Using EKM
User's Guide
Using This Guide
1. What is EKM?
1.1. Data Management and the EKM Repository
1.2. Process Management
1.3. EKM Architecture
1.4. EKM Customization
1.5. Contacting Technical Support
2. The EKM Environment
2.1. General Layout
2.2. Main EKM Sections
2.2.1. Home Section
2.2.2. Data Section
2.2.3. Jobs Section
2.2.4. Processes Section
2.2.5. Administration Section
2.3. Navigating in EKM
2.3.1. Navigating to Different Sections and Pages
2.3.2. Using the Breadcrumb
2.3.3. Displaying the Tree
2.3.4. Using the Search Box to Navigate to an Object
2.4. View Window
2.5. Toolbars and Menus
2.6. Wizards and Dialog Boxes
2.7. Applications Panel
2.8. Workspace Access
2.9. Access Level
2.10. User Menu
2.11. Getting Help
2.12. Working in a Job-Only View
3. Launching EKM
3.1. Launching the EKM Web Client
3.1.1. Connecting to a Different Workspace
3.1.2. Making Simultaneous Connections
3.1.3. Signing Out of the EKM Web Client
4. Accessing an EKM Server
4.1. Accessing an EKM Server from ANSYS Workbench
4.2. Accessing an EKM Server from the EKM Web Client
5. Customizing EKM for Your Own Use
5.1. Setting Up Your Dashboard
5.1.1. Setting Up Dashboard Gadgets
5.1.1.1. Container Gadget
5.1.1.2. File Gadget
5.1.1.3. Discussion Board Gadget
5.1.1.4. Extraction Monitor Gadget
5.1.1.5. Job Monitor Gadget
5.1.1.6. Process Monitor Gadget
5.1.1.7. My Tasks Gadget
5.1.1.8. Saved Query Gadget
5.1.1.9. URL Gadget
5.1.1.10. ANSYS Viewer File Gadget
5.1.2. Rearranging Gadgets
5.1.3. Resizing Gadgets
5.1.4. Editing Gadgets
5.1.5. Removing Gadgets
5.2. Managing Personal Applications
5.3. Managing Personal Queries
5.4. Accessing the Recycle Bin
5.5. Setting Your User Profile
5.6. Setting Your Preferences
5.6.1. Specifying General Preferences
5.6.2. Specifying List Display Preferences
5.6.2.1. Specifying Column Order Preferences for the List Display
5.6.3. Specifying File Extension Preferences
5.6.4. Specifying the Recycle Bin Preference
5.6.5. Specifying File Transfer Client Preferences
5.6.5.1. Configuring the File Transfer Client to Use a Proxy Server
5.6.5.2. Configuring the File Transfer Client to Trust an EKM Server
5.6.6. Specifying Job Management Preferences
5.6.6.1. Specifying Credential Overrides for Cluster Configurations
5.6.6.2. Specifying Credential Overrides for RSM Services
5.7. Setting the Alert Frequency
5.8. Defining Connections to Other Repositories
6. Object Types and Properties
6.1. Object Types
6.1.1. EKM Object Type
6.1.2. Built-In Types
6.1.3. Custom Types and Extended File Formats
6.2. Object Properties
7. Transferring Files
7.1. Uploading Files to EKM
7.1.1. Uploading Files/Archives Using the Web Client Browser
7.1.2. Uploading Files Using the File Transfer Client
7.1.3. Uploading Files from the Server
7.2. Assignment of Object Type on Upload
7.3. Automatic Extraction of Data on Upload
7.4. Automatic Creation of Simulation Details Reports on Upload
7.5. Automatic Extraction of Images on Upload
7.6. Monitoring Data Extraction
7.7. Extracting Data On Demand
7.8. Downloading Files from EKM
7.8.1. Viewing a Folder’s Size Before Downloading
7.8.2. Downloading Files/Folders Using the Browser
7.8.3. Downloading Files/Folders Using the EKM File Transfer Client
7.8.4. Downloading a File or Folder to the Server
7.9. Using a Cache System for WAN Transfers
8. Managing Repository Data
8.1. Navigating the Repository
8.1.1. My Data
8.1.2. Shared Data
8.1.3. Starred Data
8.1.4. Recent Data
8.1.5. Extraction Monitor
8.2. Accessing Sample Files
8.3. Displaying Objects
8.3.1. Displaying Folder Contents
8.3.2. Displaying the Content of a File
8.3.3. Displaying Object Properties
8.3.4. Displaying the Permissions on an Object
8.3.5. Displaying an Object’s Dependencies
8.3.6. Displaying an Object's Usage
8.3.7. Displaying Revision History
8.3.8. Viewing Simulation Models and Images
8.3.8.1. Setting the View
8.3.8.2. Creating a New View
8.3.8.3. Working with Views
8.3.8.4. Interacting with 3D Images
8.3.8.4.1. Rotating the Object
8.3.8.4.2. Zooming and Panning
8.3.8.4.3. Editing Mouse Button Assignments
8.3.8.5. Controlling the Visibility of Individual Parts
8.3.8.6. Highlighting Edges, Faces and Bodies
8.3.8.7. Displaying a Cross-Section
8.3.8.8. Adding Markup to a View
8.3.8.9. Exploding the Model
8.3.8.10. Saving View Changes
8.3.9. Displaying a Simulation Details Report
8.4. Creating New Objects
8.4.1. Creating a New Folder
8.4.2. Creating a New Shortcut
8.4.3. Creating a Connection to a Remote File or Folder
8.4.4. Creating a Connection to a URL
8.4.5. Creating a New Discussion Board
8.5. Opening Objects
8.6. Editing Objects
8.6.1. Copying Objects
8.6.2. Moving Objects
8.6.3. Getting Exclusive Control of an Object
8.6.4. Renaming Objects
8.6.5. Editing Permissions
8.6.6. Editing Object Properties
8.6.6.1. Setting Property Values
8.6.6.2. Adding/Removing Properties
8.6.6.3. Editing Properties for Multiple Files
8.6.6.4. Editing the Properties of a Folder
8.6.7. Editing Alert Settings
8.6.8. Editing Automatic Deletion Settings
8.6.9. Editing Shortcuts
8.6.10. Editing an Object’s Type
8.6.11. Editing the Content of a File
8.6.12. Editing the Created By Property (Admin Only)
8.6.13. Editing a Lifecycle in EKM Studio
8.6.14. Editing a Process Template in EKM Studio
8.6.15. Extracting Data on Demand
8.6.16. Editing Remote Item Properties
8.6.17. Editing a File’s Pedigree
8.7. Deleting Objects
8.8. Filtering the View
8.9. Displaying Project Files
8.10. Extracting Archives
8.11. Synchronizing Remote Objects
8.12. Creating Shortcuts to Objects
8.13. Sharing Objects
9. Version Control and Access Management
9.1. Controlling Access to Objects
9.2. Getting Exclusive Control
9.3. Releasing Exclusive Control
9.4. Adding Objects to Version Control
9.5. Identifying Objects Under Version Control
9.6. Modifying Objects Under Version Control
9.6.1. Check Out
9.6.2. Check In
9.6.3. Undo Checkout
9.7. Creating a Branch
9.8. Reverting to a Previous Version
9.9. Getting a Copy of a Version
9.10. Removing Objects From Version Control
9.11. Viewing Revision History
10. Searching a Repository
10.1. Searching by Keyword
10.1.1. Starting a Keyword Search
10.1.2. Rules and Restrictions for Keyword Searches
10.1.3. Using Expanded Word Syntax to Define Keywords
10.2. Performing an Advanced Search
10.2.1. Starting an Advanced Search
10.2.2. Specifying Search Criteria
10.2.2.1. Filtering Types and Properties in the Advanced Search Dialog Box
10.2.2.2. Creating Search Expressions
10.3. Searching for an Object by its Path
10.4. Displaying Search Results
10.5. Searching Results for Report Content
10.6. Managing Queries and Search Results
10.6.1. Saving a Search Query
10.6.2. Saving Search Results
10.6.3. Editing a Query
10.6.4. Expanding a Search to Other Repositories
10.6.5. Executing a Saved Query
10.6.6. Clearing Search Results
10.6.7. Sharing a Query
11. Creating Reports
11.1. Simulation Details Reports
11.1.1. Workbench Project Reports
11.1.2. Copying a Report
11.1.3. Downloading a Report
11.1.4. Extracting Simulation Details Reports On Demand
11.2. Comparison Reports
11.2.1. Steps for Creating and Using a Comparison Report
11.2.2. Creating a Quick Compare Report
11.2.3. Creating a Customized Comparison Report
11.2.4. Editing a Comparison Report
11.3. Creating a Process Report
11.4. Displaying a Report
11.5. Saving a Report
11.6. Downloading a Report
11.7. Exporting Properties to an Excel File Report
12. Managing Jobs
12.1. Starting Jobs in EKM
12.2. Running a Batch Job
12.2.1. Starting a Batch Job Using the Job Launch Application
12.2.2. Starting a Batch Job from Repository Files
12.2.3. Starting a Batch Job from a File System Folder
12.2.4. Setting Up a Batch Job
12.2.5. Running a CFX Batch Job
12.2.6. Running a Fluent Batch Job
12.2.7. Running a Mechanical APDL Batch Job
12.2.8. Running an LS-DYNA Batch Job
12.2.9. Running an Electronics Batch Job
12.2.10. Running Workbench Batch Jobs
12.2.10.1. Running a Workbench Project Update
12.2.10.2. Running a Design Point Update
12.2.11. Submitting Jobs to EKM from Workbench
12.2.12. Executing a Batch Job that has Not Started
12.2.13. Cancelling a Batch Job
12.2.14. Deleting a Batch Job
12.3. Running an Interactive Job
12.3.1. Starting an Interactive Job Using the Job Launch Application
12.3.2. Starting an Interactive Job from a Job Template
12.3.3. Starting an Interactive Job from Repository Files
12.3.4. Starting an Interactive Job from a File System Folder
12.3.5. Setting Up an Interactive Job
12.3.6. Starting a Remote Desktop Session
12.3.7. Connecting to an Interactive Session
12.3.8. Viewing an Interactive Session Log
12.3.9. Cancelling an Interactive Session
12.4. Monitoring and Controlling Jobs
12.4.1. Working with Fluent Server-mode Jobs
12.4.1.1. Monitoring a Fluent Solution
12.4.1.2. Pausing or Interrupting the Fluent Solution
12.4.1.3. Resuming or Restarting a Fluent Solution
12.4.1.4. Setting the Autosave Frequency
12.4.1.5. Specifying Fluent Command Inputs
12.4.1.6. Saving Changes to the Fluent Case File
12.4.1.7. Closing a Fluent Server-Mode Job
12.4.2. Working with CFX Server-Mode Jobs
12.4.2.1. Monitoring a CFX Solution
12.4.2.2. Stopping a CFX Solution
12.4.3. Monitoring Mechanical APDL Server-Mode Jobs
12.4.4. Monitoring Electronics Server-mode Jobs
12.4.5. Monitoring Workbench Jobs
12.4.5.1. Monitoring a Workbench Project Update
12.4.5.2. Monitoring a Design Point Run
12.5. Accessing a Job's Working Directory
12.6. Reusing a Job’s Working Directory
12.7. Accessing the File System
12.7.1. Creating a New Folder in the File System
12.7.2. Uploading Files to a Server Folder
12.7.3. Downloading Server Files to the Repository
12.7.4. Downloading Server Files to Your Computer
12.7.5. Renaming Server Files
12.7.6. Viewing Image and Video Files in the File System View
12.7.7. Editing the Content of Server Files
12.7.8. Moving Server Files
12.7.9. Copying Server Files
12.7.10. Deleting Server Files
12.8. Accessing the RSM Job Log
12.9. Monitoring Transfers from Slave Servers to a Master Server
12.10. Cluster Monitoring
12.11. Creating a Custom Job Template
12.12. Editing a Job Template
13. Defining Process Templates in EKM Studio
13.1. Introduction to Process Templates
13.2. Launching EKM Studio
13.3. The EKM Studio Environment
13.3.1. EKM Studio Layout
13.3.1.1. Main Editing Window
13.3.1.2. Elements Window
13.3.1.3. Properties Window
13.3.2. Customizing the Window Layout in EKM Studio
13.3.3. Menu Bar
13.3.3.1. File Menu Options
13.3.3.2. Edit Menu Options
13.3.3.3. View Menu Options
13.3.3.4. Help Menu Options
13.3.4. Toolbar
13.4. Defining Process Templates in EKM Studio
13.4.1. Process Template Terminology
13.4.2. Steps for Defining a New Process Template
13.4.3. Using Expressions in Process Elements
13.4.4. Defining Process Variables
13.4.4.1. Defining New Variables
13.4.4.2. Viewing the Properties of Variables
13.4.4.3. Editing Variables
13.4.4.4. Renaming Variables
13.4.4.5. Deleting Variables
13.4.5. Defining and Editing Process Nodes
13.4.5.1. Inserting New Nodes
13.4.5.1.1. Inserting a Process Template Node
13.4.5.2. Editing Nodes
13.4.5.2.1. Editing a Node
13.4.5.2.2. Editing a Batch Node
13.4.5.2.3. Editing an Iteration Node
13.4.5.2.4. Editing an Auto Node
13.4.5.2.5. Editing a Monitor Node
13.4.5.2.6. Editing an Update Analysis Project Node
13.4.5.2.7. Editing a Custom Dialog Node
13.4.5.2.8. Editing a Process Template Node
13.4.5.3. Renaming Nodes
13.4.5.4. Duplicating Nodes
13.4.5.5. Deleting Nodes
13.4.5.6. Creating and Editing Nested Iterations
13.4.6. Defining and Editing Process Transitions
13.4.6.1. Inserting Transitions
13.4.6.2. Editing Transitions
13.4.6.3. Renaming Transitions
13.4.6.4. Deleting Transitions
13.4.7. Editing Validation Expressions
13.4.8. Saving Process Template Files
13.4.9. Opening Process Template Files
13.4.10. Correcting an Invalid Layout
13.4.11. Editing Process Attributes
13.5. Using Macros in Process Templates
13.6. Displaying a Process Template
14. Defining Custom Dialog Boxes and Wizards in EKM Studio
14.1. Launching the Custom Dialog Editor
14.2. Defining a Sample Dialog Box
14.3. Setting the Operation of the Custom Dialog Box
14.4. Save the New Definition
14.5. Adding New Steps
14.6. Custom Dialog Node Reference
14.7. Setting the Dimensions of a Custom Dialog Box
14.8. Assigning Custom Dialog Resource Files to a Process Template
15. Starting and Managing Processes
15.1. Starting a Process
15.1.1. Requesting Approval to Make a Process Template Executable
15.1.2. Creating a New Process
15.1.3. Processes with a Single Node/Single User Custom Dialog
15.2. Managing Processes
15.2.1. Accessing the Process View
15.2.2. Monitoring the Status of Tasks
15.2.3. Managing Assignees
15.2.4. Viewing the Status and Details of a Process
15.2.5. Cancelling a Process
15.2.6. Deleting a Process
15.3. Managing Tasks Assigned to You
15.3.1. Viewing the Status and Details of a Task
15.3.2. Starting a Task
15.3.3. Executing a Batch Job in a Process
15.3.4. Cancelling a Batch Job
15.3.5. Completing a Task
15.3.6. Reassigning a Task
15.3.7. Accepting a Reassigned Task
15.4. Automatic Email Notifications Sent From Processes
16. Discussion Boards
16.1. Creating a Discussion Board
16.2. Opening a Discussion Board
16.3. Starting a Discussion
16.4. Inviting People to Join Discussions
16.5. Subscribing to Email Notifications
16.6. Unsubscribing from Email Notifications
16.7. Adding Comments to a Discussion
17. Catalogs
17.1. Creating a Catalog
17.2. Adding Content to a Catalog
17.3. Automatic Naming of Catalog Objects
17.4. Uploading Files to a Catalog
17.5. Moving a Catalog
17.6. Copying a Catalog
17.7. Downloading a Catalog
17.8. Searching a Catalog
17.8.1. Saving a View
17.8.2. Loading a View
17.8.3. Editing a View
17.8.4. Specifying a Default View
17.8.5. Copying a View
17.8.6. Displaying Information About a View
17.8.7. Deleting a View
17.9. Selecting an Object in a Catalog as a Reference Property Value
17.10. Tutorial: Creating a Widget Catalog
18. Working With ANSYS Workbench Projects
18.1. Displaying Workbench Project Reports
18.2. Saving Workbench Project Archives in EKM
18.3. Parameters in Workbench Projects
18.4. Updating Workbench Projects in EKM
18.5. Performing Design Point Studies in EKM
19. Working With Analysis Projects
19.1. Creating an Analysis Project Folder
19.2. Specifying Analysis Project Pedigree (Inputs and Outputs)
19.3. Specifying File Dependencies
19.4. Displaying Dependencies
19.5. Specifying Analysis Execution Settings
19.6. Updating an Analysis Project Folder
19.7. Tutorial: Creating a Custom Analysis Project
20. Displaying 3D Simulation Images Using VCollab
20.1. Introduction to VCollab
20.2. Interacting with 3D Images in the VCollab Viewer
A. Defining a Process Template Using XML
A.1. Translating a Conceptual Process to an EKM Process
A.2. Schema Definition for Process Templates
A.3. Defining an EKM Process Template XML File
A.4. Defining Variables
A.5. Defining Nodes
A.5.1. Node Type
A.5.2. Auto Node Type
A.5.3. Iteration Node Type
A.5.4. Monitor Node Type
A.5.5. Batch Node Type
A.5.6. Workflow Reference Node Type
A.5.7. Update Analysis Project Node Type
A.5.8. Custom Dialog Node Type
A.5.8.1. User Interface Component Definitions
A.5.8.2. Dialog Step
A.5.8.3. Panel Grid
A.5.8.4. Image
A.5.8.5. Spacer
A.5.8.6. Upload File
A.5.8.7. Command Link
A.5.8.8. Command Button
A.5.8.9. Table
A.6. Defining Transitions
A.7. Defining Blocks
A.8. Defining Expressions
A.9. Defining Macros
A.10. Defining Process Attributes
A.11. Example of a Process Template XML Definition
A.12. Editing an EKM Process Template in EKM Studio
Glossary
Administration Guide
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
Installation Guide
Using This Guide
1. Glossary
2. EKM Path Variables
3. Filesystem Path Conventions
1. Introduction to EKM
1.1. Licensing and Access
1.2. License Usage
2. Overview of an EKM Server Installation
2.1. Deployment Options
2.2. How an EKM Server is Configured
2.3. Steps for Setting Up an EKM Server
3. Planning Deployment for an EKM Server
4. EKM Server Prerequisites
4.1. Prerequisite Instructions
4.1.1. Machine Prerequisites
4.1.1.1. Minimum Hardware Requirements
4.1.1.2. Supported Operating System Versions
4.1.1.3. Required Software Applications
4.1.1.3.1. Database Server Versions
4.1.1.3.2. Required Software Applications for EKM
4.1.1.4. ANSYS Licensing
4.1.1.4.1. ANSYS License Manager and EKM License Setup
4.1.1.4.2. ANSYS Client Licensing Setup
4.1.2. Prerequisite Operations
4.1.2.1. Download the JDBC Driver for the Cluster Database Server
4.1.2.1.1. MySQL (Default)
4.1.2.1.2. Oracle
4.1.2.2. Create an EKM Server Account
4.1.2.2.1. Windows
4.1.2.2.2. Linux
4.1.2.2.3. Setting the Open Files Limit
4.1.2.2.4. Setting the Max User Processes Limit
4.1.2.2.5. Configuring Access to PAM Authentication
4.1.2.3. EKM Cluster Configuration Prerequisites
4.1.2.3.1. Components of a Cluster Configuration
4.1.2.3.2. Manual Configuration of the Cluster File Server
4.1.2.3.2.1. Network File Service
4.1.2.3.2.2. Cluster File System
4.1.2.3.3. Manual Configuration of the Cluster Database Server
4.1.2.3.4. Naming the Cluster and Cluster Nodes
5. Installing an EKM Server
5.1. Installing a New EKM Server
5.1.1. Installation Requirements
5.1.2. Running ANSYS EKM Server Product Installation
5.2. Running a Silent Installation
5.3. Special Instructions for Upgrading from 17.x
5.4. Special Instructions for Upgrading from EKM 18.0 or 18.1
6. Post-Setup
6.1. Post-Setup Instructions
6.1.1. Configure the EKM Server
6.1.2. Set the Location of ANSYS 18.2 Applications
6.1.3. Set Up an X Server (Linux)
6.2. Configure the MySQL Connector/J JDBC Driver (Optional)
6.3. Grant Database Privileges for Each Cluster Node on the Cluster Database Server
6.4. Manually Configure the JBoss Domain
6.5. Manually Configure the Front-End Web Server
6.6. Special Post-Setup Instructions for Upgrade
6.7. After Installation and Post-setup
6.7.1. Configuring Job Submission Queues
7. JBoss Domain Mode and Configuration
7.1. Domain Mode
7.2. Configuration
7.3. Management
7.3.1. Create JBoss Management Users
7.3.2. Deploy the EKM Server Application
7.3.3. JBoss Domain Controller – Failure and Promotion
8. Installing a Front-End Web Server
8.1. The Architecture of an EKM Server
8.2. Installing the Web Server and Load Balancer
8.2.1. Using EKM with Apache HTTP Server and mod_proxy
8.3. Configuring the Web Server and Load Balancer
8.3.1. mod_proxy (Apache)
8.4. Configuring the Application Server
8.4.1. JBoss Setup
8.4.1.1. Configure JBoss
8.4.1.2. Configure JBoss Web Services
8.4.1.3. Configure JBoss Undertow (Optional)
8.5. Configuring EKM to Communicate with the Web Server
8.6. Testing the Connection
8.7. Enabling HTTP Compression
8.7.1. Apache
8.8. Overview of Client-Web Server Communications
8.8.1. SSL/TLS Certificates: Background
8.8.2. Enabling Secure Connections to the Web Server (Optional)
8.8.2.1. Creating an In-House Certificate Authority
8.8.2.2. Creating and Installing a Test Certificate
8.8.2.2.1. Generating a Certificate Signing Request (CSR)
8.8.2.2.2. Signing the CSR
8.8.2.2.3. Installing the Certificate on the Web Server
8.8.3. Enabling Secure Connections to JBoss for Single-Node EKM Server (Optional)
8.8.3.1. Creating and Installing a Test Certificate
8.8.3.1.1. Generating a Certificate Signing Request (CSR)
8.8.3.1.2. Signing the CSR
8.8.3.1.3. Installing the Certificate on the Application Server
8.9. Securely Connecting to EKM (Optional)
9. Configuring Login Authentication and Access Settings
9.1. Configuring Login Authentication
9.1.1. Authenticating EKM Logins to an LDAP Server
9.1.1.1. Configuring Standard LDAP Authentication
9.1.1.2. Configuring Proxy-based LDAP Authentication
9.1.2. Authenticating EKM Logins to Windows Active Directory
9.1.3. Authenticating EKM Logins to the Windows Operating System
9.1.4. Authenticating EKM Logins to the Linux Operating System
9.2. How User Logins Work
9.3. Configuring Login-related Access Settings
9.4. LDAP Mapping
9.4.1. When to Use LDAP Mapping
9.4.1.1. Logging in to EKM Using an Alternate Authentication Identity
9.4.1.2. Synchronizing User Account Information
9.4.2. Configuring LDAP Mapping
10. Installing and Configuring EnginFrame
10.1. Installing EnginFrame
10.1.1. EnginFrame Setup
10.1.2. Setting Up Self-Signed Certificates for Client-Server Authentication
10.1.3. Creating Certificates
10.1.4. Configuring Keystore and Truststore on the EnginFrame Server
10.1.5. Configuring Keystore and Truststore on the Client (EKM Server/Nodes)
10.2. Configuring EKM to Work with EnginFrame
10.3. Troubleshooting Tips
11. Starting the EKM Server and Launching the Web Client
11.1. Service Mode and Console Mode
11.2. Starting and Stopping the EKM Server in Console Mode
11.3. Launching the EKM Web Client
11.4. Registering and Running EKM as a Service
11.4.1. Service Names
11.4.1.1. Windows
11.4.1.2. Linux
11.4.2. Running EKM as a Service
11.4.2.1. Windows
11.4.2.2. Linux
11.5. Evaluating EKM Log Files
11.5.1. JBoss Log Files
11.5.2. Java Service Wrapper Log Files (Windows service only)
12. Upgrading an EKM Server from a Previous Version
12.1. Upgrading from EKM 17.x to EKM 18.2
12.1.1. Variables and Common Commands
12.1.1.1. EKM Path Variables
12.1.1.2. Common Commands
12.1.2. Prerequisites
12.1.3. Steps for Upgrading an EKM Server
12.1.3.1. Prepare the EKM 17.0 Server for an Upgrade
12.1.3.1.1. Verify the Existing EKM 17.0 Installation
12.1.3.1.2. Back Up EKM 17.0
12.1.3.2. Prepare the EKM Database for an Upgrade – Part 1
12.1.3.3. Set Up a New EKM 18.2 Server for an Upgrade
12.1.3.4. Prepare the EKM Database for an Upgrade – Part 2
12.1.3.5. Pre-Upgrade Instructions
12.1.3.6. Launch the Upgrade Wizard
12.1.3.7. Run the Upgrade Wizard
12.1.3.8. Review the Post-Upgrade Instructions
12.1.3.9. Post-Upgrade Instructions
12.1.3.9.1. Synchronize the Repository Folders on All Cluster Nodes
12.1.3.9.2. Synchronize the Revision ID for All Cluster Nodes in the Cluster Database
12.1.3.9.3. Copy Audit Log Files
12.1.3.9.4. Update Shared Applications
12.2. Upgrading from EKM 18.0 or 18.1 to EKM 18.2
12.2.1. Terminology
12.2.2. Preparing to Upgrade from EKM 18.0 or 18.1
12.2.3. Installing the EKM 18.2 Server
12.2.4. Transferring the EKM Configuration to EKM 18.2
12.2.5. After the Upgrade
13. Gathering Support Diagnostics
13.1. Launching the EKM Server Diagnostics Tool
13.2. Using the EKM Server Diagnostics Tool
14. Uninstalling an EKM Server
14.1. Uninstalling an EKM Server on Windows
14.2. Uninstalling an EKM Server on Linux
14.3. Uninstalling the Front End Web Server
15. Appendices
15.1. Appendix A: Setting Environment Variables for EKM
15.2. Appendix B: Network Ports
15.3. Appendix C: Email Configuration
15.4. Appendix D: Resolving Network Port Conflicts
15.5. Appendix E: Changing the JBoss HTTP Port
15.6. Appendix F: Setting the HTTP Session Timeout
15.7. Appendix G: Changing the MySQL Database Server Port
15.8. Appendix H: Configuring Windows Services (Windows Only)
15.9. Appendix I: Updating EKM Server Objects
15.10. Appendix J: Granting Database Privileges
15.11. Appendix K: Clearing the Repository
15.12. Appendix L: Disabling HTTP Compression
15.13. Appendix M: Changing the JVM Heap Size
15.14. Appendix N: Configuring EKM to Use Amazon S3 Data Storage
15.15. Appendix O: Creating a Silent Installation File
15.15.1. Silent Installation Options
15.15.2. Example Silent Installation Files
15.16. Appendix P: EKM Cluster Network Configuration
15.17. Appendix Q: Configuring the MySQL Connector/J JDBC Driver
15.18. Appendix R: Changing the EKM Cluster Name
15.19. Appendix S: Changing an EKM Cluster Node IP Address
EKM Troubleshooting Guide
1. EKM Troubleshooting
2. Installation and Setup Issues
2.1. EKM server fails to start: MySQL database server not started
2.2. EKM server fails to start: “java.lang.OutOfMemoryError”
2.3. EKM server fails to start: “Node named x already exists in this cluster”
2.4. Unable to Connect to an EKM Server When Running in Service Mode
3. Sign-in and Access Issues
3.1. The EKM web client does not launch, or users cannot sign in: “License framework initialization failed”
3.2. A user cannot sign in: No EKM user account
3.3. A user cannot sign in: "The referenced account is currently locked out and may not be logged on to"
3.4. User sign-in error: “Invalid username or password”
3.5. Users cannot sign in: "Missing response from all cluster nodes"
3.6. Sign-in error: “You may have already signed in to a different session.”
4. User Management Issues
4.1. Cannot delete a selected user on Users page
5. General EKM Server Behavior Issues
5.1. EKM Server is Slow or Unresponsive
5.2. EKM server stops responding and fails to restart
5.3. EKM web client window suddenly becomes blank
6. Data Management Issues
6.1. Upload with File Transfer Client: Maximum number of objects exceeded
6.2. Tooltips not working in File Transfer Client
6.3. Metadata extraction: “Extracted data is not set”
6.4. Archive not extracted successfully
6.5. Cannot create, modify or delete objects in Shared Data
6.6. Cannot put a folder under version control
6.7. Issues checking in a version-controlled object
6.8. Image Viewer: Cannot create or save views, or add markup
6.9. Image Viewer: Image not displayed
7. Job Management Issues
7.1. Users cannot run jobs: RSM not installed, configured, or running
7.2. Users cannot run jobs: No applications available
7.3. A user cannot run jobs: Wrong credentials
7.4. Data management proxy process could not be launched: rsmWindowsDomain not specified
7.5. Cluster job failure: Job data directory not visible or defined
7.6. Cluster job failure: Multiple NIC card issue
7.7. Cluster job failure: Firewall issue
7.8. Jobs submitted from network share failing: "UNC paths are not supported"
7.9. CFX server-mode jobs failing or not showing monitors/actions
7.10. Fluent server-mode jobs failing or not showing live monitors
7.11. MAPDL server-mode jobs failing, not showing live monitors, or can’t be paused
7.12. Electronics server-mode jobs failing or not showing monitors
7.13. Cannot run interactive jobs
7.14. "Failed command: LaunchProxy. Unable to contact RSM."
7.15. Jobs page error: "Could not find the object at /Jobs/File System"
8. Usability Issues
8.1. Tablet use: Unavailable actions
8.2. Tablet use: Issues and Limitations
A. Known Issues and Limitations

Release 18.2 - © ANSYS, Inc. All rights reserved.