am_install_tree

Installs an Access Manager (AM) rule tree at your site. Teamcenter supplies a default rule tree that provides a starting point for creating rules at your site. If you do not specify the -operation option, it imports a rule tree. In that case, the -mode option is required. Syntax am_install_tree -u=user-id {-p=password | -pf=password-file} [-g=group] [-operation={import | export } ] -path=file-name [-mode={replace_all | replace_tree | no_replace}] -format={xml | txt} [-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 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. -operation Specifies whether to import or export the rule tree file. If you do not specify the -operation option, am_install_tree assumes the default of importing a rule tree. In that case, the -mode option is required. =import Default mode. Imports a rule tree. =export Exports a rule tree. If you specify -operation=export, the -mode option is not required. -path Specifies the full path of the rule tree file. -mode Specifies one of the following installation modes: =replace_all Overwrites both the existing rule tree and any named access control lists (ACLs) in the system. If an ACL exists in the file and does not exist in the rule tree, the ACL gets created. If the ACL exists in the rule tree and does not exist in the file, then nothing happens to the ACL. This mode does not delete any ACLs. =replace_tree Updates the rule tree only. It does not overwrite existing named ACLs. =no_replace Default mode. Used only when installing the first rule tree at your site. Does nothing if an existing rule tree is detected. -format Specifies one of the following file formats: =xml XML file format. =txt Text file format. -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. Return Values Return value upon success 0 Return value upon failure 1 Examples Following are examples of the use of the am_install_tree utility: The following example exports the rule tree export_rule.txt: Copy am_install_tree -u=Tc_admin -p=password -g=admin -operation=export -path=D:\export_rule.txt -format=txt The following example restores the rule tree to the default: Copy am_install_tree -u=Tc_admin -p=password -g=group -path=TC_DATA\tc_am_rule_tree.default -mode=replace_all -format=txt Related Topics Data Access Management