install

Performs limited Teamcenter maintenance and Oracle database administration. Caution This utility requires the user ID of the Teamcenter administrator account. During Teamcenter installation, this ID is infodba, but after installation, this must be changed to a different user account with similar privileges. Never use the infodba user to create working data or initiate workflow processes. The infodba user is to be used only for certain tasks during Teamcenter installation. Using this account to create data or initiate workflow processes can cause unexpected and problematic behaviors. If you require a user with high-level privileges to create data, create a new user and grant database administrator privileges to that user. This utility requires the password for the Teamcenter administrator account. The password must not be empty nor contain any whitespace characters such as space, tab, newline, carriage return, form feed, or vertical tab. In addition, the password must not contain any of the following characters: ! @ $ % = & ' " : ; . < > ( ) { } Some of the install utility arguments are reserved for Siemens Digital Industries Software use only and should not be used by customers. Using the install utility with arguments designated as being for Siemens Digital Industries Software use only can result in corruption of the Business Modeler IDE template and data model synchronization. Syntax install {-p=password | -pf=password-file} [-add_func_index user-id password grp class-name index-name unique-flag fn class-name attr1 attr2...] [-add_index user-id password group class-name index-name unique-flag class-name attr1 attr2...] [-ask_pom_param user-id password group pom-parameter] [-ask_version] [-ask_xmit_file user-id password group object-file] [-ayt ] [-drop_index user-id password group class-name index-name] [-encrypt] [-encryptpwf -e=environment-variable-name -f=pw-file-name] [-find_control_chars user-id password group class-name attribute] [-gen_xmit_file user-id password group] [-lock_db user-id password group] [-pom_object_index user-id password group] [-regen_db_stats user-id password group] [-regen_schema_file user-id password group] [-replace_control_chars user-id password group class hex-bad-char replacement-string] [-reset_last_login_time user-id password group] [-revisioning user-id password group PARTITION {REPORT | APPLY | REMOVE} ] [-set_internal_site] [-set_pom_param user-id password group pom-parameter setting hours] [-temp_table user-id password group list ] [-tidy_timestamps] [-unlock_db user-id password group] [-mark_as_test_env user-id password group [-site_id=site-id] ] [-check_for_test_env user-id password group [-site_id=site-id] ] [-h] Arguments -p Specifies the password associated with the user-ID value. This argument is mutually exclusive with the -p argument. One of the two mutually exclusive password elements is required. -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. One of the two mutually exclusive password elements is required. -add_func_index user-id password grp index-name unique-flag fn class-name attr1 attr2... Generates an index on the upper field name of the given attribute to allow case-insensitive search. Other functions should only be used upon guidance from Siemens Digital Industries Software. The following values must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. grp Specifies the group associated with the user-ID value. In most cases, the group is dba. index-name Specifies the name of the index. This is internal to POM and not the name used in Oracle. unique-flag 1 indicates that the index is unique. 0 indicates that the index allows duplicates. fn If this argument is omitted, the upper field name is assumed. class-name Specifies the name of the class. list-of-attributes Specifies the list of attributes of the class separated by a blank space. Note The order of attributes is important. Take care when creating indexes on a group of attributes. The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -add_index user-id password group index-name unique-flag class-name attr1 attr2... Generates a new POM schema file. Requires Teamcenter system administration privileges. The following values must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. index-name Specifies the name of the index. This is internal to POM and not the name used in Oracle. unique-flag 1 indicates that the index is unique. 0 indicates that the index allows duplicates. class-name Specifies the name of the class. list-of-attributes Specifies the list of attributes of the class separated by a blank space. Note The order of attributes is important. Take care when creating indexes on a group of attributes. -ask_pom_param Ask the state of a POM parameter. If the parameter is not set, the output is: Parameter … = "NULL". user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. See restrictions #1 and #3. pom-parameter Specifies the name of the POM parameter. Most POM parameters are for internal use only. -ask_version Returns the current version of Teamcenter stored in the Oracle database. -ask_xmit_file user-id password group object-file Returns the transmit file required by a Classic Multi-Site objects.meta file. This requires POM_TRANSMIT_DIR to be set. The following arguments must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. object-file Specifies the object file to transmit. Alternatively, use this syntax: -f=object-file. Note The order of attributes is important. Take care when creating indexes on a group of attributes. The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -ayt "Are You There?" Checks the database connection. Expected output for an installed database and valid credentials is: . Site is already installed. If the database connection is valid, but in a pre-install state, the output is: (check_db) Database requires an install. Otherwise, there is some issue with credentials, such as the TC_DB_CONNECT environment variable is wrong, or the database is not accessible: (check_db) Failed to connect. -drop_index user-id password group class-name index-name Drops an index to revert a change made using install -add_index. The following arguments must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. class-name Specifies the name of the class. index-name Specifies the name of the index to drop. Note The order of attributes is important. Take care when creating indexes on a group of attributes. The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -encrypt Reads a database connect string from the TC_DB_CONNECT environment variable and displays on the console that connect string with the password encrypted. To change the database password, you need to change the password (see Teamcenter Administration), set the TC_DB_CONNECT environment variable to contain that new password, run this utility specifying the -encrypt option, and copy the new version of the connect string it outputs into the tc_profilevars file. -encryptpwf Creates an encrypted password file. Requires the -e argument to identify the environment variable that contains the password to encrypt and the -f argument that indicates the name and location of the file containing the encrypted password. -e= environment-variable-name Specifies the environment variable that contains the password to encrypt. This argument is valid only if you specify the -encryptpwf argument. You can specify any environment variable that contains a clear text password value that you want to encrypt. For security reasons, chose an obscure and unique name for the environment variable and immediately unset the environment variable after you run the utility. -f= password-file-name Specifies the name and location for the file containing the encrypted password used to connect to the Teamcenter database. This file is used by Teamcenter utilities when using the -pf argument and by some other Teamcenter functions. This argument is required when you use the -encryptpwf argument and is valid only if you specify the -encryptpwf argument. -find_control_chars user-id password group class-name attribute Finds control characters in the Teamcenter database. Control characters can enter the Teamcenter database through ITK operations that are legitimate codes for the server or database code pages, but cause problems for XML because they are illegal characters and thus cause problems for SOA based integrations in particular. To find such characters, the following arguments must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. class-name Specifies the name of the class. attribute Specifies the attribute. Note The order of attributes is important. Take care when creating indexes on a group of attributes. The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -gen_xmit_file user-id password group Generates the transmit file containing a copy of the Teamcenter schema that is used by POM during import to compare the exporting site schema definition to the importing site schema definition for all classes. The file resides in the $POM_TRANSMIT_DIR directory. Note In some cases, the POM_TRANSMIT_DIR files must be deleted and regenerated when they fail to update during the -gen_xmit_file command. user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -lock_db Locks the sites against further use. The lock remains in place until unlocked with the -unlock_db argument. The following values must be supplied in this order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. See restrictions #1 and #4. -pom_object_index user-id password group Specifies an optional index on the POM_object class that allows queries to answer high frequency queries directly from the indexes (instead of referring to the table row). This is not a default argument because it requires additional database server memory. This affects the following indexes: PPOM_OBJECT_SLN on puid and ptimestamp PPOM_OBJECT_UPI on puid and ppid user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -regen_db_stats Gathers database statistics for the schema and/or specific tables within the database. It provides administrators an efficient alternative to querying the database directly. This argument operates on Oracle databases only. user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. all Regenerates table statistics for all tables (forced regeneration). When this parameter is used alone, the utility queries the tables and then displays all statistics to the console window, including stale or empty statistics tables. sql Displays to the console window the gather_schema_stats sql query that would gather the statistics. It does not perform the actual gathering of statistics. templates Displays to the console window the gather_table_stats sql query that would gather table statistics for the template. It does not perform the actual gathering of statistics. noreport Suppresses much of the output to the console window. When used with the all option, it omits tables with stale or empty statistics. table1, ... Narrows the scope of any of the options above to a specific table or list of tables to act upon. -regen_schema_file Generates a new POM schema file. Requires Teamcenter system administration privileges. The following values must be supplied in order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. See restrictions #1 and #3. -replace_control_chars user-id password group class hex-bad-char replacement-string Replaces control characters found by the -find_control_chars argument. An temporary alternative to fixing the data in the database is to set an environment variable (in the TC_DATA\tcprofilevars.bat file) to replace control characters. For example, to replace control characters with spaces (ASCII character 32), set the following variable: POM_STRIP_CTRL_CHARS=32 To use the -replace_control_chars argument, the following values must be supplied in this order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. class Specifies the class. hex-bad-char Specifies the hexadecimal code of the control character to replace. Do not prefix this value with 0x to indicate a hexadecimal value, enter only the hexadecimal value itself. For example, a value of 1f is valid, but 0x1f is not valid. replacement-string Specifies the string to insert in place of control characters. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -reset_last_login_time user-id password group Updates the last login time for the user authenticating through a command line. This argument is suitable for batch processing. The following values must be supplied in this order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -revisioning user-id password group PARTITION {REPORT | APPLY | REMOVE POM-revisable tables (used by 4GD) use database partitioning for historical data automatically during upgrade or install based on the feature availability with the database. Partitioning helps query performance where a large volume of historical data is present. Database partitioning capability is available in Oracle Enterprise, but in Teamcenter it is controlled by the TC_USE_REV_PARTITIONING environment variable. By default, this environment variable is set to N because database partitioning requires a license at extra cost from Oracle. If you want to enable partitioning for 4GD data, set TC_USE_REV_PARTITIONING to Y before installation or upgrade, or execute the install utility with the -revisioning PARTITION argument. Following are the parameters that can be used with the -revisioning PARTITION argument: REPORT Report about classes supporting minor revisions which use tables that are not partitioned. APPLY Apply database partitioning to tables of classes supporting minor revisions. REMOVE Remove database partitioning from tables of classes supporting minor revisions. -set_internal_site Sets an internal site ID. This is run automatically when using the Create environment for upgrade testing check box in Teamcenter Environment Manager (TEM). Setting the internal site ID allows FMS to communicate with both the test environment and the original production environment. -set_pom_param Sets a POM parameter. Use in combination with the following parameters: TC_TIMESTAMP_THRESHOLD Sets the threshold for the number of hours to hold timestamps in the POM_timestamps table. The default is 96 hours. Use the following format to change the threshold: Copy install -set_pom_param -u=user -p=password -g=group TC_TIMESTAMP_THRESHOLD hours To reset the threshold back to the default threshold, rerun the command without the hours variable. TC_TIMESTAMP_TIDY_MODE Allows manual cleaning of the POM_TIMESTAMP table. Use the following format: Copy install -set_pom_param -u=user -p=password -g=group TC_TIMESTAMP_TIDY_MODE manual After enabling manual cleaning, run the -tidy_timestamps argument to remove timestamps from the POM_TIMESTAMP table. To disable manual mode, rerun the parameter without the manual variable. -temp_table user-id password group list [ list | drop [all | older_than_date=YYYY/MM/DD HH:MI:SS | table_name=temp-table-name ] ] Lists Oracle temporary table names and drops them if necessary. You can use this utility to check whether Oracle temporary table definitions are accumulating and drop them to clean them up. Oracle temporary table definitions can accumulate when the server exits abruptly, for example, when a database connection is lost. You can list these table definitions using the list option or purge them using the drop option with a specific name or date, or purge all. The following values must be supplied in this order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. list Specifies to list accumulated temporary table definitions. Alternatively, use the drop option instead of list to drop temporary table definitions. Note Although Oracle prevents database users from dropping temporary tables that are in use by running processes, it is best to drop temporary tables when the system is quiet, when no users are logged in. drop all Drops all temporary table definitions. drop older_than_date=YYYY/MM/DD HH:MI:SS Drops definitions older than the specified date and time. drop table_name=temp-table-name Drops the specified temporary table. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -tidy_timestamps Removes timestamps from the POM_timestamps table. Each timestamp records the time of an object’s most recent modification. The POM_timestamp table holds timestamps for a configured amount of time. (The default is 96 hours.) By default, Teamcenter performs maintenance on the POM_timestamp table at session logout. If this becomes a bottleneck due to the volume of concurrent session logouts, moving to manual maintenance offers better control. Before using the -tidy_timestamps argument to clean out timestamps, you must enable manual mode by using the -set_pom_param argument with the TC_TIMESTAMP_TIDY_MODE manual parameter. -unlock_db user-id password group Releases locks set with the -lock_db argument. The following values must be supplied in this order: user-id Specifies the user ID of the Teamcenter administrator account. password Specifies the password or password file associated with the user-ID value. For more information, see the descriptions of the -p and -pf arguments. group Specifies the group associated with the user-ID value. In most cases, the group is dba. See restriction #1. -mark_as_test_env Changes a production environment to a test environment that can use the bulk load features for copying product data. Caution Because you cannot revert a test environment to a production environment, you are prompted to confirm this action. You can specify the -site_id= argument to change a remote site to test environment in the local site database. This selects the read-only Is A Test Environment check box for the site in the Organization application to show that it is a test environment. If you do not supply a site ID, the utility prompts you to confirm the change to the local environment. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -check_for_test_env Checks the environment to determine whether it is a test or production environment. This can be used before attempting to change an environment to a test environment and to verify that an production environment has been changed to a test environment. You can specify the -site_id= argument to check other sites known to the local environment. If you do not supply a site ID, the utility returns the status of the local site. Note The user, password, and group arguments can alternatively be supplied in one of the following forms: -u=user-id -p=password -pf=password file -g=group -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment and the following environment variables: TC_DB_CONNECT POM_SCHEMA POM_TRANSMIT_DIR For more information, see the Teamcenter Environment Variables. Files As specified in Log files produced by Teamcenter and the following: $TC_DATA/tc_profilevars Stores site environment variable settings. This file is modified by the -encrypt argument. POM schema file data file created by the install utility with the -regen_schema_file argument. Full file specification (directory path and file name) is set by the POM_SCHEMA environment variable. POM transmit schema file data file created by the install utility with the -gen_xmit_file argument. Full file specification (directory path and file name) is set by the POM_TRANSMIT_DIR environment variable. Restrictions Common command line argument syntax for user-id, password, and group arguments is not supported. Values for these arguments must be separated by an equal sign (=). For example, the following syntax works: Copy $TC_BIN/install -regen_schema_file tcAdmin password dba $TC_BIN/install -regen_schema_file -u=tcAdmin -p=password -g=dba   Requires Teamcenter system administration privileges and exclusive access to the system for this operation. Common -regen_schema_file failures: POM _db_connect_fail Unable to connect to database. POM _logins_are_disabled Login to database is disabled. POM _invalid_site_id Database is not populated. POM _not_installed Database missing data. POM _find_schema_failed Unable to create new POM schema file. Directory does not exist, cannot be written to, or the POM_SCHEMA environment variable is not set. POM _schema_exists File pointed to by the POM_SCHEMA environment variable already exists. Delete or move this file and retry. The -lock_db does not force logout of existing users, but does prevent additional users from logging on. Only the following tokens can be changed on an existing (saved class): POM_attr_export_as_string POM_attr_follow_on_export POM_attr_is_candidate_key POM_null_is_valid POM_public POM_public_read POM_public_write For additional information, see Teamcenter Server Customization. When adding a new custom privilege, you must have previously added that privilege to the am_text.uil file and recompiled the file. For additional information, see Teamcenter Server Customization. Rules-based object protection must be enabled in order to add and use new custom privileges. Examples To regenerate the POM transmit schema file, enter the following command on a single line: Copy $TCROOT/bin/install -gen_xmit_file tcAdmin password dba To change a production environment to a test environment: Copy $TCROOT/bin/install -mark_as_test_env tcAdmin password dba Related Topics Teamcenter Installation on Linux Using TEM Teamcenter Installation on Windows Using TEM Teamcenter Rich Client Installation on Linux Using TEM Teamcenter Rich Client Installation on Windows Using TEM