Setting Up EPiServer for Demo

Transcription

1 Setting Up EPiServer for Demo Abstract This document describes how to set up a standard EPiServer installation so that it can be used in a demo environment. Product version: 4.51 Document version: 1.0

2 Setting Up EPiServer for Demo 2 Table of Contents INTRODUCTION 3 QUICK GUIDE 3 SETTING UP THE DEMO ENVIRONMENT 3 INSTALLING EPISERVER... 3 Generate a License Key...3 Install SQL or Oracle Database Server...3 INSTALL EPIFIELDS... 5 How to Add EPiFields Support to Non-EPiFields Page Types...5 SET PERMISSIONS FOR FUNCTIONS... 5 SET UP THE UNIFIED FILE SYSTEM... 5 EPISERVER VERSION CONTROL... 5 ACTIVATE MICROSOFT OFFICE ADD-IN... 6 SET UP THE STATISTICS SERVER... 6 Installation with EPiServer Manager...6 Configure the Log Service to use a database...6 WSRP CONSUME WSRP PORTLETS... 6 MIRRORING... 6 Set Up Mirroring to Publish Content to a Remote EPiServer Site...6 Update web.config on the Remote Web Site with SOAP Extension Information...7 Set Up Your Demo Site as the Publishing Web Site...8 SUBSCRIPTIONS... 8 TESTING THE DEMO ENVIRONMENT 8 EPIFIELDS... 8 OUTGOING STATISTICS... 8 VERSION CONTROL... 9 CLIENT TOOLS... 9 WSRP CONSUMING PORTLETS MIRRORING Create a Channel and Destination in Your Demo Site...10 Publish a Page to the Remote EPiServer Site...10 Publish a Page to HTML...10 Publish a page to XML...11 REFERENCED DOCUMENTATION 11 APPENDIX 12 TEMPLATE.XSL The contents of this document are protected by copyright. Contents of the document may be freely copied and distributed, either digitally or in printed format, to all EPiServer users. EPiServer is a registered trademark of ElektroPost Stockholm AB. Other product and company names mentioned in this document may be the trademarks for their respective owners.

3 Introduction 3 Introduction This document describes how to set up a standard EPiServer installation so that it can be used in a demo environment. Configuration of many of the functions in this document is documented elsewhere in EPiServer, e.g. in a separate white paper. In order to ensure that this document is as accurate as possible, the document often refers to the existing documentation, which is updated in conjunction with new EPiServer releases. Quick Guide The following steps must be carried out to set up a demo site. If you have previously installed a demo site, you may know how to set up each step and need a quick overview of which steps should be done. 1. Install EPiServer 2. Install EPiFields 3. Set permissions for functions 4. Set up the Unified File System (default setting allows upload, searching and version control) 5. Set up version control 6. Activate Microsoft Office add-in 7. Set up the statistics server 8. Set up consumption of WSRP portlets 9. Set up mirroring 10. Set up subscriptions Setting Up the Demo Environment Installing EPiServer Install EPiServer from the Download Center on episerver.com. The instructions in this chapter can be found in further detail in the white paper, "EPiServer Installation Instructions". Generate a License Key EPiServer cannot be used without a valid license. If the EPiServer installation is to be used for testing and evaluation purposes, a demo license can be created using the link in the License key window in the installation wizard. Complete the Web form that appears. You can choose whether to bind the system to an IP address or to the MAC address of the network adapter. Install SQL or Oracle Database Server Install an SQL Database Server Install an SQL Database Server during installation according to the instructions below. 1. In the Databse setup/creation window of the installation wizard, select a server that the database you intend using is installed on. If the database is local, i.e. on the same machine you intend installing EPiServer, select (local).

