A target product wizard for AIM is implemented as a custom template, guided
simulation, or guided setup. When creating a target product wizard for AIM, you set the
attribute context to Study. You then set
the attributes persistent and subcontext
to indicate the extension type. These attributes control where AIM displays the
extension. The AIM product documentation refers to the following extension types as
apps.
| Extension Type | Persistent Attribute | Subcontext Attribute |
|---|---|---|
| Custom template | Unspecified | Unspecified |
| Guided simulation | Specified | Unspecified |
| Guided setup | Unspecified | Specified |
The custom templates and guided simulations that you have installed and loaded in AIM are available on the start page and when adding a new simulation on the Study panel. They are listed after ANSYS-supplied templates. On the start page, a guided simulation has the following icon on the bottom left of the tile to differentiate it from a custom template:
Guided setups that are installed and loaded appear in the Guide Me context (right-click) menu when a compatible object and geometry entity are selected. The Guide Me menu is present only if the object and geometry selection to which you’ve navigated matches the object or task and geometry selection defined in the extension.
A custom template automates the definition of a simulation process, prompting you
for needed inputs. In the XML definition file of an ACT extension for AIM, both the
attributes persistent and subcontext on
the <wizard> block are unspecified by default. In this
case, the extension is a custom template. Custom templates continue to function in
AIM in the same way as they have always have functioned. All custom templates that
are installed and loaded in AIM are available on the start page and when adding a new
simulation on the Study panel.
ANSYS supplies two examples of AIM custom templates that you can install and load if desired. For more information, see:
A guided simulation displays your own end-to-end custom workflow in a persisted
view, remaining open until you close it. In the XML definition file of an ACT
extension for AIM, you set the attribute persistent on the
<wizard> block to true to
create a guided simulation. All guided simulations that have been installed and
loaded in AIM are available on the start page and when adding a new simulation on the
Study panel. ANSYS does not supply any examples of guided
simulations.
When you launch a guided simulation, the view panel immediately displays a Guided Simulation tab with all steps in the workflow. You do not have to complete the steps in a guided simulation sequentially.

Clicking any step on the Guided Simulation tab makes the step active in the data panel. Using this tab, you can navigate to the various steps, supplying appropriate data and updating as necessary.

You can view the state of the active step in the data panel. You can view the states of all steps on the Guided Simulation tab. If a step is disabled during execution, it is removed from this tab.
In the data panel, the visual indications that can be shown for the state of a step are a subset of those shown for AIM tasks. A step can be in any of three states:

The Attention required state is tied to the current callback
<isValid> to determine if the data supplied for the
step is valid. A step in this state has one or more fields that require your
attention before the step can be updated. The step cannot be updated if any previous
step requires attention.

The Up-to-date state indicates that the callback
<onUpdate> for the step has been executed and that no
change was made to this step or any previous step.

The Out-of-date state indicates that the step has been modified after an update and an update is once again required. An up-to-date step becomes out-of-date if the data for a previous step is changed.
When an out-of-date step is active in the data panel, you click either the update
icon
or the
button to execute the callback
<onUpdate> for the step. The
button is blue when the step requires an update. In
a guided simulation, the update of a step invokes the callback
<onUpdate> for all previous steps that need to be
updated.
Unlike a simulation template, a guided simulation is not dismissed when the last step is executed. Unless you close a guided simulation, you can go back to any step and make changes and update multiple times.
In principle, users of a guided simulation leave it running because they do not need to interact directly with AIM. However, a user can close a simulation by clicking the button available on any step in the data panel.
Currently, only one guided simulation or simulation template can be open at a time. If you attempt to launch another, a dialog box opens, indicating the name of the one that is already running. You can choose to either close the running instance or let it remain running.
If you choose to close a guided simulation and then launch it again later, the last created data is restored.
A summary follows of the key distinctions between guided simulations and simulation templates.
Data supplied in a guided simulation is persisted, which is not the case for a simulation template. Each time you launch a simulation template, a new instance is opened, which means that no previously created data is restored. Each time you launch a guided simulation, the same instance is opened, even after closing and then resuming a project. This means that the data that you last created is always restored.
A guided simulation uses the and buttons in the data panel only for navigation through the steps. These buttons are not tied to the execution of callbacks as they are in a simulation template. Because the steps in a guided simulation do not have to be completed sequentially, you can navigate to any step, regardless of its state.
Each step in a guided simulation has and buttons.
If you click , a dialog box opens, asking you to confirm that you want to close the guided simulation. Because steps in a guided simulation do not have to be completed sequentially, the last step does not have a button.
When you click the update icon
or
the blue button for an out-of-date
step in the data panel, the callback
<onUpdate> for the step is invoked.
When the update of a step is invoked, the callback
<onUpdate> for any previous step that is
out-of-date is executed before the update of the current step. If
any previous step requires attention, the
button is not shown.
On the Guided Simulation tab in the view panel, each
step has a context menu with a command for executing the callback
<onUpdate>. If the callback
<IsReset> is implemented for the step, the
context menu also includes a command for resetting the step. However, the
reset of a step does not invoke the callback
<IsReset> for previous steps.
When you start working on a guided simulation, the Workflow tab in the view panel disappears.
In the XML definition file of an ACT extension for AIM, the attribute
subcontext on the <wizard>
block specifies if it is a guided setup. Installed and loaded guided setups appear in
the Guide Me context (right-click) menu when a compatible object
and geometry entity are selected. Various examples follow of what you can enter in
the <wizard> block of a guided setup named
Test1. For the attribute subcontext,
you specify a task, task group, or object.
<wizard name="Test1" caption = "Test1" version="1" context="Study" subcontext = "Physics Solution/Face" icon="Terminal" persistent="False">
When AIM is displaying a task group of type Physics
Solution, the template is shown in the Guide Me
context menu for the selected face.
<wizard name="Test1" caption = "Test1" version="1" context="Study" subcontext = "Support/Face" icon="Terminal" persistent="False">
When AIM is displaying an object of type Support, the
template is shown in the Guide Me context menu for the selected
face.
<wizard name="Test1" caption = "Test1" version="1" context="Study" subcontext = "Face" icon="Terminal" persistent="False">
Regardless of the type of task, task group, or object that AIM is displaying, the template is shown in the Guide Me context menu for the selected face.
<wizard name="Test1" caption = "Test1" version="1" context="Study" subcontext = "Meshing" icon="Terminal" persistent="False">
The template is shown in the Guide Me content menu for the selected meshing task.
As you can see by the first two code examples, a forward slash (/) in the
attribute subcontext identifies a task, task group, or object
before the slash and a selection type after the slash. Object types include
Vertex, Edge,
Face, and Body.
The second and third code examples demonstrate how you can enter a string for matching only a particular type of task, task group, or task.
Tip: Placing the mouse cursor in the upper left corner of the AIM data panel
displays a tooltip that indicates the internal name of the task, task group, or
object. The following figure shows the task group with the internal name of
.Physics Solution
