Digital StoreFront – SmartCanvas Installation Guide

Digital StoreFront - SmartCanvas

2 Digital StoreFront - SmartCanvas Installation Guide

Copyright © 2004 - 2017 by Electronics for Imaging, Inc. All Rights Reserved.

EFI Productivity Suite | Digital StoreFront - SmartCanvas Installation Guide

January 2017

Document Version 1.4

This publication is protected by copyright, and all rights are reserved. No part of it may be reproduced or transmitted in any form or by any means for any purpose without express prior written consent from Electronics for Imaging, Inc. Information in this document is subject to change without notice and does not represent a commitment on the part of Electronics for Imaging, Inc.

Patents

This product may be covered by one or more of the following U.S. Patents: 4,716,978, 4,828,056, 4,917,488, 4,941,038, 5,109,241, 5,170,182, 5,212,546, 5,260,878, 5,276,490, 5,278,599, 5,335,040, 5,343,311, 5,398,107, 5,424,754, 5,442,429, 5,459,560, 5,467,446, 5,506,946, 5,517,334, 5,537,516, 5,543,940, 5,553,200, 5,563,689, 5,565,960, 5,583,623, 5,596,416, 5,615,314, 5,619,624, 5,625,712, 5,640,228, 5,666,436, 5,745,657, 5,760,913, 5,799,232, 5,818,645, 5,835,788, 5,859,711, 5,867,179, 5,940,186, 5,959,867, 5,970,174, 5,982,937, 5,995,724, 6,002,795, 6,025,922, 6,035,103, 6,041,200, 6,065,041, 6,112,665, 6,116,707, 6,122,407, 6,134,018, 6,141,120, 6,166,821, 6,173,286, 6,185,335, 6,201,614, 6,215,562, 6,219,155, 6,219,659, 6,222,641, 6,224,048, 6,225,974, 6,226,419, 6,238,105, 6,239,895, 6,256,108, 6,269,190, 6,271,937, 6,278,901, 6,279,009, 6,289,122, 6,292,270, 6,299,063, 6,310,697, 6,321,133, 6,327,047, 6,327,050, 6,327,052, 6,330,071, 6,330,363, 6,331,899, 6,340,975, 6,341,017, 6,341,018, 6,341,307, 6,347,256, 6,348,978, 6,356,359, 6,366,918, 6,369,895, 6,381,036, 6,400,443, 6,429,949, 6,449,393, 6,476,927, 6,490,696, 6,501,565, 6,519,053, 6,539,323, 6,543,871, 6,546,364, 6,549,294, 6,549,300, 6,550,991, 6,552,815, 6,559,958, 6,572,293, 6,590,676, 6,606,165, 6,633,396, 6,636,326, 6,643,317, 6,647,149, 6,657,741, 6,662,199, 6,678,068, 6,707,563, 6,741,262, 6,748,471, 6,753,845, 6,757,436, 6,757,440, 6,778,700, 6,781,596, 6,816,276, 6,825,943, 6,832,865, 6,836,342, RE33,973, RE36,947, D341,131, D406,117, D416,550, D417,864, D419,185, D426,206, D439,851, D444,793.

Trademarks

The APPS logo, AutoCal, Auto-Count, Balance, Best, the Best logo, BESTColor, BioVu, BioWare, ColorPASS, Colorproof, ColorWise, Command WorkStation, CopyNet, Cretachrom, Cretaprint, the Cretaprint logo, Cretaprinter, Cretaroller, DockNet, Digital StoreFront, DirectSmile, DocBuilder, DocBuilder Pro, DocStream, DSFdesign Studio, Dynamic Wedge, EDOX, EFI, the EFI logo, Electronics For Imaging, Entrac, EPCount, EPPhoto, EPRegister, EPStatus, Estimate, ExpressPay, Fabrivu, Fast-4, Fiery, the Fiery logo, Fiery Driven, the Fiery Driven logo, Fiery JobFlow, Fiery JobMaster, Fiery Link, Fiery Prints, the Fiery Prints logo, Fiery Spark, FreeForm, Hagen, Inktensity, Inkware, Jetrion, the Jetrion logo, LapNet, Logic, MiniNet, Monarch, MicroPress, OneFlow, Pace, PhotoXposure, PressVu, Printcafe, PrinterSite, PrintFlow, PrintMe, the PrintMe logo, PrintSmith, PrintSmith Site, Printstream, Print to Win, Prograph, PSI, PSI Flexo, Radius, Rastek, the Rastek logo, Remoteproof, RIPChips, RIP-While-Print, Screenproof, SendMe, Sincrolor, Splash, Spot-On, TrackNet, UltraPress, UltraTex, UltraVu, UV Series 50, VisualCal, VUTEk, the VUTEk logo, and WebTools are trademarks of Electronics For Imaging, Inc. and/or its wholly owned subsidiaries in the U.S. and/or certain other countries.

