Accessing Task Group Template APIs

As of ANSYS 18.0, Workbench system task group templates are exposed at the user level through Automation API wrappers in the namespace Ansys.ACT.WorkBench.Automation.Workflows. The Project Data Model returns this wrapper type:

taskGroup = ExtAPI.DataModel.TaskGroups[0]
taskGroupTemplate = taskGroup.Template

The task group template wrapper does not store any local data. All data access and modification occur at member call time.

The following table lists the APIs that are available.

ClassMemberDescription

TaskGroupTemplate

Name

Gets the task group template name.

Category

Gets the toolbox category in which the template appears.

TaskGroupType

Gets the task group type to display in the UI in the header of the task group block.

TaskGroupTypeAbbreviation

Gets the task group type abbreviation, which is used to create the task group unique directory name and also serves as the task group object’s base name.

DisplayName

Gets the user-visible name for the type of task groups created from the template.

ToolboxGroup

Gets the toolbox group in which the task group template should be displayed.

ImageName

Gets the image associated with the task group template.

Physics

Gets the physics associated with the task group template.

AnalysisType

Gets the analysis type associated with the task group template.

TaskGroupHelpId

Gets the help ID associated with the task group template.

ToolTipHelpId

Gets the help ID associated with the tool tip for the task group.

IsParametric

Gets a value indicating whether the task group consumes parameters.

Solver

Gets the solver associated with the task group template.

TaskTemplates

Gets the task templates that make up the task group. Tasks are grouped into task groups. For the normal case with no groups, a single-element list is returned.

TaskNames

Gets the names of the tasks to create from the templates in TaskTemplates.

ExcludedTaskTemplates

Gets a list of task templates that are not permitted to be instantiated in the task group using such commands as InsertComponentBefore or InsertComponentAfter.

RequiredTaskTemplates

Gets a list of task templates that cannot be deleted from the task group.

Attributes

Gets the attributes to apply to the created task group.

PostCreationSteps

Gets the list of operations to perform after the task group is created.

Visible

Gets a value indicating whether the task group should appear in the toolbar.

IsBeta

Gets a value indicating whether the task group visibility is tied to the beta option.

IsDeletable

Gets a value indicating whether the task group can be deleted.

InternalObject

Gets the internal system template represented by the task group template.


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