Content Mirroring Configuration

Transcription

1 Content Mirroring Configuration Product version: 4.51 Document version: 1.1 Document creation date: Purpose This document describes how to configure mirroring in EPiServer and contains information on how to set up a news channel from an intranet site to an extranet site. 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.

2 2 Content Mirroring Configuration Revision Information Document version Comments release version. 1.1 Added Appendix with template.xsl. Table of Contents INTRODUCTION 2 CHANNEL... 2 DESTINATION: HTML... 3 DESTINATION: XML... 3 DESTINATION: EPISERVER... 3 SET UP A DEMO SITE AND REMOTE SITE 4 REQUIREMENTS... 4 SET UP MIRRORING TO PUBLISH CONTENT TO A REMOTE EPISERVER SITE... 4 UPDATE WEB.CONFIG ON THE REMOTE WEB SITE WITH SOAP EXTENSION INFORMATION... 5 SET UP YOUR DEMO SITE AS THE PUBLISHING WEB SITE... 5 TESTING OPERATIONS... 5 TROUBLESHOOTING 7 ERROR: SERVER FOUND REQUEST CONTENT TYPE TO BE 'APPLICATION/DIME', BUT EXPECTED 'TEXT/XML'... 7 ERROR: OBJECT MOVED TO HERE / ACCESS DENIED... 7 ERROR: SYSTEM.WEB.HTTPEXCEPTION: MAXIMUM REQUEST LENGTH EXCEEDED... 7 ERROR: TIMEOUT EXCEEDED... 7 APPENDIX 8 TEMPLATE.XSL... 8 Introduction Channel In EPiServer, the information defining the content that should be mirrored from the Web site is defined in channels. You can have multiple channels defined in one EPiServer site. Each channel contains properties that define the pages that should be included in a channel. A channel does not know or care about where the pages are being delivered, it only makes sure the underlying publisher receives information about the changes according to the channel properties. It is important to understand that the channel mirrors what it can see, not the actual pages. This means that access rights, filters, publish dates, etc. can be used to obtain a customized view of data. One of the major properties of a channel is the channel type. There are three types of channel to choose from: Tree - The tree model finds all changes made to a tree (move, delete, update, create). All these changes will be sent to all destinations. The tree model always finds differences by starting at the root page and recursing the tree. This means that a sub-page will never be included if the parent is not included. If you

3 Introduction 3 exclude a page (by using a filter), all sub-pages will also be excluded. This type is primarily used to be able to mirror a tree structure where the target will be a replica tree structure of the source. List - The list model works exactly the same way as a tree model with the difference that it won t recurse after the first level. Search - The search model will only find changed (or "marked as changed") or new pages. Delete and move operations are not intercepted. This model is specifically designed to be able to mirror pages regardless of location to a single destination/list. This is useful for scenarios when news should be exported to another system (news service or another global news list in another EPiServer system). New or modified content can be released either manually or automatically. This is defined in the channel properties. Content is manually released by the editor from EPiServer's Action window. The Mirroring service in Admin mode can be used to set up a scheduled job, so that content is automatically mirrored at, for example, a set time every day or week. When changes are approved they are handled over to destinations as defined on the channel, these changes are queued in the database on each and every destination. Destination: HTML The pages will mirror HTML files by sending a Web request to the page's URL. This request downloads the content and stores it as HTML files in the local file system on the server. A tree structure will in this way be mirrored to a tree structure in the file system, where a page becomes a folder. The function will also search all HTML that is downloaded, and search for references to images, links and style sheets. Links must be relative to the site for this to work; otherwise the links will be left untouched. Mirroring to HTML takes longer than the other types of mirroring, as the Web server must be contacted for each page and the content downloaded. As changes to a single page can affect a large amount of pages, e.g. menus, there is a setting that controls that each update fetches all pages all over again and checks whether they are affected by the change. Destination: XML XML mirroring works in a similar way to HTML mirroring in that each page will mirror a file on the local file system. The only difference is that instead of downloading HTML from the page, the properties will be extracted and formatted to an XML file via an XML style sheet (XSLT). Destination: EPiServer EPiServer mirroring can be summarized as an automated export/import between two Web sites. When the content is changed, it is packaged into an export package in EPiServer and sent via a Web service to the other Web site, where it is unpacked and imported into the system. There are, however, several differences between EPiServer's standard export/import in Admin mode. The first difference is that the receiver remembers which pages have been received for a certain channel and will make sure that the next time the same page is received, it will be updated instead of being re-created. A second difference is that files and images will not be packaged and sent inside the export package. They are sent separately before the actual export package is sent. Microsoft Web Service Extensions (WSE), which supports DIME, makes it more efficient to send binary files.

4 4 Content Mirroring Configuration Set Up a Demo Site and Remote Site 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. 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. 1. Open Internet Information Services Manager on the Web server and select the /WebServices folder on your remote EPiServer Web site. 2. Right-click and select Properties. Under the Directory Security tab, click Edit. 3. The authentication options must be configured for Basic Authentication only. Otherwise automatic authentication will not occur. 4. 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> 5. The BasicAuthentication http module will translate basic authentication requests on-the-fly to formsauthenticated cookies. Make sure that web.config has the BasicAuthentication filter defined under the httpmodules section. <httpmodules> <add name="basicauthentication" type="episerver.security.basicauthentication, EPiServer" /> 6. 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. 7. 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.

5 Set Up a Demo Site and Remote Site 5 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> 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. Testing Operations The following tests require that mirroring has been set up according to the instructions in the "Set Up a Demo Site and Remote Site" 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 6 Content Mirroring Configuration 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. 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 Appendix at the end of this document. (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.

7 Troubleshooting 7 Troubleshooting Error: Server found request content type to be 'application/dime', but expected 'text/xml' Make sure that you added the Web service extension in web.config on the destination server as described in the instructions above. Error: Object moved to here / Access denied Make sure that the Web Service user has access to log on to the server. For more troubleshooting and configuration options, please refer to the Web Services technical note. Error: System.Web.HttpException: Maximum request length exceeded Maximum request length exceeded when exporting large amounts of information. This problem is solved by changing certain settings in the system. Make sure that both httpruntime and maxrequestlength are set in the receiving mirroring site. Change the maxrequestlength to KB (40 MB). Example: <httpruntime maxrequestlength= /> <configuration> <microsoft.web.services2> <messaging> <maxrequestlength>40960</maxrequestlength> //kilobyte </messaging> </microsoft.web.services2> Error: Timeout exceeded To solve the problem of an exceeded timeout, increase the timeout value in Internet Information Service (IIS). It may also be necessary to increase the timeout value for the receiving site. See for further information.

8 8 Content Mirroring Configuration 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>