All other terms and product names may be trademarks or registered trademarks of their respective owners, and are hereby acknowledged.

Digital StoreFront - SmartCanvas | Installation Guide 3

Table of Contents

Contact Information ...................................................................................................... 4

Introduction ................................................................................................................... 5

Prerequisites ................................................................................................................. 5

Minimum System Requirements .................................................................................. 5

Requirements for SmartCanvas Server Component ........................................................................ 5 IT Requirements for SmartCanvas Server Component .................................................................... 6

Install EFI SmartCanvas Server Component .............................................................. 6

Activate SmartCanvas Software .................................................................................. 8

Integrate Your Digital StoreFront Server with the SmartCanvas Server .................. 9

Validate the Installation .............................................................................................. 11

Appendix: Create Database User for Remote Database Configuration .................. 13

Appendix B: Installation Known Issue ...................................................................... 13

4 Digital StoreFront - SmartCanvas Installation Guide

Contact Information

EFI Support

Web Site: https://customer.efi.com

US Phone: 1.855.EFI.4HLP / +1 412-690-4321

UK Phone: +44 (0) 800.783.2737

EU Phone: +31 20 658 8080

APAC Phone: +61 7 3625 9200

South America

Phone: +1 412-690-4321

E-Mail: dsf.support@efi.com

Note For problems involving infrastructure (i.e., computers, networks, operating systems, backup software,

printers, third-party software, etc.), contact the appropriate vendor. EFI cannot support these types of issues.

EFI Professional Services

US Phone: 651.365.5321

US Fax: 651.365.5334

E-Mail: ProfessionalServicesOperations@efi.com

EFI Professional Services can help you perform EFI software installations, upgrades, and updates. This group can also help you implement, customize, and optimize your EFI software, plus offers a range of training options.

Digital StoreFront - SmartCanvas | Installation Guide 5

Introduction

EFI SmartCanvas powered by DirectSmile is a Web-based (HTML5) product design tool that enables administrators to create templates within Digital StoreFront for a variety of products such as greeting cards, flyers, business cards, brochures, stationery, and banners.

This guide presents the end-to-end process of setting up EFI SmartCanvas powered by DirectSmile in an existing Digital StoreFront self-hosted environment.

Prerequisites

A new (virtual) dedicated server that meets the minimum system requirements defined in the “Minimum System Requirements” section below.

Important Note The SmartCanvas Server component cannot be installed on the same server as Digital StoreFront. Please consult the SmartCanvas server component system

requirements below and ensure that the server you will be installing SmartCanvas on meets or exceeds the minimum system requirements.

If you will be installing SmartCanvas on a dedicated server (one that is not running Digital StoreFront, EFI VDP, or EFI DirectSmile Cross Media).

Proceed to install and activate following the instructions in this document.

OR

If you are using EFI VDP or EFI DirectSmile and want to install SmartCanvas on your existing EFI DirectSmile server

SmartCanvas can be installed on that server but only with the assistance of the EFI DirectSmile team who will contact you within five (5) business days. To schedule an installation appointment with the EFI DirectSmile Support Team, please visit http://update.directsmile.com and enter the SmartServer System ID you received with your Digital StoreFront license key.

