am_re_diagnostics

Validates the accuracy of read expressions (REs) stored in the database and compares RE-based verdicts with AM rule tree-based verdicts for all relevant user, group, and role combinations. In case of a discrepancy, this tool reports the associated error. Syntax am_re_diagnostics [-u=user-ID {-p=password | -pf=password-file} -g=group] [-diagnostics_pwd=password] [-update_pwd=new_password] [-restore_all_pwd] [-filePath=filename] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. 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 password. This argument is mutually exclusive with the -pf argument. -pf Specifies the full path and filename of the password file. 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. -diagnostics_pwd Specifies the password parameter in conjunction with either the list of input users given in the -filePath argument, or all users if the file path argument is not specified. Full diagnostics against this list of users is run and all associated groups and roes are used as session input parameters when testing the existing valid REs in the system. The report is displayed on the console, but it can also be redirected to a file. This file contains the following information in tabular form: User, group, role under investigation. Total number of relevant REs found. Newly found REs to be validated against the rule tree. Issues found. If issues are found, the ITK error code is displayed, and further information can be gained from the syslog. If no issues are found, a hyphen (-) is displayed. Note The following important assumptions are made when running this utility: Run the am_read_expression_manager utility in onetime mode as follows to ensure all REs are valid: Copy am_read_expression_manager -u=user -p=pwd -mode=onetime The RDBMS should be in a test environment where user passwords can be changed; the tool expects all users in the list to have the same input password. Use the command line feature to reset the associated user passwords to a common value (see the -update_pwd argument). This is a prerequisite for this diagnostics execution. Do not run other process in the RDBMS while this diagnostics test is being executed. Otherwise, the system does not generate or alter existing REs while they are validated by this tool. If you execute multiple processes in parallel, partition a large user ID input file into several smaller files with non-overlapping user IDs. Do not use this in conjunction with the -update_pwd argument, as these two parameters are mutually exclusive. -update_pwd Uses the password parameter in conjunction with either the list of input users given in the -filePath argument, or all users if the file path argument is not specified. This argument updates the password to the password specified in the cmd-line option for all such users. As part of this operation, a backup is created with the encrypted values of all passwords about to be changed, so that these original values can be restored once diagnostics execution is complete. This is required to be able to run the tool in diagnostics mode. -restore_all_pwd Restores the state of the database for all users whose password changed as a result of execution of the -update_pwd argument described earlier. The backup table created using the -update_pwd argument is utilized for this purpose. -filePath=pathname Uses an input file containing user IDs of users that needs to be processed. This is applicable to both modes of password change and diagnostics. -h Displays help for the utility. Examples To use the userid input file to change passwords to Passw0rd for all users listed in the input file: Copy am_re_diagnostics -u=user-ID -p=password -g=group -update_pwd=Passw0rd -filePath=path To change passwords to Passw0rd for all users: Copy am_re_diagnostics -u=user-ID -p=password -g=group -update_pwd=Passw0rd To restore original passwords for all users affected by the prior -update_pwd command: Copy am_re_diagnostics -u=user-ID -p=password -g=group -restore_all_pwd To run RE diagnostics for all users in the input file: Copy am_re_diagnostics -u=user-ID -p=password -g=group -diagnostics_pwd=Passw0rd -filePath=path To run RE diagnostics for all users in the input file: Copy am_re_diagnostics -u=user-ID -p=password -g=group -diagnostics_pwd=Passw0rd -filePath=path Related Topics Data Access Management