Running the suite installer
Use the installation wizard that guides you through the installation procedure.
 | To access the installation log during the installation, you can use the following shortcut key: CTRL-SHIFT-L. Windows Explorer opens, showing the current log file in the temp location of the computer, for example C:\Users\username\AppData\Local\Temp. |
Procedure
1. Start the Installer and click Next.
2. In the next screen, select the destination folder where you want to install Planon Software Suite and click Next.
If this is your first installation, the default installation folder location is displayed as C:\Planon. If previous versions are already present, the most recent installation folder location is selected by default.
The Destination directory field allows only the following characters and symbols:
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 - _ . \ and all lowercase counterparts.
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 - _ . \ and all lowercase counterparts.
3. In the next screen, select the components you want to install by selecting the appropriate check boxes and click Next.
You must run the installer once, for every installation you do separately. If you do not want to install the new software immediately but want to upgrade or check documentation first, we advise you to choose different destinations for the documentation, installation and the Suite database upgrade tool.
The following tables provides a brief description of these components:
Suite Database Upgrade Tool
Component | Description |
|---|---|
Suite Database Upgrade Tool | Select this option, when you perform an update of the Planon software, to upgrade your database. This will install the Suite Database Upgrade Tool in the location you have selected previously. After the installation of the upgrade tool, the tool can be executed to upgrade your database. Before installing the software, we recommend that you upgrade your database. You can install the upgrade tool separately. This will allow you to first do an upgrade and then, only if successful, do the software update. |
Install software - Application server
Component | Description |
|---|---|
Planon server business logic | Select this option if you want to install or upgrade the business logic of the Planon server. If you install a second application server, for example for clustering, the certificates and keystores for the trusted services, located in \Server\wildfly-*\standalone are automatically regenerated. However, you should use the same certificate and keystore combination on all application servers. The default certificate is valid for 3650 days, or approximately 10 years. After this time, the functionality will remain operational, only the validity of the certificate will expire. If you use the default certificate it will be replaced by a new version every installation update, to for come the expiration. Trusted services are automatically generated and the certificates are automatically loaded in the database on starting the application server. If you install and automatically start a second application server, the certificate will be overwritten. To prevent this from happening, clear the Start service check box in Step 14 not to automatically start the application server after installation. |
CAD Import | Select this option if you are using or want to use CAD import. If you run a lot of imports during working hours Planon provides the option to install CAD Import on a separate application server. To use the CAD Import, complete the configuration as described in the CAD Workbench document. |
Connect for Outlook | Select this option, if you are using or want to use Connect for Outlook. This will install the Connect for Outlook application server components in the installation directory. To use the Connect for Outlook for Outlook complete the configuration as described in the Administrator's Guide-Connect for Outlook. |
Scheduler | Select this option, if you want to install the Scheduler. To use the default scheduler, please complete the configuration steps described in The Scheduler. |
Install software - Web server
Component | Description | ||
|---|---|---|---|
Planon Web Client | Select this option to install or upgrade the ProCenter Web server components, such as: • Web Client • Planon Self-Service Web Client • Kiosk • Mobile | ||
Planon SOA Web Services and Planon Software Development Kit | Select this option, if you want to use or upgrade Web services. You can also select this option, if you want to connect through the Planon Software development kit API (SDK). | ||
Connect for Outlook | Select this option, if you are using or want to use Connect for Outlook. This will install the Connect for Outlook web server components in the installation directory. | ||
Agile Workplace Management – Planon reader | Select this option, if you want to install or upgrade the Agile Workplace Management solution. Planon recommends to install the AWM Data engine on a separate web server. Only for test environments it is allowed to run on the same server.
After completing the installation, some configuration steps are required. For more information, see the AWM Technical Reference. | ||
Tomcat for WebDAV | Select this option, if you want to install or upgrade a specific web server to be used for WebDAV. For additional information, see WebDAV server in the Administrator's Guide. |
Related components - Additional software
Component | Description |
|---|---|
Planon Connect for AutoCAD | Select this option, to get the Planon Connect for AutoCAD installer (PC4A). Ensure that you run the PC4A installer to complete the PC4A installation. |
Related components - Manual Installation Resources
Component | Decription |
|---|---|
Configuration files | Select this option, if you want to include a set of configuration files. These sample files can be configured to suit your specific installation configuration. The administrator guide options use these sample files. |
Planon Software Development Kit | Select this option, if you want to develop extensions to the Planon software. |
Tools | The tools and Reset supervisor password are available for installation. |
Language files | Select this option to get all available language files. |
4. Select or generate an access key.
The access key is used to encrypt and decrypt the passwords for the connections to external systems, such as WebDAV, Connect for AutoCAD, Connect for Calendars (C4C), default user passwords. (In general, the passwords the customer enters in the System Settings).
a. Generate new external access key?
If you do not yet have a key, use this option. For example the first Planon installation or an update to the version that introduces the key.
Please note that if you generate a new key, you must also update the passwords of external connections (WebDAV, email, etc.) in System Settings.
Make sure to save the generated access key in a secure location to use it later with other installations. After completing the installation the key can be found in:
..\(app)server\WildFly*\standalone\
..\Server\tomcat-*\
b. Please select the external access key
When you run an update installation - for a standard service pack installation, Tomcat or JDK update, or major update installation - the field is prefilled with the key that is available on the system.
The field is empty if a key cannot be found, in which case you can browse to provide the key you stored in the secure location.
| | If you install a second application server, for example for clustering, you need to provide the same access key. |
5. Select the database platform and authentication you want to use and click Next.
6. Enter the database configuration settings.
If unaltered or cleared, the Min pool size and Max pool size take the default values of 10 and 30 respectively.
The exchange functionality will make heavy use of concurrent sessions. To support this, a higher minimal database poolsize is required to avoid problems creating many database connections at once.
| | The recommended minimal poolsize is 20. The <max-pool-size> must at least be equal to the <min-pool-size> |
If Oracle is selected as database platform, you have to select the Oracle version used for Planon. The installer needs this information to install the proper driver for Planon. You can use the Check connection button to connect to the database and to automatically select the driver.
For additional (manual) configuration steps, see Database configuration.
7. Enter the encoded license key in the License code area. Click Next.
The license key is written to a file called License.lic and is placed in:
\Server\wildfly-*\standalone\configuration
Note that the license will be sent to you through mail from Planon Customer Support.
 | If the license key is not correct, you will not be allowed to log on to Planon Software Suite. |
