Common Tasks - How To List
Deployment Tasks
Q. How can I manage multiple Web Servers? Do I need to create one instance for each Server in the Solution?
Q. How can I perform installation on any selected Servers or components?
Q. Can I run installation in defined sequence?
Q. How can I configure a new Server?
Q. How can I install a application patch? Should I always create a new solution for each patch?
Q. How can I run a program file/script before solution designer build deployment package?
Q. How can I schedule installation?
Q. Is there any support for File Compression to make file transfer faster?
Q. Is there any quick way to setup binding with multiple computers?
Q. How do I rollback installation?
File Manager
Q. How can I define file dependencies as pre-requisites requirement for installation?
Q. What is a Custom File Action and how can I understand implementation behavior of various inbuilt action templates?
Q. Can I create multiple Custom File Actions for one file or one Action for multiple files?
Q. What are the System variables?
Q. What is the difference between normal Folder & Fixed Path Folder?
.Net Assembly Tasks
Q. How to install .Net Assembly in Global Assembly cache on Server side? Why 'Assembly Cache' folder always exists in the File Manager?
Q. How can I install/Uninstall Windows Service on Server side?
Q. How can I register/Unregister a Assembly or (COM+) Serviced Components on Server side?
Miscellaneous
Q. How can I set individual property or advance properties of (IIS) Web Server objects that are not available in property list?
Q. How can I manage server side Configuration files?
Q. What Scripting Platforms are supported?
Q. How can I trap errors raised by VBScripts on Server side?
Q. What is the use of Installation Checklist?
Q. What is the use of User Instruction?
Other References
Frequently Asked Questions
Online Tutorials
Common Issues
General Information
Deployment Tasks
How can I manage multiple Web Servers? Do I need to create one instance for each Server in the Solution?
A Server representation in a Solution is just logical grouping of one set of build components.
You may bind one Server Package with multiple machines by Server Binding interface in Installation Manager and
the same Server Package would be deployed across all mapped machines.
How can I perform installation on any selected Servers or components?
1) It is not mandatory to map binding of all Server packages with the network machines
and Installation can be run only for mapped Server Package(s). 2) Before starting the installation,
you may select only desired Servers on the Installation Board thus you may run partial Server Package(s) on selected machines.
Can I run installation in defined sequence?
No you cannot run installation in a defined sequence because once file copy operations and
access verification is completed, all Servers start installations in Parallel mode. However if there is a need
to run installation in a defined sequence then you may achieve same by running installation in multiple batches and
keeping few Servers selected in each batch. Please note that all Server Tasks & Custom File Actions are executed
in the user defined sequence.
How can I configure a new Server?
With Installation Manager interface you can quickly build a Server by just choosing the required
Server package(s) and the target machine. All respective Server Tasks and server contents are deployed on the selected
target without any additional efforts.
How can I install a application patch? Should I always create a new solution for each patch?
It's not really required to create a new Solution for deploying a patch but you need to carefully define
deployment instructions and Server tasks.
Scenario 1: You need to copy a few new files and update some existing files on a running server.
Solution: Open the complete solution and add new files into the respective Server & Folder Structure. If the source
location of updated files is not changed then updated files would be automatically picked on Solution Build but if
the updated files are stored at a new location then remove previous files from the Solution and add updated files.
Make sure that the 'Deployment Instruction' for all new/updated file(s) is set to 'Action: Synchronize file contents on the target environment'
or set to 'Action: Copy file if not pre-exist on target' in case there are only new files. When you run the installation, only new or updated
files would be transferred & copied on the target environment.
Scenario 2: You need to update application configuration settings in an existing environment.
Solution: If the earlier installation was not done using InstallAce then create a new solution and add the
configuration file into Solution by creating a new Server & Folder Structure. Please make sure that the
'Deployment Instruction' is set to 'Condition: File must pre-exist on target environment' so that the pre-existing configuration
file is not overwritten because few settings may have been ,modified post initial deployment, to match with production environment. With this
'Deployment Instruction', the Installation Manager will validate that the file is already existing on the target Server
and will also not replace the existing file. Still we need to add this file into Solution to resolve target location.
Once the configuration file has been added into the Solution, then open the 'Configuration Files Settings' window
and you will see the Configuration file in the files drop down. Add 'Configure XML Node' or 'Configure Attribute'
Configuration Task and set Task properties appropriately. Run the solution using Installation Manager and the Server
side file(s) would be updated as per defined configuration. Please refer to Online Tutorials
for better understanding of Configuration Tasks.
The only tricky part in a Patch Installation would be the execution of Server Tasks or Custom File
Actions. If there are any such Server Tasks or Custom File Actions defined in the Solution
that may damage the target environment, if run twice, then you need to ensure that the Server Tasks/Custom File Actions are deleted/disabled before running the Patch Installation. To ensure this, the application developer
can create Installation Checklist and mark such items mandatory for verification that would force support team to
mark each step verified, before they run the installation, otherwise Installation Manager would not allow to deploy the package.
The other alternative could be to create a separate Server Package that may only contain
the Server Tasks and at run time user may simply deselect such Server Package in whole and deploy rest of contents safely.
How can I run a program file/script before solution designer build deployment package?
Add the respective Script/Program into solution. Create a Custom File Action for the
respective file/script using "Execute File" Action Template and set 'WhenToTrigger' property to 'On Solution Build'.
The program file would be run before building the solution.
How can I schedule installation?
Schedule Installation option is available on the Installation Dashboard interface.
Is there any support for File Compression to make file transfer faster?
No. As of now build contents are not compressed but the Installation Manager maintains the
copy of build contents on server side and while copying build contents to the Server, only new or updated
files are retransferred to the server.
Is there any quick way to setup binding with multiple computers?
If any change have been made in the source deployment Package and you need to again bind all
Server Packages with the target machines, then you may quickly perform Server binding using Export-Import option.
Using the unique Server IDs as internally stored within the Solution file, Install Manager automatically map & suggest the Server mapping
with the target machines.
How do I rollback installation?
Installer Service maintains the backup of all files on server side that are replaced/updated during
installation. The Backup folder is created under temporary download directory as specified in the configuration file.
Rollback for other installation steps like Server Tasks or Custom File Actions are not supported.
File Manager
How can I define file dependencies as pre-requisites requirement for installation?
Set the 'Deployment Instruction' for respective file(s) to 'Condition: File must pre-exist on the target environment'
or 'Condition: File must not pre-exist on the target environment' and Installation Manager will ensure that pre-requisites are
met before making any change on any target environment.
What is a Custom File Action and how can I understand implementation behavior of various inbuilt action templates?
Custom File Action is a framework to define discrete behavior for any build file for that just copy operation
may not be sufficient. Most of Custom File actions are defined using command line tools supported by system/internal and
Windows Environment variables. An Action Template file is deployed along with setup that have pre-configured
settings for many common tasks like File execution on various stages, .NET Assembly installation/registration,
Windows Service Installation, COM+ deployment and batch files execution etc. The Action template is based on XML
therefore user can easily create new Action template for routine tasks as per system requirement. The path of
action template file is stored in the Configuration file. Detailed information for each pre-configured Action
template has been provided within the Solution Designer UI.
Can I create multiple Custom File Actions for one file or one Action for multiple files?
Yes you can easily define a Custom Action for multiple files in one go and you may also define
multiple actions for one file.
What are the System variables?
InstallAce exposes many internal variables to support Custom Action framework mainly to take care
of run time requirements on target environment that may not be known to the Solution designer. e.g.
%targetfilepath% variable can be used in Custom Action to define the location of file on Target environment that is not known
while solution is being build and the actual value is resolved at runtime. Similarly %utilpath% define the location
of command line tool that can be changed in the Installation Manager based on actual location of utility program
on the target environment or make it completely dynamic using Windows Environment variables.
What is the difference between normal Folder & Fixed Path Folder?
The actual location of non-Fixed folder is defined at the time of installation using
the Installation Manager that should be determined based on target environment while the Fixed Folder allows
the application developer to define constraint to copy selected build contents on a pre-defined location
that cannot be changed using Installation Manager.
.Net Assembly Tasks
How to install .Net Assembly in Global Assembly cache on Server side? Why 'Assembly Cache' folder always exists in the File Manager?
The files associated with the 'Assembly Cache' folder in File Manager are automatically installed
in the Global Assembly Cache on the target environment. Only .NET Strong name assembly can be added in the GAC folder
and a error is reported on compilation if a unsigned Assembly is found to be mapped to GAC folder.
You may also use the Custom File Action templates 'Install Assembly in GAC' & 'Un-install Assembly
from GAC' to install or uninstall .NET assemblies in the GAC folder. Because GAC is a special folder, therefore you should
set the deployment instruction to 'Copy file if not exist on Target environment' for such files so that an existing
file is not replaced on target environment until it's uninstalled first. You may create both actions, Uninstall &
then Install for such files.
How can I install/Uninstall Windows Service on Server side?
You can easily (un)install Windows Service using Custom File Action templates.
How can I register/Unregister a Assembly or (COM+) Serviced Components on Server side?
You can easily register or Un-register Assembly or Serviced Components using Custom File Action templates.
Miscellaneous
How can I set individual property or advance properties of
(IIS) Web Server objects that are not available in property list?
You may use the 'PropertySettings' attribute of Server Task to define list of
custom properties that are not included in the standard property list. The detailed description of contents format
has been provided as part of property description with in the Designer.
If you want Installer to only change a few/single property on IIS Server then define the desired property settings
in the 'PropertySettings' atttibute and set 'IgnoreIndividualSettings' to 'true'. If 'IgnoreIndividualSettings' is true
then Installer Service does not process the standard property list.
How can I manage server side Configuration files?
If the earlier installation was not done using InstallAce then create a new solution and
add the configuration file into Solution by creating a new Server & Folder Structure. Please make sure that
the 'Deployment Instruction' is set to 'Condition: File must pre-exist on target environment' so that the
pre-existing configuration file is not overwritten because few settings may have been ,modified post initial
deployment, to match with production environment. With this 'Deployment Instruction', the Installation Manager will
validate that the file is already existing on the target Server and will also not replace the existing file.
Still we need to add this file into Solution to resolve target location. Once the configuration file has been added
into the Solution, then open the 'Configuration Files Settings' window and you will see the Configuration file in
the files drop down. Add 'Configure XML Node' or 'Configure Attribute' Configuration Task and set Task properties
appropriately. Run the solution using Installation Manager and the Server side file(s) would be updated as per
defined configuration. Please refer to Online Tutorials for better understanding of Configuration Tasks.
What Scripting Platforms are supported?
VBScript & PowerShell Scripts can be executed using Server Tasks.
How can I trap errors raised by VBScripts on Server side?
Installation Manager capture the VBScript execution errors raised on Server side and
same are displayed within the Installation Manager dashboard.
What is the use of Installation Checklist?
Using Installation Checklist application developer can provide instructions to the support team
to help them in making pre-installation changes in the Solution contents and by marking critical steps as mandatory,
application developer can ensure that installation is not done until all settings have been verified.
What is the use of User Instruction?
Application developer can attach User Instructions with various contents to provide instructions
to the support team to help them in understanding & making pre-installation changes in the Solution contents.
Other References
Frequently Asked Questions
Online Tutorials
Common Issues
General Information
|