Warning: The PC might reboot at any time during the silent installation, so the user should be sure to save work before starting a silent install.
Notes for the user:
1. It is required that the user should have the latest Windows updates installed before starting the ICONICS installation.
2. Please make sure there are no pending reboots before starting the ICONICS installation, e.g. users might try to consciously reboot their system before starting ICONICS installation.
3. Iconics installation installs the third party prerequisite installations, which might require a reboot to be fully installed. As ICONICS installation has a Configuration step, some of those third party prerequisites reboot requests cannot be postponed till the end of Iconics installation.
Therefore installation might perform a reboot, which might occur within first thirty minutes of ICONICS installation.
Description: How to install ICONICS products silently.
General Requirements:
Administrator privileges on the machine where the product will be installed.
Familiarity with the Windows command prompt.
Familiarity with the Windows registry editor, for the "registry modification" option.
Many ICONICS installations can be automated to install silently, without any dialog prompts. This can speed up the installation process when installing the product on many similar systems at a time.
This process is achieved by creating an answer file for the product installation. All necessary options for the installation are predefined in the answer file.
The answer file is an INI file that comes as a part of each ICONICS installation. The installation has to be copied on the disk and then the INI file can be customized. Then the user executes a command from command line that tells the installation to run without any user interaction, using the settings from the INI.
This document describes how a silent installation can be processed.
There are two methods to running the silent installation. One method is to copy the contents of the DVD or ISO file locally and modify the CustomSetup.ini file. The other is to make a local copy of the CustomSetup.ini file for modification and add a registry entry to specify the location of this file.
The two sections below describe the pre-installation steps for both methods. Users need to follow one section or the other, but not both.
1. Copy the CustomSetup.ini file from the ICONICS Suite, !. GENESIS64, or Hyper Historian DVD or ISO to a local location. The INI file can be found in the ICONICS_Suite subfolder. The local copy of the file may be renamed, if desired, but should retain the INI file extension.
2. Open the Registry Editor.
3. Browse to this key (create it if it does not exist):
HKEY_LOCAL_MACHINE\SOFTWARE\ICONICS\Installation
4. In the Installation key, create a new string value.
5. Name the value CustomSetupIniPath.
6. Edit the value. Set the Value data field to the path of your local CustomSetup.ini file. Example: C:\Users\MyUser\Desktop\MyFile.ini.
7. Modify your custom INI file according to the options explained in the "Silent Installation Parameters" section below.
Below is the list of all parameters supported by the silent installation. These parameters can be added into CustomSetup.ini and customized:
· SilentAcceptLicenseAgreement=1 – should automatically set that the user agrees with the license agreement
· Prompt=2 – 0 will not prompt, 1 will always prompt, 2 will prompt if Reporting Services are not installed with at least one local SQL Server
· Launch=0 – 0 will not launch the SQL Prerequisite, 1 will launch
· ShowProgress=1 – defines if the progress of the SQL Server installation will be visible (0 or 1)
· MinVersion=12 – Reserved, should not be modified. Do not change this value.
· Prompt=2 – 0 will not prompt, 1 will always prompt, 2 will prompt if Reporting Services are not installed with at least one local SQL Server
· Launch=0 – 0 will not launch the SSRS Prerequisite, 1 will launch
· ShowProgress=1 – defines if the progress of the SSRS installation will be visible (0 or 1)
· Prompt=2 – 0 will not prompt, 1 will always prompt, 2 will prompt if Reporting Services are not installed with at least one local SQL Server
· Launch=0 – 0 will not launch the SSMS Prerequisite, 1 will launch
· ShowProgress=1 – defines if the progress of the SSMS installation will be visible (0 or 1)
· MinVersion=12 – Reserved, should not be modified. Do not change this value.
· Rerun=0 – will set if the Prepare System utility was already executed, if it should be executed again
· ConfigureSystem=1 – enable/disable configuring the system (setting User, creating databases)
· InstallDirSkipIfExist=1 – enable/disable skipping the check of already existing installation directory. If another installation is already installed (i.e. installation target folder is already defined), current setup will quietly default to existing path
and will not consider this and an error (=1) or it will stop (=0).
· InstallDir= – sets installation directory
· UserValidateBeforeStart=0 – enable/disable validation of User before installation (if set this to 1, CheckSystem will try to validate your user and should provide feedback in log file and, if not silent mode, then in message-boxes)
· UserUseSavedValues=1 – tells the installation to use already used values in the installation (when set to 0, installation takes User credentials value from CustomSetup.ini file. When set to 1, installations take Username value from
<ProgramData>\ICONICS\IcoCustomSetup.ini, [User] block, saved by previous installation. Note: password is never saved and must be retyped in CustomSetup.ini, [Configuration], UserRetypePassword.)
· UserUseCurrentUser=1 – enable/disable usage of User who runs the installation (if there is no IcoCustomSetup.ini (first install) or if UserUseSavedValues=0 - then it will use currentUser (the one that runs the installation and Domain or Server,
to which user is logged in now))
· UserRetypePassword= – if using a saved user from IcoCustomSetup.ini or if UserUseCurrentUser=1, then retype password here.
· UserStopIfBad=1 – enable/disable the stopping of installation when User credentials are incorrect
· UserCreateNewUser=0 – enable/disable creating of new User
· NewUserDomainOrServerName= – sets Domain or Server Name for new User
· NewUserName=ICONICS_USER – sets name of New User
· NewUserPassword= – sets password of New User
· UserDomainOrServerName= – sets Domain or Server Name of already existing User
· UserName= – sets Name of already existing User
· UserGroup= – sets Group of already existing User
· UserPassword= – sets Password of existing User, if User is taken from Setup.ini
· UserUseMsa=0 – obsolete.
· SecMode=
· SecUser=
· SecUserPassword=
· AdvancedConfig=
· SqlValidateBeforeStart=0 – enable/disable the validation of SQL Server before installation (1 – validated by System Check, 0 – validated by installation dialogs)
· SqlUseSavedValues=1 – enable/disable preserving of already used values for SQL (when set to 0, installation takes Prefix, Samples, Overwrite, Use Unifies Database values from CustomSetup.ini file.
When set to 1, the installation takes these values: <ProgramData>\ICONICS\IcoCustomSetup.ini, [Sql] block, saved by previous installation. Note: password is never saved and has to be retyped in CustomSetup.ini, [Configuration], SqlRetypePassword.)
· SqlRetypePassword= – if use SQL credentials from IcoCustomSetup.ini, retype password here
· SqlStopIfBad=1 – enable/disable stopping of SQL Installation when User credentials are not correct
· SqlServer= – sets instance name of the SQL Server
· SqlWinAuthentication=1 – enable/disable usage of SQL (0) or Windows Authentication (1)
· SqlUser= – sets SQL Server user
· SqlPassword= – if use SQL from Setup.ini, sets password SQL Server user
· SqlMinVersion=12.00 – sets the oldest supported version of SQL
· UseSsrs=1 – enable/disable usage of SQL Reporting Services
· SsrsUrl= – sets URL of SQL Reporting Services
· Silent Mode=0 – enable/disable use of silent mode for SQL’s Configuration Wizard
· Samples=1 – enable/disable installation of sample SQL configurations
· Overwrite=0 – enable/disable overwriting of already existing SQL configurations
· ShouldUpgrade=1 – enable/disable automatic upgrade of ICONICS’ SQL databases
· DatabasePrefix= – sets prefix for SQL configuration databases
· UseUnifiedDatabase=1 – enable/disable usage of Unified Database
· UnifiedDatabaseName=IcoUnifiedConfig – sets name for Unified Database
· UseActiveDatabases=0 – enable/disable usage of Active Databases
· ConfigureWebHMI=1 – enable/disable WebDAV IIS extension
· CurrentVersion=10.96.0.0 – Reserved, should not be modified. Do not change this value.
· OemName=ICONICS – Reserved, should not be modified. Do not change this value.
· Versions= – Reserved, should not be modified. Do not change this value.
Note: Suite and Feature items are on by default, with the exceptions of HoloLens, TrendLogger and GenDemo. Set to 0 if the suite or feature should be turned off.
· Genesis64= – enable/disable GENESIS64 suite
· MHMI= – enable/disable MobileHMI suite
· MMX= – enable/disable AlarmWorX64 Multimedia suite
· CFSWorX= – enable/disable CFSWorX suite
· FacilityAnalytiX= – enable/disable FacilityAnalytiX suite
· QualityAnalytiX= – enable/disable QualityAnalytiX suite
· HyperHistorian= – enable/disable HyperHistorian suite
· Server= – enable/disable Server features
· PlatformServices= – enable/disable Platform Services features
· AppServers= – enable/disable Application Servers features
· AlarmLogger= – enable/disable AlarmWorX64 Logger feature
· AlarmServer= – enable/disable AlarmWorX64 Server feature
· AlertWorX= – enable/disable AlertWorX feature
· BACnet= – enable/disable BACnet feature
· BI= – enable/disable AnalytiX BI feature
· BridgeWorX= – enable/disable BridgeWorX feature
· BulkAssetConfig= – enable/disable Bulk Asset Configurator feature.
· CFSWorX= – enable/disable CFSWorX feature
· EnergyAnalytiX= – enable/disable Energy AnalytiX feature
· FacilityAnalytiX= – enable/disable Facility AnalytiX feature
· FacilityAnalytiX_SN= – sets serial number Facility AnalytiX library
· FDD= – enable/disable FDDWorX feature
· FwxNotification= – enable/disable FrameWorX Notification Point Manager
· GridWorX= – enable/disable GridWorX feature
· HHExp= – enable/disable Hyper Historian Express feature
· HoloLens=0 – enable/disable HoloLens support
· IoT= – enable/disable IoT feature
· MergeWorX= – enable/disable MergeWorX feature
· Modbus= – enable/disable Modbus feature
· N1= – enable/disable N1 feature
· ODataConnector= – enable/disable OData Connector feature for ReportWorX Express
· ProjectFiles= – enable/disable Project Files feature
· Recipes= – enable/disable Recipes feature
· ReportWorX= – enable/disable ReportWorX feature
· ScheduleWorX= – enable/disable ScheduleWorX feature
· SNMP= – enable/disable SNMP feature
· TriggerServer= – enable/disable Trigger Server feature
· TrendLogger= – enable/disable TrendWorX64 Logger feature
· VideoWorX= – enable/disable VideoWorX feature
· WebServices= – enable/disable WebServices feature
· Workflow= – enable/disable Workflow feature
· HyperHistorian= – enable/disable Hyper Historian feature
· HHExp= – enable/disable Hyper Historian Express feature
· HHF= – enable/disable Hyper Historian Full feature
· HHC= – enable/disable Hyper Historian Collector feature
· HHAC= – enable/disable Hyper Historian Assets feature
· HHDE= – enable/disable Hyper Historian Data Exporter feature
· HHSPC= – enable/disable Hyper Historian SPC feature
· MMX= – enable/disable AlarmWorX64 Multimedia feature
· Email= – enable/disable Email agent feature
· Fax= – enable/disable Fax agent feature
· Marquee= – enable/disable Marquee agent feature
· Marquee_IP= – sets IP for Marquee agent feature
· Pager= – enable/disable Pager agent feature
· PopUp= – enable/disable PopUp agent feature
· Skype= – enable/disable Skype agent feature
· Sound= – enable/disable Sound agent feature
· Telephony= – enable/disable Telephony agent feature
· Video= – enable/disable Video agent feature
· WebApps= – enable/disable Web Applications features
· WBD_Server= – enable/disable Workbench Server feature
· AnyGlass=- enable/disable AnyGlass feature
· WebAPI= – enable/disable Web API Service feature
· WebHMI_GWX= – enable/disable WebHMI Server for GraphWorX feature
· WebHMI_WBD= – enable/disable WebHMI Server for Workbench feature
· WebHMI_WBCL= – enable/disable WebHMI Server for AlarmWorX64 Multimedia Configurator feature
· Workbench_Server= – enable/disable Workbench Server feature
· RemoteExpert= – enable/disable RemoteExpert feature
· ConverterWorX= – enable/disable ConverterWorX feature
· Client= – enable/disable Client features
· ClientCommon= – enable/disable Client Common features
· GraphWorX= – enable/disable GraphWorX64 feature
· Gwx_Viewers= – enable/disable GraphWorX64 Controls features
· PhoneTemplates= – enable/disable Windows Phone Templates feature
· SymbolLibrary64= – enable/disable Symbol Library feature
· Templates= – enable/disable Templates features
· RwxExpress= – enable/disable ReportWorX Express feature
· WBD_Client= – enable/disable Workbench Client feature
· WebHMI_Client= – enable/disable WebHMI Client feature
· Workbench_Client= – enable/disable Workbench Client features
· GenDemo= – enable/disable GENDEMO64 feature
· Help=0 - enable/disable Help
· GenDemo=GenDemo – sets the OEM name for GenDemo installation feature
· Help=Help – sets the OEM name for Help installation feature
· MinOs=6.1 – The oldest supported operating system.
· ProcType=x64 – sets supported Processor type (x64 or x32)
· HomeEdition=0 – enable/disable use of a Home Edition operating system
· ServerOnly=0 – enable/disable use of non-server operating systems
· SkipErrors=0 – defines errors tolerance (0 – stop on Error, 1 – report, but continue in installation)
· DoLog=1 – enable/disable creating of installation log file
· LogFilePath= – sets path to the IcoPrepareSystem.log file. Default path is:
C:\Users\currentUser\AppData\Local\Temp\
Below is a sample CustomSetup.ini file:
;Iconics Suite
[General]
SilentAcceptLicenseAgreement=1
[SqlPrerequisite]
Prompt=2
Launch=0
ShowProgress=1
MinVersion=12
[SsrsPrerequisite]
Prompt=2
Launch=0
ShowProgress=1
[SsmsPrerequisite]
Prompt=2
Launch=0
ShowProgress=1
MinVersion=12
[PrepareSystem]
Rerun=0
[Configuration]
ConfigureSystem=1
InstallDirSkipIfExist=1
InstallDir=
UserValidateBeforeStart=0
UserUseSavedValues=1
UserUseCurrentUser=1
UserRetypePassword=
UserStopIfBad=1
UserCreateNewUser=0
NewUserDomainOrServerName=
NewUserName=ICONICS_USER
NewUserPassword=
UserDomainOrServerName=
UserName=
UserGroup=
UserPassword=
UserUseMsa=0
SqlValidateBeforeStart=0
SqlUseSavedValues=1
SqlRetypePassword=
SqlStopIfBad=1
SqlServer=(local)\SQLEXPRESS2017
SqlWinAuthentication=1
SqlUser=
SqlPassword=
SqlMinVersion=12.00
UseSsrs=1
SsrsUrl=
SilentMode=0
Samples=1
Overwrite=0
ShouldUpgrade=1
DatabasePrefix=
UseUnifiedDatabase=1
UnifiedDatabaseName=IcoUnifiedConfig
UseActiveDatabases=0
ConfigureWebHMI=1
[Upgrade]
CurrentVersion=10.96.0.0
OemName=ICONICS
Versions=
[SuiteOptions]
Genesis64=
MHMI=
MMX=
CFSWorX=
FacilityAnalytiX=
QualityAnalytiX=
HyperHistorian=
[Features]
Server=
PlatformServices=
AppServers=
AlarmLogger=
AlarmServer=
AlertWorX=
BACnet=
BI=
BridgeWorX=
BulkAssetConfig=
CFSWorX=
FacilityAnalytiX=
FacilityAnalytiX_SN=
FDD=
FwxNotification=
GenBroker=
GridWorX=
HoloLens=0
IoT=
MergeWorX=
Modbus=
N1=
ODataConnector=
ProjectFiles=
Recipes=
ReportWorX=
ScheduleWorX=
SNMP=
TriggerServer=
TrendLogger=
VideoWorX=
WebServices=
Workflow=
HyperHistorian=
HHExp=
HHF=
HHC=
HHAC=
HHDE=
HHSPC=
MMX=
Email=
Fax=
Marquee=
Marquee_IP=
Pager=
PopUp=
Skype=
Sound=
Telephony=
Video=
WebApps=
WBD_Server=
AnyGlass=
WebAPI=
WebHMI_GWX=
WebHMI_WBD=
WebHMI_WBCL=
Workbench_Server=
RemoteExpert=
ConverterWorX=
Client=
ClientCommon=
GraphWorX=
Gwx_Viewers=
PhoneTemplates=
SymbolLibrary64=
Templates=
RwxExpress=
WBD_Client=
WebHMI_Client=
Workbench_Client=
GenDemo=
Help=0
[InstNames]
GenDemo=GenDemo
Help=Help
[Platform]
MinOs=6.1
ProcType=x64
HomeEdition=0
ServerOnly=0
SkipErrors=0
[Log]
DoLog=1
LogFilePath=
1. Launch a command prompt with administrator privileges.
2. Use the cd command to change your directory to the ICONICS_Suite folder. If you used the "copy entire installation" method, make sure to go to the same folder where your modified CustomSetup.ini file is located, otherwise go to your installation media.
3. Execute this command to begin the silent installation:
setup.exe /s
Note: The silent installation will not report any feedback to the command prompt. Because the installation is a long process, it may appear as if nothing happening. Check log files for updates on the silent installation – see the next section for instructions.
If there was any issue which occurred during silent installation you can check the installation files located here by default:
C:\Users\currentUser\AppData\Local\Temp
· IcoPrepareSystem.log – log file which shows what happened during system preparation phase
· Iconics_Suite.txt – log file which shows how the silent installation went from the beginning to the end.
Note: The IcoPrepareSystem.log location can be modified using the [Log] LogFilePath INI entry.
Passwords stored in the INI file are not encrypted. If your INI file contained any passwords, ICONICS highly recommends deleting those configuration files cleanly from the computer to prevent unauthorized access.