Customer Web Portal Installation & Set-up Guide

Transcription

1 Customer Web Portal Installation & Set-up Guide

2 Miracle Service Customer Web Portal Setup Guide Last revised: November 16, 2012 Copyright Nexent Innovations Inc. All rights reserved. Miracle Service and Nexent Innovations and its related marks, images and symbols are the exclusive properties and trademarks of Nexent Innovations Inc. All other brands, product names, company names, trademarks and service marks are the properties of their respective owners. This document is provided as is and Nexent Innovations Inc. ( Nexent ) assumes no responsibility for any typographical, technical, or other inaccuracies in this document. Nexent reserves the right to periodically change information that is contained in this document; however, Nexent makes no commitment to provide any such changes, updates, enhancements, or other additions to this document to you in a timely manner or at all. NEXENT MAKES NO REPRESENTATIONS, WARRANTIES, CONDITIONS, OR COVENANTS, EITHER EXPRESS OR IMPLIED (INCLUDING, WITHOUT LIMITATION, ANY EXPRESS OR IMPLIED WARRANTIES OR CONDITIONS OF FITNESS FOR A PARTICULAR PURPOSE, NON- INFRINGEMENT, MERCHANTABILITY, DURABILITY, TITLE, OR RELATED TO THE PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE REFERENCED HEREIN, OR PERFORMANCE OF ANY SERVICES REFERENCED HEREIN). IN CONNECTION WITH YOUR USE OF THIS DOCUMENTATION, NEITHER NEXENT NOR ITS AFFILIATED COMPANIES AND THEIR RESPECTIVE DIRECTORS, OFFICERS, EMPLOYEES, OR CONSULTANTS SHALL BE LIABLE TO YOU FOR ANY DAMAGES WHATSOEVER BE THEY DIRECT, ECONOMIC, COMMERCIAL, SPECIAL, CONSEQUENTIAL, INCIDENTAL, EXEMPLARY, OR INDIRECT DAMAGES, EVEN IF NEXENT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, INCLUDING, WITHOUT LIMITATION, LOSS OF BUSINESS REVENUE OR EARNINGS, LOST DATA, DAMAGES CAUSED BY DELAYS, LOST PROFITS, OR A FAILURE TO REALIZE EXPECTED SAVINGS. Nexent Innovations Inc. Sheridan Science & Technology Park 2333 North Sheridan Way, Suite 201 Mississauga, ON L5K 1A7 Canada Miracle Service Customer Web Portal Setup Guide 2

3 Table of Contents CUSTOMER WEB PORTAL INSTALLATION AND SETUP GUIDE... 4 PREREQUISITES... 4 SYSTEM REQUIREMENTS... 4 INSTALLATION... 5 CONFIGURE MICROSOFT INTERNET INFORMATION SERVICE... 5 MIRACLE SERVICE CONFIGURATION... 6 STEP 1 ADD WEB SITE SALESPERSON... 6 STEP 2 ADD WEB SITE ORDER SOURCE... 6 STEP 3 ADD WEB SITE USER... 6 STEP 4 CONFIGURE CUSTOMER ACCESS IN MIRACLE SERVICE... 6 CUSTOMIZE CUSTOMER WEB PORTAL... 7 STEP 1 CONFIGURE GENERAL AND DATABASE PROPERTIES... 7 STEP 2 CONFIGURE SMTP SETTINGS AND CUSTOMIZE VIEWS... 9 STEP 3 CONFIGURE FUNCTIONAL SETTINGS TROUBLESHOOTING Miracle Service Customer Web Portal Setup Guide 3

4 Customer Web Portal Setup Guide Prerequisites The set-up procedure outlined in this document is based on a standard installation of Miracle Service software and a typical Microsoft computer system environment. System Requirements 1) Microsoft OS XP Pro, Windows Server 2003 or Windows Server ) Miracle Service Version 6.0 or newer. 3) IIS 6.0 or newer must already be installed and running. 4) Verify IIS has no existing application conflicts and is able to run.asp files. 5) The IIS Web server requires a Static IP address with port 80 assigned to the Miracle Service Web Portals. 6) ASP and ASP.NET features are installed in IIS Features 7) IIS6 Compatibility is installed if IIS7 is used. 8) Windows Internet Explorer Miracle Service Customer Web Portal Setup Guide 4

