Summary

How to install Shopping Central using the interactive installer wizard or in unattended mode - also includes basic instructions on uninstalling Shopping Central.


On this page:

Installing Shopping central with the wizard

To install Shopping central components, double-click ShoppingCentral.msi and follow the prompts:

  1. On the Welcome screen, click Next.
     
  2. On the Prerequisites screen, background checks are run to ensure the prerequisites are met. Click Next.
     
  3. On the License Agreement screen, accept the license agreement and click Next.
     
  4. On the Installation Type screen, choose one of the following and click Next:
    • Complete Install – installs the Shopping Web application, Shopping APIs, Shopping database, Shopping Admin console and Shopping services
    • Web Only – installs only the Shopping Web on secondary devices. It requires a complete Shopping installation to already exist on the network as the installer will prompt you for the host, port and IP address for the Shopping website.
    • Admin Console Only – installs only the Admin console on secondary devices. It requires a complete Shopping installation to already exist on the network as the installer will prompt you for the location of the Shopping database server.
     
  5. On the Customer Information screen, enter the following and click Next:
    1.  The name and organization details
    2. license key for Shopping 
    3. license key for Windows Servicing Assistant (WSA). 

      If you are evaluating Shopping, leave the license key blank for a 30-day evaluation period.

      WSA does not have an evaluation period. If you do not have a license key for WSA leave the field blank; you will be able to create WSA applications in the Shopping Admin console but users will not be able to launch them.

     
  6. On the Custom Setup screen – this corresponds to the installation type you chose in step 4. You can change the default installation location for each component by selecting the component and click Change...
    • Complete – C:\Program Files (x86)\1E\Shopping\
    • DatabaseC:\Program Files (x86)\1E\Shopping\Database\
    • WebsiteC:\Program Files (x86)\1E\Shopping\WebSite\
    • Website ApplicationC:\Program Files (x86)\1E\Shopping\Website\Shopping\
    • WebAPIC:\Program Files (x86)\1E\Shopping\WebSite\ShoppingAPI\
    • ServiceC:\Program Files (x86)\1E\Shopping\CentralService\
    • Admin ConsoleC:\Program Files\1E\Shopping\AdminConsole\ 

      The database component will always be installed onto the selected SQL Server instance, and its destination cannot be changed during this step. To see how much disk space is required for the installation, click the Space button on the Custom Setup page.

  7. On the Database Server screen, enter the following and click Next.

    1. The name of the SQL Server instance to host the Shopping database. Checks are made to see if the machine is an SQL Server. You have the option to drop any existing Shopping database. 

      If you are upgrading and want to preserve your existing data, ensure that you do not select the Drop any existing Shopping database option.

      The SQL Server Name defaults to (local) which sets Shopping to use the local machine to host the Shopping database. Both SQL alias and FQDN are supported for determining the SQL Server by the Shopping Central installer. You can also set a named instance using the format: <ServerName>\<InstanceName>. For example, if there is an SQL named instance called Admin on the server SMS01, populate the SQL Server Name: field with SMS01\Admin. You can also change the name for the Shopping database that gets created. When upgrading Shopping, if a database with that name already exists it will be upgraded, otherwise a new database will be created. If the default database name was changed for a previous Shopping installation, you will need to enter that name if you want it upgraded.
    2. If TLS 1.0 is disabled on either server that will host the Shopping website or SQL Server, then:

     
  8. On the 1E ActiveEfficiency Server screen enter the servername of the ActiveEfficiency Server (specifically the server where its Web API is installed). By default, this is the NetBIOS name for the server where ActiveEfficiency server is installed but may be set to localhost if it is installed on the same server as the Shopping Central service. To set a non-standard port (if this has been configured for the ActiveEfficiency Web API), add it to the end of the server name using the following notation: servername:portNo. If you have set a host header for the ActiveEfficiency Web API you can enter this into the field instead. When you click Next, the location will be validated for the presence of the ActiveEfficiency Web API.
     
  9. On the Active Directory integration screen – enter the details to access an AD domain controller. This may be specified using the server name or the LDAP namespace. For example, a particular DC can be referenced using the server name such as ACMEDC01 or an AD namespace such as ACME.local. The AD server value defaults to localhost. Change this to refer to the AD domain controller. For details about which DC to nominate, see Preparation: Active Directory Server. Using the AD namespace is preferred in that if you specify a domain controller and that DC becomes unavailable, you won't be able to open the Shopping console.
    Access to the AD server or namespace will be verified when you click Next.
     
  10. On the Service account screen – enter the name and password for the Shopping Central service domain account (it must have the appropriate security rights already. See Preparation: Shopping Central Service Account. For example, to set the ShoppingSrv service account for the ACME domain, enter ACME\ShoppingSrv in the User name: field. The name and password for the account will be verified when you click Next.  You must also set an account or group to be used to validate communications from the Shopping Receivers.
    • If you provide a domain account, this same account must be used for all Shopping Receivers.
    • If you provide a security group, all the accounts used for the Shopping Receivers must belong to this group.
    This second option is of particular use when using the network service account for the Shopping Receivers. In this case, you simply add the machine account where the Receiver service is running to the security group provided here.
     
  11. On the Exchange or SMTP server screen – enter the fully qualified domain name for your Exchange or SMTP server. The SMTP server name defaults to localhost for locally defined SMTP servers. You can change the SMTP server name to an external server by entering its name into the field. For example, you could set the SMTP server name to the fully qualified server name for an Exchange server such as smtp.acme.local. The server entered will be verified when you click Next.
     

  12. On the Systems Center Configuration Manager integration screen – enter the Configuration Manager server name (it defaults to local host) but you can set this to a remote server by entering the server name in the Configuration Manager Server field.

    The server is not necessarily the Configuration Manager Central site server but it must be the server at the top of the part of the Configuration Manager hierarchy you want to manage with Shopping. If you have a DNS suffix defined for the Configuration Manager server, you can only use its NetBIOS name or its fully qualified domain name. If you are intending to remotely access Configuration Manager installed on a Windows 2003 server with Service Pack 1, you will need to manually enable the Shopping Central service account to access the machine remotely. See service account permissions when Configuration Manager is remote for more details.
  13. On the Admin Console Node Security screen – enter the Shopping security groups as described in Preparation: Shopping Console Access groups. For example, we have created three Shopping security groups FullShopAdmin, PartShopAdmin and ShopSMS. These groups are required even if you are not using the Console Node Security feature. If you want to use the Console Node Security feature the FullShopAdmin group must be configured so that it has security permissions in AD to write to itself and to the two other groups. Other permissions are added to the groups automatically during installation if the installation account has AD Rights to update these groups. The accounts will be validated and warnings are raised if problems are encountered.
     
  14. On the Shopping management accounts screen – enter the details for specific accounts/groups used by Shopping to manage information, for more details please refer to Preparation: Shopping Administrator groups.
    • The Admin account refers to the Shopping Administrators group that has default access to all the nodes in the Shopping Admin console and is able to see the Administration tab on the Shopping Web portal
    • The Reports access account refers to the Shopping Report Managers group, that is granted web access to reports, via the Reports tab on the Shopping Web portal, detailing the types of Shopping interactions that have been made
    • The License manager account refers to the License Managers group, whose members are sent emails of any license threshold notifications

    The entries will be validated and warnings are raised if problems are encountered. The installer searches for email addresses for the Admin and License manager accounts using each account's AD-defined mail field. If these are not found a warning is not displayed, and they will have to be added in the Shopping Admin Console Web settings post installation. 

    1E recommend using AD Groups instead of individual accounts because groups can be managed outside of Shopping.

  15. On the Website configuration screen, enter the port and host header for the Shopping Website. You can provide an IP address for it and if you want to be non-specific about the IP address, use *. For further details, see Preparation: Shopping Central IIS configuration.
     
  16. On the Shopping URL Prefix screen, set the base URL for accessing the Shopping API so that the Shopping Central service can communicate with the Shopping Web. Typically, this is set to the host header you defined in the Web configuration screen, for example http://shopping.acme.local or if you have modified the port from its default, http://shopping.acme.local:120
     
  17. Ready to install the application screen – click Next to install Shopping.

Installing Shopping in unattended mode

You can install the Shopping Central service in unattended mode using the msiexec.exe command-line. For example, to install all Shopping components with a Shopping service account, license it, setup the admin, reports and license manager accounts, define the Shopping security AD groups, locate the AD, SMTP, SQL and Configuration Manager server, then use an install script.

Command-line switches are described in Shopping Central installer properties.

Notes

  • If you use the example of v5.5_Install.cmd then it must be placed in the same folder with the ShoppingCentral.msi. 
  • The ^  at the end of each line is a continuation character used by batch scripts and included for clarity.
  • We recommend removing the /qn to perform a dry run through installation and validate all the parameters first, this allows to visually see and confirm the values entered.
  • Any items which include spaces in the name or groups should be enclosed in quotes ""  as shown

The IISHOSTHEADER property is a requirement for an unattended installation, in order to define the HTTP bindings for the Shopping Website. The bindings can also include:

  • IISIPADDRESS – you can provide a custom IP address for the Shopping Website, set it to * if you want it to be non-specific
  • IISPORT – the IIS port for the Shopping Website

Remove WSAPIDKEY if you are not using Windows Servicing Assistant.

Ensure that the parameters you provide are correct. No validation takes place for this part of the unattended installation nor are integration errors logged. If the integration fails, configure the parameters manually.

If you want to integrate Shopping with Application Migration, add the following command-lines (substitute the [parameters>] for your environment):

APPMIGRATIONENDPOINTURL=http://[host:port] ^
APPMIGRATIONMODE=1 ^
SLAPLATFORMUSERNAME=[domain\user] ^
SLAPLATFORMPASSWORD=[password] ^

To use Shopping website with HTTPS

  • Create an HTTPS binding in IIS for the Shopping website with appropriate web server certificate and port number.
  • In the settings page on Shopping Admin Console change the Web Url, API Url to HTTPS , also change the 1E Client loopback url to HTTPS as the HTTP would not work with Shopping working on HTTPS .
  • Open the Web.Config file in C:\Program Files (x86)\1E\Shopping\WebSite\Shopping and edit the API url and ShoppingWebUrl to HTTPS from HTTP with correct port.
  • Open the ShoppingCentral.exe.Config file in C:\Program Files (x86)\1E\Shopping\CentralService and edit the API url to HTTPS from HTTP with correct port.
  • Open the Shopping.Admin.Client.exe.Config file in C:\Program Files (x86)\1E\Shopping\AdminConsole and edit the API url to HTTPS from HTTP with correct port.
  • Perform an IISReset and restart the Shopping Central Service.
  • Open the Shopping.Receiver.exe.config file in C:\Program Files (x86)\1E\Shopping\Shopping.Receiver.v5.6.0 on each SCCM server and edit the ShoppingWebUrl to HTTPS from HTTP with correct port.

  • Restart the Shopping Receiver Service on each SCCM server.

Please contact 1E if you encounter any issues while setting up Shopping to use HTTPS.

Download v5.5_Install.cmd ...  

v5.5_Install.cmd
msiexec /i ShoppingCentral.msi ^
ACTIVE_DIRECTORY_SERVER=ACME.local ^
INSTALLDIR="C:\Program Files (x86)\1E\Shopping" ^
AESERVERNAME=aeserver ^
SVCUSER=ACME\ShoppingSrv ^
SVCPASSWORD=svcpassword ^
SHOPPINGCONSOLEADMINUSERS="ACME\FullShopAdminsGroup" ^
SHOPPINGCONSOLEUSERS="ACME\PartShopAdminsGroup" ^
SHOPPINGCONSOLESMSUSERS="ACME\ShopSMSUserGroup" ^
ADMINACCOUNT="ACME\ShopAdminsGroup" ^
REPORTSACCOUNT="ACME\ShopReportsGroup" ^
LICENSEMGRACCOUNT="ACME\ShopLicenseMgrsGroup" ^
PIDKEY=abcdef-1234-5678-8765-4321 ^
WSAPIDKEY=abcdef-1234-5678-8765-4321 ^
SQLSERVER=ACME-SQLSERVER ^
SMTP_SERVER_NAME=smtp.acme.local ^
SMSPROVIDERLOCATION=SMS01 ^
IISHOSTHEADER=shopping.acme.local ^
SHOPPINGURLPREFIX=http://shopping.acme.local ^
RECEIVERACCOUNT="ACME\ShopReceiversGroup" ^
DATABASENAME=Shopping2 ^
DATABASE_COMMANDTIMEOUT=3600 ^
DATABASE_CONNECTIONTIMEOUT=30 ^
DATABASE_MODE=multiuser ^
USEGLOBALCATLOG=1 ^
ENABLETLS12=0 ^
/l*v %temp%\ShoppingCentral-install.log /qn
 
@echo Press any key to close
@pause>nul 

Upgrading

See Upgrading to Shopping 5.5.

If you use the above script to upgrade Shopping, and the command-line encounters errors, a rollback occurs which may leave your production system in an unstable state. Should that happen, you can restore the database and the files from the backup you made. If you are having trouble with the restore, contact 1E support for assistance.

Prior to running an upgrade (this is recommended and good practice):

  1. Backup your Shopping database (Shopping2).
  2. Backup the binaries and files in the installation folder typically located at: C:\Program Files (x86)\1E\Shopping. Ensure that you copy all folders and files.
  3. Test the unattended installation command-line in your lab environment to ensure it works before running it on your production environment.

Post Installation

See Post-installation steps.

Uninstalling Shopping

Shopping can be uninstalled from Windows Control Panel Programs and Features or by running the ShoppingCentral.msi and choosing the Remove option. Alternative, you can run a command-line to uninstall Shopping with: msiexec /x ShoppingCentral.msi /qb

When you uninstall Shopping central, its database (Shopping2) is left on the database server. If you subsequently reinstall Shopping, you have the option to drop the old database in the installer screen.