Professional Documents
Culture Documents
Table of Contents
Introduction
Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Preparing to install
CityEngine 2022.0 system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
License Manager
About the License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installing the License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installing CityEngine
Installation overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installing CityEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Installing a localized CityEngine setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Installing CityEngine silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Authorizing your software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
The CityEngine Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Uninstalling CityEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Reference
Copyright Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Introduction
Preparing to install
CityEngine is only supported on Linux x86_64, on CPUs that adhere to the x86_64 architecture (64 bit), with
supported Linux releases.
Machines with an underscore (_) in the name are not supported. The setup does not proceed if an underscore is
detected in the machine name.
You cannot install the software as a root user.
Prior and future updates or service packs for these operating system versions are supported unless otherwise
stated. The operating system version and updates must be supported by the operating system provider.
Hardware requirements
Supported
2 GHz dual-core CPU minimum (at least Core2 Duo
CPU speed
compatible Intel/AMD)
Memory/RAM 16 GB
Disk space 2 GB or more
Supported
Networking hardware A network adapter is required.
Software requirements
Description
Unreal exporter—To enable the Unreal exporter, install
the Epic Games Launcher from www.unrealengine.com.
Windows To run Unreal exports without running the Unreal app,
download prerequisite installers from Epic at
https://www.unrealengine.com/en-US/datasmith/
plugins. Search for "prerequisite dependencies".
• Package redhat-lsb
Linux • Package libXScrnSaver
• Package libpng12
License Manager
Note:
• The current ArcGIS License Manager can only serve CityEngine 2012 and later as well as ArcGIS 10.x and 9.x
installations. For existing ArcGIS 8.x installations, continue using the 8.x ArcGIS License Manager as it can coexist
with the current ArcGIS License Manager.
• If you have an existing License Manager that is prior to ArcGIS License Manager, you must uninstall the existing
License Manager and install the ArcGIS License Manager for ArcGIS 10.x installations to access.
• The ArcGIS License Manager supports all ArcGIS Desktop and ArcInfo Workstation 10.x and 9.x releases, ArcGIS
Engine 10.x, and CityEngine 2012 and later releases.
5. Once you have completed the License Manager installation, you can use the ArcGIS License Server Administrator
to authorize licenses for the License Manager.
6. Click Authorization in the table of contents and click the Authorize Now button to launch the Software
Authorization Wizard.
7. Follow the instructions on the dialog box to complete the authorization process.
8. Click Finish to close the wizard and return to License Server Administrator.
Once you have completed the License Manager installation, you can supply the License Manager information to
those users installing CityEngine. They can browse to this network License Manager when prompted for the License
Manager machine after their CityEngine installation.
For more information about using or troubleshooting the License Manager, see the License Manager Reference
Guide included with your installation of License Manager.
Installing CityEngine
Installation overview
The CityEngine installation requires the user to be a system administrator or have elevated privileges in a
deployment environment.
The installation procedure includes the following steps:
Licensing types
• Concurrent Use Licensing—consumes licenses from a shared License Manager (separate server).
• Single Use Licensing—locks the license to the machine on which CityEngine is installed.
• Named User Licensing—allows CityEngine to use licenses saved to your ArcGIS Online or ArcGIS Enterprise
Organization.
Note:
Windows Installer 5.0 (minimum) is required for the CityEngine setup. If you are installing by using setup.msi
directly, you must have at least Windows Installer 5.0 on the target machine. It is recommended that you use
setup.exe to install CityEngine when possible.
More information on Windows Installer can be found in the Windows Installer Software Development Kit (SDK)
which can be found at the Microsoft website.
The setup.msi installer package can be used to deploy CityEngine in Windows Installer-supported environments
such as Active Directory and Microsoft System Management Server. See Installing CityEngine silently for information
on command-line options for installing CityEngine. A deployment white paper is available on the Esri Support
website.
Installing CityEngine
The steps below will guide you through the CityEngine 2022.0 installation process.
Note:
The CityEngine install display activity will begin within a few minutes of starting the Setup. The setup process installs
all the necessary prerequisites before CityEngine begins the install. During this time, you won't see any visible
installation activity on-screen. This wait time is normal behavior and depends on the number of prerequisites
needed to be installed.
Case
Parameter Value Required Description
sensitive
CityEngine installation location. If not specified, the
INSTALLDIR No No installation location is %System Drive%\Program
Files\ArcGIS\CityEngine<Version>.
Examples
Setup.exe /qb ACCEPTEULA=yes INSTALLDIR="C:\CityEngine" ESRI_LICENSE_HOST="27000@myLMServer"
Note:
The/qb parameter provides a basic UI of progress status and error handling; /qn provides no UI at all.
The CityEngine 2022.0 Administrator assists you in configuring CityEngine. There are three license types to choose
from: Concurrent Use, Single Use, and Named User.
License types
Concurrent Use
To use CityEngine 2022.0 with the "Concurrent Use" license type, you must have ArcGIS License Manager 2022.0
installed and authorized with a CityEngine 2020-2022 "Concurrent Use" license.
You can upgrade an older ArcGIS License Manager in-place, that was previously authorized with CityEngine 2021
"Concurrent Use" licenses, to ArcGIS License Manager 2022.0 The old ArcGIS License Manager immediately
supports CityEngine 2022.0.
1. Select CityEngine Concurrent Use.
2. Under License Manager, set the license manager to the ArcGIS License Server (port and URL) defined by your
administrator in ArcGIS License Manager. Once the license manager is defined for concurrent-use products, the
application is ready to use. To install and authorize ArcGIS License Manager, see the License Manager Reference
Guide.
Note:
Certain environments where there is higher than normal latency between the client Esri software and the ArcGIS
License Manager may experience odd behavior when using concurrent use authorization. This odd behavior can
manifest itself as the ArcGIS Administrator incorrectly reporting your ArcGIS License Manager as being invalid, or
the client Esri software failing to authorize. A work around for these issues is to set an environment variable called
FLEXLM_TIMEOUT to a reasonable value such as 10000000 (10 seconds). This environment variable will increase the
maximum allowed latency between the client Esri software and the ArcGIS License Manager. For more information,
you can visit https://support.esri.com/technical-article/000013086.
Single Use
Single Use products require authorization for use on individual machines. You will need the authorization codes
sent from Esri Customer Service to the contact email address referenced in the sales order during the authorization
process. This email includes the authorization codes issued for each license in the order. In addition to finding the
information in the email, if you already have an Esri Global Account, you can log in to the Esri Customer Care site,
click on Authorization & Provisioning, then click on a product name to obtain its authorization code. If you do not
yet have an Esri Global Account, you can create one at My Esri and click on Create Account. You will receive an
email confirmation and have access to Authorization & Provisioning on the Customer Care site.
For CityEngine Single Use, the authorization code starts with the letters ESU or EVA, followed by nine numeric digits,
for example, ESU123456789. The following steps are based on the ArcGIS Administrator Wizard image provided
above to complete the Single Use product authorization. (Contact information can be found at www.esri.com/
about-esri/contact.)
1. Select one of the two single-use products.
2. Click Authorize Now to launch the Software Authorization Wizard.
The wizard will walk you through the online or offline authorization process.
Named User
Named User Licensing (NUL) allows CityEngine to use licenses saved to your ArcGIS or Enterprise Organization. To
use NUL sign in, select the CityEngine Named User option from the CityEngine Administrator. Click OK to close the
CityEngine Administrator. Start CityEngine 2022.0, you will be prompted to provide the credentials to your ArcGIS
Online or ArcGIS Enterprise account. Click Sign in to complete the sign in, and CityEngine launches using that user's
named user license. Check Sign me in automatically to have CityEngine open automatically without the sign in
prompt the next time you open it.
Online authorization
With online authorization, the Software Authorization Wizard connects directly to the Esri authorization site using
Secure Sockets Layer (SSL) from the deployed machine. Online authorization can be used if the machine on which
the software has been installed is connected to the Internet and is able to connect to service.esri.com. Online
authorization can be performed by directly entering the authorization code in the Software Authorization Wizard
or by creating a provisioning file (.prvc) at My Esri.
Offline authorization
Offline authorization is used if the machine where CityEngine is installed does not have Internet connectivity. In this
case, the authorization process creates a text file that can be uploaded to the Esri authorization server from an
Internet-connected machine or can be sent in an email to Esri Customer Service to obtain an authorization response
file (.respc). This authorization response file can be copied to the machine where CityEngine is installed and used
to authorize CityEngine without a direct Internet connection.
Select this option if you have a provisioning file created from Esri Customer Care.
Select the appropriate option and click Next.
2. In the Authorization Method dialog box shown below, select the authorization method you want to use (online
or offline authorization, or single-use licensing from a local license server).
3. Provide your contact information and details in the next two dialog boxes. If you are using a provisioning file,
this information will be automatically populated from the file.
4. Enter your CityEngine authorization code starting with ESU or EVA followed by nine digits.
5. Depending on the type of authorization process selected, follow the appropriate process below.
• Online Authorization
Use the online authorization and click Next to connect to the Esri activation site. Upon completion, you will
receive a message that authorization is successful and the applications will be ready for use.
• Offline Authorization
Follow these remaining steps to complete the offline authorization process.
• You will be requested to save your authorization information to disk as a file named authorize.txt. Then
you can do one of the following:
▪ Option #1 (via secure site authorization) - Log in at the activation secure site
(https://my.esri.com/#/activations/secure-site) and follow the provided steps to be able to download a
response (*.respc) file.
▪ Option #2 (via email) - Send the authorization file, de-authorization file, or repair file as an attachment
to authorize@esri.com and a response file will be returned as an attachment (*.respc file).
• After receiving the response file, start CityEngine 2022.0 Administrator from Start > All Programs >
ArcGIS > CityEngine 2022.0 > CityEngine 2022.0 Administrator to complete the authorization process.
• In CityEngine 2022.0 Administrator, click the CityEngine folder, select the appropriate single-use
product, and click Authorize Now.
• In the Authorization Options dialog box of the Software Authorization Wizard, select the option I have
received an authorization file from Esri and am now ready to finish the authorization process and
browse to the authorization response (*.respc) file received in step 1.
• Click Next so the application will be authorized and ready for use.
Note:
Although you can switch the product type for concurrent use, a license for that product must be present and
available for the applications to open and function.
The CityEngine 2022.0 Administrator Wizard is only launched the first time you install CityEngine. After you have
completed the CityEngine 2022.0 Administrator Wizard, you can access the CityEngine CityEngine 2022.0
Administrator by clicking Start > Programs > ArcGIS > CityEngine 2022.0 > CityEngine 2022.0 Administrator.
Note:
Certain environments where there is higher than normal latency between the client Esri software and the ArcGIS
License Manager may experience odd behavior when using concurrent use authorization. This odd behavior can
manifest itself as the ArcGIS Administrator incorrectly reporting your ArcGIS License Manager as being invalid, or
the client Esri software failing to authorize. A work around for these issues is to set an environment variable called
FLEXLM_TIMEOUT to a reasonable value such as 10000000 (10 seconds). This environment variable will increase the
maximum allowed latency between the client Esri software and the ArcGIS License Manager. For more information,
you can visit https://support.esri.com/technical-article/000013086.
Note:
If you do not have the proper permissions, the CityEngine CityEngine 2022.0 Administrator will not allow you to
change product types or the license manager. Create and delete permissions are required for the following registry
hives to change seat type and license manager:
• HKEY_CLASSES_ROOT\CLSID
• HKEY_LOCAL_MACHINE\SOFTWARE\ESRI
Refer to Knowledge Base article 17970 for more information.
Uninstalling CityEngine
Uninstalling CityEngine
The CityEngine components can be easily uninstalled. Selecting CityEngine 2022.0 from the Add/Remove
Programs or Programs and Features dialog box provides the option to Uninstall or Change the program.
For example, to uninstall CityEngine 2022.0 silently, use the following command line:
msiexec.exe /x {79CFEB76-70C1-4993-80A3-6D052080D872} /qb
Reference
Copyright Information
Copyright © 1995-2022 Esri. All rights reserved. Published in the United States of America.
The information contained in this document is subject to change without notice.
You may have received Products or Services that include Graph Editor Toolkit, Copyright © 1992-1999 Tom Sawyer
Software, Berkeley, California, All Rights Reserved, and Tom Sawyer Visualization, Ver. 8.0 Copyright © 1992-2009
Tom Sawyer Software, Berkeley, California, All Rights Reserved.
Portions of this computer program are Copyright © 1995-2016 Celartem, Inc., dba Extensis. All rights reserved.
This application supports the ECW data format and ECWP compression protocols. Portions of this computer
program are Copyright © 2007-2015 Intergraph Corporation. All rights reserved. Creating compressed files using
ECW technology is protected by one or more of U.S. Patent No. 6,201,897, No. 6,442,298, and No. 6,633,688.
PANTONE® Colors displayed in the software application or in the user documentation may not match PANTONE-
identified standards. Consult current PANTONE Color Publications for accurate color. PANTONE® and other
Pantone trademarks are the property of Pantone LLC. © Pantone LLC, 2020. Pantone is the copyright owner of color
data and/or software which are licensed to Esri to distribute for use only in combination with the ArcGIS family of
Products. PANTONE Color Data and/or Software shall not be copied onto another disk or into memory unless as
part of the execution of the ArcGIS family of Products.
EXPORT NOTICE
Use of these Materials is subject to U.S. export control laws and regulations, including the U.S. Department of
Commerce Export Administration Regulations (EAR). Diversion of these Materials contrary to U.S. law is prohibited.
US GOVERNMENT CUSTOMER
The Products are commercial items, developed at private expense, provided to Customer under this Master
Agreement. If Customer is a US government entity or US government contractor, Esri licenses or provides
subscriptions to Customer in accordance with this Master Agreement under FAR Subparts 12.211/12.212 or DFARS
Subpart 227.7202. Esri Data and Online Services are licensed or subscribed under the same DFARS Subpart
227.7202 policy as commercial computer software for acquisitions made under DFARS. Products are subject to
restrictions, and this Master Agreement strictly governs Customer's use, modification, performance, reproduction,
release, display, or disclosure of Products. Agreement provisions that are inconsistent with federal law regulation
will not apply. A US government Customer may transfer Software to any of its facilities to which it transfers the
computer(s) on which it has installed such Software. If any court, arbitrator, or board holds that a US government
Customer has greater rights to any portion of the Products under applicable public procurement law, such rights
will extend only to the portions affected. Online Services are FedRAMP Tailored-Low authorized but do not meet
higher security requirements, including those found in DFARS 252.239-7010.
Esri Trademarks
Esri Products or Services referenced in this work are trademarks, service marks, or registered marks of Esri in the
United States, the European Community, or certain other jurisdictions. To learn more about Esri marks, go to the Esri
Product Naming Guide (https://links.esri.com/product-naming-guide).
Licensed Trademarks
Other companies and products or services mentioned herein may be trademarks, service marks, or registered marks
of their respective mark owners.
The Kubernetes ship's wheel logo is a registered trademark of the Linux Foundation.
Trademark Images
Logos of licensed trademarks include the following:
OGC
®