You are on page 1of 33

Using ACT to Customize

ANSYS Products and Simulation Workflows:


A Users Guide to Creating Business-Specific Apps
(17.2 Release)
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Copyright and Trademark Information

2016 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is
prohibited.

ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX,
FLUENT, HFSS, AIM and any and all ANSYS, Inc. brand, product, service and feature names,
logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries in
the United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under
license. CFX is a trademark of Sony Corporation in Japan. All other brand, product, service and
feature names or trademarks are the property of their respective owners.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE


SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS
SUBSIDIARIES, OR LICENSORS. The software products and documentation are furnished by
ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement that contains
provisions concerning non-disclosure, copying, length and nature of use, compliance with
exporting laws, warranties, disclaimers, limitations of liability, and remedies, and other
provisions. The software products and documentation may be used, disclosed, transferred, or
copied only in accordance with the terms and conditions of that software license agreement.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and
affiliates.
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Table of Contents
Overview ........................................................................................................... 1
Extension Structure ...............................................................................................2
Extension Formats .................................................................................................2
ACT Customization Tools .................................................................................. 3
ACT Customization Capabilities ........................................................................ 4
Types of Customization ..........................................................................................4
Customization Types by Product .............................................................................5
ACT Documentation and Development Resources ........................................... 6
General Documentation ....................................................................................6
Reference Documentation ................................................................................7
Templates, Training, & Libraries .......................................................................8
Customer Portal Resources ...............................................................................9
Python Resources ..............................................................................................9
Roadmaps for ACT Customization .................................................................. 10
ACT Customization Common Roadmap ............................................................... 11
Step 1: Define Your Extension ...........................................................................11
Step 2: Install and Load Your Extension ...........................................................11
Step 3: Debug Your Extension ...........................................................................12
Feature Creation Roadmaps ................................................................................. 13
Feature Creation in AIM ..........................................................................................14
Feature Creation in the Workbench Project Page .......................................................15
Feature Creation in DesignModeler ..........................................................................15
Feature Creation in Mechanical ................................................................................16
Feature Creation in DesignXplorer............................................................................18
Simulation Workflow Integration Roadmap ............................................................ 19
Process Compression Roadmaps ........................................................................... 22
Process Compression Common Roadmap...............................................................23
Process Compression in AIM ....................................................................................24
Process Compression in the Workbench Project Page ................................................24
Process Compression in SpaceClaim .........................................................................25
Process Compression in DesignModeler ....................................................................26
Process Compression in Mechanical .........................................................................26
Process Compression in Electronics Desktop .............................................................27
Process Compression in DesignXplorer .....................................................................28
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Process Compression in Fluent and Fluent Meshing ...................................................28


Process Compression for Multiple Applications (Mixed Wizard)....................................29
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Overview
ANSYS ACT is the unified and consistent tool for the customization and expansion of
ANSYS products. Using ACT, you can create vertical apps or extensions to tailor
ANSYS Workbench, ANSYS AIM, and other ANSYS products (such as Mechanical, Fluent,
and Electronics Desktop) to meet your application-specific and multi-physics
simulation needs. You can also engage the ANSYS simulation ecosystem through
integration and custom workflow techniques.

The purpose of this document is to:

Present a high-level overview of ACT, introducing you to the general concepts youll
need to understand in order to start developing extensions.
Help you start developing your own extensions, from the initial design phase
through the implementation andwhen desiredto the final posting of your app to
the ANSYS ACT Application Store. You can post your apps using the Post My App
Google site, which details the posting process.
Deliver specialized customization roadmaps designed to guide you through the
steps of creating the desired type of ACT customization for the supported ANSYS
product you choose.
Provide references and links to the available ACT documentation and resources so
that you can easily access relevant information, such as:
ACT Developers Guide sections that specifically address your objective
Reference guides containing API and XML information
ACT templates and extension examples
ACT training materials

**Important: Note that most of links in this document go to materials on the ANSYS
Customer Portal. You must be logged into the Customer Portal in order for the links to
open directly to the desired page.

Also, documentation available on the Customer Portals Online Documentation: Current


Release 17.2 page is also available via the Help menu in ANSYS products.

1
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Extension Structure

All ACT extensions are made up of the same two basic parts: an XML extension file and
an IronPython script.

Extensions can potentially also include additional components such as external Python
libraries, C# code, input files, and images to be shown in the custom GUI.

Extension Formats

ACT extensions can be created in two different formats: scripted and binary.

Scripted Extension:
A Scripted Extension is an extension with an editable XML extension file and
IronPython script. The XML file and an extension folder containing (at minimum)
the IronPython script are saved at the same level.

Binary Extension:
A Binary Extension is a compiled extension (WBEX file) resulting from the build of
a scripted extension. These extensions can be shared with users, who will be
able to execute the extension, but will not be able to edit it.

2
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

**Note: You may need a license to create an extension. In general, the creation of
scripted extensions requires a license, while the generation of a binary extension
typically does not. The ACT license may be bundled with most ANSYS 17.2 products.

ACT Customization Tools


In 17.2, most of ACTs customization tools can be accessed via the ACT Start Page. The
ACT Start Page is available in all ANSYS products that support the use of extensions.
The way that you access this page depends on the ANSYS product that you are using.

3
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

From this page, you can access multiple tools to be used in the development and
execution of extensions: the Extension Manager, the Wizards page, the ACT
Console, and the extension log file.

The following table refers you to tools documentation in the ACT Developers Guide.

Tool Reference
ACT Start Page Using Extensions > Using the ACT Start Page >
Accessing the ACT Start Page
ACT Start Page Interface
Extension Manager Using Extensions > Using the Extension Manager >
Extension Manager Accessed via the ACT Start Page
Extension Manager Accessed via Extensions Menu
ACT Console Development and Debugging > ACT Console
Binary Extension Builder Development and Debugging > Binary Extension Builder
Debug Mode (Refresh Development and Debugging >
Extensions and Log File) Debug Mode
Debugging with Microsoft Visual Studio

ACT Customization Capabilities


This section details types of ACT customizations and what types of customization are
available for products that support ACT.

Types of Customization

ACT provides three types of customization: feature creation, simulation workflow


integration, and process compression.

Feature Creation:

The direct, API-driven customization of ANSYS products. In addition to leveraging


the native functionality already available in a product, it also enables you to add
functionality and operations of your own.

4
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Examples of feature creation include the creation of custom loads and geometries,
the addition of custom pre- or post-processing features, and the integration of third-
party solvers, sampling methods, and optimization algorithms.

Simulation Workflow Integration

The integration of external knowledge (e.g. apps, processes, scripts) into the ANSYS
ecosystem. Today users can engage in simulation workflow customization in the
ANSYS Workbench Project page. You can define new workflow tasks to construct
consistent and cohesive simulation workflows, allowing your business-specific
elements to co-exist and interface with pre-built ANSYS solutions.

Process Compression

The encapsulation and automation of existing processes available in an ANSYS


product. The result is a wizard that provides guidance within the application
workflow, walking the end-user step-by-step through a simulation. You can create
single wizards to be run in specific target applications or mixed wizards to be run
across several applications. In AIM, wizards are called custom templates.

All three types of customization are accomplished through the creation and
implementation of ACT extensions.

Customization Types by Product

The following table shows the ANSYS products that currently support ACTs
customization capabilities.

Product Simulation Workflow Feature Process


Integration Creation Compression
Workbench
AIM
DesignModeler
Mechanical
DesignXplorer

5
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Product Simulation Workflow Feature Process


Integration Creation Compression
SpaceClaim
Electronics Desktop
Fluent
Fluent Meshing

ACT Documentation and Development Resources


This section introduces you to the ACT documentation and the resources that are
available to you:

General Documentation
Reference Documentation
Templates, Training, and Libraries
Customer Portal Resources
Python Resources

General Documentation
Resource Description Location

Installation Presentation providing Customer Portal > Downloads > ANSYS ACT
Procedure instructions for installing ACT Application Store 17 > Help & Support >
extensions. Installation Procedure

