SummaryInformation that will help you design and plan the implementation of Shopping 5.5.200 in your organization. This includes those prerequisites and dependencies, which are either complex such as hardware sizing and security, or critical and cannot easily be changed after installation, such as Active Directory accounts and groups.
This page is part of the design phase of implementation.
On this page
Installing Shopping central with the wizard
To install Shopping central components, double-click
ShoppingCentral.msi and follow the prompts:
- On the Welcome screen, click Next.
- On the Prerequisites screen, background checks are run to ensure the prerequisites are met.
- On the License Agreement screen, accept the license agreement and click Next.
- On the Installation Type screen, choose:
- Complete installation – 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.
- On the Custom information screen – enter your name and organisation details along with the license keys for Shopping and the 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.
- 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 installation –
C:\Program Files (x86)\1E\Shopping
- Database –
C:\Program Files (x86)\1E\Shopping\Database
- Website –
C:\Program Files (x86)\1E\Shopping\WebSite\
- Website application –
C:\Program Files (x86)\1E\Shopping\Website\Shopping
- Web API –
C:\Program Files (x86)\1E\Shopping\WebSite\ShoppingAPI
- Service –
C:\Program Files (x86)\1E\Shopping\CentralService
- Admin console –
- Complete installation –
On the Database server screen – enter the name of the server 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.
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
Adminon 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 Shpopping installation, you will need to enter that name if you want it upgraded.
- On the ActiveEfficiency server screen – to continue with the installation, you must provide the location where the ActiveEfficiency Web API is installed. By default, this is the NetBIOS name for the server where ActiveEfficiency server is installed but may be set to
localhostif 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.
- 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 Active Directory Requirements.
Access to the AD server or namespace will be verified when you click Next.
- 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 Shopping Central service account under requirements. For example, to set the ShoppingSrv service account for the ACME domain, enter
ACME\ShoppingSrvin 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.
- 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
localhostfor 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.
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.
- On the Admin Console Node Security screen – enter the Shopping security groups as described in prerequisites under the Shopping Admin Console access groups. For example, we have created three Shopping security groups FullShopAdmin, PartShopAdmin and ShopSMS. The FullShopAdmin group is configured so that it has security permissions to write to itself and to the two other groups. This group must be set as the Full Shopping DB Admin Access group. All other permissions will be added to the groups automatically by the Shopping installer. The accounts will be validated and warnings are raised if problems are encountered.
- On the Shopping management accounts screen – enter the details for specific accounts/groups used by Shopping to manage information, see Shopping Administrators Accounts in prerequisites for more details.
- 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, whos members are sent emails of any license threshold notifications
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.
- 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 Website prerequisites.
- 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.localor if you have modified the port from its default,
- Ready to install the application screen – click Next to install Shpopping.
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 .
- 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. You can remove them if you have all the installer prioerties on the dasme line.
- 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
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
Please contact 1E if you need to use HTTPS.
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 ):
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):
- Backup your Shopping database.
- 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.
- Test the unattended installation command-line in your lab environment to ensure it works before running it on your production environment.
Shopping can be uninstalled from Add/Remove Programs 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.