Overview
When running any of Lumerical products for the first time you will be prompt with the Ansys Product Improvement Program consent dialogue. You must accept or decline the data collection before using any of Lumerical products.
Note: If a global configuration file (see below) is used, this dialogue will not be displayed when the product is first launched.
Installer new files
Below are the files and folders that have been added into Lumerical installation
- Windows:
"C:\Program Files\Lumerical\[[verpath]]\commonfiles\APIP\bin\winx64\"
- Linux:
/opt/lumerical/[[verpath]]/commonfiles/APIP/bin/linx64
Key files
Global configuration file
A global configuration file can be used to turn on or off APIP for a given installation of Lumerical. This setting overrides settings made in the local configuration file or the user interface.
By default, the directory and file are not created with the installation, therefore, to enable global APIP configurations, you may need to create the directory and file manually.
On Linux, the global APIP configuration file is in the following path,
/opt/lumerical/[[verpath]]/commonfiles/globalsettings/ANSYSProductImprovementProgram.txt
On Windows, the global APIP configuration file is in the following path,
C:\Program Files\Lumerical\v251\commonfiles\globalsettings\ANSYSProductImprovementProgram.txt
To turn on or off APIP using the global configuration file, the following lines should be placed inside the file. The commands are the same for both Linux and Windows.
To turn off APIP:
ANSYSProductImprovementProgram=off
To turn on APIP:
ANSYSProductImprovementProgram=on
Local configuration files
Depending on the Operating System in use the relevant files will be in different folders although the basic structure does not change.
- apip-data – temporary storage for the data collected that will be sent to Ansys servers.
- apip_standalone_service.txt – it is a log file generated by the APIP service.
- ApipUserConfig.txt – stores the user’s answer for the APIP consent dialogue.
On Linux, above files and folders are placed under,
<HOMEDIR>./ansys/[[verpath]]
On Windows, these are found in,
<HOME_DIR>\AppData\Roaming\Ansys\[[verpath]]
Debugging
Setting an environment variable as APIP_DEBUG_ON=1 or APIP_DEBUG_ON=true turns on the internal debugging capability which creates a “dump” folder in the above mentioned structure to keep all sent messages. Those can be inspected at any time.
Changing settings
In case you want to allow or decline the data collection, the APIP consent dialogue is available from the user interface.
For FDTD and Multiphysics, this option can be found under the “File” tab under the “Status” group.
For MODE, INTERCONNECT, and CML-Compiler, it is available from the “Help” menu.
This consent dialogue will detect the current user configuration file settings, and you can change whether you consent to APIP here.
Note: This dialogue cannot be used to change configurations set by the global configurations file, and is not reflective of the global settings, which overrides user level settings.