pub.packages:installPackage
WmPublic. Installs a package that has been published to this server.
Input Parameters
packageFile | String Name of the distribution file that contains the package that you want to install. This file must reside in the server's inbound directory ( Integration Server_directory \instances\instance_name\replicate\inbound). When specifying packageFile, Do include the .zip extension in the file name. Do not include the directory path. For example: myPackageFileAug2001.zip |
activateOnInstall | String Flag that specifies whether you want Integration Server to automatically activate the package after it is installed. Set to: yes to activate the package after installation and make it immediately available to clients. This is the default. no to install the package without activating it afterwards. If you install a package in this mode, it will not be accessible until it is explicitly activated through the Integration Server Administrator or the pub.packages:activatePackage service. |
archiveOnInstall | String Optional. Flag that specifies whether you want Integration Server to archive the package automatically after it is installed. Set to: yes to archive the package after installation. If you choose to archive the package automatically, Integration Server moves the package from the Integration Server_directory \instances\ instance_name\replicate\inbound directory to the Integration Server_directory \instances\ instance_name\replicate\archive directory. This is the default. no to install the package without archiving it. |
Output Parameters
message | String Message from server. (This is the same message that is displayed when you install a package with the Integration Server Administrator.) |
Usage Notes
If the installed package replaces an existing package on the server, pub.packages:installPackage will automatically put a backup copy of the existing package in Integration Server_directory \instances\instance_name\replicate\salvage before it installs the new package.
This service will throw an exception if the file named in packageFile does not exist or cannot otherwise be installed correctly.
See Also