Publication Server Setup
Introduction
Smartsite iXperion Publication Server Setup utility (PubSetup_xxx.exe) can be used to update a Smartsite iXperion instance and its added modules to the stated version as well as to add modules to the targeted Smartsite instance. Note that this utility only takes into account one Smartsite instance at a time. Make sure that if a corresponding CMS Server Setup is available, this utility should also be installed once on each hosting server.
As soon as the setup is started, it will enumerate all available Smartsite instances by reading registry settings. When setup generates a fatal exception at this stage, this simply means some prerequisites are missing or incorrectly configured. An error message will appear stating the cause of the exception. E.g. Error: No Smartsite instances found. Please check registry. simply means that in the regsitry no Smartsite instances can be found. This may be caused by a misspelled registry setting, absence of Smartsite regsitry settings or simply absence of a Smartsite instance.
It is highly recommended to stop all web servers and any other processes that may keep Smartsite dll files and other files like DataEditor xmls, css, JavaScript and config files locked before continuing.
Actions
The Publication Server Setup may perform the following actions:
- Replacing the site binaries in WWW\Bin with corresponding versions
- Updating the site files (e.g. DataEditor xmls, css, JavScript and config files)
- Updating the site database
It is good practice to keep the option to create backup of the replaced files checked. This way the setup can manually be rolled back afterwards.
Furthermore, it is highly recommended (if not required) to make a backup of the existing site, especially the database. This way the setup can manually be undone by simply restore the database.
If it is desired to add site to start menu, simply leave this option checked. If this site is already added to the start menu, this option will have no effect.
On 64-bit operating systems, it is possible to install 32-bit binaries. However it is recommended (and the setup's default) to use 64-bit binaries for a 64-bit operating system.
When there may be a collision due to incompatible versions, the setup will say so. While successful completion of the setup is not guaranteed, it is possible to force the setup procedure anyway.
Skipping actions
It is possible to do a partial setup by skipping physical files or skipping database scripts. Be aware that skipping either action while invoking the other may result to an incomplete setup, thus corrupting the Smartsite instance!
Skipping site files and binaries update
To skip the update of site files and binaries, simply uncheck the option Update site files and site binaries. Note, however, that this feature does not have effect of site files involved with add-on modules, if any checked. The main advantage of this feature is rerunning this setup (if and only if already successfully completed once) while targeting only add-on modules or only database scripts. The only advantage here is gain of time since this utility is designed to be able to run multiple times while having effect only once.
Skipping database scripts
There are several reasons possible to skip database scripts during setup. Similar to skipping physical files, it's possible that the database scripts are already run on the corresponding databases. Although these scripts are designed to be able to run multiple times while having effect only once, it is possible to skip particular scripts by unchecking these in the popped up Database Window.
Another reason: Since a third party tool like SQLCMD for SQL Server or SQL*Plus for Oracle is required to execute the database scripts, this tool should be properly installed on the server where the Smartsite instance is hosted. However, if it is not possible (or not allowed) to install such a tool on the particular server, skipping the database scripts (in order to run them separately on the database server) is the only option. To do so, simply click Cancel after running the setup and showing the specific Database Script Window. Note that this window will not even show if the required database tool is not properly installed.
Generic info
The Publication Server Setup will show some generic information considering the chosen Smartsite instance, database, detected architecture, etc. Please check these before running the setup. Make sure that every setting is as expected and only click OK to continue if all prerequisites and settings are 100% correct.
Guidelines for running database scripts
It is strongly recommended to use the Publication Server Setup to run the database scripts for SQL Server as well as Oracle. Within this user interface, it is strongly recommended not to check or uncheck the suggested database scripts. Note that running "update" scripts to an older version of Smartsite may harm the Smartsite database.
When running database scripts manually, maintain the order of the script file names. Always run the update scripts first; preceding any add-on scripts. Some add-on scripts may have dependencies on other add-on scripts. In order to maintain the correct order of running add-on scripts, follow the guidelines of the corresponding add-ons.