5 Installation The web portal installation files can be found on the Miracle Service website. Login to the Customer Center at and go to the Downloads section, or go directly to: Scroll to Web Portal Installation & Upgrades > ClickOnce Portal Installation/Upgrader. Be sure to follow the Installation Instructions posted there. You can also see them here: Configure Microsoft Internet Information Service See the document entitled Configuring Microsoft Internet Information Service. This can be found on the Miracle Service website. Login to the Customer Center at ww.miracleservice.com and go to the User Guides & Manuals section, or go directly to: The document is intended as a general guide on how to set-up and configure your computer to run the Technician or Wireless Web Portal applications. This guide assumes that you will set up your IIS server and that you have a good understanding of the IIS server. It also assumes you have established an Internet connection and are capable of managing any issues with Internet connectivity. The following are some internet links that may provide more information and background on these settings: Miracle Service Customer Web Portal Setup Guide 5

6 Miracle Service Configuration Step 1 Add Web Site Salesperson The Customer Web Portal requires that a salesperson defined as Web Site exists within your Miracle Service database. To add a new salesperson, run the Miracle Service Administration application. Select General Lookups and add Web Site to the Salesperson list. Step 2 Add Web Site Order Source The Customer Web Portal requires that an order source defined as Web Site exists within your Miracle Service database. To add a new order source, run the Miracle Service Administration application. Select General Lookups and add Web Site to the Source of Order list. Step 3 Add Web Site User The Customer Web Portal requires that a dedicated web user be created in Miracle Service that will have access to the database. To add a new user, run the Miracle Service Administration application. Select Administration->Security->User Security and add a web user. We recommend a username and password set to website. Step 4 Configure Customer Access in Miracle Service Your Miracle Service customers must be configured to allow access to the Customer Web Portal. In order to configure your customers, run the Miracle Service Client application. For each customer that you want to allow access, you will need to set them as a web active customer and assign them a password. Miracle Service Customer Web Portal Setup Guide 6

7 Customize Customer Web Portal The Customer Web Portal offers a high level of customization that allows you to define many aspects of the application. After the initial setup, you will be required to restart IIS after any changes are made to these settings. This will ensure that the changes are applied for all of your customers as they run the application. To restart IIS, open IIS and right click on Default Web Site. Select Stop. Right click again and select Start to restart IIS. Click the following link to run the administrative wizard. You should add this link to your browser favorites for future use. Note that you can substitute the IP address where localhost is used. Step 1 Configure General and Database Properties The first page of the administration wizard defines the general settings and database connection properties of the Customer Web Portal. Welcome Message: A greeting message that is displayed on the main application page. Logo Filename, Logo Width, Logo Height: Represents the file name of your logo. This file must be stored in the c:\inetpub\wwwroot\miracleservice\customerportal\customer\images directory. Logo width and height are specified in pixels (default size is 1000x100). You can specify the default MSv3_banner.jpg if you do not have a logo. Server Path URL: The absolute path to the Customer Web Portal. Miracle Service Customer Web Portal Setup Guide 7

8 Contact URL: A URL to your company web site, contact information, etc. Logging Path: Logging occurs for several application events, such as record changing, error logging, etc. The path specified must have write permissions for the Internet user. We recommend c:\inetpub\wwwroot\miracleservice\customerportal as the logging directory. Write permissions have already been granted in a previous step. Note that only the path should be specified. The file name for logging is eventslog.txt. Maximum List Size: Specifies the number of records to display on a single page when viewing Open Jobs, Metered Service Equipment and Item Search results. Database Path: Specifies the path to your Miracle Service database. Typically c:\miracledb\msbe.mdb. Security File Path: Specifies the path to your Miracle Service security file. Typically c:\miracledb\mo.mda. Connection Username: Specifies the username to use for the web site authentication. See Step 3 of Miracle Service Configuration. Connection Password: Specifies the password to use for the web site authentication. See Step 3 of Miracle Service Configuration. Miracle Service Customer Web Portal Setup Guide 8

9 Step 2 Configure SMTP Settings and Customize Views Click Next to continue with the administration wizard. The second page defines the SMTP settings and Customize Views of the application. Host: Hostname of your SMTP server. This is also referred to as your Outgoing Mail Server. Server Port: Specifies the TCP port for outgoing messages. The default is 25. Connection Timeout: Specifies the time allowed before an inactive connection is closed. Time is measured in milliseconds. A value of -1 indicates no timeout period. Server requires a login: If this option is checked, the username and password fields are used to authenticate the connection to the SMTP server. Sender Address: The complete address associated with the sender's account. It must be a valid account on the SMTP server specified in the host. View Open Jobs: Enables or restricts access to view open jobs. Create New Job Request: Enables or restricts access to create new job requests. Update Meter Readings: Enables or restricts access to update meter readings. Order Parts/Supplies: Enables or restricts access to order parts and/or supplies. View Order Status: Enables or restricts access to view the status of open orders. Miracle Service Customer Web Portal Setup Guide 9

