Environment Variables for Server Diagnostics

This topic describes the environment variables that can be used for performing diagnostics on the 3DSpace Service.

See Also
Configuring Server Diagnostics
Studio Customization Toolkit Origin Trace Facility
ENOVIA Live Collaboration Memory Management
Environment Variable Description
MX_DS_TRACE May be set to a filename that logs most of the interaction between 3DSpace and the DesignSync server. Errors related to checkin or checkout are not logged. The file specified is located in MX_TRACE_FILE_PATH.

It is recommended to use this setting only while troubleshooting DesignSync File Access problems and then to disable it again when problems are solved.

MX_INDEX_TRACE May be set to a filename to detect queries/expands that can benefit by using an index. When enabled, a message is logged whenever a query/expand is executed in which none of the items in the where clause are included in any index. The file specified is located in MX_TRACE_FILE_PATH.

When this trace type is enabled, trace messages will be displayed in the format:

No index found for field1,field2,field3?

A developer can conclude that adding at least some of the listed fields to a new or existing index (and enabling it) may improve system performance.

MX_JPO_TRACE May be set to a filename that logs the compilation and classloader messages of JPOs. The file specified is located in MX_TRACE_FILE_PATH.
MX_LDAP_TRACE May be set to a filename that logs the interaction of 3DSpace with the LDAP server. The specified file is located in MX_TRACE_FILE_PATH.

This variable should be disabled before performing any hot fix installation. Otherwise, the hot fix installation will crash. You can disable this variable by removing the following lines from the mxEnv.sh file on UNIX/Linux (or the analogous lines in the enovia.ini file on Windows):

MX_LDAP_TRACE=TRUE
export MX_LDAP_TRACE
MX_LOG_SWITCH May be set to a size limit or a time interval to aid in the management of log files.

The 3DSpace Service automatically tracks warnings and error messages encountered by the system during normal operations, and stores these messages in log files on the server. You can enable additional logging and trace capabilities to help debug and analyze critical end-user symptoms. However, large trace files can make debugging more difficult and could result in loss of data if the log files exceed operating system limits.

This setting allows you to configure automatic switching to a new log file based on a size limit or time interval, such as daily or weekly. The log switching option ensures that there is no loss of data if log files exceed operating system size limits.

Available options are DAILY, WEEKLY, or NNNN (size of file). If you set a size of less than 100m, 100m will be used. You can set the value in bytes (number only) or in megabytes or gigabytes (such as MX_LOG_SWITCH=100m or MX_LOG_SWITCH=1g).

MX_MQL_TRACE May be set to a filename for use with timing tests and debugging of program objects and wizards. Output is generated that shows start and end of all programs executed (Tcl or Java), all MQL commands processed within a Tcl program, or calls made through the Studio Customization Toolkit MQLCommand interface. The file specified is located in MX_TRACE_FILE_PATH.
MX_SMTP_TRACE May be set to a filename that logs the interaction of 3DSpace with the SMTP server. The file specified is located in MX_TRACE_FILE_PATH.
MX_SQL_TRACE May be set to a filename to trace all SQL commands generated by 3DSpace for database access. The file is located in MX_TRACE_FILE_PATH.
MX_TRACE_FILE_PATH The directory name for all trace files. Must be set in platform-specific format. If this variable is not set, the default location is ENOVIAHOME (UNIX) or ENOVIA_INSTALL (Windows).
MX_TRIGGER_TRACE May be set to a filename for the 3DSpace event log. The log contains information for each trigger that is fired during that session. The file specified is located in MX_TRACE_FILE_PATH.
MX_VERBOSE_TRACE May be set to a filename to contain tracing for all client/server calls. The file specified is located in MX_TRACE_FILE_PATH.

If the Studio Customization Toolkit Origin Trace Facility is configured on an 3DSpace Service, verbose output includes information about the parameters being passed.

MX_WORKFLOW_TRACE May be set to a filename that traces the logic executed to process workflow events. It is useful for debugging workflow behavior. The file specified is located in MX_TRACE_FILE_PATH.