Files and Directories used by optiSLang Web Service

After creating an administrator account, multiple files and directories are created.

Windows

File/Folder NameDescription
config.ini

Global configuration settings file.

By default, located in the installation directory. Location can be overridden using the DATA_BASE_PATH or CONFIG_FILE environment variables.

db

Folder containing all database-related files.

By default located in %APPDATA%\Ansys\optiSLang Web Service\<Version>. Location can be overridden using the APP_DATA_PATH environment variable or the [serialization] base_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

Note:  This folder replaces the users.xml and projects.xml files used in previous versions of optiSLang Web Service. All data will be migrated to the new database and the two files will be renamed after migration.

doc

Documentation directory.

Contains the REST API documentation and scheme files used for certain JSON files referenced by the application wizards.

Located in the installation directory and cannot be moved or overridden.

docroot

Static files directory served by the web server.

Contains the optiSLang Web Service front end and application wizards.

By default, located in the installation directory. Location can be overridden using the DATA_BASE_PATH environment variable or the [docroot] path configuration setting. The path must be set either absolute or relative to the config.ini file location.

lib

Application files directory.

Contains application executables and libraries.

Located in the installation directory and cannot be moved or overridden.

projects

Project working directory.

Contains time-stamped working directories for projects executed within the optiSLang Web Service. They contain the optiSLang project, result files, and so on.

By default located in %APPDATA%\Ansys\optiSLang Web Service\<Version>. Location can be overridden using the APP_DATA_PATH environment variable or the [projects] path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

scripting

Custom scripts directory.

Contains custom and customizable Python scripts used for different optiSLang Web Service functions.

By default located in %APPDATA%\Ansys\optiSLang Web Service\<Version>. Location can be overridden using the DATA_BASE_PATH environment variable or the [customization] scripting_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

user_project_manager.log

Log file of user messages, including:

  • General errors

  • General warnings

  • User registration

  • User de-registration

  • Project registration

  • Project de-registration

  • Project start errors

  • Project start warnings

By default located in %APPDATA%\Ansys\optiSLang Web Service\<Version>. Location can be overridden using APP_DATA_PATH environment variable or the [serialization] base_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

Linux

File/Folder NameDescription
config.ini

Global configuration settings file.

By default, located in the installation directory. Location can be overridden using the DATA_BASE_PATH or CONFIG_FILE environment variables.

db

Folder containing all database-related files.

By default located in <installation-dir>/web_service. Location can be overridden using the APP_DATA_PATH environment variable or the [serialization] base_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

Note:  This folder replaces the users.xml and projects.xml files used in previous versions of optiSLang Web Service. All data will be migrated to the new database and the two files will be renamed after migration.

doc

Documentation directory.

Contains the REST API documentation and scheme files used for certain JSON files referenced by the application wizards.

Located in the installation directory and cannot be moved or overridden.

docroot

Static files directory served by the web server.

Contains the optiSLang Web Service front end and application wizards.

By default, located in the installation directory. Location can be overridden using the DATA_BASE_PATH environment variable or the [docroot] path configuration setting. The path must be set either absolute or relative to the config.ini file location.

projects

Project working directory.

Contains time-stamped working directories for projects executed within the optiSLang Web Service. They contain the optiSLang project, result files, and so on.

By default located in <installation-dir>/web_service. Location can be overridden using the APP_DATA_PATH environment variable or the [projects] path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

scripting

Custom scripts directory.

Contains custom and customizable Python scripts used for different optiSLang Web Service functions.

By default located in <installation-dir>/web_service. Location can be overridden using the DATA_BASE_PATH environment variable or the [customization] scripting_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

user_project_manager.log

Log file of user messages, including:

  • General errors

  • General warnings

  • User registration

  • User de-registration

  • Project registration

  • Project de-registration

  • Project start errors

  • Project start warnings

By default located in <installation-dir>/web_service. Location can be overridden using APP_DATA_PATH environment variable or the [serialization] base_path configuration setting. The path can be set either absolute or relative to the DATA_BASE_PATH.

Environment Variables

The locations of most of the files and directories used by optiSLang Web Service can be overridden by the config.ini file settings and/or environment variables.

The environment variables you can use are:

  • DATA_BASE_PATH: Change the value to override the default search directory. The default value points to the installation directory.

  • APP_DATA_PATH: Change the value to override the default directory for user/project databases, project working directories, and project action databases. The default value on Windows systems is %APPDATA%\Ansys\optiSLang Web Service\<Version>. The default value on Linux systems is DATA_BASE_PATH.

  • CONFIG_FILE: Explicitly set the config.ini file path.