Table of Contents

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

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