If you do not have a license key yet, you can temporarily proceed by selecting the Continue installation without license key check box. This will allow you to complete the installation.
After receiving the license key from Planon, open the license key file and paste the newly received key in the License.lic.
If you paste the license key along with the prefix and suffix markers appended to the license key [EE License key- BEGIN] <license key> [EE License key -END], these markers are removed and the license key is then stored in the database. You need to restart the application server to pick-up the license key if you already did a test login.
| | If any other markers are used or if any changes are made to the above mentioned markers, the license is rendered invalid and is not stored in the database when the first user logs on to the application. |
| | For more information on licensing, see Licensing. |
After entering the license key and clicking Next the installer will perform a port set availability check.
8. To secure the JBoss CLI and HTTP management interface of the application server, a new management user will be added. Enter the credentials for this user. By default, both interfaces only allow access from the localhost.
9. In the next screen, select the port set you want to use.
There are 30 port sets available. The first available port set is selected by default. Click Next.
10. Enter the application server hostname and click Next.
11. Specify user name and password for the Planon web service client administration module.
The Planon SOA Web Services client administration module can be accessed through http://<hostname>:<portnumber>/nyx/.
The same user name and password can be used to log into the Administration Module.
The Planon SOA Web Services client administration module can be accessed through http://<hostname>:<portnumber>/nyx/.
The same user name and password can be used to log into the Administration Module.
The hostname in the URL string should be replaced with the hostname of the Web Server installation machine. The port number is the port number on which the Planon Web Client runs.
12. Enable clustering; if you run multiple application servers, clustering must be enabled for each application server. The application servers will be registered in the database as part of the cluster, which enables communication between the servers.
If clustering is enabled, port 7600 is used to communicate between the application servers.
If you are using the same machine for installing the application servers, you need to offset the ports (for example: 7600 and 7601). If you install the application servers on separate machines, you can use the default port number 7600.
| | Make sure the application servers are allowed to communicate via these ports. |
Fill in the host that other Planon instances can use to connect to this instance:
◦ If you have multiple Planon instances on one machine, you can enter 'localhost' or '127.0.0.1’.
◦ If you have Planon instances on separate machines but on the same network, you can fill in the internal ipv4 address or an internal network host name.
To find the internal ipv4 address, you can open a command prompt, type 'ipconfig', and then copy the ipv4 address in the LAN section (usually it starts with 192).
◦ If you have Planon instances on separate machines and separate networks, you can connect over the internet with a public host or IP address.
| | There is a way to check whether you are actually setup and running in a cluster correctly. The application server logs should indicate a line that starts with Received new, either: 'Received new clusters view' or 'Received new, MERGED cluster view'. |
Example
Received new, MERGED cluster view for channel ejb: MergeView::[wildfly-1|1] (2) [wildfly-1, wildfly-0], 2 subgroups: [wildfly-1|0] (1) [wildfly-1], [wildfly-0|0] (1) [wildfly-0]
The number in parenthesis, such as (2), indicates the number of nodes in the cluster.
If you see a (1) in parenthesis and no other log line later,this indicates that the Planon instance has not found the other Planon instances, and something must be wrong with the configuration, environment, or deployment:
Received new cluster view for channel ejb: [wildfly-1|0] (1) [wildfly-1]
| | • On-premise customers wo have installed a WildFly cluster must ensure that the JGROUPSPING table is emptied when a database is copied from one environment to another. This needs to be done - for example - to prevent the ACC environment connecting to the Prod environment. • For Cloud, this is done automatically when restoring Production to ACC, TEST or DEV, or ACC to TEST etc. |
13. In the next screen you can configure secure communication.
If configured the application will communicate via HTTPS. HTTP communication will be disabled.
14. In the next screen, enter the application server service name and Web server service name and click Next.
In Planon Software Suite, servers are registered as services in Windows. When entering the Application server service name, ensure the name is unique, if other application servers will be running as a service on the same system. If the service name matches any existing service name, the current installation may overwrite the previously installed service or the application may not be installed. The service name you enter in this screen will be prefixed with PlanonApplicationServer.
The service will also be suffixed with _ID<generated number>. This number is based on the version of the Planon Software Suite used for the installation. If a web server service or an application server service is reinstalled during an update, the suffix is updated to a new unique number.
| | Clearing the Start service check box prevents the application server from starting automatically after the installation is complete. This is recommended if you are installing a second application server and do not want the certificate of the first installation to be overwritten. |
15. Select the required Planon Software Suite Client shortcut that must be installed and provide a unique name. Click Next.
16. Select the directory which contains the certificates (*.crt, *.cer, *.der, *.pem) you want to import into the trust store and click Next.
The certificates are copied into the ..install4j/customercertificates directory and used during the installation. The certificates are only imported, if you are executing one of the following installations:
◦ New full installation
◦ New Java service pack installation
Select a new directory containing certificates, only if you want to:
◦ Include certificates and did not do this with a previous installation
◦ Introduce new certificate files in the installation (..install4j/customercertificates). They will be added next to the existing ones.
If you want to remove certificates, remove them manually from the .install4j/customercertificates directory and also from the trust store if needed. Check Updating Cacerts, to see whether you need to perform an intermediate update of certificates in the trust store (no full install, or new JDK installation).
17. The WebDAV configuration screen is displayed, if you selected Tomcat for WebDAV.
Enter the WebDAV settings:
◦ WebDAV location: This location will contain your files and a folder called WEB-INF. The WEB-INF folder will not be visible for the your users. The WebDAV location cannot be inside the installation location.
◦ WebDAV credentials: User name and password that will be used for securing the WebDAV location with BASIC authentication. After installation, you still need to configure these WebDAV settings in the System settings > WebDAV settings.
| | For more information, see WebDAV (System settings). |
18. Check if the settings are correct and click Start to start the installation.
19. The next screen displays the installation in progress. The process creates the entire folder structure and copies the files into it. It also creates the database connection and configures the application server and web server and registers them as Services.
After the installation, you can find an installation summary containing your port set selection in the following location:
.install4j\installation_summary.txt
.install4j\installation_summary.txt
20. Click Finish. The installation process is now complete. Planon Software Suite is installed on your computer. The version of the Suite Installer is logged in the serverboot.log on start up of the application server. Search for the string “Installation history:”