restore

Accepts input objects of type Item and 4GD objects of type Mdl0ApplicationModel which were previously archived from the current site. This utility restores the objects to the current site along with their dependent objects with ownership privileges. Run this utility from the owning site. Restoring is a pull operation from the archive site to the owning site. (The companion archive operation is a push operation from the owning site to the archive site.) Syntax restore -u=user-ID {-p=password | -pf=password-file} -g=group -f={list | perform} [-item_id=itemid] [-rev=revision] [-uidfile=data_file] [-itemidsfile=data_file] [-key=key] [-itemKeyFile=data_file] [-include_bom] [-report_file=report_filepath] [-4gd_id] [-verbose] [-class=wso_class_name] [-classoffile=class_name] [-h] Arguments -u Specifies the user ID. The user must have administrative privileges. If this argument is used without a value, the operating system user name is used. 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 user password. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. 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. -f Specifies one of the following functions: list Performs a dry run and reports the objects that would be restored from the database. perform Performs a restore operation and reports the objects that are restored from the database. -item_id Specifies the Item ID of the item to process. -rev The revision of the item to process. -uidfile Specifies a data file containing comma-separated values (CSVs) or carriage return/line feed separated item UIDs of items to process. -itemidsfile Specifies a data file containing comma-separated values (CSVs) or carriage return/line feed separated item IDs of items to process. -key Specifies a comma-separated list of items or 4GD key name and value pairs. If the key is for a 4GD object, the related 4GD class must also be specified with -class=. Use the following format: Copy keyAttr1=keyVal1[,keyAttr2=keyVal2]…[,keyAttrN=keyValN] Item example: Copy item_id=M2Item1_001,object_name=M2Item_name1,object_type=M2Item1 4GD example: Copy 4gd_id=CD00001_ID,object_name=CD00001_Name,object_desc=CD00001_Desc -itemKeyFile Specifies the name of the file containing the list of Item or 4GD object key strings to process. The file format is: Copy keyAttr1=keyVal1[,keyAttr2=keyVal2]…[,keyAttrN=keyValN] If the list has 4GD object key strings, the related 4GD classes must also be specified with -classoffile=. File list with item IDs: Copy item_id=M2Item1_001,object_name=M2Item_name1,object_type=M2Item1 File list of item IDs with revisions: Copy item_id=s1005,rev_id=B item_id=s1005-1,rev_id=A item_id=s1005-2,rev_id=C File list of 4GD objects with -classoffile=: Copy 4gd_id=CD_Export_001 4gd_id=CD00001_ID,object_name=CD00001_Name,object_desc=CD00001_Desc -include_bom Optionally includes assembly components of the BOM to all levels for processing. This option cannot be used with 4GD objects. -report_file Specifies that a report be saved to the given file path. If the report_filepath argument is not given, the archive report will be created in the folder containing the utility logs. -4gd_id Specifies a 4GD object identifier or 4GD object pattern to process. The -class or -classoffile argument must be specified with the -4gd_id argument. The utility maps the -4gd_id argument to the corresponding unique ID of the 4GD class. For example: Copy Class=Cpd0CollaborativeDesign, 4gd_id=CD_100 A 4GD partition object uses multifield key attributes by default. Consequently, using -4gd_id for partition objects may result in the restoring of multiple objects. -verbose Includes additional detailed messages in the utility's output. -class (cl) Specifies the Teamcenter class of the object specified by the -4gd_id argument. -classoffile (cof) Specifies the 4GD Teamcenter class of the objects contained in the input file. Valid on with the -itemKeyFile argument. -h Displays the help for this utility. Environment As specified in Manually configure the Teamcenter environment.. Files As specified in Log files produced by Teamcenter. Restrictions This utility accepts input objects of type Item and 4GD objects of type Mdl0ApplicationModel only. The utility removes all replicated and published information associated with input objects and further transfers the input objects and their dependents to the archive site with ownership privileges. You cannot restore an older revision if the latest revision is still archived. Examples Generate a dry run report of an item ID and its dependent objects that would be restored: Copy restore -u=Tc-admin-user -p=password -g=group -f=list -verbose -item_id=ABC_101 Generate a dry run report for a given input file of item ID strings that would be restored: Copy restore -u=Tc-admin-user -p=password -g=group -f=list -itemidsfile=item_archive.txt -verbose Perform a restore and generate a report for a given item ID: Copy restore -u=Tc-admin-user -p=password -g=group -f=perform -verbose -item_id=ABC_101 -report_file=c:\temp\myreport.txt Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration