Deployment Center
Deployment Center
Deployment Center ─
Usage
Teamcenter 2406
Unpublished work. © 2024 Siemens
This Documentation contains trade secrets or otherwise confidential information owned by Siemens Industry Software Inc. or
its affiliates (collectively, “Siemens”), or its licensors. Access to and use of this Documentation is strictly limited as set forth in
Customer’s applicable agreement(s) with Siemens. This Documentation may not be copied, distributed, or otherwise disclosed
by Customer without the express written permission of Siemens, and may not be used in any way not expressly authorized by
Siemens.
This Documentation is for information and instruction purposes. Siemens reserves the right to make changes in specifications
and other information contained in this Documentation without prior notice, and the reader should, in all cases, consult
Siemens to determine whether any changes have been made.
No representation or other affirmation of fact contained in this Documentation shall be deemed to be a warranty or give rise to
any liability of Siemens whatsoever.
If you have a signed license agreement with Siemens for the product with which this Documentation will be used, your use of
this Documentation is subject to the scope of license and the software protection and security provisions of that agreement.
If you do not have such a signed license agreement, your use is subject to the Siemens Universal Customer Agreement, which
may be viewed at [Link] as supplemented by the product specific terms
which may be viewed at [Link]
SIEMENS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENTATION INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF
INTELLECTUAL PROPERTY. SIEMENS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, LOST DATA OR PROFITS, EVEN IF SUCH DAMAGES WERE FORESEEABLE, ARISING OUT OF OR RELATED
TO THIS DOCUMENTATION OR THE INFORMATION CONTAINED IN IT, EVEN IF SIEMENS HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.
TRADEMARKS: The trademarks, logos, and service marks (collectively, "Marks") used herein are the property of Siemens or other
parties. No one is permitted to use these Marks without the prior written consent of Siemens or the owner of the Marks,
as applicable. The use herein of third party Marks is not an attempt to indicate Siemens as a source of a product, but is
intended to indicate a product from, or associated with, a particular third party. A list of Siemens’ Marks may be viewed at:
[Link]/global/en/legal/[Link]. The registered trademark Linux® is used pursuant to a
sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a world-wide basis.
Managing repositories
Manage repositories ───────────────────────── 3-1
Maintaining repositories ─────────────────────── 3-4
Troubleshoot the repository service ────────────────── 3-4
Quick deployment
Understanding quick deployment ─────────────────── 6-1
Quick deployment procedure ───────────────────── 6-2
Using the dc_quick_deploy utility ─────────────────── 6-4
Creating an XML configuration file ────────────────── 6-7
Sharing components across environments using Quick Deploy ────── 6-8
Troubleshoot quick deployment ─────────────────── 6-11
Download software packages to a central location, set up your installation or update in Deployment
Center, and generate deployment scripts. Run the scripts on target machines that access and install the
software.
Benefits
• Deploy, manage, and maintain multiple versions of software in multiple Teamcenter environments
from a single web application with authenticated user access.
• Reduce the costs of managing Teamcenter environments by reducing the number of people, steps,
and time involved in software deployment.
• Provide a centralized location to create and view Teamcenter environments and view deployment
information.
• Ensure consistency and accuracy by reviewing and adjusting deployment configuration before rollout
to Teamcenter environments.
• When setting up your environment, take advantage of entering parameters for one component and
having those values shared with related components. For example, when you enter a machine name
or port number for a component, that information is shared with other components that require the
same information.
1. Select the software and configure the deployment in the Deployment Center web application. You
can manage responsibility for software deployment using a single administrator or share it among
the site's deployment experts. For example:
• A business analyst can make decisions about choosing the applications. Business analysts can
choose the software versions and the applications needed by business units.
• An administrator can make decisions about the machines, ports, URLs, user names, passwords,
and component settings for the target machines in an environment. Administrators can
make deployment selections based on knowledge of hardware infrastructure, number of
users, and which applications are used by business units. For more information about
recommended distribution of hardware and components, see the Teamcenter Deployment
Reference Architecture, which provides detailed examples of Teamcenter deployments, plus
sample deploy scripts and other resources. This package is available in the Teamcenter
Downloads area on Support Center.
2. After reviewing the deployment configuration, generate the deployment scripts and deploy the
software on the target machines.
You can deploy a variety of applications and components among your Teamcenter environments. A
typical deployment process specifies software configuration and generates deployment scripts that
install or update the software on target servers using software kits from a common repository.
You can deploy Teamcenter environments by following a quick deployment process that uses
a Deployment Center utility to manage application and component configurations and generate
deployment scripts.
The following terms and concepts are used throughout Deployment Center.
• Environment
Centrally-managed environment you model in Deployment Center to deploy and update Teamcenter.
• Software
• Applications
Related binaries, files, and data model that comprise a set of Teamcenter functionality, contained in a
Deployment Center-compatible software package.
• Components
Finding information
The following Deployment Center documentation deliverables describe how to create, deploy, and
manage Teamcenter environments using the Deployment Center application and its utilities:
To learn how to deploy a specific solution, application, or server component, see the documentation for
the given version that you want to install or update.
Deployment considerations
System requirements and compatibility
Download support documents from Support Center to find system software certified for Deployment
Center and supported upgrade paths for Deployment Center and Teamcenter.
Limitations
• See the Teamcenter Interoperability Matrix (Teamcenter Interoperability Matrix [Link]) for
information about versions of Deployment Center that can be upgraded directly to Deployment
Center 2406.
• To perform deployment actions that are not yet available in Deployment Center, run Teamcenter
Environment Manager (TEM) on the target machines to complete your environment updates and
configuration.
For additional information specific to this release, see the Deployment Center README document
available with the Deployment Center 2406 product download.
Deployment process
Using Deployment Center, you can create and configure Teamcenter environments, with the flexibility
to change applications, components, and parameter settings before you deploy Teamcenter software to
the target machines in your network. The deployment process allow you to:
• Import environments created using Teamcenter Environment Manager (TEM) into Deployment Center.
• Add Teamcenter software kits from updates, patches, and asynchronous product releases.
• Review selected applications, components, and parameter settings before you generate deployment
scripts.
In the deployment process, you will perform the following common Deployment Center procedures:
Start and log on to Deployment Center. You can display information about all existing, registered
Teamcenter environments, including deployed software, applications, server components, and
environment properties.
Plan where to store Teamcenter and related software kits for deployment.
• Keep the software in a single local repository on the Deployment Center web server. Use this option if
you don't have spare server space located near target servers.
• Put software in multiple locations that may be shared with your target environment. Plan for enough
disk space to hold the entire set of software for an environment. If you have existing software kits
in a software directory, you can map a UNC path to that location. Be sure the server is accessible to
Deployment Center. Use this option to make access easier during deployment.
• Copy the software from the repository to each target server, ensuring each server gets the complete
set of software. Specify this path in the -softwareLocation argument when you deploy. Plan for
additional disk space on each target server. Use this option to install software more quickly.
• Specify the software repository locations when you install or upgrade Deployment Center. If you
already have software on another server, you can include it.
• Deployment Center scans repository locations regularly for unzipped software. The scanned software
appears on the Software Repositories page which lists all available, valid software kits. If you have
software dependencies, the repository notes missing software.
• Place the downloaded software kits in a repository software directory. Be sure they have been
unzipped.
Manage environments
You can create and manage registered environments in Deployment Center. You can view the list of
Teamcenter environments on the Environments page.
You can create a new environment, register an existing Teamcenter environment, or remove an
environment.
You can view all machines from your registered Teamcenter environments. On the Machines page, you
can see all server machines used by the components in your registered environments.
In Deployment Center, determine your approach for installing or updating an environment. Then
deploy your software using the Deployment Center application.
You can deploy software in a multiple server environment or on a single machine. If your components
are on multiple servers, verify the server configuration for each component.
In Deployment Center, you configure server components that are associated with your selected
software and applications. Some components may be automatically selected, and some settings may
already be configured. You can choose multiple servers for deployment.
Because selections and settings are saved as you go, you can review and verify them. If you are unsure
of your setup or you need to make changes, return later to complete or change your settings before
deployment.
When you enter user names and passwords for server components in Deployment Center, passwords are
encrypted in the generated deployment scripts or you can provide an encrypted password.
After you verify your configuration information, generate the deployment scripts, and copy each script
to its corresponding target server. Each script contains the designated target machine name, what to
install or update on the target machine, and the software configurations you specified in Deployment
Center.
Tip:
Validate the deployment scripts in a test run. As a best practice, run the deployment scripts
in diagnostic mode on each target machine to validate the configuration. Check the log output
for errors. No updates are made to the target machine during diagnostic validation. Make the
corrections in Deployment Center, regenerate the deployment scripts, and run them in diagnostic
mode until all errors are addressed.
After validation is successful, run the deployment scripts on each target machine. The deployment
script has a parameter to specify the location of the software directory. Be sure the software is available
to the target machines.
You can install or update additional applications and components in Teamcenter environments
managed from Deployment Center. You can also perform maintenance on component configuration
or parameter values after installation from Deployment Center.
To perform additional deployment actions that are not yet available in Deployment Center, run
Teamcenter Environment Manager (TEM) on the target servers to complete your environment updates
and configuration.
Password encryption
You can provide an encrypted password for Deployment Center installation, as well as for command
line utilities, by creating a secure encrypted password or password file. The dc_encrypt.bat utility (on
Windows systems) and dc_encrypt.sh utility (on Linux systems) are located in the deployment_center
directory of the software download kit.
When creating an encrypted password, the input password is specified either in text form or in an
environment variable that contains the password.
Caution:
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:
!@$%=&'"^:;._<>(){}
-password
Specify the clear text password for the Deployment Center administrator user that you want to
encrypt.
-env
Specify the environment variable containing the Deployment Center administrator password.
-file
Specify the file in which you want to save the encrypted password.
Example:
To produce an encrypted password and save it to a file:
dc_encrypt -password=dc_password
-file=D:\pwd_files\dc_admin.pwf
dc_encrypt -password=dc_password
dc_encrypt -env=DC_PWD_ENVAR
Note:
If you generate an encrypted password without using the -file argument, you must prefix the
encrypted password with dc: and save it to a text file before you can use the encrypted password
with a Deployment Center utility. For example, save the following to a file named dc_admin.pwf:
dc:encrypted-PW
You can create an encrypted password or password file that can be used by these Deployment Center
utilities:
send_configuration_to_dc
deploy
HTTPS communication
Deployment Center supports HTTPS and HTTP communication. HTTPS ensures encrypted, secure
communication between the Deployment Center server and Deployment Center services and utilities.
When you install or upgrade Deployment Center, you can enable HTTPS communication in
the .properties files.
Deployment Center supports an HTTPS encrypted connection using JKS and PKCS12 certificates. You
may use the Deployment Center Vault as the certificate authority to generate certificates locally.
Alternatively, you may purchase a certificate from a Certificate Authority (CA) or create a self-signed
certificate.
If the KeyStore certificate is not signed by a trusted CA (such as when you create a self-signed
certificate), you may provide an associated TrustStore and password.
Set the Certificate Authority Settings parameters for Deployment Center to configure how you will
obtain certificates.
To use HTTPS communication between the Deployment Center server and other machines, set the
useHttpsCommunication parameter to true. To use this setting, you must configure Certificate
Authority Settings parameters.
By default, useHttpsCommunication is set to false. Setting it to true enables HTTPS and disables HTTP
communication with Deployment Center.
After you enable HTTPS, Deployment Center refuses all HTTP connections. If you receive unexplained
web browser errors when accessing the Deployment Center server, determine whether the URL is using
HTTP.
Set Deployment secrets distribution setting parameters to configure management of passwords and
other Deployment Center secrets with the Deployment Center Vault.
The onlineSecretsDistribution parameter specifies whether to enable online access to secrets from the
Deployment Center Vault. The supported values and modes for this setting are as follows:
true (Online mode) With this setting, deploy scripts retrieve secrets from the Deployment
Center Vault during deployment.
Caution:
If you set onlineSecretsDistribution to true, you must set the
useHttpsCommunication parameter to true to ensure encrypted transmission
of secrets from the Deployment Center server.
false (Offline mode) With this setting, secrets are encrypted and distributed in the
deployment packages generated by Deployment Center.
After you configure HTTPS support, the following utilities use HTTPS:
send_configuration_to_dc
deploy
dc_quick_deploy
Jetty web A Jetty web server is automatically installed and configured for Deployment Center,
server and and the installation automatically deploys and runs the Deployment Center web
the application. No additional installation or configuration is required for the Jetty web
Deployment server or the Deployment Center web application. Access the web application from a
Center web web browser on any machine.
application
H2 database The H2 database is also automatically installed and configured for Deployment Center.
The database stores information about the Teamcenter environments registered with
Deployment Center. No additional installation or configuration is required for the H2
database.
Hashicorp Deployment Center uses Hashicorp Vault to securely store and retrieve deployment
Vault secrets. In the installation configuration properties or upgrade configuration properties
(Deployment for Deployment Center, you specify:
Center
Vault) • Online or offline retrieval of deployment secrets from the vault
• Service name and port of Hashicorp Vault
• Whether to use the vault as the certificate authority
Repository The repository stores the downloaded software kits and files needed during
and the deployment. Deployment Center uses the repository subdirectories when it registers
repository Teamcenter environments and displays choices for installing and updating software
service and applications.
You provide the repository directory location during installation of Deployment Center.
Be sure that repository location has adequate disk space available to store all the
software kits needed for your deployments.
• backup
Contains a backup of the repository folder when you upgrade the Deployment
Center server.
• dc_contributions
Contains the Deployment Center files that are needed for Deployment Center
to install earlier releases of Teamcenter, Active Workspace, and other supported
software.
Caution:
Do not make changes to this directory.
• deploy_scripts
Contains the deploy scripts Deployment Center generates for an environment. The
deploy scripts and related files are generated into a timestamped folder in the
respective environment folder.
• report
Contains the generated environment validation report that supports the registration
of an existing environment from Teamcenter Environment Manager (TEM)
environment.
• snapshot
• software
Kits available to install are listed in the Active Media tab in the Software
Repositories page.
You may define multiple software repository locations when you install Deployment
Center.
• system
Caution:
Do not make changes to this directory.
The repository service is automatically installed when you install Deployment Center.
The repository service runs automatically and monitors the repository. The repository
service reports the software kits to Deployment Center and populates the list of
available software selections.
1. Log on to Support Center and open the Support White Papers Certifications page:
a. Open Products→Teamcenter→Downloads.
Make sure the required system software is installed on your machine before you install
Deployment Center.
Teamcenter Interoperability Matrix (Teamcenter Interoperability Matrix [Link])
Lists which versions of Teamcenter are compatible with Deployment Center 2406. It also lists
which versions of Deployment Center can be upgraded to Deployment Center 2406.
Make sure the version of Teamcenter you plan to install is compatible with Deployment Center
2406.
3. Install a certified Java runtime environment (JRE) on the Deployment Center machine.
4. Set the JAVA_HOME and JRE_HOME system environment variables to the location of the certified
JRE.
Siemens Digital Industries Software recommends the following storage space be available on your
Deployment Center machine:
• Deployment Center software repository: Minimum 12 GB, plus about 56 MB for each generated
deployment package.
The software repository also requires space for downloaded software kits and additional space for any
custom software packages. You can store software downloads on the Deployment Center server or
you can configure repository locations on separate file systems.
The Deployment Center software kit is included in the Teamcenter software kit.
If you already downloaded the Teamcenter 2406 software kit, skip to step [Link], begin at step 1.
Products→Teamcenter→Downloads
2. Under Select a Version, choose Teamcenter 2406, and then click the Teamcenter 2406 tile.
3. Download the Teamcenter 2406 software kit for your platform (Tc2406_platform.zip). Extract its
contents to a local directory.
4. In the Teamcenter 2406 software directory, change to the install\DeploymentCenter directory (on
Windows systems) or the install/DeploymentCenter directory (on Linux systems).
6. Extract the contents of the Deployment Center software kit on your Deployment Center machine.
1. In the directory where you expanded the Deployment Center software kit, change to the
deployment_center directory. Locate the installation properties file, install_config.properties,
which specifies parameters for the Deployment Center installation.
Open your installation properties file in a text editor to begin setting installation parameters.
3. Set values for the required parameters or accept the default values provided.
Parameters that are optional are commented out. You may uncomment and set these parameters if
you want, but do not remove optional parameters from your installation properties file.
When you are finished setting parameters, save your installation properties file.
Make sure this name does not match any existing service name. A
duplicate service name causes installation to fail.
serviceDName Specifies the display name for the Deployment Center service.
The default value is Deployment Center Service. This parameter
applies to Windows systems only.
Deployment Center repoDir Specifies the full path to the directory for the primary Deployment
Repository Settings Center software repository. The Deployment Center installation
script creates a software subdirectory in this path.
The path must be a local path. UNC paths and mapped drives are
not supported for the primary repository directory.
repoPort Specifies the port where the Deployment Center repository listens
for requests from the Deployment Center server.
Make sure this name does not match any existing service name. A
duplicate service name causes installation to fail.
repoServiceDName Specifies the display name for the Deployment Center repository
service. The default value is Deployment Center Repository
Service. This parameter applies to Windows systems only.
repoServicePublisherDName Specifies the display name for the Deployment Center repository
publisher service. The default value is Deployment Center
Repository Publisher Service. This parameter applies to
Windows systems only.
repoPublisherPort Specifies the port used by the repository publisher. Do not change
this value unless it conflicts with a port already in use.
repoSubscriberPort Specifies the port used by the repository subscriber. Do not
change this value unless it conflicts with a port already in use.
Make sure this name does not match any existing service name. A
duplicate service name causes the installation to fail.
vaultServiceDName Specifies the display name for the Deployment Center Vault
service. The default value is DC_Vault_Service. This parameter
applies to Windows systems only.
osUserNameVaultService Specifies the OS user name to use to access the
(Optional) Deployment Center Vault service in online mode. (That is, if
onlineSecretsDistribution is set to true.) This setting applies to
Windows systems only.
osUserPasswordVaultService Specifies the OS password for the user specified in
(Optional) osUserNameVaultService.
1. Open an administrator command prompt and change to the directory where you expanded the
Deployment Center software kit. Then, change to the deployment_center directory within this
directory.
2. Run the Deployment Center installation script, deployment_center.bat (on Windows systems)
or deployment_center.sh (on Linux systems), specifying your updated installation properties file
using the -inputFile argument. Example:
• Windows systems:
deployment_center.bat -install
-inputFile=DC_install_config.properties
• Linux systems:
deployment_center.sh -install
-inputFile=DC_install_config.properties
3. After the installation is complete, the script displays the URL to access Deployment Center:
[Link]
Open this URL and enter the user and password you specified in the Deployment Center installation
properties file.
4. On Linux systems, Deployment Center creates a post-installation tasks script that installs daemon
processes for the Deployment Center server, repository service, publisher service, and vault service.
After the installation is complete, run the post-installation tasks script:
DC-server-dir/rootscripts
Replace DC-server-dir with the Deployment Center server directory you specified in the
serverDir parameter in your installation parameters file.
root_servicessetup.sh
This script registers daemons and performs other installation actions that require root
privileges.
If the installation fails or the installation script displays errors, see the Deployment Center installation log
file:
• Windows systems:
DC-root\deployment_center\webserver\logs\
• Linux systems:
DC-root/deployment_center/webserver/logs/
Replace DC-root with the Deployment Center installation path you specified in the serverDir parameter.
The Deployment Center installation log file also includes the URL to Deployment Center.
Note:
If you did not install Deployment Center as a service (on Windows systems) or a daemon (on
Linux systems) by specifying the serviceName parameter in the Deployment Center installation
properties, you must start the Deployment Center web server manually. You may need to set
the locale when you do this.
• Migrate to using the HTTPS protocol for communication with the Deployment Center server.
Configure Deployment Center upgrade properties, and then run the Deployment Center upgrade script.
3. In the directory where you expanded the Deployment Center software kit, change
to the deployment_center directory. Locate the upgrade properties file, named
upgrade_config.properties, which specifies parameters for the Deployment Center upgrade.
Open your installation properties file in a text editor to begin setting installation parameters.
5. Set values for the required parameters, or accept the default values provided.
Parameters that are optional are commented out. You may uncomment and set these parameters if
you want, but do not remove optional parameters from your upgrade properties file.
When you are finished setting parameters, save your upgrade properties file.
Make sure this name does not match any existing service name.
A duplicate service name causes installation to fail.
vaultServiceDName Specifies the display name for the Deployment Center Vault
service. The default value is DC_Vault_Service. This parameter
applies to Windows systems only.
osUserNameVaultService Specifies the OS user name to use to access the
(Optional) Deployment Center Vault service in online mode (that is, if
onlineSecretsDistribution is set to true). This setting applies to
Windows systems only.
osUserPasswordVaultService Specifies the OS password for the user specified in
(Optional) osUserNameVaultService.
Caution:
Do not remove the repository subscriber port (repoSubscriberPort) or repository publisher
port (repoPublisherPort) parameters. These parameters are for internal use by the
repository. If the port specification conflicts with a port already in use, you may change
the port to an unused port.
1. Open an administrator command prompt and change to the directory where you expanded the
Deployment Center software kit. Then, change to the deployment_center directory within this
directory.
2. Run the Deployment Center installation script, deployment_center.bat (on Windows systems) or
deployment_center.sh (on Linux systems), specifying your updated upgrade properties file using
the -inputFile argument. Example:
• Windows systems:
deployment_center.bat -upgrade
-inputFile=DC_upgrade_config.properties
• Linux systems:
deployment_center.sh -upgrade
-inputFile=DC_upgrade_config.properties
3. After the upgrade is complete, the script displays the URL to access Deployment Center:
[Link]
Open this URL and enter the user and password you specified in the Deployment Center upgrade
properties file.
If the installation fails or the installation script displays errors, see the Deployment Center log file:
• Windows systems:
DC-root\deployment_center\webserver\logs\
• Linux systems:
DC-root/deployment_center/webserver/logs/
Replace DC-root with the Deployment Center installation path you specified in the serverDir parameter.
The Deployment Center installation log file also includes the URL to Deployment Center.
Note:
If you did not install Deployment Center as a service (on Windows systems) or a daemon (on
Linux systems) by specifying the serviceName parameter in the Deployment Center installation
properties, you must start Deployment Center manually.
You may need to set the locale on the Deployment Center URL.
If you want to change the Deployment Center administrator password, use the deployment_center.bat
-maintenance command.
If you encounter problems during Deployment Center upgrade, see Troubleshoot Deployment Center
installation or upgrade.
Caution:
When you add or remove directories, be sure that no one is using the Deployment Center for any
activity during maintenance. Deployment Center services are stopped and restarted during the
update.
If you run Deployment Center on Windows, you must be logged on using an account with administrator
privileges. On Windows systems, you may specify local drives or UNC paths. When you specify a path,
use double backslashes (\\) to make the path valid for Java.
1. Stop the Deployment Center web server, and stop the Deployment Center Windows service if it is
running.
-serverDir (required)
Specify the full path to the existing directory for the Deployment Center installation.
-user (required)
Specify the user name for the Deployment Center administrator to validate the change.
-password (required)
Specify the password for the Deployment Center user to validate the change.
If useEncryptedPassword was set to True when the password was entered previously, enter
the encrypted password.
3. To change the password for the Deployment Center server user, specify these parameters:
• -changePassword
• -newPassword
Provide the updated password. You may specify a clear text password or an encrypted password.
The current password will be authenticated to make the change.
• -useEncryptedPassword
-addSoftwareDir (optional)
Specify additional paths to software directories for the repository. These paths must be
separated by commas (,).
You may specify local file system paths or UNC paths. Mapped drives are not supported.
-osUserNameRepoService
Specify the OS user name for the Deployment Center Repository Service on the current
machine. The OS user must exist on the current machine and should have access to the
UNC paths specified in the additional software directories.
-osUserPasswordRepoService
Specify the OS user password for the Deployment Center Repository Service on the
current machine.
To reiterate, this OS user must exist on the current machine and should have access to
the UNC paths specified in the additional software directories.
-removeSoftwareDir (optional)
Specify existing paths to software directories that are scanned by the repository. Paths are
separated by commas (,).
This action does not delete software directories, and it does not remove scanned software
from the repository display. However, the repository no longer scans the directory for
additional software. Software in the directory is not removed from the system.
Do not remove a directory specified as the primary repository, specified by -repoDir during
installation.
5. If you are adding or removing deployment script directories, use these parameters:
-addScriptsDir
Specify one or more directories where you want to generate deployment scripts for the
dc_quick_deploy utility. Append a positive integer to each scriptsDirn argument followed by
a colon : and the associated path, for example, scriptsDir123:scripts_path. Separate multiple
specifications with a comma (,).
You may specify local drives or UNC paths. For network locations, specify the user name and
password.
If you specify an existing scriptsDirn, the previous value will be overwritten by the new value.
-osUserNameDCService (required)
-osUserPasswordDCService (required)
-removeScriptsDir
Specify one or more locations you want to remove from deployment script generation. Specify
the scriptsDirn argument that defines the location, for example, scriptsDir123. Separate
multiple specifications with a comma (,).
Example:
Add and remove directories for the repository list and the generated scripts list:
information assists us in improving future releases of Deployment Center. Data collection occurs in the
background as software is used and does not affect performance or functionality.
During the installation, you can opt in or out of the program by setting the enableSoftwareAnalytics
parameter in the Deployment Center installation configuration parameters.
After installation, you can change your participation choice using the Deployment Center maintenance
utility from a command line on the Deployment Center machine:
Linux:
deployment_center.sh -maintenance –
enableSoftwareAnalytics=yes
Opt out of Windows:
the program
deployment_center.bat -maintenance –
enableSoftwareAnalytics=no
Linux:
deployment_center.sh -maintenance –
enableSoftwareAnalytics=no
After you change this setting, log out of Deployment Center and log on again for the change to take
effect.
Siemens Digital Industries Software collects information about the use of our products by customers
through the Product Excellence Program. This program is designed to protect the privacy of users and
the intellectual property created through the use of Siemens Digital Industries Software offerings.
The information we collect helps us improve our product features and functionality to meet our
customers' needs better.
Privacy statement
The Product Excellence Program helps Siemens Digital Industries Software understand how
customers use our products and assists us in improving our products. The program is anonymous
and participation is voluntary.
The Product Excellence Program is designed to protect the privacy of the user and the intellectual
property created through the use of Siemens Digital Industries Software products.
The Product Excellence Program is used to collect data about your installation, the features you
use and how you use them. The data is sent to Siemens Digital Industries Software for analysis. By
examining usage patterns from a large number of people, we gain insight into how the products
are used and how to improve the software in future releases. Data collection occurs in the
background as you use the software and does not affect performance or functionality.
The data collected can vary by product and by release as we gain more insight or add new
capabilities. The Product Excellence Program may collect information on the functions utilized, the
operating environment (for example, OS, RAM, and graphics), product version, or other indications
of user interactions. This data is solely used by Siemens Digital Industries Software to improve our
products and is never shared with any third party.
There is no contact information in the data and Siemens Digital Industries Software will not contact
you by phone or email as a result of the data collected. Absolutely no information about the data
you create or manage is collected.
Participation is optional.
You can opt out of the Product Excellence Program during installation or after installation. Change
your decision to join or opt out at any time.
The following table provides examples of the type of usage data that is collected by Siemens Digital
Industries Software and, equally as important, clarifies what data is not collected by Siemens Digital
Industries Software.
For more information about the Product Excellence Program, see the Siemens Digital Industries
Software Trust Center.
Remove Deployment Center services, the software repository, and Deployment Center files.
1. Open an administrator command prompt on the server where Deployment Center is installed.
Enter this command for all Deployment Center services you installed as Windows services:
Example:
This example uses default service names. If you changed any of these service names in the
installation parameters when you installed Deployment Center, use the service names you
specified to stop the services.
To find a service's service name using the Windows Services panel, right-click its displayed name
and choose Properties.
sc delete service-name
Example:
sc delete DC_RepoService_Publisher
sc delete DC_RepoService
sc delete DC_Service
sc delete DC_Vault_Service
If you used non-default service names when you installed Deployment Center, use the service
names you specified to delete the services.
5. Delete the software repository directory. You specified this location in the repoDir parameter when
you installed Deployment Center.
If you specified additional software directories in the extraSoftwareDir parameter, delete those
directories also.
Make sure you run the Deployment Center installation script from a location with no spaces or quotation
marks in the path. For example, this path contains a space:
D:\DC Kits\deployment_center\deployment_center
The space in the path (DC Kits) may cause the following error:
On Windows systems, if you upgraded an installation of Deployment Center and also performed a new
installation of Deployment Center 2406, you may notice the displayed names of the Deployment Center
services differ between the new and upgraded installations. This does not cause problems and the
services will operate normally.
You may need to set the browser locale for Deployment Center as it does not read the web browser
locale language. Set the locale by appending the locale code to the end of the Deployment Center URL.
Example:
[Link]
cs_CZ, de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, ko_KR, pl_PL, pt_BR, ru_RU, zh_CN, zh_TW
On Windows systems, if you specified the serviceName parameter during installation, the
Deployment Center web server is installed as a service and starts automatically.
On Linux systems, the root_servicessetup.sh script installs the Deployment Center service as a
daemon.
If you did not specify the service arguments, start the Deployment Center service from its startup
script. Navigate to the server directory specified by the serverDir parameter when you installed
Deployment Center and run the [Link] script.
If you experience a problem starting Deployment Center, see Troubleshoot Deployment Center
operations.
[Link]
serverPort is the port number specified by the serverPort parameter for the Deployment Center
installation script.
Tip:
The URL is displayed in the command window after Deployment Center installation is
complete.
The URL is also specified in the installation log file.
2. Enter the user name and password as specified in the user and password parameters for the
Deployment Center installation script.
If you experience a problem in logging on to Deployment Center, see Troubleshoot Deployment Center
operations.
• Deployment Center operation failures such as internal server error, display problems, or missing
configuration files.
If you configure HTTPS for Deployment Center, it refuses all HTTP connections. If you get an
unexplained web browser error when accessing the Deployment Center server, check whether the URL is
using HTTP instead of HTTPS.
If you have a problem with the browser locale for Deployment Center as it does not read the browser
locale language, you can append the locale code to the end of the Deployment Center URL.
Backup and recovery procedures rely on the Deployment Center installation process as and require
Deployment Center installation paths and parameters. In the following procedures, DC-install-dir refers
to the installation path to Deployment Center.
Note:
As a good practice, perform a backup when you add software to Deployment Center.
2. If you set up a repository service, stop the service. To locate the service, look for the service name
or display name which you specified in the serviceName and serviceDName parameters when you
installed Deployment Center.
DC-install-dir\serverDir\db\deploy_center.[Link]
DC-install-dir\serverDir\db\deploy_center.[Link]
4. Record the list of software packages you downloaded to the repository. The repository directory is
set to the location specified by repoDir during Deployment Center installation, for example:
DC-install-dir\repository\software
Note:
If you already recorded the list of software packages and there have been no changes to the
repository since the last backup, you can skip this step.
If you encounter a problem, stop Deployment Center and the repository service and replace the
database files from your backup. If that does not fix the problem when you restart Deployment
Center, download and replace the software packages in the repository.
If your recovery is not successful, you may need to reinstall Deployment Center.
2. Move or rename the existing Deployment Center installation, in case you need to access the
software directories to repopulate the repository.
3. Reinstall Deployment Center in the same location, using the same paths and ports as the original
installation. To restore the database files, the repository path specified by repoDir must be identical
to the previous installation.
4. Update the repository with the same software packages that you retrieved from the previous
backup. If the repository software packages are available from the installation that you moved or
renamed, copy those files.
7. Copy the backup database files to your current Deployment Center installation:
DC-install-dir\serverDir\db\deploy_center.[Link]
DC-install-dir\serverDir\db\deploy_center.[Link]
8. Restart the repository service and other services and start Deployment Center.
Deployment Center is restored to the state it was in from the last backup.
Each Deployment Center repository contains a software directory that stores your unzipped software
kits. The primary repository is specified by the repoDir parameter during Deployment Center
installation.
You may have Teamcenter software in more than one location. You can add these locations using the
extraSoftwareDir parameter. Specify the paths for Deployment Center during installation, upgrade, or
maintenance. Each specified path presumes there is a software subdirectory where unzipped software
kits are stored.
The primary repository location (repoDir) must be a local directory path. UNC paths and mapped drives
are not supported.
Additional repository locations (extraSoftwareDir) can be local file system paths or UNC paths. Mapped
drives are not supported.
Deployment Center scans for software in unzipped subdirectories of these registered repository software
directories. Deployment Center reads directories nested one level under software. These subdirectories
must contain unzipped, valid software directories.
Deployment Center does not scan further than the first level subdirectories under software. Software
nested under another software folder is not found. Software that is placed in another location on the
server is not scanned.
The Active Media tab displays information about each software kit in the Software Media table.
Deployment Center refers to the base Teamcenter software as Foundation software.
Software kit information includes the name, version, release type, repository folder location, and when
it was last scanned. You can see whether it's in use by a Teamcenter environment and whether it has a
dependency.
Dependent software must be present to successfully choose software to install or update. If you are
missing dependent software, Deployment Center displays a message explaining what you need.
If the repository scanner detects an invalid file, the repository displays the file with a message. Invalid
files can be a Word or Excel document, a directory containing software not supported by Deployment
Center, or a software ZIP file that is not unzipped.
The repository service scanner updates the repository list periodically, but the refresh rate may be
affected by factors such as server location and network performance.
You can add and remove software locations in the repository at any time using deployment_center.bat
in maintenance mode.
You can review configuration information for any software listed in the repository, and the applications
and components the given version supports. The report contains information about products,
applications, components, and configurable properties you may need to set for a Teamcenter
environment using the quick deploy process.
Choose a software kit from the Active Media tab and click Generate Software Configuration
Report . The HTML results provide comprehensive information about software dependencies and
IDs, application internal names and dependencies, and component and property internal names
and configuration values. This information can help you create or update the quick deploy XML
configuration file.
1. Download the software kits for the software versions that you want to deploy in your Teamcenter
environment. Be sure to get the current full release any updates you want to apply to your
Teamcenter environment.
2. Unzip the software kits and copy the unzipped directories to the software subdirectory in one of
your registered repository locations.
The Software Repositories page opens the Active Media tab of the repository and displays the
Software Media table.
4. Check the list of software to verify that it is correct and complete for your planned deployment.
Check whether missing dependencies are noted. If so, retrieve the missing software and check
again. The list may take a little while to update.
If you experience a problem in adding software to the Deployment Center repository, you can try to
troubleshoot the repository service.
When a software kit is no longer being used in a registered Teamcenter environment, you can remove it
from the Active Media list.
1. Open the Active Media tab to display all the registered software kits. Click the software kit you
want to remove.
If the software is used by an environment, an error message explains that it can't be removed and
which environments are using it.
If the software is not used and is free to be removed, the selected software is moved to the
Obsolete Media tab. Deployment Center deletes the software and the software directory from the
file system.
To complete the software kit removal from Deployment Center, click the Obsolete Media tab,
select the software to remove, and then click Remove on the command bar.
The repository scanner removes the software kit registration and removes the software from
Deployment Center database. The selected software no longer appears in the Obsolete Media tab.
The Overview tab provides helpful information about the server where the primary repository is
located. The system information includes disk space, which you can monitor when you put software
kits in the repository. The available and used disk space values are updated when you add or change
software kits in the primary repository.
• Repository Name
• Location
Enter or update a location for the repository server. You can use any convention you wish,
such as geographical location, the name of a facility, or another value that helps you define the
location.
• Comments
Maintaining repositories
Use the maintenance procedure for deployment_center.bat to add, remove, or update the repository
software locations being used by Deployment Center.
If software placed you placed into the repository does not appear on the Software Repositories page,
this could indicate a problem with software files or that an error occurred when Deployment Center
scanned the repository. View the software repository logs for information about problems encountered
during repository scanning. The repository log files are located on the Deployment Center server in
webserver\repotool\logs.
If your software repository is large, for example, 40 or more items, you could encounter an error similar
to the following when Deployment Center scans the repository:
The scan process may terminate and the scan results may be left incomplete.
To resolve this issue, you can increase Java memory allocation by editing the following registry key in the
Windows Registry Editor:
Replace the old data values with the new data values shown:
The Deploy Software tab displays the selected software used by registered environments. You choose
the software necessary to proceed with deploying updates. If an environment is new, the selected
software list may be empty. This is where you begin the software deployment process.
The Status column shows the installation status of the selected software:
Install in Progress Deployment scripts are running, sending current status to Deployment Center.
The Overview tab displays the environment's properties, such as the architecture, site, software version,
applications, and components installed in the environment. Click an environment to learn more about it.
If an environment is new, the Overview displays the information used to create it.
• Review the Software, Applications Installed, and Components for an existing environment. You can
click a selection to display more information in the right pane.
If an environment is new, Software, Applications Installed, and Components may not be populated,
so no Teamcenter environment information may be displayed.
Deployment Center can create a snapshot of an environment, which records the applications,
components, parameter settings, deployment status, and other properties in the form of a Quick
Deploy XML file. Snapshots can be used to capture an environment in a current state and to roll
an environment back to a previous state if necessary.
If you have captured snapshots of an environment, you can restore an environment to the state at
which the snapshot was captured. Components that were partially configured in the snapshot are
restored to their partially configured states.
Existing deployment scripts cannot be used after restoring a snapshot. You must generate new deploy
scripts in the Deploy tab.
Exporting environments
You can use an existing environment as a starting point to create a new environment. You can
export an XML configuration file that contains the selected environment's configuration. Edit this
configuration file and then reuse it as the input XML file for the dc_quick_deploy utility.
On the Environments page, choose an environment from the list, and run Export Environment .
Select whether you want the output XML file to contain all component configuration properties or just
the required component properties.
Information about the software is available from the Software Configuration Report. The report may
be helpful in making updates to the XML configuration file.
Software You can verify the status of software for the selected environment. The list includes
installed and pending software. You can select the software package to see additional
software details.
Applications You can verify the status of applications for the selected environment. The list includes
Installed installed and pending applications. You can select an application package to see
additional application details.
Applications are associated with their installed software, such as Search for Active
Workspace.
Components You can verify the status of components for the selected environment. The list includes
installed and pending components. You can select the component package to see
additional information about component settings. Components are associated with
their applications, such as Indexing Engine and Indexer for Search.
The component information in the right pane offers two views of the information. In
the upper right corner, you can choose the view:
• Environment Name
Displays the name provided during setup for the environment. You can update the name for the
environment.
Note:
An environment name cannot contain spaces.
• Environment Type
Displays the type of the environment. The available types are Integration, Development,
Production, Test, and Training. The type is set to Production by default when the environment
is registered, but you can select another type.
• Config ID
• Site ID
Displays an auto-generated site ID for the environment. When you copy an environment,
Deployment Center generates a different site ID.
• Location
Displays the location of the environment. You can enter or update the geographical location for
the environment, such as a city, the name of a facility, or another value that helps you define the
location of the environment.
• Comments
Displays additional information entered by the administrator. You can enter or update
information about the environment.
Create environments
You can create an environment for your planned deployment. When you are ready to add software to
your new environment, Deployment Center displays only the versions of Available Software that are
supported in a new environment.
Create an environment
2. On the far right below the command bar, click Add Environment .
3. The new environment appears highlighted in the list. Choose Overview to display its information.
4. You can edit some of the properties, such as Name and Type. On the command bar:
Click Start Edit to edit properties. To save your changes, click Save Edits .
You can also choose to export the configuration of an existing environment. You can reuse its
configuration to create another environment using the quick deployment procedure.
Note:
The registration utility (send_configuration_to_dc) scans only configurations from TEM.
Components supported by Deployment Center that were installed by other installers, such as
Web Application Manager (insweb), must be added manually after scanning the environment.
For information about features supported in the current software, generate a software
configuration report.
Register an environment
The utility sends TEM configuration information for installed features to Deployment Center.
Windows systems:
DC-installation\webserver\additional_tools\send_configuration_to_dc.zip
Linux systems:
DC-installation/webserver/additional_tools/send_configuration_to_dc.zip
a. Copy the send_configuration_to_dc.zip package to a local directory and unzip the package.
d. Change to the send_configuration_to_dc directory in the path where you unzipped the
registration utility.
e. Set the JAVA_HOME and JRE_HOME environment variables to the location of the JRE.
f. Set the TC_ROOT environment variable to the Teamcenter installation directory on the given
host.
3. Beginning with the corporate server machine, type the send_configuration_to_dc.bat command
(on Windows systems) or the send_configuration_to_dc.sh command (on Linux systems) with
the following arguments to register the local Teamcenter configuration from TEM into Deployment
Center:
-dcurl (required)
-dcusername (required)
Specifies the password for the Deployment Center administrator. You can specify the password
as text or use an encrypted password or password file. If the password file path contains
spaces, enclose it in quotes.
-environment (required)
-config (optional)
Specifies the ID of the Teamcenter configuration you want to scan. Specify this argument if
you installed multiple configurations in a single TC_ROOT location.
Example:
send_configuration_to_dc.bat -dcusername=dcadmin
-dcpasswordfile="E:\admin passwords\[Link]"
-dcurl=[Link]
-environment=tc_scanned
5. After you scan all machines in the environment, review and validate the environment in
Deployment Center.
2. In the Environments page, select the name of the scanned environment in the
environments list. You specified this name in the -environment argument when you ran the
send_configuration_to_dc utility.
3. In the Software tab, note the status of the selected software is In Review .
If problems were encountered when scanning the environment, Deployment Center displays a
warning icon above the Selected Software list.
4. In the command bar on the far right, click Validate and Generate Environment Report:
Deployment Center generates an environment validation report that contains feature mappings,
information about scanned TEM environments, and actions to perform to complete the configuration
of the scanned environment. The report is placed in the following location:
Windows systems:
Deployment Center-repository\report\EnvironmentValidationReport_environment-[Link]
Linux systems:
Deployment Center-repository/report/EnvironmentValidationReport_environment-[Link]
Deployment Center automatically downloads the report, so you can open it through the web browser
Downloads feature or from the location above.
Alternatively, you can generate a validation report from the command line by running the
send_configuration_to_dc utility with the -gvr (generate validation report) argument:
Open the environment validation report and review all information about the scanned environment.
Describes total numbers and types of actions required to complete the configuration of the scanned
environment.
• Mapping of Scanned TEM Environment Information for This Deployment Center Environment
Maps TEM features and GUIDs to Deployment Center applications and components. It maps TEM
configuration properties to Deployment Center properties and highlights items that require attention.
1. In each table in the report, note values in the Scanned Status and Error/Warning columns.
In the Scanned Status column, a check mark (✔) indicates a valid item, an X (❌) indicates an item
that requires corrective action:
Note:
Some items in the report may show a check mark (✔) with a warning. These items are not
critical to validation but changes are recommended either during validation or soon after.
2. For each item that error or warning, click the message in the Error/Warning column to view the
specific required actions, for example:
4. When you have performed all actions, generate a new report by clicking Validate and Generate
Environment Report in the command bar on the far right.
5. If the Summary of Required Actions and Informational Warnings section in the new report still
lists required actions, perform the required actions and generate a new report again.
6. When the environment validation report prescribes no further required actions, the environment is
ready to be marked complete. Click Complete Registration in the command bar on the far right:
In the Software tab, note the status of the selected software is changed to Installed .
Alternatively, you can complete the environment registration from the command line by running the
send_configuration_to_dc utility with the -rc (complete registration) argument:
To view properties of machines in your scanned environment, go to the Deployment Center home page
and click the MACHINES tile. From the resulting page, you can view all machines used in deployed
Teamcenter environments.
Caution:
If you use TEM to update a configuration that has been scanned as part of an environment
in Deployment Center, make sure that you run the send_configuration_to_dc utility to update
the environment information. Otherwise, configuration changes performed locally on Teamcenter
servers since the last time the send_configuration_to_dc script ran could be overwritten.
Web Application Manager (insweb) is a separate tool from TEM, and the registration utility
(send_configuration_to_dc) can only process TEM configuration files. As a result, the Teamcenter Web
Tier (Java EE) component is not included in a scanned environment. After you scan your environment
from TEM, you must add the Java EE web tier component to the environment.
If you use Security Services, you must also add the Teamcenter Security Services (TcSS) component.
1. Log on to Deployment Center and go to the Environments page. Select the environment you
scanned from the list.
2. In the Components tab, click Add component to your environment . Add the Teamcenter
Web Tier (Java EE) component to the environment. And, if you use Security Services, add the
Teamcenter Security Services (TcSS) component.
3. In the Selected Components list, select Teamcenter Web Tier (Java EE) and enter the
configuration parameters for the web tier from the original environment. If you are unsure of
these settings, you can find them using either of these methods:
• In the Web Application Manager, select your web application and click Modify. Then review the
web application information in Modify Web Application.
• Review the .dat files in the staging location for your web application. For example, find
WEB_ROOT\staging1 on the machine where you run the Web Application Manager.
Repeat this step for the Teamcenter Security Services (TcSS) component, if applicable.
5. Review the remaining Selected Components to make sure they are all 100% configured.
If you experience other problems in registering environments with Deployment Center, see
Troubleshoot registering environments.
Copy environments
You can create an copy of an existing environment from your Environments list in Deployment
Center for various development or training purposes. Copying an environment duplicates the software,
applications, components, and configuration parameters of the selected source environment, changing
the machine names to avoid impact to the source environment.
Copying an environment does not create a copy of the database. You must manually export the
database and volumes.
Caution:
The Copy Environment function is not intended for copying an environment and deploy scripts
to the same machines to redeploy the same environment. It should be used only to create a new
environment from a source environment and deploy it on a different set of machines. Deploying
a copied environment to the same machines as the source environment may result in ambiguous
deployment status and the environment could become unrecoverable.
4. In the Copy source environment dialog box, define values for the copied environment:
a. In the Environment Name box, type a name for the copied environment.
b. In the Environment Type box, choose the type of environment you want to create:
5. Click Copy to create a copy of your selected environment, or click Cancel to cancel the copy.
Deployment Center adds the copied environment to the Environments list. You can continue
configuring the copied environment at this time or return to it in a later session.
6. To continue configuring your copied environment, proceed to the Applications tab to add
applications to, or remove applications from, your copied environment.
7. Proceed to the Components tab. Note any components whose MACHINE name is prefixed with
REPLACEME and update those machine names as needed.
Deployment Center inserts these machine names to prevent changes to the source environment.
9. Proceed to the Deploy tab. Generate install scripts and deploy them on affected machines.
Remove environments
You can remove an environment from the Environments list in Deployment Center.
The environment is only removed from Deployment Center tracking. The Teamcenter system remains
intact.
Note:
Remove an environment removes Deployment Center tracking of the environment, including any
stored snapshots of it. A removed environment can no longer be configured or deployed through
Deployment Center. However, the Teamcenter system itself remains intact.
When you generate deploy scripts for an environment, Deployment Center automatically creates a
snapshot of the environment before deployment scripts are run. Snapshots are stored in the Deployment
Center repository.
Note:
A snapshot does not capture the entire Teamcenter deployment, such as the Teamcenter root
directory and the Teamcenter database, it captures the modeled environment in Deployment
Center. It is not used to restore a deployed Teamcenter installation, but the settings and contents
of an environment before deployment.
If you intend to use a snapshot to recover a deployment failure, back up your Teamcenter
deployment, including database and volumes.
Using the dc_quick_deploy utility, you can capture a snapshot or restore a snapshot to roll back an
environment to a previous state.
Before you create or restore a snapshot, you must copy and unzip the dc_quick_deploy.zip file from
the Deployment Center installation.
To create a snapshot of a Teamcenter environment, run the dc_quick_deploy utility with the create
snapshot argument:
Example:
dc_quick_deploy -create_snapshot
-dcurl=[Link]
Windows systems:
DC-repository\snapshot\environment-name_environment-ID\snapshot_snapshot-ID\environment-
ID_snapshot_snapshot-[Link]
Linux systems:
DC-repository/snapshot/environment-name_environment-ID/snapshot_snapshot-ID/environment-
ID_snapshot_snapshot-[Link]
Note:
The dc_quick_deploy utility cannot create or restore a snapshot of a global environment (an
environment with an Infrastructure Type of Global) or a local environment that references a
global environment component.
You can generate a listing of all existing snapshots for a certain environment by running the
dc_quick_deploy utility with the list_snapshot argument:
In the -snapshot_file argument, specify an output text file for the listing.
Example:
dc_quick_deploy -list_snapshot
-dcurl=[Link]
-environment=Env_tc2406 -dcusername=dcadmin
-dcpasswordfile="E:\admin passwords\[Link]"
-snapshot_file=c:\\[Link]
|-------------------|----------------------------------|---------------------|
| Snapshot | Comment | Creation Date |
|-------------------|----------------------------------|---------------------|
| Env_01_snapshot_2 | Pending install Teamcenter 2406 | Apr 02 [Link] EST |
| Env_01_snapshot_3 | This is an automatic snapshot | Apr 02 [Link] EST |
| | that was taken before deployment | |
| Env_01_snapshot_4 | Pending install Teamcenter 2406 | Apr 02 [Link] EST |
| Env_01_snapshot_5*| Pending install Teamcenter 2406 | Apr 12 [Link] EST |
| Env 01_snapshot_6 | This is an automatic snapshot | Apr 12 [Link] EST |
| | that was taken before deployment | |
|-------------------|----------------------------------|---------------------|
In the Snapshot column, the asterisk (*) indicates the last applied snapshot.
Restore a snapshot
To restore a snapshot of a Teamcenter environment, run the dc_quick_deploy utility with the apply
snapshot argument:
Example:
This command rolls back an environment to the state at which the snapshot was captured. Components
that were partially configured in the snapshot are restored to their partially configured states.
Existing deployment scripts cannot be used after restoring a snapshot. You must generate new deploy
scripts in the Deploy tab.
Note:
The dc_quick_deploy utility cannot create or restore a snapshot of a global environment (an
environment with an Infrastructure Type of Global) or a local environment that references a
global environment component.
You can use the dc_quick_deploy to delete old snapshots or snapshots you do not intend to use.
Deleting a snapshot removes the snapshot file only. It does not remove backups of the Teamcenter root
directory or database backups.
To delete a snapshot of a Teamcenter environment, run the dc_quick_deploy utility with the delete
snapshot argument:
Example:
Note:
When you delete an environment, Deployment Center automatically deletes snapshots of the
environment.
Note:
For information about known software problems and workarounds, see the README files for
Deployment Center and Teamcenter that accompany the software kits in the Downloads area on
Support Center.
The environment registration utility (send_configuration_to_dc) generates log files when errors occur
during environment scanning, such as:
For details of errors during environment scanning, see these log files in the
send_configuration_to_dc_dir\logs directory on the machine where you ran the utility.
• tem_config_scanner_error_timestamp.log
• tem_config_rest_service_timestamp.log
Provides the communications information between the Deployment Center server and the
send_configuration_to_dc utility.
This error occurs when a dependent application is not present in the [Link] from the TEM
environment, so the application is not scanned.
The application that is not scanned is shown in bold text in the Dependencies column of the
Applications table in the environment validation report.
To resolve this problem, you must manually add the missing application entry in the TEM
[Link] file. This requires you to identify the global unique identifier (GUID) of the missing
TEM feature by performing the following steps:
1. Copy the display name of the missing application dependency highlighted in bold text in the
report. Search for this name in the following directory:
DC-repository\software\software-kit\install\lang\en_US
This search should return the feature_feature-name_en_US.xml file associated with the feature.
4. Open the feature_feature-[Link] file and locate the line that contains the GUID:
<guid value="GUID"/>
5. In the TEM [Link] file, locate the <root><config><features> section. In the area
where other installed feature entries are listed, insert the following line:
Repeat these steps for any other "application dependency not scanned" errors.
Note:
Some dependencies may have been corrected in a later release. For example, the microservice
package oar1oaraw is removed in later releases of Active Workspace, so this feature is reported as
missing in scans with later releases.
If this happens, place the latest release of the software in Deployment Center repository, and then
scan the environment again.
Component Missing
This error occurs when an expected component is not scanned. This typically occurs with the
Teamcenter Web Tier (Java EE) or Teamcenter Web Tier (.Net) components. Deployment Center does
not scan the web tier components, so you must add them manually to the environment after you scan
the TEM environment into Deployment Center.
You can add the web tier components either of two ways:
• Prepare a quick deploy file to add the missing components, then apply the quick deploy to the
scanned environment.
This error occurs when a dependent application is not present in the [Link] from the TEM
environment, so the application is not scanned.
This error occurs when a feature in the [Link] from the TEM environment is not scanned
because the GUIDs of the TEM feature and the corresponding Deployment Center package file do not
match.
Please report this error to product development to verify if this is already addressed in the later release of
the product or not.
1. Note the TEM feature display name and the GUID for the feature not scanned. Copy the GUID from
the TEM GUID column of the Applications table in the report.
2. Typically, the Deployment Center package file begins with the same feature name,
for example, see the feature-name_package.xml in the DC-repository\software\software-
kit\dc_contributions\packages directory.
If you cannot find the Deployment Center package file, search the steps executed in the TEM
feature file, which should be the same as the steps executed in the Deployment Center package file:
a. In the TEM feature file, search for any copy or unzip operation, for example, the following line
for the unzip operation in the feature file.
3. Correct the GUID in the Deployment Center package file to match the GUID in the TEM feature file.
In the environment validation report, the Required Actions for Network Connection Configurations
table shows all the unresolved connections between the components scanned in the environment.
These problems are reported because the values for the properties scanned from the TEM
[Link] mapped to the Deployment Center properties do not match. The table shows the
TEM value in the TEM Value column and its Deployment Center value in the DC Value column. If the
values in these columns do not match exactly, an unresolved connection error is reported.
To resolve these connection errors, you must make the values in the TEM Value and DC Value columns
match by either of the following actions:
• Edit the TEM [Link] to modify the TEM value as to match the Deployment Center value,
and then rescan the environment.
• Edit the Deployment Center property value in the Deployment Center user interface for the Target
Component shown in the report.
If a property such as Machine Name is disabled for modification, then you can supply the expected
value of Machine Name in the -machine argument when you run the send_configuration_to_dc
utility.
1. Log on to Deployment Center, and click MACHINES. The Machines page lists all servers used
by components in deployed environments. When you select a machine, the Overview provides
information about the server where one or more software components are installed.
2. Verify that the properties for the server machine are what you expect.
• OS and OS version
Displays the operating system type and version installed on the machine.
• Local Time
Displays the current date, time, and time zone at the machine's location.
Displays the total disk space and the free space available. The pie chart to the right displays the same
information visually.
• Last Update
Displays the last time information about this server was refreshed. The information is obtained and
sent by the send_configuration_to_dc utility.
• Be sure you have a registered existing environment in Deployment Center before you perform
maintenance on its components.
• Put your current environment's software in the repository and check for dependencies.
Perform maintenance
1. Open the Environments page and choose the environment you want to maintain. Begin the
Deploy Software process.
2. Software
Choose software from the Available Software list. The software selections determine the list of
available applications that you can update. Applications that must be updated are automatically
selected. The Selected Software list displays currently installed versions.
3. Options
Either single server or multiple server deployment is selected for Environment Type. If you
previously had a Single Box environment, you can choose Distributed; however, you will need
to update the server information for affected components.
Architecture Type for your environment is automatically selected and can't be changed.
4. Applications
Applications that are already installed are automatically displayed. You can add applications from
the list. Applications that display a Pending Install status are waiting for deployment. Applications
that are installed but need updates to support your selected software display the Pending Update
status.
5. Components
It's possible that a selection from the current update may cause a previously configured component
to need more information, especially if you add applications or move from a Single Box
environment to a Distributed environment.
Components that are not yet installed display the Pending Install status. Components that are
installed but need updates to support your selected applications display the Pending Update
status.
Components display the % configured. If it's less than 100%, complete the required parameter
values. Components that are not impacted can be ignored (showing 100% configured).
6. Deploy
Generate deployment scripts for the update. This tab is enabled when the other tasks are complete.
Deployment scripts contain the information you configured in Deployment Center for the selected
environment.
After the scripts and software ZIP files are generated, copy them to each target machine and run
them.
You can install software into a new environment. To prepare for a new installation:
• Create a new environment if you are starting with a new Teamcenter installation.
• Register an existing environment if you are installing new software in an existing environment.
This may be the case if you are installing Active Workspace in an existing Teamcenter environment.
• Put your unzipped installation software kits in a repository directory. If you have an existing
environment, put the software you used to install it into the repository.
You can upgrade or patch software in an existing environment. Software dependencies are noted in
the Deployment Center repository and in the Software deployment task. Deployment Center displays
messages explaining issues with upgrade software or dependencies.
• Be sure you have a registered existing environment in Deployment Center before you start an
upgrade.
• Be sure to send existing configuration information from the environment to Deployment Center
using the send_configuration_to_dc script.
• Put your unzipped installation software kits in the repository and check for messages about
dependencies.
You can update some software or components in an existing registered environment. Maintaining
an existing registered Teamcenter environment means updating software or components for your
current version, as permitted by Deployment Center. Be sure you send existing environment
configuration information to Deployment Center. You must have the source software for your
environment in the repository.
You can run deployment_center.bat -maintenance to change the administrator password, add and
remove repository directories, and add and remove deployment script directories.
The Deployment Center user interface Deploy Software page displays each step in the deployment task
bar. In each task, Deployment Center prompts you to make selections and provide information. At any
time in the process, you can save your work and exit. The settings are stored in Deployment Center, and
you can return to the deployment process at your convenience.
Gray means the task is not available yet. These tasks become
available as steps within the previous tasks are completed.
Click a chevron to go to that task. You can revisit any task you previously completed to make changes.
For example, if you completed the Components tab, you can still return to the Applications tab and
make changes.
Caution:
Before proceeding to update an existing registered Teamcenter environment, be sure that you run
the send_configuration_to_dc script from server components to provide current environment
information in Deployment Center. Configuration changes performed locally on Teamcenter
servers since the last time the send_configuration_to_dc script ran could be overwritten.
A Teamcenter environment doesn't track mass client software installations, so this action is not
necessary for clients that have been deployed in this manner for the environment.
1. Open the Environments page and choose the environment where you want to install or update
software. The Deploy Software page provides access to the deployment tasks.
2. Software
Choose the software to install or update. The software determines the list of available applications.
For example, if you choose Active Workspace software, you can install the applications it provides.
• Pending Update software is already installed in your environment, but it needs an update to
support other selected software.
3. Options
4. Applications
Choose the applications. The list of available applications depends on the software selected in the
Software tab. Some applications may be automatically selected for you by default.
Each software package can have one or more applications in its bundle. Applications provide
business logic, data model, work processes, and administration data for specific business uses,
industries, or integrations. In this step, you do not need to know details of your network or
configuration of software or hosts.
5. Components
Choose and configure components. Components run on the specified servers in your environment.
Some components are automatically selected for you as required by the applications selected in the
Application task. You need to configure any component that is not listed as 100% complete.
Component status:
• Pending Update components are already installed in your environment, but they need updates
to support your selected applications.
• Installed components are already installed in your environment, and they don't need any
updates.
You need to know the server hosts on which components will be installed or updated, user names
and passwords for the server component, and component URLs. Some components may have
additional required or optional settings.
6. Deploy
Generate deployment scripts. This task is not available until the Components tab is complete.
Deployment scripts contain the information you configured in Deployment Center for each of the
servers in your environment. The scripts install the software, applications, and components onto
each target machine in your environment.
After the scripts and software ZIP files are generated, copy them to each target machine and run
them.
If you are installing both server and client deployments, both types of scripts are generated.
Always run server component deployment scripts before running client deployment scripts.
You can run the deployment script in diagnostic mode to determine whether your script has any
errors before updating the target machine.
You may not be required to put source release software kits in the repository. Deployment Center
constructs source to target release mapping using the environment's current configuration files sent in
the report from send_configuration_to_dc. Deployment Center analyzes the target release information
to construct the mapping at the time you choose to update. Sometimes, Deployment Center may
require the source software if the target release doesn't provide adequate mapping information. If
there is missing software that is required, Deployment Center displays messages telling you about the
dependency and how to proceed.
Before you perform an update, you must download, unzip, and put the software update or patch kits
in the Deployment Center repository. Check the repository for software dependencies and messages
about missing software.
Deployment Center can update or patch software in a registered Teamcenter environment. If the
environment you want to update originated in TEM, run the send_configuration_to_dc script on the
target servers to send the latest environment configuration information to Deployment Center.
1. Open the Environments page and choose the environment where you want to update software.
Begin the Deploy Software process.
2. Software
Choose the target update software from the Available Software list. The Selected Software
list displays currently installed versions and latest pending versions for the environment. If the
software you need is not available, check whether it was listed in the repository.
If missing software is required, Deployment Center tells you about the dependency and how to
proceed.
3. Options
Either Single Box or Distributed is selected for Environment Type. If you previously had a Single
Box environment, you can choose Distributed; however, you will need to update the server
information for components.
The Architecture Type for your environment is automatically selected and can't be changed.
4. Applications
Applications that are already installed are automatically included for update. You can add other
applications from the list. Applications that display a Pending Install status are waiting for
deployment. Applications that are installed but need updates display the Pending Update status.
See Application names changed in Deployment Center for additional information about application
names.
5. Components
Components that are not yet installed display the Pending Install status. Components that are
installed but need updates to support your selected applications display the Pending Update
status.
It is possible that a selection from the current update may cause a previously configured
component to need more information.
Components display the % configured. If it's less than 100%, complete the required parameter
values. Components that are not impacted can be ignored (showing 100% configured).
6. Deploy
Generate deployment scripts for the update. This task is available when the Components tab is
complete.
Deployment scripts contain the information you configured in Deployment Center for the selected
environment.
After the scripts and software ZIP files are generated, copy them to each target machine and run
them.
Server scripts must be run prior to running mass install client scripts for individual user machines.
After the environment is updated, then run mass client install scripts on user machines.
If you are configuring client software as a component, such as a single installation of rich client on a
specific server, this is considered a server deployment script because the deployment is for a specific
server machine.
Mass client deployment scripts
Install and configure client software for users to run locally on individual machines. Client
deployment scripts can only be created in a distributed environment. Mass client software is not
machine-specific, so one client deployment script can run on any number of machines. Client scripts
do not send any information back to the Deployment Center, so the environment is not aware of
which clients are installed or using it.
Multiple types of clients may be installed together with one script. Configure each type of client
component and specify the same Instance Name for all of them. For every specified instance name,
Deployment Center groups the installation scripts together and generates a single client install
deployment script.
Caution:
Server component scripts must run prior to running any mass client installation scripts for an
environment.
Tip:
If a user's machine already has a client installation and the deploy script can detect the installation
path, the deploy script runs the update on the user's current client installation. If the deploy script
has multiple clients but doesn't detect all the installation paths, it performs an installation if it
doesn't find an installation path or an update if it finds the current installation.
2. Choose the client you want to deploy in the Components tab. If a client supports mass user
installations, the configuration panel displays a check box to enable it.
3. Enable mass client deployment and specify the required parameters. Machine Name is replaced by
Instance Name for a client script. Enter a name for the current client deployment.
4. Save the client component configuration and complete any remaining required component
parameters.
The client component displays (Mass Client) in the Selected Components list as the type of client
deployment. Client components configured for mass deployment display a status of n/a because
they are not tracked as part of a server component.
5. Generate the deployment scripts. The Deploy Instructions displays the path to the output zip
files. A client deployment file is named deploy_mass_client_instance-[Link].
6. Optionally, you can reduce the size of the client deployment scripts by running the
generateMiniSoftware utility.
7. Run the client deployment script after running any server component scripts that were
generated for the Teamcenter environment.
You can reduce the size of your mass client deployment files by generating a mini software kit. Running
the generateMiniSoftware utility extracts only the necessary software from the full software kits and
builds a smaller, more portable software kit for the specific client deployment.
2. To generate a mini software kit, type the following command in a single line:
[Link] -deployScriptDir=deploy-script-dir
-softwareLocation=software-dir
-outDir=output-dir -includeAllConfiguredApps
deploy-script-dir: Path to the mass client deployment scripts directory. Be sure the scripts are
in .zip file format.
software-dir: Path to the directory or software repository from which the utility can gather
files for the mini software kit. This can be a single path, or multiple paths separated
by commas. Type the value the default to gather files from software kits in repositories
registered with Deployment Center.
The optional includeAllConfiguredApps argument creates a mini kit that can be used to install
a rich client or update an existing rich client. To create a mini kit for updating only, omit this
argument. Omitting this argument creates a smaller but limited-use mini-kit.
For example:
[Link] -deployScriptDir=D:\DC_deploy_scripts
-softwareLocation=E:\DC_software -outDir=D:\mini_deploy_scripts
-includeAllConfiguredApps
After you run the utility, its output log file contains information about which components and
applications are included in the mini-kit as well as information about the size of the mini kit compared to
the original software kits.
For more information about the generateMiniSoftware utility, see the Teamcenter Utilities in the
Teamcenter documentation.
Software tab
In this task, select the software to install from the list of installable applications. The software you select
determines the list of applications available in the Applications tab. The Selected Software list displays
both current and pending installations for the environment.
If a software kit you select depends on another kit, Deployment Center automatically selects the
additional required kit.
2. The Available Software panel lists software from the repository. The software status displays
information about the software kit. After making your selections, click Update Selected Software
to add them to Selected Software.
If the software you need is not listed, you must add it to the repository. Add software as needed,
but you may have to choose applications and configure components before deployment.
Options tab
• Choose Single box to install all components on a single machine using the same installation
path.
After you define Machine Name, OS, and Teamcenter Installation Path for one of the
components, those values are adopted by the other components.
If an environment is already deployed on multiple servers, this type will not be available.
• Choose Distributed to install components on separate servers in an environment. This type may
be selected automatically if your environment is already set up as a distributed environment.
Key configuration values (Machine Name, OS, and Teamcenter Installation Path) are shared
only with components that are required to be on the same server.
If you install all components on the same host, but in different installation paths, choose the
Distributed environment type.
You can change the value from Distributed to Single box if an install or an update is not
in progress. For configured components that are not yet installed, Machine Name, OS, and
Teamcenter Installation Path are changed to the values specified for the corporate server
component.
If your environment already has deployed one of the architectures, the type is selected and can't be
changed.
• Choose Global if your environment is to contain components configured for sharing to multiple
Teamcenter Local environments.
A Global infrastructure is used to define mass client information that can be shared to multiple
environments managed in Deployment Center.
Only certain components are supported for sharing to other environments, such as the four-tier
rich client, TCCS, and Security Services Session Agent.
4. If you install SolrCloud in a distributed environment with high availability, select the High
Availability check box.
Note:
This option applies only to SolrCloud. It does not apply to high availability configuration for
other components.
5. When your selections are complete, click Save Environment Options to go to the Applications
tab.
Applications tab
In this task, choose applications for the software you selected. The list of available applications
is determined by the Selected Software packages. Each software package includes one or more
applications as a part of its bundle. The applications contain components, which you select later in
the Components tab.
Some applications are automatically selected based on your Selected Software. For example, if you
choose Active Workspace, the Selected Applications list displays the applications that are configured as
required for installation.
Applications that have a Pending Install status are waiting for installation deployment to complete.
Applications that have a Pending Update status are already installed but need an update to support
other selections,
2. In Available Applications, choose the applications to install. If you choose an application that has
one or more required applications associated with it, the associated applications are automatically
selected. Click Update Selected Applications to add them to the Selected Applications list.
3. You can add or remove applications as long as they are not already installed. Selected applications
show the Pending Install status. When your Selected Applications list is complete, go to the
Components tab.
Components tab
In this task, configure components for installation. Components provide the functionality for your
environment. The Selected Components list displays required components that are automatically added
from the Selected Applications list. Selected Components also displays optional components that
were either already installed or previously selected. You can add more optional components from the
Available Components panel.
Components that have a Pending Install status are waiting for installation deployment to complete.
Components that have a Pending Update status are already installed but need an update to support
other selections.
Some administrative tasks require that you have server names, user names, passwords, URLs, and
other information available for the deployment. The following conditions may apply during component
configuration:
• If a server machine was previously deployed in another environment or is specified in the current
deployment for a different component, you can select it from the Machine Name list.
• If a component has a dependency on another component that is already defined, those values are
shared with dependent components. This means that the component displays some percentage of
completion.
• If you have not configured a component, the state may be either Start or some percentage complete
if it has a shared dependency.
• When you are defining parameter values, some fields may not be editable. For example, if the
component is already deployed in an environment, some parameters can't be changed (such as
Machine Name and OS).
• If you selected the Single Box environment type in the Options tab:
• Specifying a Machine Name, OS, and Teamcenter Installation Path for one component shares
those values with the remaining components. If you change these values on one of the
components, the changes are propagated to the other components when you save.
Add a component
1. In the Components tab, click Add component to your environment to add components.
2. In Available Components, select the components to install. Then click Update Selected
Components to add them to the Selected Components list.
3. In Selected Components, the COMPLETE column displays the state of completion for required
component settings.
4. Click a component in the list to display its parameters in the right panel. This panel initially displays
only required parameters. You must enter values for settings that appear in required parameters
view. You can toggle the view between required parameters and all parameters.
All parameters view displays both required and optional parameter information.
Click to collapse the view to required parameters.
5. Completing all of the required settings pushes the state to 100% complete. If you don't have all the
information you need, you can save your settings at any time and return to finish them.
For example, if you are installing the corporate server, required parameters include machine name,
platform, Teamcenter installation path, and administrative user information. If you expand to Show
all parameters , the corporate server displays additional optional settings.
6. When you are finished entering settings, click Save Component Settings.
7. The next component that is not complete appears in the right-side panel. When all Selected
Components are 100% configured, go to the Deploy tab. The Deploy tab is not enabled until the
Selected Components are all complete.
Remove a component
You can remove components from an environment in the Components tab in Deployment Center, with
certain conditions.
You can remove a component from the list, provided that the component:
• Is optional.
4. In the Selected Components list, select the components you want to remove from your
environment.
The check box by each component name indicates whether the component can be removed:
Hover over any disabled check box to view the reason the component cannot be removed. For
example:
5. After you select components to remove, click Remove Selected Components, then confirm the
deletion.
6. If any components do not have a configuration status of 100%, update configuration parameters
until all components show a configuration status of 100%.
7. Proceed to the Deploy tab. Click Generate Install Scripts to generate deployment scripts to update
affected machines.
When script generation is complete, note any special instructions in the Deploy Instructions panel.
8. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.
For more information about running deployment scripts, see Deployment Center ─ Usage.
Deploy tab
In this task, generate deployment scripts for the components you want to install. Deployment
scripts contain the information you configured in Deployment Center for the selected environment.
These scripts install the software, applications, and components on to each target machine in your
environment.
When the scripts are finished, the Deploy Instructions panel displays information about the deployment
and instructions for proceeding with the deployment. You must copy the scripts to each target machine
and run them to complete the installation.
Deployment Center generates installation scripts, and reports information about the scripts in the
right panel.
2. In the Deploy Instructions panel, you can view the report about the deployment, including the
location of the deployment scripts and the instructions for continuing the deployment.
3. After you confirm that the scripts you need are in the directory, you can proceed with the
deployment.
• Script Generation Date displays the time stamp for the local date and time of script generation.
• Software Needed For Install lists software that is already installed on the machine but is still needed
for this process to deploy other components.
• Deploy Script Directory displays the path to the location of the ZIP files containing the generated
scripts. Go to the ZIP file directory and check for one or more ZIP files corresponding to the machines
in your Teamcenter environment. Look for the Deploy_Instructions.html file, which contains the same
information and instructions that you reviewed in the report.
• Deploy Scripts displays the ZIP files that were generated for each server along with the associated
component names. Each ZIP file contains the installation scripts for a single server.
If all components are to be installed on the same machine, there is only one ZIP file. The ZIP file
name ends with the target machine name where you run the script. For example, if the ZIP file is
named 20180511_202452EDT__Sandbox_LM6W006.zip, it runs on the LM6W006 machine. Run an
installation script only on its designated machine.
Note:
Deployment Center automatically generates an environment snapshot before generating deploy
scripts. This snapshot can be used to restore the environment to its state before the deploy scripts
were run.
The deploy_scripts staging area contains directories for each deployment environment. There is a
subdirectory for each set of generated deployment scripts for the Teamcenter environment. Each server
or mass client instance has its own deployment ZIP file.
The deployment files are generated to a location that was specified by the -scriptsDir configuration
during install or upgrade, or maintenance.
The dc_quick_deploy utility may specify either a -scriptsDir value or a -scriptDirectoryName for the
location of deployment scripts,
• Deploy_Instructions.html
Provides information about the deployment and instructions for running your deployment scripts.
• Software ZIP files for the installation or update that contain the software required to complete your
server or mass client deployment.
Caution:
When you deploy server components on an existing Teamcenter environment using the
Deployment Center application, be sure that you run the send_configuration_to_dc utility
to update the configuration information in Deployment Center before making changes.
Configuration changes performed locally on Teamcenter servers since the last time the
send_configuration_to_dc script ran could be overwritten.
Tip:
Be sure that your environment is not running when you deploy.
The Deploy Instructions in the Deploy tab display the path in the Deploy Script Directory section.
Be sure you logged in as a user with administrative privileges before running deployment scripts.
1. Navigate to the deploy_scripts directory. There may be one or more directories under the
deploy_scripts directory that identify the environment with a timestamp subdirectory.
2. Determine which subdirectory you need, and find the ZIP files and the Deploy_Instructions.html
that you generated.
deploy_host_name.zip
deploy_mass_client_instance_name.zip
3. Before you run the deployment scripts, make them available to the designated machines. For server
deployments in your Teamcenter environment, copy the ZIP files to a directory that is accessible to
the servers in your environment using one of these methods:
Copy the ZIP files directly to each server and unzip them
Select this method if you want to run the deployment locally on the machine. You must
copy the correct ZIP file that matches each server. Be sure the server host name matches the
host_name in the ZIP file name.
Copy the ZIP files to a shared location, unzip them, and map a drive on each server
Select this method if you want to run the deployment from a common location accessible to
all the servers in the Teamcenter environment. You must share the deployment location by
mapping a drive to that location on each server.
If you unzip on a Linux system, be aware that path and file names are in mixed case.
Avoid converting path and file names to lowercase, as paths are case sensitive. See the
documentation for your ZIP utility for information.
Caution:
Be sure to run server deployment scripts before running client deployment scripts for an
environment.
4. Set these environment variables to the location of a certified 64-bit Java JDK:
JRE64_HOME
JRE_HOME
JAVA_HOME
6. Open a command prompt window and navigate to the location where you unzipped the files.
7. Run the [Link] (Windows) or [Link] (Linux) script with the necessary arguments:
Argument Description
-dcusername Specifies the user name of the Deployment Center administrator.
You defined this user when you installed Deployment Center.
-dcpassword OR Specifies the password for the Deployment Center administrator.
-dcpasswordfile
Use -dcpassword to specify the password as text, or use -dcpasswordfile
to specify an encrypted password or password file. If the password file
path contains spaces, enclose it in quotes.
-softwareLocation Specifies the software location or locations.
Set to default to find software in the registered repository directories, or
specify one or more software paths separated by commas. For example:
-softwareLocation=D:\deploy_software,X:\Foundation_s
oftware
Argument Description
The specified URL replaces the Deployment Center URL in the deploy script
configuration for authentication and communication with the Deployment
Center server.
-diagnosticChecks Specifies diagnostic mode.
(optional)
This option runs a diagnostic validation test of the deployment. Diagnostic
mode checks whether the deployment tasks in the deploy script can be
completed successfully on the target machine. Diagnostic mode does not
perform any updates during validation.
Run the deploy script in diagnostic mode to validate properties like
operating system and database credentials, ports, installation paths, FSC
unique IDs, and so on. The log output provides success and failure
information.
For client mass installation scripts, there is no server host validation as they
are machine neutral.
Make any necessary corrections in Deployment Center, regenerate your
deployment scripts, and run them again in diagnostic mode. Repeat until
all the errors are addressed.
-ignoreDiagnostics Skips diagnostic validation tests of the deployment.
(optional)
You may want to ignore diagnostic validation if you determine that an
issue reported by -diagnosticChecks does not need to be addressed.
Specify this argument if you've received a diagnostic report that meets your
requirements for acceptable deployment.
-startServices Starts the services of all required components in an installed environment.
Run the deploy script in this mode to start all the necessary services.
Running the deployment with this option only performs the service start
operation and skips executing the remainder of the deployment tasks.
-stopServices Stops the services of all required components in an installed environment.
Run the deploy script in this mode to stop all the necessary services.
Running the deployment with this option only performs the service stop
operation and skips executing the remainder of the deployment tasks.
-getServiceStatus Retrieves the status of the services of all required components in an
installed environment. Run the deploy script in this mode to retrieve the
status of all the necessary services. Running the deployment with this
option only performs the service status operation and skips executing the
remainder of the deployment tasks.
On Linux systems, make sure you run the script in Korn Shell (ksh) to avoid errors. For example:
./[Link] -softwareLocation=/kits/software
-dcusername=dcadmin -dcpasswordfile=/opt/passwords/[Link]
-dcurl=[Link]
When the installation or update is complete, the command prompt returns a success message with
the location of the log files.
If you experience a problem in running the deploy script, see Troubleshooting deployment.
If you have multiple Teamcenter servers in your environment, you can run deployment scripts on
them in parallel. To do this, run the deployment script on the primary business logic server (the
corporate server) first. Deployment Center uploads a dataset to the volume that contains key items
from the TC_DATA directory, which provides the necessary information for deploying on the remaining
servers. You can then subsequently run the install or update deployment script on the remaining servers
concurrently. Running deployment scripts in parallel can significantly reduce deployment time.
If you generated a software mini-kit, you can run the mass client deploy script using the mini-kit by
performing the following steps:
1. Copy the mini-kit zip file to a directory accessible to the target machine on which you will run the
mass client deploy script.
2. Expand (unzip) the mini-kit in the location to which you copied it.
3. Copy the mass client deploy script ([Link] on Windows or [Link] on Linux) to the target
machine.
4. Run the mass client deploy script as for a typical installation, except in the softwareLocation
argument, specify the location of the mini-kit you expanded in step 2.
Troubleshooting deployment
Troubleshooting deployment on a target machine
Three types of log files may be generated when you run the deploy script on a target machine. If an error
occurs when you run [Link] or [Link], first review the log file deployer_timestamp.log.
Deployment Center log files are located in the logs directory under your unzipped
deployment_script_dir directory on the Teamcenter machine where you are running [Link] or
[Link].
Review the deployer_timestamp.log log file created by the [Link] or [Link] scripts and check
for errors.
• Other deployment failures. These may be related to the machine, the environment, Deployment
Center, the software’s contributions for Deployment Center, Teamcenter utilities, or Business
Modeler IDE.
Look for a section titled Diagnostic Checks Details, which provides validation information.
If you have Diagnostic Checks errors, make the corrections using the method you used to create the
deployment script. Regenerate the deployment scripts and run them again in diagnostic mode. Repeat
this process until all errors are addressed.
After Diagnostic Checks have passed, deployment errors shown in the deployer*.log files may also
require reviewing logs from the Teamcenter utilities that are called by Deployment Center.
Deployment Center deploy scripts may call Teamcenter utilities to perform actions in the Teamcenter
database. These utilities (for example, Teamcenter installation utilities) try to connect to servers
during deployment.
Logs for these utilities are located in either the logs directory under TC_ROOT or the server's
temporary directory (for example, TEMP or TMP).
The Business Modeler IDE utilities are run by Deployment Center and can encounter an error during
deployment. This information is shown in the deployer*.log files, but additional information may be
recorded in Business Modeler IDE logs located in the logs directory under the TC_ROOT directory.
Deployment Center assists in troubleshooting by automatically retrying failed commands that were
called by a deploy script. When a command called by Deployment Center fails during a deploy action,
the deploy script automatically enables the debug mode for the Teamcenter utility that was called, and
then retries the command that failed.
Running a Teamcenter utility in debug mode provides additional troubleshooting information in the
utility's debug log. If the given command succeeds when it is retried, Deployment Center turns off debug
mode so the utility does not generate a debug log file. This minimizes clutter in the logs directory,
avoids creation of large unnecessary log files, and thereby helps focus troubleshooting efforts.
For information about utilities and debug modes, see Teamcenter Utilities.
• You want to schedule or automate environment updates using continuous development tools.
The principles for setting up an environment and choosing software in the Deployment Center
application also apply to the quick deployment process. You must have experience setting up and
configuring applications and components for Teamcenter environments to effectively use this approach.
• Create the XML configuration file that contains application and component configuration for your
environment. You can export an XML configuration file from an existing environment to use as a
starting point. Update the file with the configuration required to install or update your Teamcenter
environment. XML configuration files can be generated from the Deployment Center application
Environments page or the dc_quick_deploy utility.
You may want to use an existing environment that was created using Teamcenter
Environment Manager (TEM) as your starting point. Register the environment using the
send_configuration_to_dc utility to send the configuration information to Deployment Center. Then
you can generate an XML configuration file from the environment for editing.
• Create deployment scripts for the target environment by running the dc_quick_deploy utility. The
input is your XML file containing your software, application, and component configuration. The utility
generates the deployment scripts in the directory specified by the -scriptsDir parameter. Configure the
locations for the -scriptsDir parameter during install, upgrade, or maintenance.
• Run the deployment scripts generated by dc_quick_deploy on the target component servers, as you
normally would, to complete the installation or update.
This type of deployment requires that software, application, and component configuration information
are defined in a structured XML configuration file. The dc_quick_deploy utility processes the XML file,
and then generates deployment scripts and instructions.
If you are also deploying mass client installations or updates, the dc_quick_deploy utility generates two
types of deploy scripts, one for server software and one for client software.
Before you begin, define the components for your software and applications. Gather and evaluate the
associated server information as needed for each component. You must have experience setting up and
configuring applications and components for Teamcenter environments to successfully use the quick
deploy approach.
Ensure the repository has the software required for your installation or update. Identify and include any
software dependencies. Determine whether you are using a single or distributed server environment.
Define the list of applications and their dependencies.
You may need to know server names, locations, operating systems, port numbers, user names,
passwords, installation paths, connection URLs, or other required or optional settings for your
components.
• You can review software configuration information from the Repositories page for each software kit.
From the Active Media tab, click Generate Software Configuration Report . The HTML report
provides comprehensive information about software dependencies and IDs, application internal
names and dependencies, and component and property internal names and configuration values.
• You can create a quick deploy XML configuration file from an existing Teamcenter environment and
edit it for reuse in another environment.
Information from the Software Configuration Report may be helpful in making updates to the XML
configuration file.
1. Assemble the information required to successfully deploy the target Teamcenter environment,
including software, application, server, and configuration settings.
2. Create an XML configuration file to work from. You can evaluate the best method to create or
obtain an XML configuration file.
• If the environment is registered in Deployment Center, select it from the Environments page
and choose Export Environment .
• Run the dc_quick_deploy utility in export mode to generate an XML configuration file from a
specified environment.
• For an environment that was configured using TEM, register the environment with Deployment
Center using the send_configuration_to_dc utility. Then you can export an XML configuration
file.
3. Edit the XML configuration file, ensuring it contains all the configuration information for your
desired environment.
You will need to provide passwords for target servers in the configuration file. The
dc_quick_deploy utility can generate encrypted passwords for you if needed. The encrypted
password can then be entered in the XML configuration for the specific component.
4. After you complete the XML configuration file, run the dc_quick_deploy utility in import mode to
generate deployment scripts. The import mode requires the XML configuration file you created as
input.
The output includes generated deployment scripts for each of the servers in your environment and
a Deploy Instructions HTML file.
If dc_quick_deploy encounters an error, the returned error message includes information about
how to resolve the problem.
If you are generating both client and server scripts, the output provides:
• One or more server scripts, where the zip file name follows the pattern deploy_server-[Link].
• One script for each set of client installs, where the zip file name follows the pattern
deploy_mass_client.zip.
5. After the script files and instructions are generated, copy them to each target machine and run
them as you usually would. Run the deployment script in diagnostic mode on the target machine
to determine whether you have errors. After making your corrections, run the deployment script.
Find the Quick Deploy utility package in the following location in your Deployment Center installation:
Windows systems:
Deployment Center-installation\webserver\additional_tools\dc_quick_deploy.zip
Linux systems:
Deployment Center-installation/webserver/additional_tools/dc_quick_deploy.zip
Copy the package to a local machine, unzip it, and locate the Quick Deploy utility (dc_quick_deploy.bat
on Windows systems, dc_quick_deploy.sh on Linux systems).
Export mode
The export mode exports the configuration information for an existing environment in Deployment
Center. Use this mode to generate a valid XML configuration file that you can use as a starting
point for a new or updated environment. The following arguments are required when you run the
dc_quick_deploy utility in export mode:
Argument Description
-mode (required) Specifies export to generate the environment's
configuration.
-environment (required) Specifies the name of the Teamcenter environment being
exported.
-exportfile (required) Specifies the full path and name of the file, including
the .xml extension, where the configuration file will be
exported.
-exportType (required) Specifies whether the exported file contains Full
(all component properties) or Lean (only required
properties) configuration information.
-dcURL (required) Specifies the URL to access Deployment Center.
-dcusername (required) Specifies the user name for Deployment Center as defined
when installing Deployment Center.
-dcpassword or -dcpasswordfile (one is Specifies the password text or the encrypted password or
required) file.
-preserveDeploymentStatus (optional) Specifies you want to export the environment preserving
the deployment status of software, applications, and
components.
Example:
dc_quick_deploy.bat -dcurl=[Link]
-mode=export -environment=test_env -exportType=Full
-exportfile=D:\export_files\quick_deploy.xml
-dcusername=dcadmin -dcpassword=14pXjKcFG8CIrbjdy1teV5JWJY
Import mode
The import mode imports a configuration file containing the configuration for the specified
environment. Use this mode to import a valid XML configuration file for a new or updated environment.
The following arguments are available when you when you run the dc_quick_deploy utility in import
mode:
Argument Description
-mode (optional) Specified by default, import imports the specified XML configuration file.
-environment (required) Specifies the name of the Teamcenter environment being created or
updated.
-inputFile (required) Specifies the path and file name for a valid environment XML
configuration file.
-dcURL (required) Specifies the URL to access Deployment Center.
Argument Description
-dcusername (required) Specifies the user name for Deployment Center as defined when
installing Deployment Center.
-dcpassword or Specifies the password text or the encrypted password or file.
-dcpasswordfile
-machine (optional) Specifies the name of the machine where the deployment scripts will be
generated, which defaults to the current user's machine if not specified.
-platform (optional) Specifies the operating system for the machine where the deployment
scripts will be generated, which defaults to the current user's platform
if not specified. For example, use wntx64 for Windows and lnx64 for
Linux.
-scriptDirectoryName or Specifies the path to where deployment scripts will be generated.
-scriptsDir (optional)
-scriptDirectoryName specifies a directory name using letters,
numbers, and underscores. No special characters or spaces are
supported.
Example:
dc_quick_deploy.bat -dcurl=[Link]
-environment=test_env -platform=wntx64 -machine=abc236wxyz
-inputFile=D:\import_files\quick_deploy_input.xml
-dcusername=dcadmin -dcpasswordfile=C:\dc_pwds\[Link]
You can use dc_quick_deploy to quickly generate encrypted passwords that you can use to specify
passwords in the XML configuration file.
dc_quick_deploy -encrypt=clear_text_password
Enter the resulting encrypted password in the property specification for a component, as in this example:
The easiest way to create an XML configuration file is to export the current configuration of an existing
environment that most closely resembles the one you wish to produce. You can then edit the exported
XML file to add or update the configuration information for your desired environment. After you
complete your edits, run dc_quick_deploy again, and import the XML configuration file as the input
file. This action generates the scripts you deploy on the target servers.
• On the Environments page, choose an environment from the list, and click Export Environment .
Select whether you want the output XML file to contain all component configuration properties or just
the required component properties.
• Use the export mode of the dc_quick_deploy utility to generate an XML configuration file for a
specified environment.
Choose whether you want to generate a full (all configuration properties) or lean (only required
configuration properties) XML file.
As part of a strategy for creating Teamcenter environments, evaluate what the XML configuration file
requires. When specifying the exportType, you can choose Full or Lean.
Full
Includes all the application and component parameters for the environment.
Lean
For applications:
• Includes only top level applications that display in the Deployment Center application.
Does not include applications associated by default with a software selection, such as Teamcenter
Foundation and Active Workspace.
Does not include applications that are either automatically selected as dependent applications or
hidden in Deployment Center.
For components:
Includes only required properties for components, including properties that have a value
different from the default value.
After you update the XML configuration for your desired environment, use the the import mode of
the dc_quick_deploy utility to generate the scripts to create the environment from the input XML
configuration file.
The Teamcenter Deployment Reference Architecture contains sample Quick Deploy and
configuration files that you can review to learn more about the XML file structure.
Open the downloads page for Teamcenter 2406 and download the latest version of the
Teamcenter_Deployment_Reference_Architecture_version.zip file.
Also, see the Software Configuration Report for information that may be helpful in making updates to
the XML configuration file.
The following client components are supported for sharing from a Global infrastructure environment:
The following example defines a Global infrastructure environment. The infraTypeName tag designates
the environment as Global. The infrastructureType properties indicate a component belongs to a
Global environment and is therefore sharable. .
<infraType infraTypeName="GlobalEnvironment"/>
<quickDeploySoftware>
<software id="Foundation" version="2312.20231030.00"/>
</quickDeploySoftware>
<quickDeployApplications/>
<quickDeployClients>
<client id="fnd0_4tierrichclient" machineName="testingl"
massDeploy="false" platform="wntx64
<property id="fndO_compressWebResponse" value="true"/>
<property id="fnd0_4tierrichclient.massDeployCheck"
value="false"/>
<property id="fnd0_4tierrichclientInstallationPath"
value="C:\Program Files\Siemens\Teamcenter\
teamcenter root"/>
<property id="fnd0_4tierrichclient.appSupportedList"
value="selectedApps"/>
<property id="fnd0_4tierrichclient.infrastructureType"
value="GlobalEnvironment"/>
<property id="fndO_racRuntimeTempFolder" value=""/>
<property id="fnd0_4tierrichclientPortalViewerLicenseLevel"
value="Base"/>
<package id="fnd0_foundation"/>|
</client>
</quickDeployClients>
<quickDeployComponents/>
<removeQuickDeployApplications>
<package id="fnd0_foundation"/>
</removeQuickDeployApplications>
After configuring the Quick Deploy script for your Global infrastructure environment, you can deploy it
using the dc_quick_deploy utility.
You can similarly define a Local infrastructure environment in a Quick Deploy script like the following
example. Note the infrastructureType property that denotes the environment as a Local infrastructure.
imported properties denote components imported from a Global infrastructure environment.
Again, you can deploy your Local infrastructure environment using the dc_quick_deploy utility.
To deploy a Business Modeler IDE template package, obtain the directory of the template package output
generated by the Business Modeler IDE. Place the Business Modeler IDE output directory in the software
subdirectory of the Deployment Center repository.
template-internal-name_OS_template-version_build-version_YYYY_MM_DD_HH-MM-SS
An optional template version may be assigned by the Business Modeler IDE user to track the versions
of a template package. If the Business Modeler IDE user assigns a build number, the template is in
development. The build version tracks iterative testing before the template is ready for production.
Template versions and build versions are expressed as integers separated by periods, up to four
places.
• artifacts subdirectory
• dc_contributions subdirectory
Contains the template bundle information (called packages) for deployment by Deployment Center. If
you use TEM, this directory is ignored.
• tem_contributions subdirectory
Contains the template bundle information for deployment by TEM. If you use Deployment Center, this
directory is ignored.
• media_teamcenter_template-[Link] file
Provides the application names to both TEM and Deployment Center for deployment.
The Deployment Center repository displays Dependencies as specified within Business Modeler IDE
packages using package IDs.
For information on creating and updating Business Modeler IDE packages, refer to the Business Modeler
IDE documentation included with Teamcenter.