Contents
-
Introducing Shopping
-
Implementing Shopping
-
Working with Shopping
-
Troubleshooting
-
Training
-
Reference
-
Supported Platforms
-
Server Sizing
-
Communication Ports
-
Shopping Central installer properties
-
Shopping Receiver installer properties
-
Shopping Admin Console settings
-
1E Client Shopping module settings
-
Configuring AD synchronisation
-
Default and recommended Configuration Manager legacy package settings
-
Fields and limitations
-
Customizations
-
The Shopping workflow
-
Shopping and other ticketing systems
-
Deploying Shopping Administrator Console using Configuration Manager
-
Localizing Shopping
-
Accessibility
-
Windows Servicing Assistant UI Pages
-
Release notes
-
Supported Platforms
The following table describes the installer properties for the Shopping Central installer.
Switch | Default value | Notes |
---|---|---|
ACTIVE_DIRECTORY_SERVER | 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 | 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:
For further guidance see Active Directory security groups. | |
AESERVERNAME | Must be set to the server name of the server hosting ActiveEfficiency. It may be set to To set a non-standard port (after configuring it for the ActiveEfficiency Web API), add it to the end of the server name using the following format: <servername>:<portNo> If you have set a host header for the ActiveEfficiency Web API, you can set this as the value instead. | |
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:
The default value sets the upgrade scripts to run in single-user mode to avoid multiple connections during upgrade (Only for SQL 2005). Enabling DATABASE_MODE="MultiUser" Please Note: MultUser 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 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: |
IISHOSTHEADER | IIS Host Header for the Shopping Website. This value is used to create the HTTP binding for the Shopping 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. | |
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 the HTTP binding for the Shopping Website. |
IISPORT | 80 | IIS port for the Shopping Website. This value is used to create the HTTP binding for the Shopping Website, and Console settings for the Web URL and API URL. |
INSTALLDIR |
| Installation directory for all components. |
INSTALLTYPE | COMPLETE | Governs the components that are installed. Values are:
|
LICENSEMGRACCOUNT | Shopping license manager account – must be a domain user of group. For further guidance see Active Directory security groups . | |
PIDKEY | License key for Shopping. A valid license key must be purchased from 1E. | |
RECEIVERACCOUNT | 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.
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
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
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 | ||
SHOPPINGURLPREFIX | Prefix for the URL of the Shopping Website and defined in one of the following formats depending on your IIS configuration: http://<ServerName> http://<ServerName>:<PortNumber> | |
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. | |
USEGLOBALCATALOG | 1 | Configures use of the Global Catalog for searches in AD. Values are:
|
WSAPIDKEY | License key for the Windows Servicing Assistant. A valid WSA license key must be provided to enable its features in Shopping. |