Skip to main content

Shopping

  • Shopping
  • Reference
  • Shopping Central installer properties

Shopping Central installer properties

The following table describes the installer properties for the Shopping Central installer.

Switch

Mandatory

Default value

Notes

ACTIVE_DIRECTORY_SERVER

Yes

Name of the AD server. This parameter can also be set to the fully qualified domain name for the server. Information on which Domain Controller you should nominate is here.

ADMINACCOUNT

Yes

The Shopping Admin account. This is either set as Domain\User or Domain\Group.

This account, or members of this group, can view the Shopping Admin pages. Once set it cannot be changed, therefore we recommend using a domain group so that access to the Shopping Admin pages can be determined using AD group membership.

During installation, this account/group is also used for the following which can be changed later in the Shopping Admin Console settings section. Each setting requires that the Admin account or group and its members are email enabled:

  • Admin email setting, Shopping will forward alerts to the Administrator email account set in this parameter

  • Deputy Default setting, which Shopping uses as a deputy approver in the event that an approval times out, and the approver does not have a deputy defined

For further guidance see Active Directory security groups.

AESERVERNAME

This is an old installer property that is no longer supported.

AZURETENANTID

Your Azure Active Directory tenant ID. Use in conjunction with ENABLEINTUNESUPPORT and its associated installer properties.

CONSOLECLIENTAPPID

The Application ID for your Azure Active Directory Enterprise app for console authentication set up as per the Enabling Intune integration documentation.

DATABASE_COMMANDTIMEOUT

3600

The timeout (in seconds) and denotes how long the installer waits for SQL commands to execute before reporting an error. Can be used to facilitate the upgrading of large Shopping databases. The default is 1 hour.

DATABASE_CONNECTIONTIMEOUT

30

The timeout (in seconds) and denotes how long the installer waits for the SQL connection before reporting an error. Can be used to facilitate the upgrading of large Shopping databases.

DATABASE_MODE

SingleUser

Database usage mode. It may be set to one of the following values:

  • SingleUser - Sets the upgrade scripts to run in single user mode

  • MultiUser - Sets the upgrade scripts to run in multi-user mode

The default value sets the upgrade scripts to run in single-user mode to avoid multiple connections during upgrade (Only for SQL 2005).

Enabling MultiUser mode, by setting the following property on the installer command-line, may be necessary for larger databases to help to smooth the upgrade process:

DATABASE_MODE="MultiUser"

Note

Please Note: MultiUser and SingleUser are case sensitive

DATABASENAME

Shopping2

Enables the name for the database to be changed from the default. Changing this will create a new database on installation with the value you have chosen.

Any existing Shopping database with a different name will not be upgraded, will be left unchanged by the installation and the new database will be installed alongside it.

DROPOLDDB

0

If set to 1 on the command-line this will drop the current Shopping database on install. If you do not want to drop any existing data, do not include this property on the command-line.

Note

Use with caution as existing data will be deleted.

The default behavior for this property is to not drop the old database.

ENABLEINTUNESUPPORT

0

Enable Intune integration. 1 to enable it, 0 otherwise. Other required installer properties are:

  • AZURETENANTID

  • SERVICECLIENTAPPID

  • CONSOLECLIENTAPPID

ENABLETACHYONSUPPORT

0

Enable Tachyon integration. 1 to enable it, 0 otherwise. Other required installer properties are:

  • PLATFORMURL

  • PLATFORMUSERNAME

  • PLATFORMPASSWORD

IISHOSTHEADER

Yes

IIS Host Header for the Shopping Website.

This value is used to create theHTTPS binding for theShopping Website, and Console settings for the Web URL and API URL.

See Shopping Website name for design considerations of what this should be. Typically it will be the DNS Alias FQDN of the Shopping Central server.

Shopping 6.1 onwards only supports HTTPS connections to the Shopping Website, because supported browsers block Cross-Origin Resource Sharing (CORS) in non-secure contexts such as HTTP.

IISHOSTHEADER, SHOPPINGURLPREFIX, and THUMBPRINT are mandatory properties, used to configure the Website HTTPS binding.

IISIPADDRESS

*

Custom IP address for the Shopping Website, if you want to be non-specific about the IP address, set it to *.

This value is used to create theHTTP binding for theShopping Website.

IISPORT

80

IIS port for the Shopping Website.

This value is used to create theHTTP binding for theShopping Website, and Console settings for the Web URL and API URL.

INSTALLDIR

C:\Program Files (x86)\1E\Shopping

Installation directory for all components.

INSTALLTYPE

COMPLETE

Governs the components that are installed. Values are:

  • COMPLETE – installs all components

  • WEBONLY – installs only the Shopping website

  • CONSOLEONLY – installs only the Shopping Admin console

LICENSEMGRACCOUNT

Shopping license manager account – must be a domain user of group.

For further guidance see Active Directory security groups.

PIDKEY

Yes

License key for Shopping. A valid license key must be purchased from 1E.

PLATFORMURL