Important: You must not attempt to install SmartCanvas on your existing EFI VDP

or EFI Cross Media server without first securing the assistance of the EFI DirectSmile team.

Note If you have not received your license keys, you can request them by filling out the Order

Upgrade Contact Form available at upgrade order form.

You must have a public IP addresss and domain name and public certification prior to installation of SmartCanvas.

You must use a full server certificate that is installed in your Personal certificate store—not a self-signed certificate. Using a self-signed certificate will require every person who logs in to add the

server certificate on the local machine.

Minimum System Requirements

Requirements for SmartCanvas Server Component

Ensure that your system meets the minimum system requirements listed below:

Computer / Processor: 64-bit processor, minimum 1.5 GHz and 4 Virtual Cores

Operating System: Windows 2012 Server R2 Standard Edition or Microsoft Windows Server®

2008

x64 Standard Edition

Note You must have all Windows updates installed and have the server configured as a Web server.

Role check box

6 Digital StoreFront - SmartCanvas Installation Guide

Memory: 8 GB of RAM

Storage: 500GB

Other: .Net framework 4.6.1 must be installed on the computer before SmartCanvas is installed

Note To determine what version of .Net framework you are using, see

https://exchangemaster.wordpress.com/2016/03/16/quick-method-to-determine-installed-version-of-net-framework/.

You can download .Net framework 4.6.1 from https://www.microsoft.com/download/confirmation.aspx?id=49981

IT Requirements for SmartCanvas Server Component

Server accessibility

Important Note The SmartCanvas site must be accessible outside the network.

Note The SmartCanvas server is being set up as an application server.

Ports Out: 80, 443

Ports In: 80, 443

Site Security

Important Note The SmartCanvas site must be secured (https URL) and accessible outside the network. If the

SmartCanvas site is not secured, you will not be able to create or edit a SmartCanvas design template.

Install EFI SmartCanvas Server Component

Note Please be aware that there is a known issue with the SmartCanvas installation involving an Unhandled

Exception. If you encounter this error at any point during the installation process, please follow the steps in the “Appendix B: Installation Known Issue” section on page 13 of this document.

1. Once you have received the information from EFI on receiving and installing your software, follow the steps below after downloading the exe file.

2. Locate and copy the SmartCanvas install media exe file into the C:\Temp folder on the SmartCanvas server.

3. On the SmartCanvas server, double click the SmartCanvas install exe to extract.

4. Run the SmartCanvas setup.exe installer which can be found in the extracted install media.

5. On the Welcome screen, click Next.

Note The installer will now enable the Windows Features required to install SmartCanvas. This can

take several minutes.

6. On the License Agreement screen:

Read & Accept the EULA.

Click Next.

7. On the Choose Destination Location screen:

Select a Default destination for the installation.

Click Next.

8. On the Setup Type screen:

When prompted to select a SQL installation mode:

If you have already installed Microsoft SQL Server Express 2012/2014, choose Use existing 2012/2014.

Digital StoreFront - SmartCanvas | Installation Guide 7

OR

If you have not already installed Microsoft SQL Server Express 2012/2014, select Install SQL Express 2014.

Click Next.

On the pop window for providing SQL Instance name and Credentials click on OK Button

9. On the Database Server screen, when prompted for database server credentials:

Note If you will be connecting to a remote database (i.e., if the database you are connecting to is not

on the SmartCanvas server), you will need to create a database user. See Appendix: Create Database User for Remote Database Configuration on page 13 for instructions.

If you have already installed Microsoft SQL Server Express 2012/2014, enter the account created during the Create Database User step. OR

If you have not already installed Microsoft SQL Server Express 2012/2014, enter the Microsoft

SQL Express 2014 instance name and sa password.

Click Next ().

10. On the Database Names screen, provide the values below:

DSMI: dsmodb

DSMImage: dsmoImages

LP3: LP3_DSM

11. Click Next

12. On the Common Cert Name screen:

If you have installed your own certificate, select it from the certificate list. OR

If you have not installed your own certificate, ensure that the last item in the list SelfSSL is

selected.

Note If you do not see the Common Cert Name screen, no certificates were found and a self-signed

certificate will be created and used.

Click Next.

13. On the Fully Qualified Server Domain window , provide <<HostServerName>>.myprintdesk.net

Click Next

14. On the Data Paths screen, specify folders for temporary and user data files:

Note The installer will create the folders with the appropriate permissions (i.e., Full Control). If you

specify an external location for the DSMTEMP and/or DSMUSERS folders, the installer will prompt you for the user credentials for accessing the folders.

DSMG: Accept the default value (C:\Program Files (x86)\EFI\DSF\SmartCanvas\Generator)

Temp: C:\DSMTemp

Users: C:\DSMUsers

Click Next.

15. On the Ready to Install screen, click OK.

16. On the InstallShield Wizard complete screen:

8 Digital StoreFront - SmartCanvas Installation Guide

Select Yes, I want to restart my computer now.

Click Finish.

Note Your computer will reboot.

Activate SmartCanvas Software

1. Log into the SmartCanvas server.

2. Browse to the SmartCanvas install folder (i.e., C:\Program Files (x86)\EFI\DSF\SmartCanvas) and click the ActivateSmartCanvas shortcut.

If the site does not load, verify that:

the certificate you selected is present in the Personal Folder under certificates.

there is a binding in IIS for https for the Default Web Site with the certificate.

3. On the “Let’s activate DSMI step 1/3” page, enter your [System Id] to load your contact data.

Note If you have a self-signed certificate, the site is blocked. To fix, add the URL to the trusted site.

Digital StoreFront - SmartCanvas | Installation Guide 9

Click Add… and add the website in the Trusted sites window.

4. Click Get activation data.

5. On the “Let’s activate DSMI step 2/3” page, complete all the fields and verify that your email address is correct (your activation key will be sent to this email address).

6. Click Request activation key.

7. Check your email for the activation key. After you have received it, proceed to the next step.

Note Be sure to check the junk mail folder in your email client.

8. Enter the activation key.

9. Click Activate your DSMI.

Integrate Your Digital StoreFront Server with the SmartCanvas Server

After installing EFI SmartCanvas you need to integrate Digital StoreFront with SmartCanvas.

(1) Generate the administrator public and private keys that enable Digital StoreFront to communicate with SmartCanvas

Note You can generate admin public and private keys only on the local server (i.e., where your

DirectSmile SmartCanvas software is installed).

1. On the SmartCanvas server, go to the \Program Files (x86)\EFI\DSF\SmartCanvas folder and click the SmartCanvas.html to open the generator URL.

Note You can also go to the generator manually by opening a web browser and accessing the following URL using the IntegrateSmartCanvas shortcut in C:\Program Files

(x86)\EFI\DSF\SmartCanvas.

2. Click to save the generated .json file from the local host to your download folder.

3. Open the json file and copy your generated keys in the SmartCanvas server AdminPublic Key and SmartCanvas server Admin Private Key fields described below.

Note The ID in the json file is the code you will need to enter in the AdminPublic Key field in Digital

StoreFront (in step (3) 2 below).

10 Digital StoreFront - SmartCanvas Installation Guide

(2) Verify that you are licensed for SmartCanvas

1. Log into Digital StoreFront.

2. Go to Administration > License.

3. Scroll down to the PRODUCT OPTIONS section and verify that the SmartCanvas option is selected.

(3) Configure SmartCanvas connection

1. In Digital StoreFront, go to Administration > DirectSmile VDP Configurations (under the Platform

Settings heading).

2. On the DirectSmile VDP Configuration page, SmartCanvas Server Configurations tab, configure the following settings:

SmartCanvas Server URL: This is the address (URL) to the SmartCanvas server. (On an intranet this will be http://[computername]>/dsmx.)

Note The SmartCanvas URL must be accessible to external sites.

Note If you want to use SmartCanvas securely (https), you must have a valid certificate

installed on the SmartCanvas server. The URL you enter in this field should be prefaced with https rather than http. When you access the SmartCanvas site, you will be able to see the certificate.

Note Use of HTTP or HTTPSis based on the Digital StoreFront site url. If the Digital StoreFront

site is https then set the server URL on the SmartServer Configuration tab to HTTPS.

If you want to integrate Digital StoreFront and SmartCanvas in non-secured mode (http), you do not need a valid certificate on the SmartCanvas server.

SmartCanvas server AdminPublic Key (called ID in the json file): Enter your 32 digit

SmartCanvas administrator public key.

SmartCanvas server Admin Private Key: Enter your 64 digit SmartCanvas administrator private

key.

Status Report HTTP: This is the address to which SmartCanvas calls back to your system web

site to report on the status of SmartCanvas jobs.

Note You can accept the default value for this field unless otherwise directed.

Digital StoreFront - SmartCanvas | Installation Guide 11

Note After clicking Default ensure that the Status Report HTTP URL always uses HTTP not HTTPS.

3. Click Save and Create Account.

Validate the Installation

1. In Digital StoreFront, go to Administration > Manage SmartCanvas Templates.

2. On the Manage SmartCanvas Templates page, click Create New Design.

3. On the Create Template window:

Enter a Template Name (e.g., “Test”).

Click Create Template.

4. Verify that the SmartCanvas designer opens.

5. When the designer opens, create and save a simple test design template.

6. Go to Administration > Products.

7. Click Create Product.

8. Create a test product of the type EFI SmartCanvas Powered by DirectSmile.

9. Click Next and configure your test product and publish it on the storefront.

10. Go to the storefront and verify that you can order your product.

12 Digital StoreFront - SmartCanvas Installation Guide

11. If you were able to create, publish, and order the test product and ordered successfully: Your

installation was successful. OR If you were not able to create, publish, and order the test product:

Please verify that the following service is running on the SmartCanvas server:

DSMOnlineBackend.exe

DirectSmile Trigger Service

Verify that the following processes are running on the SmartCanvas server:

DSMWatchDog.exe

VDPOnlineServer.exe

Note When contacting the support team, please provide support with the following log files in the

event of any technical issues:

C:\Program Files (x86)\EFI\DSF\LogFiles\dd-mm-yyyy\ \SMARTCANVAS_SOFTWARE_INSTALL1.log C:\Program Files (x86)\DirectSmile\DirectSmile Logs\dsmi-backend-yyyy-mm-dd.log

C:\Program Files (x86)\DirectSmile\DirectSmile Logs\DSMWatchDog.log C:\Program Files (x86)\DirectSmile\DirectSmile Logs\vdp-online-server-yyyy-mm-dd.log

Digital StoreFront - SmartCanvas | Installation Guide 13

Appendix: Create Database User for Remote Database Configuration

Note This step is needed only if you are using a remote database connection (i.e., if the database you are

connecting to is not on the SmartCanvas server).

Follow the steps in this section if you have already installed Microsoft SQL Server Express 2012/2014 and need to create the following user In SQL Server Management Studio (if the user does not already exist):

1. In Object Explorer, highlight the SQL Server and open a new query.

2. Load the query with the SQL (i.e., CreateDatabaseUser.sql) from the following folder:

9.2.0.xxxxx_Update\Support\SmartCanvas\Setup\.

3. Update the certificate name certname ( CERTIFICATE certname ) and then execute the query.

4. Expand Security/Logins and right-click the DSMSQLUSER login and select Properties.

Appendix B: Installation Known Issue

Please be aware that there is a known issue with the SmartCanvas installation.

If an error dialog opens at the beginning or during SmartCanvas installation with text ”Error Number: 0x80040707 Description: DLL function call crashed: ISRT._RegQueryKeyValue Setup will now terminate” complete the steps below.

1. Restart the server.

2. Delete the following registry value (if it exists): Hive: HKLM Key: SYSTEM\CurrentControlSet\Control\Session Manager Multi-String: PendingFileRenameOperations

3. Restart the SmartCanvas installation.