am_rule_test_harness

The am_rule_test_harness utility uses an input file that contains test information and outputs the test results embedded inside of the Administration Data Documentation report. While this utility is running, it searches for specified objects and evaluates whether the operations are granted or denied for a given user, group, role, and optionally project combination. The Administration Data Documentation report also contains the Access Manager rules, Organization, and other administration data types, as each of these types can have an impact on these rules or these rules can impact access to the administration data of these types. To view the outcome of this utility: Open the output-directory/AdminDataReport/index.html in a browser. Click Access Manager. Click Test Results. The generated output report specifies the conditions that passed and failed. If this report indicates corrections need to be made, correct the data in the input file and rerun the tests using the updated input file. Note When the Access Manager rule tree contains the Current Group Is condition, the am_rule_test_harness utility uses the group from the current logged-on user and not the group specified in the input XML file. Syntax am_rule_test_harness -u=Tc-admin-user {-p=password | -pf=password-file} [-g=group] -inputFile=path-name-to-input-file -outputDir=path-name-to-output-file -adminDataTypes -listTypes [-h] Arguments -u Specifies the user ID. This must be 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 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. -inputFile Specifies the full path to the Access Manager test harness input XML file. Locate sample input files for Access Manager (am_rule_test_harness_sample_input.xml) in TC_ROOT\bin. Note To include children of Form, you must use the Form class for the search criteria. -outputDir Specifies the full path to where the Access Manager test harness output file is generated. The utility also copies all data used for the report into this directory to ensure you have a copy of all related data: Report input file Report output file Exported administrative data from the environment Administration Data Documentation report Utility log file -adminDataTypes Specifies a comma-separated list of administration data types to be exported. Following are the administration data types available for export: AccessManager Organization Preferences Projects RevisionRules SavedQueries Stylesheets Subscriptions WorkflowTemplates Use all as the value to export all administration data types. -listTypes Lists all supported administration data types that can be specified in the -adminDataTypes option. If specified, this option does not export any administration data or run any test harness test. -h Displays help for this utility. Examples The am_rule_test_harness utility requires an XML input file, which specifies the user, group, role combination, object, and privileges to be tested. You can also use the uid of an object in searchCriteria in order to perform rules testing, as shown in the second example input file. Copy am_rule_test_harness -u=johnadmin -p=passjohn -g=dba -inputFile=C:\inputDir\am_rule_test_harness_input.xml -outputDir=C:\output Following is a sample input XML file to test Access Manager rules. An input file can use the uid of an object in the searchCriteria argument for rules testing. The input format for uid in searchCriteria is: Copy searchCriteria="uid=uid1,uid=uid2" The following input file checks the read and write privilege of the object whose uid is Btd9zn1s58c_TA. Following is a list of access privileges: ADD CONTENT ADMINISTER ADA LICENSES ASSIGN TO PROJECT BATCH PRINT CHANGE CHANGE OWNER CICO (also known as check-in/check-out) COPY CREATE DELETE DEMOTE DIGITALLY SIGN EFFECTIVITY EXPORT IMPORT IP ADMIN IP CLASSIFIER ITAR ADMIN ITAR CLASSIFIER MANAGE VARIABILITY PDF CONTROL PROMOTE PUBLISH READ REMOTE CHECKOUT REMOVE CONTENT REMOVE FROM PROJECT SUBSCRIBE TRANSFER IN TRANSFER OUT TRANSLATION UNMANAGE VOID DIGITAL SIGNATURE VIEW MARKUP WRITE WRITE CLASSIFICATION ICO Related Topics Data Access Management