Best practices#

This section provides examples of best practices to use when building your solution.

Essential rules for writing correct SAF modules.

General rules

Implement the business logic in your solution.

Business logic

Stateless design, file naming, and field defaults.

Backend conventions

When to merge or split steps in your workflow.

Step decomposition

Design the dependency graph between fields and steps.

DAG design

Define typed step fields and supported data types.

Data model rules

Transaction types, cross-step reads, progress streaming, and decorator order.

Transaction methods

Manage solution files and avoid common file handling errors.

File management

Follow recommended patterns for reliable and maintainable file management with BDM.

BDM best practices

Manage Ansys product instance lifecycles correctly.

Product instance management

Properly access environment variables in your solution.

Environment variables

Dash callbacks, project injection, and UI component choices.

Frontend

Learn to define, access, and modify dictionary step fields.

Dictionaries

Learn how to use Ansys products within your solution.

Ansys products