Initializing help system before first use

# xpressinsight.AppInterface.user_id

Purpose
Property for the user ID of the Insight user that initiated the current scenario execution.
Synopsis
`xpressinsight.AppInterface.user_id: str`
Return value
The identifier for an user.
Example
Demonstration of setting the user ID (test mode only).

    >>> insight.user_id = 'userid123456789'

Demonstration of getting the user ID then outputting it.

    >>> print('user_id = ', insight.user_id)
    user_id = userid123456789

Further information
1. The property user_id is part of the class xpressinsight.AppInterface.
2. The user_id property can only be set in test mode.
3. When called while the model is not running within Insight, this returns f3c92ab3-6996-4b4b-87c9-f5a146019c51.
4. Used to mock the user ID of the user who requested the scenario execution, when testing code outside an Insight scenario.
5. Modifying this property when insight.test_mode is False will cause the model to abort with a runtime error.
Parent Topic App Interface Classes

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.