1E Platform server installer properties
Learn about the properties used during 1E Platform installation. This guide explains each installer option to help you customize and automate your 1E Platform setup.
1E Server setup is the only supported method of installing, upgrading, and patching a 1E server. Installation using standalone msi or msp files is not supported unless advised by 1E, which may be necessary in complex installations, using non-interactive (quiet/silent) command-lines, and may require further post-install configuration steps.
Mandatory properties must be provided when installing using a command-line.
The installer file is: TachyonServer.msi
The fields in the table below are:
ACTIVE_DIRECTORY_SERVER | ADDLOCAL | DEVICECOUNT | DROPOLDDB_EXPERIENCE | DROPOLDDB_MASTER | DROPOLDDB_RESPONSES | EXTERNALIISHOSTHEADER | HTTPSIISPORT | IISIPADDRESS | IISPORT | INSTALLDIR | INTERNALIISHOSTHEADER | LICENSEFILEPATH | LOGPATH | MAILFROM | SERVERCERTIFICATETHUMBPRINT | SMTPENABLED | SMTPPORT | SMTPSERVER | SQLSERVER_EXPERIENCE | SQLSERVER_MASTER | SQLSERVER_RESPONSES | SSASDROPDB_EXPERIENCE | SSASSERVER_EXPERIENCE | STARTCOORDINATOR | STARTSWITCH | TWOFACTORAUTHENABLED |WORKFLOWWEBPORT
|
Property |
Default |
Mandatory |
Description |
|---|---|---|---|
|
GC:// |
Yes |
A list of Active Directory URLs. 1E services locate users and computers and membership of security groups by querying a semi-colon delimited list of Active Directory GC and/or LDAP URLs.
Any domain which contains 1E servers, users or groups must:
The default GC:// is sufficient for a 1E Server in a simple Active Directory environment of one forest which has a Global Catalog. You can include, but it is not required, the name of the server's local domain or root domain, for example: GC://acme.local To add support for a remote forest which has its own GC, you would for example have GC://acme.local;GC://nadir.local and so forth adding the root domain of any other forests to the list of GC URLs. If you prefer to use LDAP, or there are difficulties with trusts between forest domains, then you would create a list of LDAP URLs including all domains that have 1E users and groups, as well as domains in which a 1E server resides. For example: LDAP://acme.local;LDAP://pop.acme.local;LDAP://rock.acme.local;LDAP://country.acme.local;LDAP://nadir.local;LDAP://disco.nadir.local You can mix GC and LDAP URLs, but you should avoid mixing LDAP URLs that are also resolved by a GC URL. For example: GC://;LDAP://nadir.local;LDAP://disco.nadir.local The Coordinator Workflow module queries AD for email details of Platform users, and the Consumer API queries AD for security details of 1E users to support Role-Based Access Control. 1E Setup will verify the details you have supplied. However you can run the following command on your server to confirm it can resolve the name of the local domain in DNS and locate Domain Controllers with the Global Catalog role: Copy
Use the following command to resolve <domain> and its GC DCs: Copy
|
|
|
ALL |
No |
Default is ALL when installing all components on a single-server. The following components (MSI features) are selected when installing a Master Stack, Response Stack and Custom configuration. Names are delimited by a comma and are case-sensitive. Master Stack:
Response Stack:
Specifying Portal or Experience does not install 1E applications, but are required in order for relevant applications to work. 1E applications are installed separately by 1E Setup. |
|
|
1000 |
No |
This is the number of devices supported by the 1E server which is being installed. The number of devices supported by a 1E Server determines the number of Switches configured on the server. The range is 1 to 250,000; default is 1,000. A single server with suitable resources can support up to five Switches and up to 250,000 devices, with each Switch supporting up to 50,000 devices. Additional servers or configuration may be required according to the design of the 1E system. The total number of devices supported across the 1E system must not exceed the license file allocation. |
|
|
0 |
No |
|
|
|
0 |
No |
|
|
|
0 |
No |
|
|
|
TACHYON.<DomainFQDN> |
Yes |
Sets the host header used by the HTTPS binding of the Platform Website. This must be the same as the DNS Alias FQDN. EXTERNALIISHOSTHEADER and HTTPSIISPORT configure the HTTPS binding that uniquely identifies the Platform Website used by the following:
|
|
|
443 |
Yes |
Sets the port used by the HTTPS binding of the Platform Website. EXTERNALIISHOSTHEADER and HTTPSIISPORT configure the HTTPS binding that uniquely identifies the Platform Website used by the following:
|
|
|
* |
Yes |
Sets the IP Address used by the HTTP and HTTPS bindings of the Platform Website. The default value of * sets IIS to listen on all IP addresses. On multihomed servers with multiple IP addresses you may optionally set this value, but in general we recommend leaving this as * to bind to all IP addresses. If this value is set it must correspond to one of the IP addresses configured for the DNS Alias FQDN. INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that can be used to access IIS web applications that are not configured to Require SSL, for example ContentDistribution, CoreExternal and CatalogWeb. Refer to Services and NTFS Security |
|
|
80 |
Yes |
Sets the port used by the HTTP binding of the Platform Website. INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that can be used to access IIS web applications that are not configured to Require SSL, for example ContentDistribution, CoreExternal and CatalogWeb. |
|
|
%ProgramFiles%\1E\Tachyon\ |
No |
Sets the installation folder for all the 1E components. For a non-default installation refer to Services and NTFS Security. |
|
|
<computername>.<DomainFQDN> |
Yes |
Sets the host header used by the HTTP binding of the Platform Website. This should be the computername FQDN of the 1E Server. INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that can be used to access IIS web applications that are not configured to Require SSL, for example ContentDistribution, CoreExternal and CatalogWeb. |
|
|
|
Yes (UI) No (command-line) |
The full path, including the file name, must be provided for a valid Platform license file. 1E will provide you with a Tachyon.lic license file that defines the applications, tools, and features your 1E System is able to use, for how long, and how many devices it supports, this may be an evaluation or subscription license.
|
|
|
%AllUsersProfile%\1E\Tachyon\ |
No |
Sets the path to the 1E server log files. It does not set the filename of each log. For a non-default installation refer to Services and NTFS Security. Not supported by 1E Setup. If you need to change the default location, contact 1E. |
|
|
|
Yes |
Sets the mail-from email address used by the 1E Server when it sends emails. For guidance about the Mail-From address see Email and 2FA requirements. |
|
|
|
No |
Used by 1E Setup to uniquely identify which certificate was selected by the user for use by 1E components. 1E Setup uses the selected certificate to assign to the main binding for the Platform website, the coordinator web service, and Switches. SERVERCERTIFICATETHUMBPRINT=3d699d8f28c2d7e0514cb0e047a1fd2f9db9bf4f If you are using the installer instead of 1E Setup, and do not specify a thumbprint property in the command-line, the installer will automatically select the first suitable certificate it finds in the server's Personal certificate store. In which case you must ensure there is only one suitable certificate, otherwise you may find Switches, and the bindings for the website and coordinator using different certificates. You can review the bindings using 1E Setup > Maintenance > Server certificate Refer to Certificate requirements. |
|
|
1 |
No |
Determines whether 1E email features are available. It uses email for:
For guidance about using non-default SMTP settings, see Email and 2FA requirements. If email notifications need to be disabled after installation, then see Changing the SMTP Host configuration. To configure Telemetry after installation, refer to Enabling or disabling Telemetry features. If set to 1 then email is enabled. If set to 0 then the following are disabled:
|
|
|
25 |
No |
Sets the port used to connect to the SMTP relay/gateway Default is 25. If the port needs to be changed after installation, refer to Changing the SMTP Host configuration. |
|
|
|
Yes |
Sets the FQDN of the SMTP relay/gateway. If the FQDN needs to be changed after installation, refer to Changing the SMTP Host configuration. |
|
|
(local) |
Yes |
Sets the name for the SQL Server instance that hosts the TachyonExperience database. This can be set in one of the following formats depending on the setup of the instance. (local) ServerName ServerName,PortNumber ServerName\InstanceName ServerName\InstanceName,PortNumber |
|
|
(local) |
Yes |
Sets the name for the SQL Server instance that hosts the TachyonMaster database. This can be set in one of the following formats depending on the setup of the instance. (local) ServerName ServerName,PortNumber ServerName\InstanceName ServerName\InstanceName,PortNumber |
|
|
(local) |
Yes |
Sets the name for the SQL Server instance that hosts the TachyonResponses database. This can be set in one of the following formats depending on the setup of the instance. (local) ServerName ServerName,PortNumber ServerName\InstanceName ServerName\InstanceName,PortNumber |
|
|
0 |
No |
If set to 1 then the installer will drop the TachyonExperience cube and attempt to create a new cube. To create the cube requires the server installation account has sysadmin rights on the SQL Server Analysis Service instance SSASSERVER_EXPERIENCE. If set to 0 (default) then the installer will keep the existing TachyonExperience cube. |
|
|
(local) |
Yes |
Sets the name for the SQL Server Analysis Service instance that hosts the TachyonExperience cube. This can be set in one of the following formats depending on the setup of the instance. (local) ServerName ServerName,PortNumber ServerName\InstanceName ServerName\InstanceName,PortNumber |
|
|
1 |
No |
Flag indicating if the Coordinator service should be started after installation. |
|
|
1 |
No |
Flag indicating if the Switch Host service should be started after installation. |
|
|
1 |
No |
Determines whether 1E uses two-factor authentication. If email is disabled then so is two-factor authentication which relies on email, refer to Email and 2FA requirements. Default is same as SMTPENABLED. |
|
|
8080 |
No |
Sets the port used by HTTPS binding of the Coordinator Workflow module. This is separate from the Platform Website. 1E Setup suggests 8081 by default, and should not need to be changed. TachyonServer.msi installer defaults to 8080 if the WORKFLOWWEBPORT parameter is not provided. 1E Setup uses 8081 to avoid conflict with HTTP port 8080 which is the default used by SLA Platform 3.3 and earlier versions. |