4 4 Setting Up EPiServer for Demo 2. Select the name of the database you intend using from the Existing Database list or enter the name of a new database. Note The database must be installed and configured before you start installing EPiServer. Make sure that the specified user has owner rights to the database. Database installation instructions can be found in the Readme file supplied with the installation program. 3. In the User area, select an existing user or create a new user that has owner rights to the database specified above. In the Password box, type the password associated with the specified user. 4. Select the Do not install database check box if you do not wish to install a database for the EPiServer site. Click Next Setting Up Oracle Server The Oracle version of EPiServer requires a few extra files and a special license file. These files can be requested from support@ep.se since these files are not included in the standard installation. Setting Up Oracle Database Follow the instructions below to set up the Oracle database. 1. Log on to the Oracle database server with SQL*Plus, as the SYSTEM user. 2. Create tablespace for the EPiServer database. The following names and paths are just examples, adjust as suitable for your environment. The size specifications may need to be adjusted, but should be enough for a medium-sized Web site. CREATE TABLESPACE EPISERVER_DATA1 LOGGING DATAFILE '/oracle/oradata/epdev/ep_data1.ora' SIZE 50M EXTENT MANAGEMENT LOCAL; 3. Create a user and give the user basic rights. CREATE USER EPISERVER IDENTIFIED BY PASSWORD DEFAULT TABLESPACE EPISERVER_DATA1 TEMPORARY TABLESPACE TEMP; GRANT CONNECT, RESOURCE TO EPISERVER; 4. Logout from SQL*Plus. 5. Load the database schema. This assumes that the database host string is dbserver.company.com and user is defined as above. The SQL files referred to below are provided by support@ep.se. sqlplus > out.log 6. Verify that the out.log file does not indicate any errors. Upgrading From Older Versions of EPiServer The files distributed with the Oracle version contain an Upgrade folder. This folder contains several files to upgrade specific versions of the EPiServer database. Check the version number of your current EPiServer installation (see the title bar of Internet Explorer when in Admin or Edit mode) and run the files consecutively to upgrade the database step-by-step to the most current version. Finally you should run the oracle_proc.sql script to update all procedures and functions. Installation with Oracle Database Server Follow the instructions below to install EPiServer with Oracle Database Server. 1. Start the installation and proceed through the installation screens until you reach the Database setup/creation dialog.

5 Setting Up the Demo Environment 5 2. Select Do not install database. This will prevent any database installation to take place during installation, since the database has already been set up. 3. After the installation has completed, you need to make the following modifications to the web.config file: Change the database connection string. Data Source should correspond to the database host, User ID is the user and Password is the password. <add key="epsconnection" value="data Source=dbserver.company.com;User Id=EPISERVER;Password=PASSWORD;" /> Indicate that you are using the Oracle database driver by adding the following line to web.config. <add key="epsdatabaseclient" value="oracle" /> Install EPiFields Install EPiFields from the Download Center on episerver.com according to the installation instructions there. The installation instructions can alternatively be found in EPiFields Developer Information. Note EPiFields can only be used in the Editor in "EPiFields Ordinary Page" page types. To add EPiFields support to other page types, e.g. ordinary Web pages, follow the instructions below. How to Add EPiFields Support to Non-EPiFields Page Types 1. Go to Admin mode and, in the Page Type tab, select the page type that you want EPiFields to be available in, e.g. Ordinary Web page. 2. To change the LongString property type, click the MainBody property, which will open the Edit property window. Change the Type field so that it has property EPiServer.Fields.LongString. Click Save. Set Permissions for Functions Certain functions in EPIServer will not work as designed until you have set the correct access rights. Setting these access rights ensures that you have access to all functions in the Editor, detailed error messages for troubleshooting, advanced upload of files, and view and publish pages from Microsoft Office. In Admin mode, click Permissions for Functions from the Config tab. Click Edit for all the listed functions and add your username by clicking Add User. Set Up the Unified File System The standard EPiServer installation sets up the file system so that you have access to /upload and the version control folder /Documents. Drag-and-drop of files from Windows Explorer and upload of multiple files is enabled by default in the standard EPiServer installation. For further information about setting up the Unified File System, refer to the technical note, "Unified File System". EPiServer Version Control The EPiServer standard installation is delivered with a folder that is ready to be used for file version control. The /Documents folder is ready for files to be added, checked in, checked out and edited in Microsoft Office. Searching in the /Documents folder is enabled in EPiServer Manager. Open EPiServer Manager and go to the Capabilities section for the Web site in question. Click Enable in the Indexing section. If indexing is already enabled, you must first disable it and then re-enable it. If you receive an error message that the EPiServer Indexing Service is not running or installed, click View Configuration and delete the contents of the <indexes> element and save the file. Start the EPiServer Indexing

6 6 Setting Up EPiServer for Demo Service by clicking Administrative Tools and then Services from the Control Panel. Click EPiServer Indexing Service and then Start the service. Return to EPiServer Manager and click Enable again. Activate Microsoft Office Add-In Go to the root of your Web site and click the Microsoft Office Add-In tab. Check that the most recent version of the Office add-in is activated. If a new version of the add-in is available, install and activate it here. Set Up the Statistics Server Installation with EPiServer Manager Follow the instructions below to install the Log Service with EPiServer Manager. 1. Select the Capabilities node under the Web site for which you want to generate log messages. 2. In the Logging/Statistics group box, click Enable. Configure the Log Service to use a database To configure the Log Service with a database, the connection string in the configuration file (%programfiles%/episerver.logservice/episerver.logservice.exe.config) must be changed. Change the value for the parameter connectionstring to a connection string to an EPiServer 4.50 database. <configuration> <episerver.baselibrary> <objectstores> <parameter name="connectionstring" value="data Source=(local);Database=dbEPi ServerDemo450RC3;User Id=usrEPiServerDemo450RC3;Password=password;Network Library=D BMSSOCN;" /> WSRP Consume WSRP Portlets The standard EPiServer 4.50 installation includes a portal that can consume WSRP portlets for a WSRP producer. To set up your demo site as a WSRP producer, follow the instructions below. 1. Go to Admin mode in your demo site and click WSRP Sources in the Config tab. Enter a name for the WSRP producer and enter the following URLs in the following fields. Replace "450DemoSite" with the name of your demo site. Markup URL Service Description URL Registration URL Portlet Management URL 2. Test the settings by clicking the Test button. Mirroring The following instructions tell you how to setup a remote site and your demo site so that you can publish content from your demo site to the remote site. Requirements The following is required to be able to set up a news channel from an intranet site to an extranet site. Both sites must run EPiServer 4.50 or later. Both sites must have page types with the same name, in this case. Both page types should share at least MainBody so that there is a property to display externally.

7 Setting Up the Demo Environment 7 Set Up Mirroring to Publish Content to a Remote EPiServer Site 1. Install a new site and name it RemoteSite. 2. Step 2 only applies if your extranet site is using Forms authentication. Set up the new site with basic authentication. Make sure that the IIS directory security is set to Basic authentication AND that anonymous access is NOT allowed. Note By default the user needs to be a Windows administrator on the server that runs the extranet site. a. Open Internet Information Services Manager on the Web server and select the /WebServices folder on your remote EPiServer Web site. b. Right-click and select Properties. Under the Directory Security tab, click Edit. c. The authentication options must be configured for Basic Authentication only. Otherwise automatic authentication will not occur. d. Edit the Web configuration file, web.config, in the EPiServer root directory. Make sure that the Web service account is allowed access in the WebServices folder. Replace DOMAIN with the name of the domain or local machine where the user account was created. <location path="webservices"> <system.web> <authorization> <allow users="domain\mywebserviceuser" /> <deny users="*" /> </authorization> </system.web> </location> e. The BasicAuthentication http module will translate basic authentication requests on-the-fly to forms-authenticated cookies. Make sure that web.config has the BasicAuthentication filter defined under the httpmodules section. <httpmodules> <add name="basicauthentication" type="episerver.security.basicauthentication, EPiServer" /> f. Test the setup by opening a Web browser and entering the URL to a Web service on your Web site, for example: You will receive a standard Windows login pop-up window. g. Enter the WebServiceUser account information. If everything is working, you should see the Web Service definition page 3. Go to Admin mode and click the Config tab and then Remote Web Sites. 4. Edit the local site name, enter "RemoteSite" in the field and click Save. 5. Click Create. Enter the name of your demo site in the Name field. Enter in the URL field. (Replace DemoSite with the name of your demo site.) In the Shared secret for signature field, click Create to the right of the field and verify that a key is generated in the field. Leave the username, password and domain fields and check boxes empty. Click Save. Update web.config on the Remote Web Site with SOAP Extension Information Add the following under the <system.web> section in web.config on the RemoteSite: <webservices> <soapextensiontypes> <add type="microsoft.web.services2.webservicesextension, Microsoft.Web.Services2, Culture=neutral, PublicKeyToken=31bf3856ad364e35" priority="1" group="0" /> </soapextensiontypes> </webservices>

8 8 Setting Up EPiServer for Demo Set Up Your Demo Site as the Publishing Web Site (Replace all the occurrences of DemoSite in the instructions below with the name of your demo site.) 1. In your demo site, go to Admin mode, click the Config tab and then Remote Web Sites. 2. Edit the local site name, enter "DemoSite" in the field and save. 3. Click Create. Enter "RemoteSite" in the Name field. Enter in the URL field. In the Shared secret for signature field, copy and paste the key that was created when you created the remote site in the previous step. 4. Enter a valid Web service user, password, and domain. This is the same Web service user you entered in the previous step. 5. Click Save. Click Ping and verify that the connection between the demo (publishing) and remote sites works. Subscriptions Set up outgoing by entering the default SMTP server to be used under EPsSmtpServer in the site's web.config file, e.g. <add key="epssmtpserver" value="mailman.ep.se" /> Testing the Demo Environment EPiFields Make sure that you have added EPiFields support to non-epifields page types according to the instructions in the "How to Add EPiFields Support to Non-EPiFields Page Types" chapter. Create a new page on your demo site with the same page type that you have configured to use EPiFields support. If you have set up EPiFields correctly, the EPiFields icon is available in the Editor toolbar. Clicking the EPiServer icon opens the Insert EPiServer Field window, where you have access to the sample EPiFields. Outgoing Check that outgoing is working correctly by creating a subscription Go to the Subscription page under the Inspiration folder on the site. 2. Enter your address. (This is pre-stated if you have previously entered your address in My Settings.) Select As soon as possible in the Interval box and select the News check box. Click Save. 3. Create a news page with some content unde the News folder in the Inspiration tab. 4. Go to Admin mode and select Subscription under Scheduled Jobs. Click Start Manually, 5. A subscription will be sent to the address that you stated in the subscription. Statistics The setup of the statistics server is tested by going to Edit mode and viewing a page. A fourth tab, Statistics, should be available, which displays the statistics for the page in question. The home page of the site (in View mode) will also contain statistics information. Further information about the log service can be found in the white paper, "Log Service Installation Instructions".

9 Testing the Demo Environment 9 Version Control To test EPiServer's version control, open the File Manager and go to the /Documents folder. Right-click and select Add File. Add a file to the /Documents folder. Right-click and select Check Out. Check that your username appears in the Checked Out By column. Right-click the checked out file and select Edit in Office. Edit and save the document. Click Check In and write an appropriate comment. Go to the File Manager and Refresh the /Documents folder. Right-click the document you changed and select Version History. The changed version is version number 2. Right-click the document and select Download. Your changes should be visible in the opened document. For further information on version control, see the white paper, "Version Control in EPiServer". Test that searching is setup correctly for the /Documents folder by clicking the Search for files in the toolbar button. Enter the information for the file to be searched and click Search. If searching has been set up correctly according to the "EPiServer Version Control" chapter, you should get some search results. For further information on searching in the file system, see the technical note, "Unified File System". Client Tools Open the File Manager in your demo site. Open Windows Explorer and copy one or more files to the File Manager by dragging them from Windows Explorer and dropping them in the File Manager. Right-click in the File Manager and select Add Multiple Files. Select some files and make sure that they are loaded into the File Manager. For further information on setting up the file system, see the technical note, "Unified File System". Test that it is possible to publish documents from Microsoft Office by first opening an Office program. Create and save a new document. Click Publish to EPiServer and follow the instructions in the wizard to publish the document. For further information about publishing with EPiServer Office add-in, refer to the Editor's Manual and the technical note, "Microsoft Office Integration". Note If you have previously had a site installed and activated in the root and not in a virtual directory, you must remove the registry of the previously installed site from Office before you can register a site in a virtual directory. To do this, right-click and delete the virtual directory from the Publish to EPiServer dialog (see the image below). Go to Edit mode and deactivate and activate the Office add-in from the Activate tab under Microsoft Office Add-In. Click Publish to EPiServer from Office again. Your site is now included in the list of sites in the Publish to EPiServer dialog. Right-click and delete Deactivate and activate the Office add-in.

10 10 Setting Up EPiServer for Demo WSRP Consuming Portlets Test that you have set up the WSRP producer correctly by going to the EPiServer Portal Framework template under Templates. Fill the framework with content by selecting Design from the drop-down box in the top right corner. Drag some of the provided portlets to the empty page on the left. Mirroring The following tests require that mirroring has been set up according to the instructions in the "Mirroring" chapter. Mirroring can also be used to publish content to HTML and XML. This document initially contains information on how to do this, but this information will later be included in a separate document. Create a Channel and Destination in Your Demo Site 1. In the demo site, go to Admin mode, click the Config tab and then Mirroring Administration. 2. Click Create. Enter DemoChannel in the Name field. Choose a page, from where you wish to publish the tree structure (It should have children). 3. Choose "Tree" in the Mirror Type box. 4. Select Include the start page. Click Save. 5. Click Create Destination. Select EPiServer in the Select destination type box. Click OK. 6. Enter EPiServerDest in the name field. Choose your second EPiServer site in the Remote site box. Choose a page at the remote site and enter the page s ID in the Root page on destination field. Click Save. Publish a Page to the Remote EPiServer Site 1. In the demo site, edit the page that you selected as the publishing start page above. Save and publish the page. 2. Open the Action Window and click Approve mirroring updates. A list of updated channels appears and DemoChannel is listed with the amount of updated pages in parentheses. Click DemoChannel. 3. The currently updated pages are listed and a Publish button appears at the bottom. Click Publish. 4. Go to Mirroring administration on the Config tab in Admin mode. A list of queued jobs is listed under the channel Queue Length (If the scheduled service already executed it will say 0). 5. If the scheduled service does not run, click Mirroring Service under the Admin tab and click Start Manually. Check that the pages were published on the remote site. Publish a Page to HTML 1. In the demo site, go to Admin mode, click the Config tab and then Mirroring Administration. 2. Click DemoChannel and then Create Destination. 3. Select HTML as the destination type and click OK. 4. Enter EPiServerHTML in the name field. 5. Create a directory C:\episerverhtml in your file system. Enter C:\episerverhtml in the Target Directory on the server field. Enter /episerverhtml/ in the Relative root path field if you are to run the remote site from your hard drive. Click Save. 6. Create a new page in the demo site, publish it, and approve the mirroring updates in the Action Window. If the scheduled service does not run, click Mirroring Service under the Admin tab and click Start Manually. 7. Verify that the pages have been written to C:\episerverhtml.

11 Referenced Documentation 11 Publish a page to XML 1. In the demo site, go to Admin mode, click the Config tab and then Mirroring Administration. 2. Click DemoChannel and then Create Destination. 3. Select XML as the destination type and click OK. 4. Enter EPiServerXML in the name field. 5. Create a directory C:\episerverxml in your file system. Enter C:\episerverxml in the Target Directory on the server field. 6. Create a file called template.xsl under C:/episerverxml and fill it with the text in the "template.xsl" chapter of the Appendix. (The demo template.xsl is only a basic XSL example.) 7. Enter C:\episerverxml\template.xsl in the Path to XSL template field. Click Save. 8. Create a new page in the demo site, publish it, and approve the mirroring updates in the Action Window. If the scheduled service does not run, click Mirroring Service under the Admin tab and click Start Manually. 9. Verify that the pages have been written to C:\episerverxml. Referenced Documentation The following documents are used as a reference in this document. EPiServer Installation Instructions EPiFields EPiFields Developer Information Unified File System Version Control in EPiServer Log Service Installation Instructions Content Mirroring in EPiServer Content Mirroring Configuration

12 12 Setting Up EPiServer for Demo Appendix template.xsl <!-- --> - XSLT is a template based language to transform Xml documents It uses XPath to select specific nodes for processing. - A XSLT file is a well formed Xml document <!-- every StyleSheet starts with this tag --> <xsl:stylesheet xmlns:xsl=" version="1.0"> <!-- indicates what our output type is going to be --> <xsl:output method="xml" /> <!-- Main template to kick off processing our Sample.xml From here on we use a simple XPath selection query to get to our data. --> <xsl:template match="/"> <Page> <Title><xsl:value-of select="/page/properties/property[@name='pagename']/text()"/></title> <Body><xsl:value-of select="/page/properties/property[@name='mainbody']/text()"/></body> </Page> </xsl:template> </xsl:stylesheet>