manage_effectivity_options

Allows you to manage 4GD effectivity options from a command line. Syntax manage_effectivity_options [-u=user-id {-p=password | -pf=password-file} -g=group] {-contextItemId=ItemID | -contextItemKey=Key -contextRevisionId=revisionID -effOpt=option-name-string [-effValues=valid-values] -owningItemId=ItemID | -owningItemKey=Key} | -file=xml input file [-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. -contextItemId Specifies the item ID to which to attach a new option. This is typically the item ID of the product for which the effectivity option should be added or modified. The effectivity option may be an effectivity stream group such as Engineering Intent or Model Year. -contextItemKey Specifies keys and values to pass if the item ID and revision ID are insufficient to uniquely identify the context item revision. You can specify contextItemId or contextItemKey, not both. -contextRevisionId Specifies the item revision for which a new effectivity option should be attached or modified. The item revision represents the product namespace in which the option will be available. -effOpt Identifies the effectivity option to create or modify. This option usually represents an effectivity stream grouping such as Engineering Intent or Model Year. -effValues Specifies a comma-separated list of valid values for the effectivity option. This is an absolute list and all valid values must be passed. Teamcenter treats the absence of valid values when you update existing effectivity options as a request to remove those values from the context revision. Valid values must be given in the context of the context item revision. You can attach the modified item revision to multiple models for which effectivity streams with these valid values are needed. -owningItemId Specifies the item that defines the effectivity option to modify. If specified, the effectivity option defined on the owning item is reused on the product item. It is restricted to the set of specified values if -effValues is populated with a list of valid values. -owningItemKey Specifies keys and values to pass if the owning item ID is insufficient to uniquely identify the owning item. You can specify owningItemId or owningItemKey, not both. -file Facilitates bulk support of this utility and specifies the name of the XML file that contains all required information. In presence of this argument, all other required arguments, such as contextItemId | contextItemKey, contextRevisionId, owningItemId | owningItemKey, effOpt, effValues, are ignored because they are considered mutually exclusive. Note The full file path is required with the file name. If not specified, the current directory is used. -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 This example declares effectivity options in a dictionary. Copy manage_effectivity_options -u=Tc_admin -p=password -contextItemId= DictID -contextRevisionId=A -effOpt=OptName -effValues=Val1,Val2,Val3 -owningItemId=DictID This example allocates subset of effectivity options for a configurator context. Copy manage_effectivity_options -u=Tc_admin -p=password -contextItemId=ContextID -contextRevisionId=A -effOpt=OptName -effValues= Val1,Val2 -owningItemId= DictID This example performs bulk update (declaration/allocation). Copy manage_effectivity_options -u=Tc_admin -p=password -file=\ManageEffectivityOptions.xml