Analytics Setup Command Line
This topic explains the Analytics Setup Command Line in Agility.
Use these commands to install Analytics from the command line.
Setup [action] [instance] [options]
Note that you need a colon between the argument and the value, like this:
...... -Quiet -Action:Install -InstanceDir:"c:\Program Files\VersionOne\VersionOne173 to VersionOne173-datamart" -EnterpriseDbServer:dnix\versiononesql ......
| Argument | Values | Comments |
|---|---|---|
| (default arg) | Instance Name | This is the default argument for setup |
| -Action | Install, Uninstall, Upgrade, Reload | Install is used to create and configure a new instance Uninstall removes an instance and any artifact created during the install process. Note, you may choose keep the database created by the installer. Upgrade replaces the files and makes the necessary changes to take an instance to the next version. There is additional information about this option below. Reload updates labels in Analytics from the Terminology values defined in the Digital.ai Agility instance. This option is only available from the commandline. |
| -LogFile | FileName.txt | default is "setup.log" |
| -Quiet | (none) | Suppress all wizard/confirmation UI; Will show error messages. Good for automated setups run by humans. |
| -VeryQuiet | (none) | Suppress all UI, including error messages. Good for full automation. |
| -AnalyticsDeleteDb | true,false | Remove the Analytics meta-data database Defaults to True This option is only honored when the action is Uninstall |
| -WebDir | Installation Path | Default is <wwwroot><instance name="name"/></wwwroot> This option is only honored when the action is Install |
| -DatamartDbServer | SQL Server Address | This option is only honored when the action is Install |
| -DatamartDbUser | username | SQL user for installation work. Omit for integrated auth. This option is only honored when the action is Install |
| -DatamartDbPassword | password | SQL password for installation work. Omit for integrated auth. This option is only honored when the action is Install |
| -DatamartDbName | Database name | SQL Database that ETL will load. Will be created if it doesn't exist. This option is only honored when the action is Install |
| -AnalyticsDbServer | SQL Server Address | This option is only honored when the action is Install |
| -AnalyticsDbUser | username | SQL user for installation work. Omit for integrated auth. This option is only honored when the action is Install |
| -AnalyticsDbPassword | password | SQL password for installation work. Omit for integrated auth. This option is only honored when the action is Install |
| -AnalyticsDbName | Database name | SQL Database Analytics application data. Will be created if it doesn't exist. This option is only honored when the action is Install |
| -WebSiteRootPath | Web sit identifier | Directory Services entry of the IIS Web Site to install to e.g. IIS://localhost/W3SVC/1/ROOT This option is only honored when the action is Install |
| -WebAppUrl | Public URL that clients This option is only honored when the action is Install | |
| -ApplicationDataPath | Path | Specify the location for persisting cache data and other runtime configuration files. This option is only honored when the action is Install |
| -CacheDataPath | Path | Specify the location for persisting cache data. Use this parameter if you want the data cache files in location different from other runtime configuration files. This option is only honored when the action is Install |
| -EnterpriseUrl | URL | URL used to get back to the "owning" instance of Digital.ai Agility Ultimate, e.g. [http://v1webserver/VersionOne] This option is only honored when the action is Install |
| MyAnalyticsDbUser | username | By default the Analytics Setup program generates unique, application specific, database connection credentials during install and upgrade. Some organizations prefer to specify, and manage, credentials rather than have Setup generate these credentials. Use this option, along with the other options that begin with "My", only when you want to specify and manage your own database connectivity credentials. Specify the username Analytics should use when connecting to the Analtyics meta-data database. When passing this parameter, you must also include -UseExistingUser:true |
| MyAnalyticsDbPassword | password | By default the Analytics Setup program generates unique, application specific, database connection credentials during install and upgrade. Some organizations prefer to specify, and manage, credentials rather than have Setup generate these credentials. Use this option, along with the other options that begin with "My", only when you want to specify and manage your own database connectivity credentials. Specify the password for the username provided with MyAnalyticsDbUser. When passing this parameter, you must also include -UseExistingUser:true |
| MyDatamartDbUser | username | By default the Analytics Setup program generates unique, application specific, database connection credentials during install and upgrade. Some organizations prefer to specify, and manage, credentials rather than have Setup generate these credentials. Use this option, along with the other options that begin with "My", only when you want to specify and manage your own database connectivity credentials. Specify the username Analytics should use when connecting to the Data Mart database. When passing this parameter, you must also include -UseExistingUser:true |
| MyDatamartDbPassword | password | By default the Analytics Setup program generates unique, application specific, database connection credentials during install and upgrade. Some organizations prefer to specify, and manage, credentials rather than have Setup generate these credentials. Use this option, along with the other options that begin with "My", only when you want to specify and manage your own database connectivity credentials. Specify the password for the username provided with MyDatamartDbUser. When passing this parameter, you must also include -UseExistingUser:true |
| -SmtpEnabled | true/false | Enables or Disables SMTP Functionality. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpServer | SMTP Server name | Name of server hosting SMTP server. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpPort | numeric | SMTP Server listen port. Defaults to 25. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpConnectionTimeout | numeric | SMTP Server connection timeout. Defaults to 30. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpAuthenticationMethod | None, Logon, CramMD5 | SMTP Authentication Method. Defaults to None This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpAuthenticationUser | username | Name of user for connecting to SMTP server. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SmtpAuthenticationPassword | password | Password for SmtpAuthenticationUser. This option is honored when the action is Install or Upgrade. If it is not provided when upgrading, the value provided at the last install will be used. |
| -SigningKey | secret word | This is the Integration code for Analytics to talk to V1 core app. |
| -UseExistingUser | boolean | By default the Analytics Setup program generates unique, application specific, database connection credentials during install and upgrade. Some organizations prefer to specify, and manage, credentials rather than have Setup generate these credentials. This option defaults to false if not provided. Therefore, if you want Setup to manage the database connectivity credentials, do not include this option. Only use this option, and set the value to true, when you want to specify, and manage, your own database connectivity credentials. The option must be included during install and upgrade. If you do not include MyAnalyticsDbUser and MyAnalyticsDbPassword Setup will configure Analtyics to use Windows Integrated Authentication when connecting to the Analytics meta-data database. If you do not include MyDatamartDbUser and MyDatamartDbPassword Setup will configure Analtyics to use Windows Integrated Authentication when connecting to the data mart database. When configured to use Windows Integrated Authentication, you must either grant the application pool permission to access the databases or manually configure the application pool with the credentials you intent to use. |
Note on using the Upgrade action.
Except for the SMTP configuration, the Upgrade action cannot be used to move or reconfigure an instance. Upgrade can be used to re-configure the SMTP options. If you need to move the instance or re-configure something besides SMTP, you will need to Uninstall the instance and then Install with the new options. Remember to keep the databases when uninstalling and to backup any user configuration files in
C:/ProgramData/VersionOne/Analytics/InstanceData/{instance name}/LogiInfoBookmarkLocation
and
C:/ProgramData/VersionOne/Analytics/InstanceData/{instance name}/LogiInfoDashboards