SDK Installation Using Installer

Version 34 by Ats Kagawa
on Sep 23, 2010 09:25.

<< Changes from 33 to 34

compared with

Current by Richly Chheuy
on Nov 03, 2010 08:37.

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (2)

View Page History

...

First, [Review Software and Hardware Requirements|ecf51installanddeploy:System Requirements].

h3. Follow These Steps

h4. Download and Extract Mediachase ECF G5.1 Package to Local Machine

Download the Mediachase.ECF.SDK.5.1 zip package from the link we send you. For information on how to purchase a package and obtain the link, contact [sales@mediachase.com|mailto:sales@mediachase.com].

Once you download and extract the package you will the following contents as shown in the image below. 
\\
           !InstallationWizardScreen0.png|thumbnail,border=1!

*<<Note>> For Windows Server 2003 users only:* Our current release has one known issue that requires one additional manual process before running the installer. For more details, click on [#Known Issues with the installer]  

h4. Run the Installation Wizard

* Click *\Mediachase.ECF.SDK.5.1\setup.exe* and the ECFG5.1 Installation Wizard will launch.
*{+}Note{+}{*}*:* There are two files with similar names: *setup.exe* and *setup.exe.config*. Please use setup.exe as the config file will only open the XML file in a browser.
* Select *Next* to move on to the next screen. You can always return to previous pages at any time by clicking *Back.*
!InstallationWizardScreen1.png|thumbnail,border=1!

* You will see the *End User License Agreement* screen. If you agree with the Terms and Conditions, select *I have read and accepted the Agreement* and click *Next*.
*{+}Note{+}{*}*:* If your machine is does not fulfill the (system requirements link), the installer will give you a warning and will not allow you to continue with the wizard. Make sure that all system requirements are met before continuing.
!InstallationWizardScreen1Eula.png|thumbnail,border=1!
* In *Database Configuration* screen, enter all the necessary information to your SQL database.
** *Server Name or IP Address:* Enter in directly or click on *Browse* and select your database server.*Note:* If you are installing on localhost, you can either click *Browse* and the select the actual name of your workstation, or manually enter the database server name as ".", or "(local)" without the quotations. Entering "localhost" into this field does *NOT* work by design.
** *Site Database Name:* Select an existing database name available in the drop-down menu or type in a new name, and a new database in the specified SQL database server will be created. 
*{+}Note{+}*: If you enter in a name that already exist, you will be asked to confirm whether it is okay to overwrite the existing one.
** *Database Owner Credentials:* You have an option to set up SQL Authentication or Windows Authentication for your ECF Database.
*** With the SQL Authentication option, database user name and password fields are used to create a database owner log-in account for your database to be used in the website. Enter a unique set of credentials each time you run the installer to create a new user account. On the other hand, if you wish to re-use the same user name, you *must* enter the same password* *that you previously used for the particular user name (The installer will fail if you enter a preexisting user name with a different password).
*** With the Windows Authentication, the database user name and password will be matched to your windows log-in.

** *SQL Admin Credentials:* Just as the Database Owner Credentials, you have two options to for setting up your database authentication.
*** Under the SQL Authentication option, you must enter a preexisting user account that has sys_admin rights in your SQL server. You may use the exact same user name and password as the database owner you entered above, provided that it has sys_admin rights. 

*{+}Note{+}*: While a new SQL login for Database Owner can be created automatically for you by the wizard, the SQL Administrator login must be an existing login with sys_admin rights to your SQL Server.

** Click *Next* to move on.

...

          !InstallationWizardScreen3DbConfig.png|thumbnail,border=1!

* *IIS Web Site Configuration* screen: This screen will help you set up an IIS web site for your installation.
** *IIS Web Site:* Use the pull-down menu to select an existing site or click on *New Site* and a new window will appear. Here, you will be asked to enter the web site name, port number, host header, and the path to the folder you want to deploy the web folders.
*{+}Note{+}{*}*:* The "New Site" option will not be available to XP users since IIS 5 does not allow you create multiple web sites. XP users will have to keep the Public Site as the \*Default Web Site\* and use the two options below to set up a Web Application.
** *Map to IIS Web Application:* Check mark *Map to IIS Web Application* if you choose to create a web application directory under the IIS site you specified in the previous step.
** *IIS Web Application Name:* This field is enabled if the check box above is selected. Enter a site application name here.
*** *Option 1:* Selecting the Web Application option is useful because it enables multi-site functionality in a single domain/site folder scenario. For example, if you set the IIS Web Site to *Default Web Site* and enter "/b2csamplesite" for the IIS Web Application name, then your IIS web site will be set up with an URL [http://localhost/b2csamplesite|http://localhost/b2csamplesite]. When you are ready to add your second site, all you need to do is to go to your IIS directory and create a second Web Application and call it "/site2" and point its local path to your original /b2csamplesite Web Application directory (no copying of files/folders is necessary).
*** *Option 2:* You can choose not to select the "Map to IIS Web Application" option if you are interested in a multi-site/multi-domain scenario.
For example, you can create a IIS web site with multiple host headers all pointing to the same directory. The first site would be [http://www.yoursite.com|http://www.yoursite.com/] and your second site can be [http://www.testsite.com|http://www.testsite.com/] (or [http://subdomain.yoursite.com|http://subdomain.yoursite.com/]) and everything is pointing to the same IIS directory.          

          !InstallationWizardScreen5IISWebSite.png|thumbnail, border=1,width=300!

* *Configuration Options*: This screen will allow you to specify the options to set up a B2C Sample Site catalog and install and start a Quartz Job Secheduler Service for ECF.
** Choosing the "Install Sample Site and Catalogs" option will allow the installer the import the B2C Sample Site and Catalog. Unless you have your site and catalogs all ready, we recommend you to select this option, since you can always disable or delete the site and catalogs that gets imported here.
** Choosing to "Install the Quartz Service" will allow the installer configure and start the start the Quartz Service, which periodically runs configured jobs such as search indexing of your catalogs, rotating encryption, or placing recurring orders. Catalog search indexing is available by default and selecting this option will start running the re-indexing service.
*Note*: Since selecting this option will perform the initial build of the catalog search index, if it is NOT selected, you must manually index the catalogs in Commerce Manager (Back-end) after completing the installation.  Otherwise, the catalogs will not appear in the public site. To see how to accomplish this, see the [#Browsing Your Public Sample Site] section towards the bottom of this screen.
** The path specified for the "Shared Program Files Location" is where ECF's shared files (License, Quartz, CMS/Apps folders) will be placed.
*Note*: By default, this will be set to the C:\Program Files\Mediachase\eCommerceFramework\5.1\{Web Site or Web Application Name specified above}, but can be changed to any path you like. If you don't have any preference, we recommend that you either use this default location, or the path where you specified your IIS Web Site folders to be in the "*IIS Web Site Configuration*" screeen above.

           !InstallationWizardScreen6ConfigOptions.png|thumbnail,border=1,width=200!

* *Confirm Installation:* The summary of your setup will be displayed here. Select Next to begin your installation. It will take a few minutes for the installation to complete.
** If there are any issues with the information you entered in the previous steps, an error message appears in the progress window. If that happens, you can return to previous steps in the Installation Wizard and re-run the installation. 
** You can also submit the error you are seeing directly to Mediachase ECF G5 Support by clicking on the email icon at the bottom right corner of the progress window. It will help us if you can also provide any additional information such as your OS version and the installation step you see the error on.

           !InstallationWizardScreen7Summary.png|thumbnail,border=1! 
           !InstallationWIzardScreen8SetupProgress.png|thumbnail,border=1!

h3. Known Issues with the installer

* {color:#c0c0c0}On the Database Configuration screen there are options to use Windows Authentication for the database owner and admin. These options are currently not working. Use SQL Authentication instead.{color} >> This has been resolved in the new release (Installer ver 1.2.2.46).

* We have one known issue with the installer for Window Server 2003 users. If you are planning to use the installer to set up a trial package, you will need to manually create a new IIS Web Site before you run the installer. On Step 3 of the wizard titled "Public Website Configuration," use the drop-down menu to select the web site that you manually created beforehand. The option to *Create New Website* does not work for Windows Server 2003. The installer works fine on all other operating systems without having to create a new IIS Web Site manually. 
** When manually creating your IIS Web Site, make sure that the following IIS properties are correctly set:
*** Execute permissions option > *Scripts Only*
*** ASP.NET version > *2.0.50727*

h3. Verification: Performing Simple End User Tasks

Now you should be able to verify a few simple tasks on the front-end site.

h4. Browsing Your Public Sample Site

Browse to [http://localhost/b2csamplesite|http://localhost/b2csamplesite], or any other URL you specified. The B2C Sample Site homepage will open.
Click on *Digital Cameras* menu or other catalog menus and you will be redirected to the chosen catalog samples.

*Note:* If you didn't choose the *Install Quartz Service* option on the *Configuration Options* screen of the wizard, then you must first index your catalogs. To do this, log in as "admin" using the default credentials (*user name*: admin, *password*: store) and select the *Management Console* tab that will appear on the top of the sample page. Once you are in the Commerce Manager environment, go to *Administration > System Settings > Search Index* and click *Rebuild*. The catalog will be indexed momentarily. Once the indexing is complete and everything works, you are done. If you encounter problems, please read our (Adding Troubleshooting link) section.

h4. Accessing Commerce Manager

To access Commerce Manager, select *Log in to Your Account* located at the top of your public site and use the default administration credentials (same as logging in as "admin"). Click on the *Management Console* tab appears at the top of the screen and you will be rerouted to the Commerce Manager.

h3. Completely Uninstalling ECF after a Successful or Failed Installation

To completely uninstall a successful or failed installation, do these four tasks:

* Delete the Mediachase installation folder (typically found into C:\Program Files)

* Delete the newly created database

* Delete the site in IIS

* Delete Quartz service running

If the install failed and depending on where it failed, you may not need to do all four, but at the minimum delete the entire Mediachase folder under Program Files.