ANSYS ACT Migration notes containing the Customer Portal > Knowledge Resources >
Migration Notes information needed to migrate Online Documentation > Customization >
(17.0 through 17.2) between 17.0 through 17.2. ANSYS ACT Migration Notes
Customer Portal > Downloads > ANSYS ACT
Application Store 17 > Help & Support > ACT
Migration Notes 17.2

6
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

General Documentation
Resource Description Location

ACT Developers General introductory guide for Customer Portal > Knowledge Resources >
Guide ACT which provides: Online Documentation > Customization >
Introduction to ACT ACT Developers Guide HTML
capabilities, interface, and ACT Developers Guide PDF
tools. Customer Portal > Downloads > ANSYS ACT
Information about Application Store 17 > Help & Support > ACT
customization types and Developers Guide
product support.
Extension examples
showing product-specific
capabilities, API usage,
and customization types.

License Agreement Software licensing agreement Customer Portal > Downloads > ANSYS ACT
for publishing extensions to Application Store 17 > Help & Support >
the ANSYS ACT Application License Agreement
Store 17.

Reference Documentation
Resource Description Location

ACT Online Easy-to-navigate online HTML Customer Portal > Downloads > ANSYS ACT
Reference document providing both API and Application Store 17 > Help & Support >
XML reference materials for ACT. Online Reference Guide
Available in both online (.html)
Download Reference Guide
and downloadable (.zip) versions.
**Recommended version of
developers reference
documentation

ACT API Reference document providing Customer Portal > Knowledge Resources >
Reference Guide API namespace information for Online Documentation > Customization >
ACT. ACT API Reference Guide HTML
ACT API Reference Guide PDF

7
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Reference Documentation
Resource Description Location

ACT XML Reference document providing Customer Portal > Knowledge Resources >
Reference Guide XML definition and tagging Online Documentation > Customization >
information for ACT. ACT XML Reference Guide HTML
ACT XML Reference Guide PDF

ANSYS AIM and Reference document providing a Customer Portal > Knowledge Resources >
Workbench general introduction to journaling Online Documentation > Customization >
Scripting Guide and scripting capabilities that can AIM and Workbench Scripting Guide HTML
be used in some customizations.
AIM and Workbench Scripting Guide PDF
Also contains product-specific
data container information.

Templates, Training, & Libraries


Resource Description Location

ACT Templates Zip packages containing templates. Customer Portal > Downloads > ANSYS ACT
Package contains a variety of Application Store 17 > ACT Templates >
templates, each including a sample ACT Templates for Mechanical
extension and example project. ACT Templates for DesignModeler
ACT Templates for DesignXplorer
ACT Wizard Templates
ACT Intro Training modules containing Customer Portal > Downloads > ANSYS ACT
Training: lectures and workshops for ACT Application Store 17 > Help & Support >
Lectures and R17. Training ACT for Mechanical
Workshops Training for ACT Wizards
ACT Libraries Libraries containing release- Customer Portal > Downloads > ANSYS ACT
specific and product-specific Application Store 17 > Previous Releases >
extension examples and models. 16.2 ACT Library
15.0 ACT Library
Framework SDK Library
Simplorer Device Models Library

8
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Customer Portal Resources


Resource Description Location

ANSYS ACT Contains extensions posted by Customer Portal > Downloads > ANSYS
Application Store 17 ANSYS or ANSYS customers. ACT Application Store 17
Extensions can be filtered by:
Free, Paid, Workbench
Mechanical, Workbench
DesignModeler, Workbench
Project Schematic, Workbench
Meshing, Workbench
DesignXplorer, and Workbench
Wizard.

Case Studies & Section containing ACT case Customer Portal > Downloads > ANSYS
Videos studies, videos, and ACT Application Store 17 > Case Studies &
presentations. Videos >
(Sidebar to the Application Store.) ANSYS ACT General Presentation
ANSYS ACT Videos
Oticon, DK
Epsilon, USA
ADAPT (US Army)
Whirlpool Corp.

Python Resources
Resource Description Location

Python Training Training presentation providing Customer Portal > Downloads > ANSYS ACT
basics of using XML and Python Application Store 17 > Help & Support >
programming. Introduction to Iron Python

IronPython IronPythons documentation http://ironpython.net/documentation/


