validate_revrule_effectivity

Validates the effectivity criteria on one or more specified revision rules, generates validation records, and associates them with the revision rules. Optionally, you can create a text file containing the names of revision rules to validate. Validation may take a significant time, depending on the number of constraints and default rules defined in the system. If you have a large number of constraints and rules, consider running the utility during off-peak hours. Syntax validate_revrule_effectivity [-u=user-id {-p=password | -pf=password-file} -g=group] {-rule_name=rule-name1 [-rule_name=rule-name2] | -rev_rule_names_file=file-name} [-apply_constraints= 0 | 1+] [-apply default= 0 | 1+] {-model_id=model-id | [-product_name=product-name -product_namespace=product-namespace]} [-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 user and password 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. -rule_name Specifies the name of the revision rule to validate. If you want to validate more than one revision rule, use this argument once for each revision rule. This argument is optional if you use the -rev_rules_file_name argument, but takes precedence if both arguments are entered. -rev_rules_file_name Specifies the name and full path of a text file containing the names of revision rules to validate. The file must contain the name of one revision rule on each line. This argument is optional if you use the -rule_name argument. -apply_constraints Specifies whether the system applies constraints. 0 The system does not apply constraints. 1 The system applies constraints. -apply_defaults Specifies whether the system applies defaults. 0 The system does not apply defaults. 1 The system applies defaults. -model_id This is an optional argument and is specified only if you connect to an external configurator. Specifies the identifier of the 4GD model object in the context of which the revision rules should be validated. CPD model objects define the appropriate external configurator using the EffectivityInModel object. -product_name Specifies the name of the product, for example, the item ID. Teamcenter uses this value in conjunction with the -product_namespace argument to resolve any ambiguities in effectivity option value names. If you do not specify a value, Teamcenter deduces the product name from the EffectivityInModel object associated with the model. -product_namespace Specifies the namespace of the product in which the product name has unique semantics, for example, the item revision ID, model year, and product type. Teamcenter uses this value in conjunction with the -product_name argument to resolve any ambiguities in effectivity option value names. If you do not specify a value, Teamcenter deduces the product namespace from the EffectivityInModel object associated with the model. -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 Consider the following two products that are configured with effectivity: Product Default Rule checks P1 WHILE Unit > 5 DEFAULT Date >= 2012-01-01 WHILE Unit <= 5 RAISE ERROR “message” IF Date < 2012-01-01 P2 RAISE ERROR “message” Unit > 5 If you validate a specified revision rule with an effectivity criteria of Unit=7, you obtain the following results: Revision rule effectivity criteria Product Result Violations Applied default Unit=7 P1 Unit=7, Date=2012-01-01.. None Date >= 2012-01-01 P2 Unit=7 Unit > 5: “message” None These validation results are persisted in records that are attached to the revision rule. If a client queries the revision rule effectivity criteria in the context of product P1 or P2, the server response includes the corresponding validation records. This allows sites to run this utility to perform potentially CPU intensive criteria validation once for each revision rule during off-peak hours, while permitting the system to deliver an acceptable validation service to hundreds of users during working hours. There are two limitations to this practice: In this version of Teamcenter, you cannot create, view, or change defaults and rule check constraints in the user interface. You can create them only with ITK APIs. In this version of Teamcenter, you cannot review validation results in the user interface when asking the server for revision rule effectivity criteria. You can view results only with the validate_revrule_effectivity utility. Also, when you validate the effectivity criteria of a revision rule, the criteria are sent to a configurator service for validation. These criteria may be sent to external or remote configurator services in a future version of Teamcenter (this capability is not supported in the current version). In this case, the construction of the validation records is subject to any limitations of the external or remote configurator service. Examples This example validates a revision rule called My Latest Released in the context of a model whose ID is ship123. It does not apply constraints or default rules. It creates a validation record and associates it with the revision rule. Copy validate_revrule_effectivity -u=Tc-admin-user -p=password -g=group -rule_name=My Latest Released -model_id=ship123 This example validates revision rules called My Latest Working and My Latest Released which are listed in the file C:\xyz\revrule.txt in the context of a model whose ID is Malibu_V6_2010. It applies defaults and constraints. It creates validation records for each revision rule and associates them with the relevant revision rules. Copy validate_revrule_effectivity -u=Tc-admin-user -p=password -g=group -rev_rules_file_name=C:\xyz\revrule.txt -apply_constraints=1 -apply_defaults=1 -model_id=Malibu_V6_2010