TeamcenterKnowledge

Workflow utilities

cleanup_userinbox

Consolidates two or more My Worklist inboxes of a user into a single inbox, preserving the resource pool subscriptions and surrogate lists of each. If two inboxes have the same surrogate, it is indeterminate which effective start and end dates are kept. Note Under normal circumstances, a Teamcenter user should not have more than a single unique My Worklist inbox. Syntax cleanup_userinbox [-u=user-id {-p=password | -pf=password-file} -g=group-name] [-report=file-name] [-dryrun] [-debug] [-v] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. If this argument is used without a value, the operating system user name is used. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the user's password. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -report Specifies the output file for the report. If this argument is not specified, it is written to the standard output. -dryrun Generates a report of the changes to be made but does not update the database. Actions that would be performed are displayed. -debug Displays extra diagnostic information. This argument also forces the use of the -v argument. -v Verbose mode. Provides information about the My Worklist inboxes processed. This argument is recommended. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples To generate a report about which changes would be made without actually updating the database: Copy cleanup_userinbox -v -dryrun To consolidate the tcadmin user’s inboxes and display the report in the standard output: Copy cleanup_userinbox -u=tcadmin -p=password To consolidate the tcadmin user’s inboxes and display the report in the rpt_file file: Copy cleanup_userinbox -u=tcadmin -pf=pswd_file -report=rpt_file Related Topics Workflow Designer on Rich Client

Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/utilities_reference/dwz1737253694634/xid615231.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)