Use the command-line options
Using this feature, you can execute a deployment package by running a script that contains command-line deployment options or a reference to a configuration file of deployment options.
- Log on to the computer where the InForm server software is installed.
- Open a Microsoft Windows command window.
- Do one of the following:
- In the directory where the deployment package is saved, run the PKGInst.exe executable, along with the desired deployment options.
- Execute a script that contains the desired deployment options.
- Execute a script that refers to an XML configuration file containing the desired deployment options.
Deployment command-line options
The usage for the deployment command-line feature is as follows:
/help |
/testconversion | /testc |
/silent [/ConfigFile filename] |
[[/LogFileName filename][/UnpackDirectory directoryname][/ForceBASEInstall (TRUE | FALSE)][/CheckInFormVersion (TRUE | FALSE)][/DontExitIfUnsuccessful (TRUE | FALSE)][/Server ServerName][/Trial TrialName][/User UserName ][/Password UserPassword]
[/Strict (TRUE | FALSE)][/TrialCreateModeValue (DB [/Connect DatabaseConnectString]| DSN [/TRIDSN DSNString])]]
For example, the following statement installs the ASM916S deployment package, without prompting for user input, to a study called ASM916 on an InForm server called INF916:
ASM916S.exe /silent /LogFileName ASM916S.log /ForceBASEInstall TRUE /Server INF916 /Trial ASM916 /User ASM916uid /Password ASM916pid /Strict TRUE /TrialCreateModeValue DB /Connect APPSRV_dev1
Deployment command-line options
Option |
Description |
---|---|
/help |
Display a dialog box summarizing the command-line usage and options. |
/CsmlToMedml or /cm [filename] |
Convert the study to MedML. Note: Optionally, you can specify a file name. If you do not specify a file name, an XML file is saved in the directory that holds the deployment package. |
/Csml [filename] |
Extract the CSML from the deployment package. Note: Optionally, you can specify a file name. If you do not specify a file name, a CSML file is saved in the directory that holds the deployment package. |
/RuleAssembly or /rule [directoryname] |
Extract the rule assembly and all function DLL files. Note: Optionally, you can specify a directory in which to store the files. If you do not specify a directory, a rule directory is created in the directory that holds the deployment package, and all extracted files are saved in the directory. |
/DesignerUnit or /unit [directoryname] |
Export the units file. Note: Optionally, you can specify a directory in which to store the file. If you do not specify a directory, the file is saved in the directory that holds the deployment package. |
/Version or /ver |
Obtain the release number of the Central Designer application from which the deployment package was created. |
/testconversion or /testc |
Test whether the deployment package can create MedML from CSML, without installing the MedML files in an InForm study. The MedML files generated by the deployment process are saved to a temporary system directory or to a directory that you specify using the /UnpackDirectory option. |
/silent |
Run in silent mode (without prompting for user input), using the options specified either on the command line or in the configuration file named in the /ConfigFile option. In silent mode the Deployment Wizard appears, enabling you to follow the progress of the deployment, but does not prompt you for deployment options. |
/ConfigFile filename |
Use the specified configuration file to obtain deployment options. |
/LogFileName filename |
Create a log file in the specified location. By default, a log file called StudyInstaller.log is created in the InForm installation folder. |
/UnpackDirectory directoryname |
Unzip the deployment package in the specified local directory. Deployment files include:
If you do not specify this option, the files are unzipped to a temporary system directory. The StudyInstaller.log file includes the location of the deployment files. |
/ForceBASEInstall (TRUE | FALSE) |
|
/CheckInFormVersion (TRUE | FALSE) |
|
/DontExitIfUnsuccessful (TRUE | FALSE) |
|
|
The following values are required if you run deployment in silent mode; otherwise, they are optional. If you specify any of the following command-line options and do not run in silent mode, the corresponding fields in the Deployment Wizard are populated with the values you specify. |
/Server ServerName |
Name of the InForm application server. |
/Trial TrialName |
Name of the InForm study. |
/User UserName |
Oracle user name for the study database. |
/Password UserPassword |
Oracle password for the study database. |
/Strict (TRUE | FALSE) |
|
/TrialCreateModeValue (DB | DSN) |
|
/Connect DatabaseConnectString |
Connection string for the Oracle instance. |
/TRIDSN DSNString |
ODBC System DSN for the InForm study. |
/ServerAutoStartup |
The InForm server starts automatically when the InForm Service starts. If you do not include the /ServerAutoStartup option, the InForm server must be started manually. |
/TrialAutoStartup |
The InForm study starts automatically when the InForm Service starts. If you do not include the /TrialAutoStartup option, the InForm study must be started manually. |
/CacheInitWaitTime |
Time to wait (in milliseconds) for the InForm caches to initialize. |
As an alternative to entering deployment options at the command line or in a script, you can include the options for executing a deployment package in a configuration file referenced by the /ConfigFile command-line option. The configuration file is in XML format.
Deployment ConfigFile options
Option |
Description |
---|---|
<DeploymentData>
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.phaseforward.com/DeploymentData/2006-04-25" |
<HostName /> <HostUserName /> <HostUserPassword /> <HostSharedDirectory /> <HostSharedDirectoryLocalPath /> |
Reserved for future use. |
<TargetType/> |
INFORM |
<ServerName/> |
Name of the InForm application server. |
<TrialName/> |
Name of the InForm study. |
<UserName/> |
Oracle user name for the study database. |
<UserPassword/> |
Oracle password for the study database. |
<StrictMode/> |
|
<TrialMode/> |
|
<TRIDSN /> |
ODBC System DSN for the InForm study. |
<DatabaseConnectString/> |
Connection string for the Oracle instance. |
<TrialStartupMode/> |
|
<ServerStartupMode/> |
|
<ForceBASEInstall/> |
|
<CheckInFormVersion/> |
|
<ProtocolName /> <ProtocolUserName /> <ProtocolUserPassword /> <DBAdminUser /> <DBAdminUserPassword /> <DataSpace /> <TableSpace /> <UNCHelpDirectory /> <VirtualHelpDirectory /> <WebPath /> <SSL/> |
Reserved for future use. |