Instance management#
Enterprise Feature
Available to Ansys customers and Channel Partners
This feature is available to Ansys customers and Channel Partners. Contact the PyAnsys team to request access.
SAF GLOW Engine provides the ability to run, access, and manage Ansys products. Because SAF GLOW Engine is built upon the promise that a solution can be deployed in various kind of environment (Desktop, On-premises, Cloud, and so on), you need to take special care when using those products.
You need to understand that your solution may be running on its own, in a container that does not have any product installed.
The products may be installed on complete different machines and the files generated by those products will not be directly available to the solution.
Therefore, any code interacting with a given product will fail in such environment, even though “it works on my desktop machine!”
To deal with these issues, SAF GLOW Engine provides special functionalities to hide this complexity through what is called “product instance management” and “product instance.”
Using a product instance manager also gives you the ability to share a product instance between multiple transaction method invocations.
Prerequisites for using the product instance manager (PIM) functionality#
To use the product instance manager (PIM) functionality in SAF, you need to have:
A SAF solution created and installed using the SAF CLI
newandinstallcommandsA token string that enables access to the PIM light server package.
Install the product instance manager (PIM) server#
To be able to launch and manage products in your desktop solution, you need to have the PIM light server installed locally. The PIM light server can be installed using one of the following methods:
Having optiSLang >= 261 installed on the same machine as your solution. (The PIM light server will be automatically installed as part of the optiSLang installation.)
Add the PIM light server package as main dependency of your solution. To add the dependency you need to do the following in order:
Add the PIM Light Server package repository as a source for your solution#
Run the following command by replacing the placeholder <pim-package-repo-url> with the value communicated by the SAF SDK team.
saf execute <solution-name> "poetry source add --priority=supplemental solutions-private-pypi <pim-package-repo-url>"
Enable access to the new source for your solution#
Run the following command supplying the package repository password when prompted
saf install <solution-name> -f
Add the PIM Light Server package as a dependency for your solution#
Run the following command
saf execute <solution-name> "poetry add --source solutions-private-pypi ansys-saf-pim-light-server"
This may take a few minutes to complete.
Learn how to enable product instance management in your solution.
Learn how to use product instance management in your solution.
List of supported products and their product instance managers.
Supported gRPC transport modes between SAF GLOW Engine and the Product instance.
Learn how to modify the built-in product configurations and managers.
Learn how to create your own product instance manager.