AB Suite System Deployment Utility (DeployPackage.exe)

The Deployment command line utility allows you to deploy an AB Suite generated package to a local or remote server. This enables you to

Install an MSI package containing a system and/or report to a server
Install a CAB package containing a single report to a server

Refer to Transferring a System for more information on how to deploy an application to a Runtime machine.

This utility is automatically installed with Agile Business Suite Runtime and is located in the AB Suite 7.0 installation directory. You can invoke the utility directly from a command line.

Note: You must have local administrator privileges to use the DeployPackage.exe

To run Deploy.exe from a command line

Point to the bottom-left corner of the screen to enable the Start icon, right-click Start, and then click Run.
Type cmd in the Run dialog box and press Enter to open a Command Prompt.
In the command prompt, change the working directory to the /bin64 folder of the AB Suite 7.0 installation directory.
```
cd C:\Program Files\Unisys\AB Suite 7.0\Bin64
```

Type "DeployPackage.exe / ". This displays the complete usage of the utility.

The command line syntax of AB Suite system deployment utility is

Deploy /L <DeployPackagePath> /U <UserName>
/P <Password> [/DN <DeploymentName>] [/PC <true|false>]

[/RDB <true|false>] [/BDB <true|false>] [/TSN <TargetServerName>] [/TDBR < TargetDatabaseRegistration>] [/TDBN <TargetDatabaseName>] [/TP <TargetPath>] [/TW <TargetWinformPath>] [/ ]

Parameters

Argument	Description
/L <DeployPackagePath>	Specifies the MSI package or CAB files to be deployed along with the complete path. You should specify the absolute file path. *Notes:* This argument is mandatory. If you do not pass any option with this argument, the error message "Error: Missing value for required parameter/s: DeployPackagePath" appears. If you provide an incorrect value or enter spaces as a value for this argument, an error message specifying that the package file cannot be found along with the package file location appears. You can also provide the MSI package name within double quotes. For example: If you try to deploy an AB Suite system with the corresponding Application User account details without providing the deploy package path, you receive an error message. DeployPackage /U Appuser /P Password
/U <UserName>	Specifies the name of the user account that is defined as the Application User. You can provide the user name as Domain\user for a remote server or a period (.) as the domain if the target is the local server. *Notes:* This argument is mandatory. If you do not pass any option with this argument, the error message "Error: Missing value for required parameter/s: UserName" appears. If you pass an incorrect user account name, the error message "UserName/Password details are incorrect" appears. For example: When you deploy an MSI package to a local server without specifying the Application User details, an error message appears. DeployPackage /L C:\TEMP\stagingarea\sampapi.msi /P Password To deploy an MSI package to a remote server by specifying the domain name, type DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Unisys\ Appuser /P Password
/P <Password>	Specifies the password for the Application User. *Notes:* This argument is mandatory. If you do not pass any option with this argument, the error message "Error: Missing value for required parameter/s: Password" appears.
/DN <DeploymentName>	Specifies the folder on the target machine in which the package (MSI or CAB) is saved. The default value is the current package name.
/PC <true\|false>	You can set the argument Deploy Progress Callback to true to receive the progress messages and vice versa. The default value is true. *Note:* If you set this argument to false , you will not receive any progress messages. For example: Deploying an MSI package to a local server by setting the /PC argument to false does not return any progress message. DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Appuser /P Password /PC false
/RDB <true\|false>	You can set this argument to "true" to retain the existing database when redeploying to the local machine. The default value is true. If this argument is false, the existing database is cleared. For example: To clear an existing application database while redeploying to a local server, type DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Appuser / P Password /RDB false
/BDB <true\|false>	You can set this argument to true to have a backup of the existing database. The default value is false. *Note:* Since reorganizing a large database might take time depending on the size of a database, ensure that you back up the database before reorganizing it. For example: To back up a database while deploying an MSI package to a local server, type DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Appuser / P Password /BDB true
/TSN <TargetServerName>	Specifies the name of the Runtime server to which you want to deploy. The default value is "localhost", which redeploys to the local server. *Note:* If you do not pass any value for this argument, the package is deployed to the local server.
/TDBR <TargetDatabaseRegistration>	Specifies the name of the database server registration of the local or remote server to which you want to deploy. *Note:* If target database registration is not provided, the utility uses the built-in values. For example: To deploy an MSI package to a specified target database server registration, type DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Appuser /P Password /TDBR UNIREG
/TDBN <TargetDatabaseName>	Specifies the name of the database of the local or remote server to which you want to deploy. *Note:* If you do not pass any value for this argument, the utility uses the built-in values. For example, to deploy an MSI package to a specified target database, type: DeployPackage /L C:\TEMP\stagingarea\NGENSampleDeploy.msi /U Appuser / P Password /TDBN UNIDB
/TP <TargetPath>	Specifies the path of the folder in which the deployed application files are stored. If you do not provide any value for this argument, the utility uses the path defined when the package was originally built.
/TW <TargetWinformPath>	Specifies the path of the folder in which the Winform files should be stored. If you do not provide any value for this argument, the path defined when the package was originally built is used.
/?	Displays the command syntax and arguments of the utility. If specified, a usage message appears and the utility exits without starting the deployment process.

Troubleshooting Error Messages

If database server registration does not exist on the target server, an error message specifying that the Database Server Registration does not exist appears along with the database server name.
If database does not exist on the target server, an error message specifying that the Database does not exist appears along with the database name.
If you provide incorrect option for an argument, an error message specifying that the argument is invalid appears along with the usage of the utility, for reference.
If you pass an incorrect command, the error message "Invalid input specified" appears.
If you pass an incorrect argument, an error message specifying that the input is invalid appears, along with the argument and the usage of the utility, for reference.
If you pass duplicate arguments, the error message "Encountered duplicate arguments. Please address the duplicates before proceeding" appears.
If you pass valid arguments to run the utility, the message "Operation Completed successfully" appears.
If any failure is detected, the error message "Operation Completed with errors" appears.

Example

The following command deploys an MSI package for Appuser.

DeployPackage /L C:\TEMP\stagingarea\sampapi.msi /U Appuser /P Password