Documentation page, which provides version-
specific documentation and
application/implementation
examples.

Python Essential PDF copy of the Python http://microembedded.googlecode.com/files/


Reference Essential Reference book by Python_Essential_Reference_3rd_Edition.pdf
David Beasley.

9
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Roadmaps for ACT Customization


The next sections of this document contain development roadmaps to guide you through the extension creation
process. Each roadmap provides a high-level description of the steps necessary for the specific customization that you
want to perform. It then directs you to more detailed information in the ACT documentation set.
Note: Unless otherwise indicated, documentation references are to the ACT Developers Guide.

The sections go from the general to the specific: from the steps that are applicable to all extensions (ACT customization)
through the type of customization (Feature Creation, Workflow Integration, and Process Compression), to the specific
application being customized.

Click the links in the following flowchart to navigate to the corresponding section in this document.

ACT Customization (Main Objective)

Feature Creation Workflow Integration Process Compression

Project DesignModeler Mechanical DesignXplorer Project


AIM
Page Page

Project Electronics Fluent/Fluent


AIM SpaceClaim DesignModeler Mechanical DesignXplorer
Page Desktop Meshing
10
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

ACT Customization Common Roadmap

The following tables provide steps that are common to all extensions and refer you to
relevant documentation in the ACT Developers Guide.

Step 1: Define Your Extension


Step Description Reference

1a Create the XML definition Defining Extensions > Creating a Scripted Extension >
file. Creating the XML Extension Definition File
1b Create the IronPython script. Defining Extensions > Creating a Scripted Extension >
Creating the IronPython Script
1c Place the files in the correct Defining Extensions > Creating a Scripted Extension >
directory structure. Setting Up the Directory Structure/File Hierarchy
1d Optional: Compile the Defining Extensions > Building a Binary Extension
scripted extension into a
Also see Binary Extension Builder.
binary extension (.wbex).
1e Configure extension options Defining Extensions > Configuring Extension Options
in Tools > Options >
Extensions.

Step 2: Install and Load Your Extension


Step Description Reference

2a Install your extension. For Scripted Extensions:


Note that for binary Using Extensions > Installing and Uninstalling Extensions >
extensions, you will use Installing a Scripted Extension
the ACT Extension
Manager tool. For Binary Extensions:
Using Extensions > Installing and Uninstalling Extensions >
Installing a Binary Extension
2b Load your extension. Using Extensions >
Loading and Unloading Extensions
Configuring Extensions to be Loaded by Default

11
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Step 3: Debug Your Extension


Step Description Reference
3 Optional: Debug your extension using ACT Development and Debugging >
or external tools. Debug Mode

12
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Feature Creation Roadmaps

Feature Creation customization is the API-based creation of new custom features for a product. The following flowchart
shows:

the products for which ACT Feature Creation capabilities are available
the types of features that can be created for each product

Click the links to navigate to the product you wish to customize.

Feature Creation

Project Mechanical
AIM DesignModeler DesignXplorer
Page

Pre- Custom Custom


Geometry Pre- Post- Third-Party
Processing Objects Scripting Algorithm
Builder Processing Processing Solver
Integration

13
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Feature Creation in AIM

In AIM, you can perform customization activities such as the addition of a pre-
processing feature for a structural analysis and the creation of a custom object to
encapsulate and expose existing AFD features.

AIM

Pre-processing Custom Objects

Add pre-processing features Create and expose a complete CFD


such as custom loads to a system with access to all existing
structural analysis. fluids boundary conditions.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications Common Capabilities
ACT-Based Properties
Capabilities specific to AIM ACT Developers Guide > Feature Creation Capabilities >
Capabilities for ANSYS AIM >
Adding a Pre-Processing Feature in ANSYS AIM Structural
Creating a Custom Object to Merge Existing AFD Features
Online HTML reference providing both Customer Portal > Downloads > ANSYS ACT Application Store
API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide
namespace information.
Reference document providing XML ACT XML Reference Guide
definition and tagging information.

14
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Feature Creation in the Workbench Project Page

In the Workbench Project page, you can perform common customization activities
such as custom toolbars and pop-up dialog creation; extension data storage; and ACT-
based property and property group definitions.

Project Page Scripting

Create toolbars and pop-up dialogs; store


data in an extension; define ACT-based
properties and property groups.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications Common Capabilities
ACT-Based Properties

Feature Creation in DesignModeler

In DesignModeler, you can create custom Geometry Builder features.

DesignModeler Geometry Builder

Create specialized geometries with custom


properties and apply custom geometric
operations.

Topic Reference
Capabilities common to all ACT Developers Guide > Feature Creation Capabilities >
target applications Common Capabilities
ACT-Based Properties

15
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Capabilities specific to ACT Developers Guide > Feature Creation Capabilities >
DesignModeler Capabilities for ANSYS DesignModeler >
Geometry Definition in the XML File
Geometry Definition in the Python File
DesignModeler API Usage ACT Developers Guide > APIs Description > APIs for ANSYS
Examples DesignModeler >
Using the Selection Manager in DesignModeler
Creating Primitives
Applying Operations
Online HTML reference Customer Portal > Downloads > ANSYS ACT Application Store 17 >
providing both API and XML Help & Support >
information. Online Reference Guide
**Recommended version of Download Reference Guide
developers reference
documentation.
Reference document providing ACT API Reference Guide >
API namespace information. Ansys.ACT.Automation.DesignModeler
Ansys.ACT.Interfaces.DesignModeler

Reference document providing ACT XML Reference Guide >


XML definition and tagging <extension>
information. <simdata>
<geometry>

Feature Creation in Mechanical

In Mechanical, you can create custom Pre-Processing, Post-Processing, and Third-Party


Solver features.

Mechanical

Pre-processing Post-processing Third-Party Solver

Add pre-processing Add post-processing Add the ability to connect


features such as loads features such as custom to third-party or launch
and boundary conditions. results. external processes.

16
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications Common Capabilities
ACT-Based Properties
Capabilities specific to Mechanical ACT Developers Guide > Feature Creation Capabilities >
Capabilities for ANSYS Mechanical >
Adding a Pre-Processing Feature in ANSYS Mechanical
Adding a Post-Processing Feature in ANSYS
Mechanical
Creating Results with Imaginary Parts
Connecting to a Third-Party Solver
Mechanical API Usage Examples ACT Developers Guide > APIs Description > APIs for ANSYS
Mechanical >
Directly Accessing an Object
Handling Property Types
Model Object
TraverseExtension
User Interface and Toolbars
Mechanical Extension Examples ACT Developers Guide > Examples >
Mechanical Extension Examples >
Von-Mises Stress as a Custom Result
An Edge-Node Coupling Tool
Online HTML reference providing both Customer Portal > Downloads > ANSYS ACT Application Store
API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide >
namespace information. Ansys.ACT.Automation.Mechanical
Ansys.ACT.Automation.Mechanical.AnalysisSettings
Ansys.ACT.Automation.Mechanical.BoundaryConditions
Ansys.ACT.Automation.Mechanical.Connections
Ansys.ACT.Automation.Mechanical.Enums
Ansys.ACT.Automation.Mechanical.ImportedLoads
Ansys.ACT.Automation.Mechanical.MeshControls
Ansys.ACT.Automation.Mechanical.Results
Ansys.ACT.Interfaces.Mechanical
Ansys.ACT.Mechanical.Fields

17
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Reference document providing XML ACT XML Reference Guide >
definition and tagging information. <extension>
<simdata>
<load>
<object>
<result>
<solver>

Feature Creation in DesignXplorer

In DesignXplorer, you can integrate custom and external algorithms.

Custom Algorithm
DesignXplorer
Integration

Integrate custom and external


sampling and optimization algorithms.

Topic Reference
Capabilities common to all target ACT Developers Guide > Feature Creation Capabilities >
applications Common Capabilities
ACT-Based Properties
Capabilities specific to DesignXplorer ACT Developers Guide > Feature Creation Capabilities >
Capabilities for ANSYS DesignXplorer >
The Design Exploration Process
Implementing a DX Extension
Notes on Method Class Implementation
DesignXplorer API Usage Examples ACT Developers Guide > APIs Description > APIs for ANSYS
DesignXplorer >
DOE APIs
Optimization APIs
DesignXplorer Extension Examples ACT Developers Guide > Examples > DesignXplorer Extension
Examples >
DOE Extension Examples
Optimization Extension Examples

18
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Online HTML reference providing both Customer Portal > Downloads > ANSYS ACT Application Store
API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide >
namespace information. Ansys.DesignXplorer.API
Ansys.DesignXplorer.API.Common
Ansys.DesignXplorer.API.Optimization
Ansys.DesignXplorer.API.Sampling
Ansys.DesignXplorer.Automation
Reference document providing XML ACT XML Reference Guide >
definition and tagging information. <extension>
<simdata>
<extensionobject>
<optimizer>

Simulation Workflow Integration Roadmap

Simulation Workflow Integration customization is workflow integration in the


Workbench Project page. You can create custom task groups (systems) and tasks
(components) to facilitate interaction with the Workbench Project Schematic.

Project Page Scripting

Create custom tasks groups and tasks to be


included in the ANSYS Workbench workflow.

Topic Reference

Capabilities specific to the Workbench ACT Developers Guide > Feature Creation Capabilities >
Project page Capabilities for Custom ACT Workflows in Workbench >
The Custom Workflow Creation Process
Creating the Extension Definition XML File
Creating the IronPython Script

19
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference

Workbench Project Page Extension ACT Developers Guide > Examples > Custom ACT Workflows
Examples in Workbench Examples >
Custom User-Specified GUI Operation
Custom, Lightweight, External Application Integration
with Parameter Definition
Custom, Lightweight, External Application Integration
with Custom Data and Remote Job Execution
Generic Material Transfer
Generic Mesh Transfer
Custom Transfer
Parametric

Appendices containing Workbench ACT Developers Guide >


Custom Workflow Info
Appendix A. Component Input and Output Tables
Appendix B. ANSYS Workbench Internally Defined System
Template and Component Names
Appendix C. Data Transfer Types
Appendix D. Addin Data Types and Data Transfer Formats

Online HTML reference providing both Customer Portal > Downloads > ANSYS ACT Application Store
API and XML information. 17 > Help & Support >
Online Reference Guide
**Recommended version of
developers reference documentation. Download Reference Guide

Reference document providing API ACT API Reference Guide >


namespace information.
Ansys.ACT.Interfaces.Common
Ansys.ACT.Interfaces.DataModel
Ansys.ACT.Interfaces.UserInterface
Ansys.ACT.Interfaces.UserInterface.Components
Ansys.ACT.Interfaces.UserObject

20
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference

Reference document providing XML ACT XML Reference Guide >


definition and tagging information.
<extension>
<workflow>
<callbacks> ... </callbacks>
<property>
<propertygroup>
<propertytable>
<taskgroups>
<tasks>

Reference document providing AIM and Workbench Scripting Guide


journaling and scripting information,
including product-specific data
container details.

21
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Process Compression Roadmaps

Process Compression customization is the encapsulation and automation of existing processes available in an ANSYS
product into a wizard.

The following flowchart shows the products for which ACT Process Compression capabilities are available. In AIM, wizards
are called custom templates.

Click the links to navigate to the product that you want to customize.

Process Compression

Target Application Wizard Mixed Wizard

Project Electronics Fluent/Fluent


AIM SpaceClaim DesignModeler Mechanical DesignXplorer
Page Desktop Meshing

22
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Process Compression Common Roadmap

The following table refers you to documentation on topics that are common to the
creation of wizards and AIM custom templates.

Topic Reference
Types of wizards ACT Developers Guide > ACT Simulation Wizards > Types of Wizards
Creating wizards ACT Developers Guide > ACT Simulation Wizards > Creating Wizards
Installing and loading ACT Developers Guide > ACT Simulation Wizards > Installing and Loading
wizards Wizards
Using wizards ACT Developers Guide > ACT Simulation Wizards > Using Wizards
Online HTML reference Customer Portal > Downloads > ANSYS ACT Application Store 17 > Help
providing both API and & Support >
XML information. Online Reference Guide
**Recommended version Download Reference Guide
of developers reference
documentation.
Reference document ACT API Reference Guide >
providing API namespace
information. Ansys.ACT.Interfaces.Wizard