The URL for the Tachyon server. For example, https://tachyon.acme.local:443/

Set this to the base URL for your Tachyon Platform implementation.

For example: https://tachyon.acme.local:443/

PLATFORMUSERNAME

Username given in domain\username format for the Tachyon account with the Shopping administrator role added.

Set this to the user name for the account you want to use for running the Tachyon Instruction that implements the client-side Order Tracking feature and any Tachyon Instructions you are making available as Shopping applications. The user name must be provided in the form Domain\User. You could even set this to the account details you used for the Shopping Service account to save having to provision another account. The installer will:

  • Create the Shopping Administrators role in Tachyon

  • Create an instruction set called 1E Shopping and add the client-side Order Tracking instruction to it

  • Give the Shopping Administrators role permission to run the instruction

  • Add the specified user account to Tachyon

  • Assign the user account to the Shopping Administrators role

  • Save the name as Tachyon username in the Shopping Console settings (also saves its password encrypted).

PLATFORMPASSWORD

Password for the Tachyon account with the Shopping administrator role added.Set this to the password of the Tachyon user account you want to use for running Shopping instructions.

RECEIVERACCOUNT

Yes

Name for the account or security group used for the Shopping Receiver accounts.

Must be a group and contain the Configuration Manager Network Access account if calling Shopping OSD APIs in OSD task sequences.

Must be a group if Shopping Receivers are configured to use Network Service or have different service accounts.

For further guidance, see Active Directory security groups.

REPORTSACCOUNT

Shopping reports access account – must be a domain user or group. For further guidance, see Active Directory security groups .

SERVICECLIENTAPPID

The Application ID for your Azure Active Directory Enterprise app for service authentication set up as per the Enabling Intune integration documentation.

SHOPPINGCONSOLEADMINUSERS

The Shopping AD security group for Full Database Access. Provides access to the following nodes in the Shopping Console.

  • Sites

  • Applications

  • Settings

  • Node Security

During installation, this group is granted various rights to the Shopping SQL database.

For further guidance see Active Directory security groups.

For further information about Shopping Console node security, see Configuring Shopping Admin console users.

SHOPPINGCONSOLESMSUSERS

The Shopping AD security group for ConfigMgr access in the Shopping Admin Console. Provides access to the following nodes in the Shopping Console

  • Sites

  • Applications

During installation, this group is granted various rights to the Configuration Manager SQL database.

For further guidance see Active Directory security groups.

For further information about Shopping Console node security, see Configuring Shopping Admin console users.

SHOPPINGCONSOLEUSERS

The Shopping AD security group for partial Shopping Admin Console access. Provides access to the following nodes in the Shopping Console

  • Approvers

  • User Categories

  • Computer Categories

  • Event Log

During installation, this group is granted various limited rights to the Shopping SQL database.

For further guidance see Active Directory security groups.

For further information about Shopping Console node security, see Configuring Shopping Admin console users.

SHOPPINGDBSERVER

Note

This property is no longer supported and has been replaced with SQLSERVER.

SHOPPINGURLPREFIX

Yes

Prefix for the URL of the Shopping Website and defined in one of the following formats depending on your IIS configuration:

https://<ServerName>
https://<ServerName>:<PortNumber>

Shopping 6.1 onwards only supports HTTPS connections to the Shopping Website, because supported browsers block Cross-Origin Resource Sharing (CORS) in non-secure contexts such as HTTP.

IISHOSTHEADER, SHOPPINGURLPREFIX, and THUMBPRINT are mandatory properties, used to configure the Website HTTPS binding.

SMSDBPORT

1433

The Configuration Manager database port if it is using the non-default port.

SMSPROVIDERLOCATION

localhost

Name of the Configuration Manager server or its FQDN.

SMTP_SERVER_NAME

localhost

Name of the SMTP server or its FQDN.

SQLSERVER

local

Name for the Shopping SQL Server instance. This can be set in one of the following formats depending on your database setup:

<ServerName>
<ServerName>\<InstanceName>
<ServerName>,<PortNumber>

It may also use a local SQL Alias.

SVCPASSWORD

Password for the Shopping Service account.

SVCUSER

Username (in for format domain\username) for the Shopping Central service account.

THUMBPRINT

Yes

The thumbprint of the Web Server certificate used for the Shopping Website. Please refer to Preparation: Shopping Server certificate.

Shopping 6.1 onwards only supports HTTPS connections to the Shopping Website, because supported browsers block Cross-Origin Resource Sharing (CORS) in non-secure contexts such as HTTP.

IISHOSTHEADER, SHOPPINGURLPREFIX, and THUMBPRINT are mandatory properties, used to configure the Website HTTPS binding.

USEGLOBALCATALOG

1

Configures use of the Global Catalog for searches in AD. Values are:

  • 0 – Disable Global Catalog

  • 1 – Enable Global Catalog

WSAPIDKEY

License key for the Windows Servicing Assistant. A valid WSA license key must be provided to enable its features in Shopping.

In this section: