TeamcenterKnowledge

Configuration utilities > Business Modeler IDE

deploy_archive

Archives deployment files for both Teamcenter Environment Manager (TEM) and the Business Modeler IDE. An administrator can run this utility from the command line in retrieve mode to retrieve the last set of deployment archive files. This utility is automatically run at deployment to archive files, but you can turn off this functionality by setting the DEPLOY_ARCHIVE_ACTIVE environment variable to false (or off, no, or 0). The deployment archival process is as follows: A set of extractor and updater utility log files (specified by an input directory) are zipped into an archive file. A set of compare history files associated to the specific deployment are zipped into an archive file. For every deployment, the zipped archive files are uploaded into a new deploy archive dataset (Fnd0BMIDEDeployArchive dataset type). The deployment archive file retrieval process is as follows: Locate the archive datasets (Fnd0BMIDEDeployArchive dataset type) from the Teamcenter database using the BMIDEDeployArchiveRecovery saved query. A subdirectory using the dataset name with the create date/time stamp is created under a specified target directory. Each named reference (archive zip file) for the archive dataset is exported to that subdirectory. For more information, see Retrieve deployment archive files in BMIDE for Data Model Design. Syntax deploy_archive -u=user-id {-p=password | -pf=password-file} [-g=group] -action=[deploy | retrieve] -dir=source-or-target-file-path -deploySource=[tem | bmide] -retrieveNum=number-of-archives -afterDate=date-and-time -log=log-file-path [-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 full path and filename of the password file. For 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. -action Creates or retrieves the archive. You must specify one of these options: deploy Collects and creates the deploy archive ZIP files and upload them into a deploy archive dataset. Requires the -deploySource argument to be specified. retrieve Extracts the deploy archive ZIP files from the specified deploy archive datasets. The dataset name is used to create a subdirectory in the OS under the directory name given by the -dir parameter. The named references (archive ZIP files) are exported to that subdirectory. -dir Specifies the full path to the source directory (when using the -action=deploy argument) or to the target directory (when using the -action=retrieve argument). The source directory must exist and have read access and contains files to archive for the deploy action. The target directory must exist and have write access and contains subdirectories (by dataset name) that each contain ZIP archive files from the retrieve action. -deploySource Identifies the source of the deployment activity when using the -action=deploy argument. (Ignored when the action is retrieve.) The dataset name format is deploy_tem | bmide_user-id_date-time-stamp. Valid values are: tem Specifies that Teamcenter Environment Manager is the source of the deployment. bmide Specifies that the Business Modeler IDE is the source of the deployment. -retrieveNum Qualifies the number of archive datasets (from latest to earliest) to return from the saved query execution when the -action=retrieve argument is used. (Ignored when the action is deploy.) The default is 3. If not specified, 3 datasets are retrieved. If 0 is set, then all datasets are retrieved. The actual number of datasets exported can be different than this value based on the total number of deploy archive datasets. -afterDate Specifies the time after which to collect archive log files when using the -action=deploy argument. (Ignored when the action is retrieve.) The required format is yyyy-mm-dd hh:mm:ss. -log Specifies file path and name of the log file that contains the results of this execution. This argument is optional. -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. Related Topics BMIDE for Data Model Design

Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/utilities_reference/coz1737253683897/avc1737253684501/xid458351.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)