Reference document ACT XML Reference Guide >


providing XML definition <extension>
and tagging information. <application>
<appstoreid>
<author>
<description>
<uidefinition>
<wizard>

Reference document AIM and Workbench Scripting Guide


providing journaling and Refer to the sections for the specific applications being customized.
scripting information,
including product-specific
data container details.

23
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Process Compression in AIM

The following table refers you to documentation on creating custom templates to


compress and automate processes in ANSYS AIM.

Note that an AIM simulation can also be automated by running a Project wizard from
the AIM Project tab.

Topic Reference
Using AIM custom templates ACT Developers Guide > ACT Simulation Wizards > Using Wizards
> Using an AIM Custom Template

AIM Custom Template ACT Developers Guide > Examples > Wizard Examples >
Examples Project Wizard (AIM Project Tab)
AIM Custom Template (Single-Step)
AIM Custom Template (Multi-Step)
Online HTML reference Customer Portal > Downloads > ANSYS ACT Application Store 17 >
providing both API and XML Help & Support >
information. Online Reference Guide
**Recommended version of Download Reference Guide
developers reference
documentation.
Reference document providing ACT API Reference Guide
API namespace information.

Reference document providing ACT XML Reference Guide


XML definition and tagging
information.
Reference document providing AIM and Workbench Scripting Guide
journaling and scripting Refer to the Workbench section.
information, including product-
specific data container details.

Process Compression in the Workbench Project Page

The following table refers you to documentation on creating wizards and AIM custom
templates to orchestrate workflows on the Project Schematic.

Topic Reference
Workbench Project Page ACT Developers Guide > Examples > Wizard Examples >
Wizard Examples Project Wizard (Workbench Project Tab)

24
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Project Wizard (AIM Project Tab)
Mixed Wizard
Online HTML reference Customer Portal > Downloads > ANSYS ACT Application Store 17 >
providing both API and XML Help & Support >
information. Online Reference Guide
**Recommended version of Download Reference Guide
developers reference
documentation.
Reference document providing ACT API Reference Guide
API namespace information.
Reference document providing ACT XML Reference Guide
XML definition and tagging
information.
Reference document providing AIM and Workbench Scripting Guide
journaling and scripting Refer to the Workbench section.
information, including product-
specific data container details.

Process Compression in SpaceClaim

The following table refers you to documentation on creating wizards to compress and
automate processes in the SpaceClaim application. Wizards can be run in SpaceClaim
both when SpaceClaim is opened via Workbench and when it is opened by itself.

Topic Reference
SpaceClaim Wizard Examples ACT Developers Guide > Examples > Wizard Examples >
SpaceClaim Wizard
Online HTML reference providing Customer Portal > Downloads > ANSYS ACT Application Store
both API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference Download Reference Guide
documentation.
Reference document providing API ACT API Reference Guide
namespace information.

Reference document providing XML ACT XML Reference Guide


definition and tagging information.
Reference document providing AIM and Workbench Scripting Guide
journaling and scripting information, Refer to the SpaceClaim section.

25
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
including product-specific data
container details.

Process Compression in DesignModeler

The following table refers you to documentation on creating wizards to compress and
automate processes in the DesignModeler application.

Topic Reference
DesignModeler Wizard Examples ACT Developers Guide > Examples > Wizard Examples >
DesignModeler Wizard
Mixed Wizard
Online HTML reference providing Customer Portal > Downloads > ANSYS ACT Application Store
both API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference Download Reference Guide
documentation.
Reference document providing API ACT API Reference Guide
namespace information.

Reference document providing XML ACT XML Reference Guide


definition and tagging information.
Reference document providing AIM and Workbench Scripting Guide
journaling and scripting Refer to the DesignModeler section.
information, including product-
specific data container details.

Process Compression in Mechanical

The following table refers you to documentation on creating wizards to compress and
automate processes in the Mechanical application.

Topic Reference
Mechanical Wizard Examples ACT Developers Guide > Examples > Wizard Examples >
Mechanical Wizard
Mixed Wizard

26
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Online HTML reference providing Customer Portal > Downloads > ANSYS ACT Application Store
both API and XML information. 17 > Help & Support >
**Recommended version of Online Reference Guide
developers reference Download Reference Guide
documentation.
Reference document providing API ACT API Reference Guide
namespace information.

Reference document providing XML ACT XML Reference Guide


definition and tagging information.
Reference document providing AIM and Workbench Scripting Guide
journaling and scripting Refer to the Mechanical section.
information, including product-
specific data container details.

Process Compression in Electronics Desktop

The following table refers you to documentation on creating wizards to compress and
automate processes in the Electronics Desktop application. Wizards can be run in
Electronics Desktop both when Electronics Desktop is opened via Workbench and when
it is opened by itself.

Topic Reference
Accessing the ACT Start Page in Electronics ACT Developers Guide > Using Extensions > Using the
Desktop ACT Start Page > Accessing the ACT Start Page
Electronics Desktop Wizard Examples ACT Developers Guide > Examples > Wizard
Examples > Electronics Desktop Wizard
Online HTML reference providing both API Customer Portal > Downloads > ANSYS ACT
and XML information. Application Store 17 > Help & Support >
**Recommended version of developers Online Reference Guide
reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide
namespace information.

Reference document providing XML definition ACT XML Reference Guide


and tagging information.
Reference document providing journaling and AIM and Workbench Scripting Guide
scripting information, including product- Refer to the Electronics Desktop section.
specific data container details.

27
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Process Compression in DesignXplorer

The following table refers you to documentation on creating wizards to compress and
automate processes in the DesignXplorer application.

Topic Reference
Online HTML reference providing both API Customer Portal > Downloads > ANSYS ACT
and XML information. Application Store 17 > Help & Support >
**Recommended version of developers Online Reference Guide
reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide
namespace information.
Reference document providing XML definition ACT XML Reference Guide
and tagging information.
Reference document providing journaling and AIM and Workbench Scripting Guide
scripting information, including product- Refer to the DesignXplorer section.
specific data container details.

Process Compression in Fluent and Fluent Meshing

The following table refers you to documentation on creating wizards to compress and
automate processes in the Fluent and Fluent Meshing applications.

Wizards can be run in Fluent and Fluent Meshing either when they are opened via
Workbench or when opened by themselves.

Topic Reference
Fluent Wizard Examples Customer Portal > Downloads > ANSYS ACT Application
**Two Fluent wizard examples are Store 17 > ACT Wizard Templates
included in the zipped ACT Wizard
Templates package.
Online HTML reference providing both API Customer Portal > Downloads > ANSYS ACT Application
and XML information. Store 17 > Help & Support >
**Recommended version of developers Online Reference Guide
reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide
namespace information.
Reference document providing XML ACT XML Reference Guide
definition and tagging information.

28
Using ACT to Customize ANSYS Products and Simulation Workflows:
A Users Guide to Creating Business-Specific Apps (17.2 Release)

Topic Reference
Reference document providing journaling ANSYS AIM and Workbench Scripting Guide
and scripting information, including Refer to the Fluent/Fluent Meshing section.
product-specific data container details.

Process Compression for Multiple Applications (Mixed Wizard)

The following table refers you to documentation on creating mixed wizards, which are
executed across multiple target applications. A mixed wizard begins with the
Workbench Project Schematic and engages any data-integrated application with
Workbench journaling and scripting capabilities, such as DesignModeler or Mechanical.

Topic Reference
Mixed Wizard Example ACT Developers Guide > Examples > Wizard Examples
> Mixed Wizard
Online HTML reference providing both API Customer Portal > Downloads > ANSYS ACT Application
and XML information. Store 17 > Help & Support >
**Recommended version of developers Online Reference Guide
reference documentation. Download Reference Guide
Reference document providing API ACT API Reference Guide
namespace information.
Reference document providing XML ACT XML Reference Guide
definition and tagging information.
Reference document providing journaling AIM and Workbench Scripting Guide
and scripting information, including Refer to the sections for the applications included in the
product-specific data container details. wizard.

29

You might also like