10 Step 3 Configure Functional Settings Click Next to continue with the administration wizard. The third page defines the functional settings of the application. Default Request Type: The default request type for all new job requests created through the Customer Web Portal. New Job Request Confirmation Message: A message that is displayed to the user on the confirmation page of new job requests. New Job Request Customer Subject: The subject text used in outgoing confirmation s to a customer when a new job is created. Data values can be used by inserting a keyword identifier*. New Job Request Customer Text: The text used in outgoing confirmation s to a customer when a new job is created. Data values can be used by inserting a keyword identifier*. Miracle Service Customer Web Portal Setup Guide 10

11 New Job Request Internal Subject: The subject text used in all outgoing s to the Miracle Service user s account when a new job is created. Data values can be used by inserting a keyword identifier*. New Job Request Internal Text: The text used in all outgoing s to the Miracle Service user s account when a new job is created. Data values can be used by inserting a keyword identifier*. Order Confirmation Message: A message that is displayed to the user on the confirmation page of new orders. New Job Request Confirmation The Miracle Service user s address that will receive new job request notices. Order Parts/Supplies Confirmation The Miracle Service user s address that will receive new order notices. Order Status The Miracle Service user s address that will receive status requests for specified orders. Always Send New Job Request To Bill-To: Enables or restricts notifications to the customer s Bill-To when creating new job requests. Always Send New Job Request To Ship-To: Enables or restricts notifications to the customer s Ship-To when creating new job requests. Display Next Job Comments: Displays or hides the next job comments when reviewing job details. Display Item Pricing With Each Parts Order: Displays or hides item pricing when ordering parts. Display Order Totals: Displays or hides totals (subtotals, taxes, other charges and discounts) when viewing order details. *When you are configuring the subject and text you can specify data values to insert in the message. As listed below, the pipe ( ) symbol is used to identify keywords. The following keywords can be use: REQID = identifies the Request ID TASKID = identifies the Task Number CUSTID = identifies the Customer ID CUSTNAME = identifies the Customer Name SCHEDDATE = identifies the Scheduled Date SCHEDTIME = identifies the Scheduled Time Miracle Service Customer Web Portal Setup Guide 11

12 TASKDESC = identifies the Task Description REQUESTER = identifies the Task Requester REQUESTERPHONE = identifies the Task Requester s Phone BR = identifies a hard line break Display In-stock Items Only: Displays items in the Sales Order list if the Quantity in stock is greater than 0. If the Stock level is zero, the item will not display in the customer portal automatically. If you want to show items even if there is no stock, leave this unchecked. Allow Billto access to Shipto data (jobs and meter readings): Displays job information and meter reading information for all Shipto sites related to a Billto when logged in to the Billto account. This gives users a master account view to see all jobs for all sites by logging in to the main Billto Account. If this is left unchecked, the Billto account login will only see the jobs and meter reading records for the equipment at the Billto site. Miracle Service Customer Web Portal Setup Guide 12

13 Troubleshooting Problem Issue Resolution Error Type: (0x F) Web Page not Displaying Access is denied Logo does not display. Application configuration changes are not updated. The event class for this subscription is in an invalid partition. The problem is due to the SMTP settings on server. The server is not setup to relay SMTP messages. IIS may not be started or able to run.asp file. This error occurs upon moving to the second wizard screen in the administration wizard OR upon logging into the Customer Web Portal. The logo specified in the administration wizard does not appear in the Customer Web Portal. Application settings are not applied when your customers run the Customer Web Portal. Setup your SMTP Virtual Server to relay messages. See section Setup SMTP Relay Open your Services and verify that IIS Admin and World Wide Web Publisher started. Create a test file in the wwwroot directory under inetpub. Open the test file using Internet Explorer to verify the site can serve.asp files. Read and Write permissions have not been properly set to the directory that stores the adminconfig.xml file or to the defined logging directory. The image file must be located in the images directory of the web server files. i.e. c:\inetpub\wwwroot\miracleservice\ CustomerPortal\Customer\Images After running the administration wizard you must restart IIS in order for the changes to apply. Miracle Service Customer Web Portal Setup Guide 13