Open topic with navigation

Synchronizing servers using eSync

Ektron’s eSync keeps websites up-to-date efficiently. From single sites, global multi-sites, and server farms, eSync provides scalable, geo-synchronization capabilities that let you easily update exactly what you want, when you want to update it.

Ektron’s eSync lets users update content anywhere safely by employing certificate-based authentication to secure your website, whether it is on a production server or a development environment. Also, your updates can take place on the safe side of your firewall before being moved to the live site. Within complex IT infrastructures, eSync can synchronize content, assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s, HTML pages and other website components, whether they are managed by Ektron or not.

eSync efficiently makes updates and eliminates site downtime by moving only the changes you want to move, from single pieces of content to entire sites. With its intelligent synchronization technology, eSync securely moves selected content bidirectionally: Web 2.0 sites have a wealth of user-generated content and membership information which can be synchronized back to the development side of the firewall. To track changes to Ektron data between syncs, eSync creates a c:\sync folder structure that mirrors your site’s Windows folder structure. This structure is created on each server when sync relationships are first established. No Ektron files reside in the \sync folders. Instead, each folder has four .sync files that monitor changes to Ektron files in the corresponding folder.

eSync manages content dependencies, that is references to other files such as images. eSync automatically handles the synchronizing of dependencies, so you do not need to worry about these extra files. Adjusting relationship settings explains how to sync content dependencies.

You can synchronize at any time with single or multiple servers; strategic times that assure optimal performance, while facilitating site updates; low-traffic times to coordinate global multi-site setups. You also can schedule time-sensitive events.

If conflicting versions of content exist, eSync’s configurable conflict resolution engine preserves your most recent content. The version that isn’t posted is saved in a history log (along with other previous versions), letting you track changes or restore if necessary.

If you have multiple development servers, eSync can create a copy of the live site to work with. As your developers change the site, their updates can by synchronized to the staging and production servers. eSync also can support advanced infrastructures, including load balancing and failover server configurations.

Every server in a sync relationship is assigned a unique number. The originating server is 1, the first server with which it establishes a relationship is 2, and so on. The server number is stored in the c:\sync\serverinfoXX.xml file.

<SyncServerInfoList>
  <SyncServerInfo IsSyncRunning="false" Migrated="false" MaxId="2" ServerNumber="1" ...

All Ektron data is assigned a unique ID number to distinguish it from similar objects. Examples are content (see illustration), folders, menus, users, and so on.

When you create a sync relationship, Ektron applies a new ID numbering range to each server to ensure that, from then on, objects created on either server have a unique ID. This prevents collisions when synchronizing between servers. For example, since membership users created on a production server have a different ID number range from those created on the staging server, eSync does not overwrite them.

To view a server’s ID number range, open its C:\sync\serverinfoXX.xml file, and check the MaxId value as shown in the following example.

<SyncServerInfoList>
  <SyncServerInfo IsSyncRunning="true" MaxId="3" ServerNumber="1"....

Multiply that number by 1 trillion to get the largest ID number which that server can assign. For example, if MaxId = 3, ID numbers range from 2,000,000,000,001 to 3,000,000,000,000.

Setting up eSync

This section explains several scenarios for installing and setting up eSync.

Prerequisites for Using eSync

To use eSync, you must have the following:

  • Ektron software and files
    • Ektron Version 8.5 or higher

      IMPORTANT: The version of Ektron on every server in the sync relationship must match. You can neither upgrade nor downgrade Ektron using eSync.

    • An Ektron base installation file (for example, cms400Base9x.exe). Use to install a second site with which to sync your current site.
    • Ektron licenses that support Enterprise or Professional with eSync on every server being synchronized.
    • Matching security certificates on every server being synchronized. See also: Managing eSync security certificates.

      NOTE: If you upgrade, your initial sync must be to a min database.

  • Microsoft Software
    • See Ektron System Requirements.
    • Microsoft Sync Framework 2.1

      NOTE: It is not a problem if your templates were created using the 2.0 Framework.

    • Database servers may use different SQL server versions. (For example, your development server uses SQL 2008 Express, and your production server uses SQL Server 2008 R2.)

  • User Permissions
    • You are a member of the Ektron Administrators group or assigned the Synchronization Admin role. See also: Defining roles.
    • The user performing the sync is assigned the following SQL database roles
      • db_owner (needed for initial sync only; after that is complete, you may remove this role)
      • db_datawriter
      • db_executor (created by Ektron installer when setting up database)
      • db_ddladmin

      • db_datareader

  • Server
    • GMT time on each server’s clock must be within 5 minutes of each other.

Characteristics of eSync

You administer eSync through the Workarea > Settings > Configuration > Synchronization > Profiles screen. The screen lets you establish a sync relationship between 2 websites, then specify any number of sync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.s for each relationship.

You can sync immediately by clicking Sync ().

You create profiles to sync these kinds of data.

  • database objects (content, menus, users, and so on)
  • Workarea folder files
  • remaining site files

File types or individual files can be included or excluded from a sync profile. Alternatively, you can sync content or folders. See also: Synchronizing content and folders.

Sync relationships

You can synchronize any server to or from any other server with one important exception: you cannot initiate a sync from a server outside the firewall. You can only initiate a sync from a server inside the firewall because an outside server does not know the address of servers inside the firewall. However, your staging server can push to and pull from a production server.

IMPORTANT: eSync transmissions use port 8732. This is not configurable.

Relationship 1: One staging server, one production server

The most basic eSync relationship involves a staging and a production server. Each server has a database and one site.

eSync can automatically create a production server from your staging server. See also: Initializing a new site.

For installation instructions for this relationship, see Scenario 2: Synchronizing a local server with a remote server.

Relationship 2: One development, one staging, one production server

This relationship includes a development server. Developers can use it to create new features and modify existing ones. When they are done, they can sync changes to the staging server, where they can be verified before being moved to production.

For installation instructions for this relationship, see Scenario 3: Setting up a development > staging > production environment.

Relationship 2a: Multi-site staging and production servers

The following relationship illustrates synchronizing several sites on a staging server with those sites on production.

Relationship 3: Several dev. servers, one staging, one production server

As shown in the illustration, any number of development servers can sync to each other and your staging and production servers.

Relationship 4: One dev., one staging, one production site, one production DB server

In this relationship, the production site has 2 servers: one for site files, and another for the database.

To synchronize these servers, set up several eSync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.s. One syncs the database, assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s, and templates to the production database server. Another profile syncs the staging server’s Workarea files with the production site server.

NOTE: When using separate site and database servers, assets are stored on the site server.

Relationship 5: Relationship 4 plus pre-production server

This relationship adds a server between staging and production. The preproduction server can be used for review and testing of changes before they are moved to production.

Relationship 6: Multi-site: each Site and DB on own production server

In this relationship, each production server has its own database plus the site files. As an alternative, you could have a separate server for each production database, with all sites on one production server.

NOTE: The above relationship also supports separate site and database servers.

To synchronize this type of relationship, set up several eSync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.s, one for each site.

  • 3 database and template profiles
  • 3 Workarea profiles

Initializing a new site

Typically, before you begin using eSync, one server hosts an Ektron website, and you want to bring other servers into the relationship. After the servers are synchronized, one is the staging server, the one on which content is created or updated, then published. Another server, production, hosts your live website.

IMPORTANT: The names of the site and all folders must match on both servers. This is because paths to images, XSLTExtensible Stylesheet Language Transformations files, and so on, refer to a site and its folders. If the names do not match, the links break.

First, use eSync to initialize new servers from the existing one. Afterward, use eSync to periodically sync updated content, folders, users, menus, and so on.

Scenario 1: Synchronizing 2 sites on the same server

It is unlikely that you will use this relationship in “real-life” situations, but it provides the simplest way to begin testing and learning eSync.

IMPORTANT: Only use this scenario in a test environment. For a live environment, use either Scenario 2: Synchronizing a local server with a remote server or Scenario 3: Setting up a development > staging > production environment.

  1. Log into your Ektron server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. Begin to install the first site. See also: Installing Ektron.
  3. During installation, when the following dialog appears, check eSync.

  4. Near the end of the installation, the following dialog appears.

    1. At the Site Name drop-down, select the site you just installed.
    2. Check the radio button next to Generate Certificates.
    3. Click Generate.
  5. Install a second site on the same server, again using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.

    IMPORTANT: Install both sites to a physical folder relative to the root folder. Do not install one site to a physical folder relative to the root folder and the other site to a virtual directory.

  6. Repeat Steps 2 and 3 above for the second site.
  7. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The security configurator screen appears.

  8. In the Web Site Description drop-down, select the first site.
  9. Click Apply Remote Server Certificates.
  10. Click Browse next to that field.
  11. Browse to C:\Program Files (x86)\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.
  12. Click Apply.

    NOTE: Ektron Windows Services stop and restart at this point.

  13. Repeat Step 7 through 11 for the second site.

Now that both sites’ security certificates are configured, continue from Part 3: Connect local and remote servers.

Scenario 2: Synchronizing a local server with a remote server

To sync a local to a remote server, install a minimal Ektron site to a new, remote server. Next, use eSync to upload your Ektron site from the local to the remote server. After the you complete the initial and template syncs explained in this chapter, the 2 sites are mirror images of each other.

Follow these steps to configure 2 servers to sync with each other.

Prerequisite

See s for Using eSync

Part 1: Set up a Min site on the remote server

  1. Upgrade the local server to the latest version of Ektron if necessary.
  2. On the remote server, install a minimum Ektron site whose version matches the local server by running the Ektron base installation file (CMS400Base9x.exe). For more information, see System Requirements.

    IMPORTANT: Install both sites to a physical folder relative to the root folder. Do not install one site to a physical folder relative to the root folder and the other site to a virtual directory.

  3. If the local site is pre-compiled, you must also pre-compile the remote site.

Part 2: Generate and copy security certificates

Security certificates authorize file synchronization between servers. In this part, you generate security certificates on the local server, then copy them to the remote.

IMPORTANT: Near the end of the installation procedure, you are prompted to generate security certificates. If you completed that screen, skip steps 2 through 6.

  1. Sign on to the local server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  3. The following screen appears.

  4. At the Web Site Description field, select the website on the local server.
  5. Click Generate.
  6. Click Yes. The certificates are created on the local server.

    NOTE: Ektron Windows Services stop and restart at this point.

  7. Close the dialog.
  8. Open 2 Windows Explorer windows side-by-side: one showing the local server’s file system, and the other showing the remote server’s file system.
  9. In the remote server window, create a folder underneath the root folder. Name the folder local security certificate.

    WARNING! Do not create the new folder under the Web root, C:\inetpub\wwwroot.

  10. In the local server window, open the following folder:
    32-bit:
    C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator
    64-bit:
    C:\ProgramFiles (x86)\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator
  11. From that folder, copy these files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
  12. Paste the files into the remote folder you created in Step 8. Make sure there are no other security files in the folder.
  13. Close both windows you opened in Step 7.

    NOTE: After copying security certificates to the remote folder, they need to be registered and moved to the correct folders. The Security Configurator screen does this.

  14. Sign on to the remote server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  15. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  16. The security configurator screen appears.

  17. Click Apply Remote Server Certificates.
  18. Click Browse next to that field.
  19. Browse to the local security certificate folder where you pasted the security certificates in Step 11.
  20. Click Apply.

    NOTE: Ektron Windows Services stop and restart at this point.

  21. Click Yes to continue.
  22. The security configurator copies the certificates you pasted in Step 11 to the correct folder, and configures them for the remote server.
  23. Click OK when you see All sites are now configured for eSync.
  24. Next, generate security certificates on the remote server, then copy them to the local.

    To accomplish this, repeat the steps in Part 2: Generate and copy security certificates, but this time, treat the remote server as the local server and vice versa.

Part 3: Connect local and remote servers

WARNING! Back up your database before beginning this procedure.

  1. On the local server, sign on to the Workarea > Settings > Configuration > Synchronization > Profiles. The View All Synchronization Configurations screen appears.

  2. Click Create Synchronization Server Relationship. This screen appears.

  3. At the Remote Server field, enter the remote server name. The remote server appears in the Choose Certificate field.
  4. Click Connect. A screen shows the remote server's databases.

  5. Click the database with which you want to sync then Next. A screen appears, showing both servers.
  6. Click Switch Synchronization Direction. The screen indicates that the database will be uploaded from your local server to the remote server.
  7. Click Create. This action connects the local and remote servers.

Part 4: Upload the local server’s database and resources to the remote server

NOTE: If your Ektron has a very large database or number of assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s, and you want to reduce the time required to complete the initial sync, see Minimizing the time of the initial sync.

  1. From the View All Synchronization Configurations screen, click Start Initial Sync ().

  2. The initial sync uploads the local server’s database and resources to the remote server. A screen tracks the progress.

  3. When the sync is finished, Synchronization is Complete appears.

    The initial sync creates a default database profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.. You can reuse this profile to sync database/resource files in the future.

Minimizing the time of the initial sync

Use the following procedures if you have a large database or number of assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s and want to minimize the time to complete an initial sync. In both cases, you use a tool other than eSync for the initial copy. From then on, use eSync to sync your servers.

Copying the initial database

To quickly copy a database between servers:

  1. On your Ektron server, open the folder C:\Program Files (x86)\Ektron\EktronWindowsService40.
  2. Open Ektron.ASM.Services40.exe.config.
  3. Set the <add key="skipDataSyncChanges"> element to true.
  4. Restart the Ektron Windows Service.
  5. Back up the database of the local server.
  6. Restore that backup to the remote server.
  7. Run an initial sync.
  8. Restart the Ektron Windows Service.
  9. Update your license key.
    For example, if the original database is backed up from staging and restored on production, the license key in the database may be for the Staging.abc.com domain. But, on the production server, you need a production domain key, such as abc.com. See also: License keys.
  10. Change the <add key="skipDataSyncChanges"> element to false.

Copying initial assets

Assets consist of files in these folders:

  • siteroot/assets
  • siteroot/privateassets
  • siteroot/uploadedfiles
  • siteroot/uploadedimages
  • C:/assetlibrary

If your Ektron has a large number of assets, you may want to reduce the initial sync time. To copy asset files between servers quickly:

  1. On your Ektron server, open C:\Program Files (x86)\Ektron\EktronWindowsService40\Ektron.ASM.Services40.exe.config.
  2. Set the <add key="skipFileSyncChanges"> element to true.
  3. Restart the Ektron Windows Service.
  4. Using Windows Explorer, copy the folders listed above from the local to the corresponding folders on the remote server.
  5. Run an initial sync.
  6. Change the <add key="skipFileSyncChanges"> element back to false.
  7. Restart the Ektron Windows Service.

Part 5: Upload local server’s templates to remote server

  1. From the View All Synchronization Configurations screen, click Add Sync Profile. The Add Synchronization Profile screen appears.

  2. At the Synchronization name field, give this profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. a name, such as Local - Remote Template Sync.
  3. At the Items to Synchronize field, select Template.
  4. Check bin to include dlls and assembly changes.
  5. For Synchronization Direction, choose Upload.
  6. For Schedule, choose None.
  7. Save the profile.
  8. Click Sync () to the right of the template profile.

  9. A screen tracks the sync’s progress. When it is complete, Synchronization is Complete appears. You can use the template profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. to sync templates in the future.

Scenario 3: Setting up a development > staging > production environment

Before

After

In this scenario, Ektron initially resides on one server. Consider that your production server and use it to initialize the staging and development servers.

NOTE: In this scenario, you cannot sync between the development and production servers. The sync can only be run between Development and Staging or Staging and Production.

Prerequisite

See s for Using eSync

Part 1: Set up min site on the staging and development servers

  1. Upgrade your server to the current version of Ektron if necessary.
  2. Install a minimum site on the staging and development servers by running the Ektron base installation file (cms400Base9x.exe). See System Requirements.

    IMPORTANT: Install both sites to a physical folder relative to the root folder. Do not install one site to a physical folder relative to root and the other sites to virtual directories.

Part 2: Generate and copy security certificates

Security certificates authorize synchronization between servers. In an eSync relationship, every server needs a security certificate from every other server.

To generate and copy these certificates:

2a. Generate certificates on production and copy to staging and development

IMPORTANT: Near the end of the installation procedure, you are prompted to generate security certificates. If you completed that screen, skip steps 2 through 4.

  1. Sign on to the production server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.

  2. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The following screen appears.

  3. In the Web Site Description field, select the production server website.
  4. Click Generate. The certificates are created on the production server.
  5. Open 2 Windows Explorer windows: one showing the production server’s file system, and the other showing the staging server’s file system.
  6. In the staging server window, create a folder underneath the root folder. Name the folder Prod security certificates.

    WARNING! Do not create the new folder under the Web root, C:\inetpub\wwwroot.

  7. In the production server window, open the following folder: C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.
  8. From that folder, copy these files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
  9. Paste the files into the folder you created in Step 6. Make sure there are no other security files in the folder.
  10. Close both windows.

    After copying security certificate files to the staging folder, they need to be registered and moved to the correct folders. The Security Configurator screen does this.

  11. Sign on to the staging server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  12. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The security configurator screen appears.

  13. Click Apply Remote Server Certificates.
  14. Click the browse button next to that field.
  15. Browse to the folder to which you pasted the security certificates in Step 9.
  16. Click Apply. The security configurator copies the certificates you pasted in Step 9 to the correct folder, and configures them for the staging server.
  17. Follow the same procedure to move production certificates to the development server. To do this, begin at Step 6 and follow all steps. Wherever the instructions mention a staging server, substitute the development server.

2b. Generate certificates on staging and copy to development and production

  1. Sign on to the staging server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.

    IMPORTANT: Near the end of the installation procedure, you are prompted to generate security certificates. If you completed that screen, skip steps 2 through 4.

  2. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The following screen appears.

  3. At the Web Site Description field, select the staging server website.
  4. Click Generate. The certificates are created on the staging server.
  5. Open 2 Windows Explorer windows: one showing the staging server’s file system, and the other showing the production server’s file system.
  6. In the production server window, create a folder underneath the root folder. Name it staging security certificates.

    WARNING! Do not create the new folder under C:\inetpub\wwwroot.

  7. In the staging server window, open the following folder: C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.
  8. Copy these files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
  9. Paste the files into the folder you created in Step 6. Make sure there are no other security files in the folder.
  10. Close both windows opened in Step 5.

    NOTE: After copying the security certificate files to the production folder, they need to be registered and moved to the correct folders. The Security Configurator screen does this.

  11. Sign on to the production server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  12. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The security configurator screen appears.

  13. Click Apply Remote Server Certificates.
  14. Click the browse button next to that field.
  15. Browse to the folder to which you pasted the security certificates in Step 9.
  16. Click Apply. The security configurator copies the certificates you pasted in Step 9 to the correct folder, and configures them for the production server.
  17. Follow the same procedure to move staging certificates to the development server. To do this, begin at Step 6 and follow all steps. Where the instructions mention a production server, substitute the development server.

2c. Generate certificates on development and copy to staging and production

  1. Sign on to the development server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.

    IMPORTANT: Near the end of the installation procedure, you are prompted to generate security certificates. If you completed that screen, skip steps 2 through 4.

  2. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    The following screen appears.

  3. At the Web Site Description field, select the website on the development server.
  4. Click Generate. The certificates are created on the development server.
  5. Open 2 Windows Explorer windows: one showing the development server’s file system, and the other showing the staging server’s file system.
  6. In the staging server window, create a folder underneath the root folder. Name the folder Dev security certificates.

    WARNING! Do not create the new folder under C:\inetpub\wwwroot.

  7. In the development server window, open the following folder: C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.
  8. Copy these files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
  9. Paste the files into the staging server folder you created in Step 6. Make sure there are no other security files in the folder.
  10. Close both windows you opened in Step 5.
  11. After copying the security certificate files to the staging folder, they need to be registered and moved to the correct folders. The Security Configurator screen does this.
  12. Sign on to the staging server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  13. Click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator. Right click and choose Run As Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  14. Click Apply Remote Server Certificates.
  15. Click the browse button next to that field.
  16. Browse to the folder you created in Step 6.
  17. Click Apply.
  18. The security configurator copies the certificates you pasted in Step 9 to the correct folder, and configures them for the staging server.
  19. Follow the same procedure to move development certificates to the production server. To do this, begin at Step 6 and follow all steps. Wherever the instructions mention a staging server, substitute the production server.

Part 3: Connect staging and production servers

WARNING! Back up your database before beginning this procedure!

  1. On the staging server, sign on to Ektron.
  2. In the Workarea, go to Settings > Configuration > Synchronization > Profiles. The View All Synchronization Configurations screen appears.

  3. Click Create Synchronization Server Relationship. That screen appears.

  4. In the Remote Server field, enter the production server.
  5. In the Choose Certificate field, the name of the production server appears.
  6. Click Connect. This action connects the staging with the production server. A new screen appears showing the production server's database.

  7. Click Next. A new screen appears, showing both servers.

  8. Click Create. This action connects the staging and production servers.

Part 4: Download production server database to staging server

NOTE: If your Ektron has a very large database or number of assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s, and you want to reduce the initial sync time, see Minimizing the time of the initial sync.

  1. From the View All Synchronization Configurations screen, click Start Initial Sync ().

  2. The initial sync downloads the production server’s database and resources to the staging server. A screen tracks progress.

  3. Synchronization is Complete appears.

    The initial sync creates a default database profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.. You can use the profile to run database/resource syncs in the future.

Part 5: Download the production server’s templates to staging

  1. From the View All Synchronization Configurations screen, click Add Sync Profile. The Add Synchronization Profile screen appears.
  2. At the Synchronization name field, give this profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. a name, such as Prod - Staging Template Sync.
  3. At the Items to Synchronize field, select Template.
  4. Check bin to include dlls and assembly changes.
  5. For Direction, choose Download.
  6. For Schedule, choose None.

  7. Save the profile.
  8. Click Sync () to the right of the profile. A screen tracks the sync’s progress.

  9. When the sync is complete, Synchronization is Complete appears. You can reuse the template sync profile in the future.

Part 6: Connect development and staging servers

  1. Sign on to Ektron development server.
  2. In the Workarea, go to Settings > Configuration > Synchronization > Profiles. The View All Synchronization Configurations screen appears.

  3. Click Add (). The Create Synchronization Server Configuration screen appears.

  4. At the Remote Server field, enter the name of the staging server.
  5. At the Choose Certificate field, the name of the staging server appears.
  6. Click Connect. This action connects the development with the staging server. After you connect to the staging server, a new screen appears showing its database.

  7. Click Next. A new screen appears, showing both servers.

  8. Click Create. This action connects the development and staging servers.

Part 7: Download staging server database to development server

NOTE: If your Ektron has a very large database or number of assets, and you want to reduce the initial sync time, see Minimizing the time of the initial sync.

  1. From the View All Synchronization Configurations screen, click Start Initial Sync ().

    The initial sync downloads the staging server’s database and resources to the development server. A screen tracks the sync’s progress.

  2. When the sync is complete, Synchronization is Complete appears.

    The initial sync also creates a default database profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.. You can reuse this profile to sync the database/resources between these 2 servers at any time in the future.

Part 8: Download staging server templates to development

  1. From the View All Synchronization Configurations screen, click AddProfile. The Add Synchronization Profile screen appears.
  2. At the Name field, give this profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. a name, such as Staging-Dev Template Sync.
  3. At the Items to Synchronize field, select Template.
  4. Check bin to include dlls and assembly changes.
  5. For Direction, choose Download.
  6. For Schedule, choose None.

  7. Save the profile.
  8. Click Sync () to the right of the profile. A screen tracks the sync’s progress.

  9. When the sync is complete, Synchronization is Complete appears. You can reuse the profile to sync templates in the future.

Setting up eSync profiles

To minimize data entry, eSync saves job specifications in a profile. After you enter specifications once, select the profile to sync again using the same details. A profile contains the following information:

Use the Add/Edit Synchronization Profile screen to manage eSync profiles.

While Setting up eSync, you created a default database and a template profile. This section explains how to modify those profiles and create new ones.

To sync a website, you need at least 2 profiles: one for the siteroot/Workarea folder, and another for all other site files. To create a profile for

The following list explains which files are synchronized by each grouping under Items to Synchronize.

  • Database/Resources. Synchronizes database tables plus the following site root folders. See also: Setting up a profile to Sync a database.
    • assets
    • PrivateAssets
    • uploadedimages
    • uploadedfiles
  • Workarea. Synchronizes files in the site’s Workarea folder. See also: Setting up a profile to sync workarea files.
  • Template. Synchronizes files in the site root folder. See also: Setting up a profile to sync template and bin files.

    IMPORTANT: If you run a template sync and Bin is checked, and one server is running is 32-bit mode while the other is running in 64-bit mode, users will not be able to drag and drop DMSDocument Management System; Ektron's way of managing assets (Microsoft Office files and other types of files) files on the staging server.

    NOTE: If you perform an initial sync of a recently-installed min site with your staging site, the min site’s templates could overwrite templates on your staging site. This is because, when 2 templates have the same name, the most recently-modified one overwrites the other.
    To avoid this, rename the only template installed with the min site (login.aspx) before performing the initial template sync. You should also rename login.aspx’s supporting files, such as login.aspx.vb.

  • Bin. Synchronizes the siteroot/bin folder, including DLLs and assemblies.

The following file types are not synchronized by default.

  • .config files
  • .txt files
  • .sln files

You may add these file types to a Workarea or Template profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. via the Include/Exclude Files field.

Setting up a profile to Sync a database

Prerequisites

To set up a profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.:

  1. Go to the Settings > Configuration > Synchronization > Profiles screen.

  2. Click Add Sync Profile. The Add Synchronization Profile screen appears.
  3. At the Name field, enter a name for this profile.
  4. At the Profile Type field, choose Scope or Local Package.
    • To define a Scope, continue through the steps.
    • To define a Local Package, see Synchronizing a package. After selecting the package, you still choose a Synchronization Direction, Conflict Resolution Policy, and a Schedule.
  5. At the Items to Synchronize field, select Database/Resources.

    The following list describes the database scope filter checkboxes.

    NOTE: The Include/ExcludeFiles field is available only for Workarea, Template, or bin syncs.

    Use these checkboxes to choose groups of database tables. You must choose one scope if you check Database/Resources.

    NOTE: Click any label under Database/Resources to see the list of database tables synchronized by that scope.

  6. For the Include/Exclude files field, see Include/exclude files field.
  7. At the Synchronization Direction field, select the direction of the copy. Your choices are:
    • Bidirectional. Changed data on either server is updated on the other. See also: Choosing a bidirectional sync.
    • Upload. database is copied from the local server (the one to which you signed on) to the remote server (specified at the Remote Site field above). Items on the remote server are overwritten.
    • Download. database is copied from remote to local server. Items on the local server are overwritten.
  8. At the Conflict Resolution Policy field, decide what to do if the same data changed on both servers since the last sync. Your choices are:
    • Version on Remote Site Wins
    • Version on Local Site Wins

    Effect of Choosing Conflict Resolution Policy

    If the synchronization direction is Bidirectional

    • and you choose Version on Remote Site Wins, the remote version overwrites local version
    • and you choose Version on Local Site Wins, local version overwrites remote version

    If the synchronization direction is Upload

    • and you choose Version on Remote Site Wins, the remote version is retained; nothing is copied
    • and you choose Version on Local Site Wins, the local version overwrites remote version

    If the synchronization direction is Download

    • and you choose Version on Remote Site Wins, the remote version overwrites local version
    • and you choose Version on Local Site Wins, local version is retained; nothing is copied
  9. If desired, select a schedule on which sync runs automatically. The choices are
    • None. Don’t set up a schedule. Sync as needed via the Sync Profile screen‘s Sync Now button.
    • One Time. specify a start time and date. The profile runs once at that date/time.
    • Hourly. specify a start minute. The profile runs every hour at this minute.
    • Daily. specify a start time. The profile runs every day at this time.
    • Weekly. specify a start time and weekday. The profile runs on this day every week at this time.
    • Monthly. specify a start time and calendar day (numbers 1 through 31). After the start date, the profile runs on this day every month at this time.

      NOTE: If you enter a date greater than 28, the sync will not run in a month that does not include that date. For example, if you enter 31, the sync will not run in February, April, June, September, and November.

Setting up a profile to sync workarea files

Setting up a profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. to sync Workarea files is the same as Setting up a profile to Sync a database with the following exceptions:

  • At the Items to Synchronize field, select Workarea.
  • You may use the Include/ExcludeFiles field to refine the files to be synchronized. See also: Include/exclude files field.

Include/exclude files field

Use the Include/Exclude Files field to include files not normally synchronized, or exclude files or directories that are synchronized by default. This screen section is active only if you choose a Template or Workarea sync and no Database/Resources scopes.

NOTE: By default, eSync ignores .config and .txt files.

For example, .txt files are not normally synchronized, but you want to sync several of them. In this case, check Include and enter *.txt into the Files field.

Examples of the Exclude Files option:

  • you do not want to sync Flash (.swf) files. If you check the Exclude button, and enter .swf into the Files field, eSync ignores them.
  • you do not want to sync files in the widgets folder. If you check the Exclude button, and enter widgets into the Directories field, eSync ignores them.

You can exclude file types and directories. eSync ignores files that satisfy either criterion.

Files excluded from the Workarea sync

Workarea synchronizes all files in the site’s Workarea folder, except files in these subfolders:

  • ewebeditpro
  • explorer
  • ewebdiff
  • foundation
  • resources
  • sync

Setting up a profile to sync template and bin files

Setting up a profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. to sync Workarea files is the same as Setting up a profile to Sync a database with the following exceptions:

  • At the Items to Synchronize field, under Files, select Templates and Bin.
  • You may use the Include/ExcludeFiles field to refine the list of files to be synchronized.

Regardless of how you complete the Include/ExcludeFiles field, the following siteroot folders are not synchronized:

Choosing files and file types via include/exclude files

Within a template/bin sync's folders, you can select individual files. For example, you updated template files and related .css files on the staging server, and want to update the production server without moving everything else.

After saving the profile, click Synchronize files () from the View Profiles screen to access the Sync Files screen. Here, you can select individual files. If you included files types, only they are available for selection. If you excluded file types or directories, they are unavailable.

IMPORTANT: If you select one or more files on the Sync Files screen, the profile includes only those files. If you select no files, the profile includes all files indicated by your responses to the Include/Exclude Files field.

Previewing a sync

Before running a sync, you can view what will be synchronized by clicking Sync Preview.

Ektron recommends this feature to help confirm that tables, assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s, private assets, uploaded files, uploaded images and assetlibrary files that you delete, add, or change will be synchronized between servers as you expect. Also, you can predict how long a sync will take, because the preview takes the same amount of time.

The Sync Preview produces Sync Log files. See also: Viewing eSync activity.

NOTE: You cannot preview a sync profile that includes only Workarea files.

Pausing the sync schedule

If a sync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. has a schedule, you can pause it by clicking the profile's pause/play button.

While paused, the sync will not run. To resume the schedule, click the pause/play button again.

For example, a sync is scheduled to run every hour @ :50: 1:50, 2:50, 3:50, and so on. At 10:30 a.m., you pause the sync profile. So, at 10:50 a.m., the sync does not run. At 12:00 noon, you click the pause/play button again. The next sync starts at 12:50 p.m.

Choosing a bidirectional sync

Although most Ektron data is created and updated on the staging server, some data is collected on the production server. This information can be viewed and edited on the staging server. Here are some examples:

  • membership users
  • content ratings
  • forum and blog posts
  • community folders

When you set up a profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. to sync this kind of data (maintained in the database), you typically choose Bidirectional as the direction, and Notifications and User Generated Content under Database/Resources. So, if a membership user updates his or her profile on the production server, eSync copies the changes to staging. On the other hand, if your administrator changes that information on staging, the next eSync copies it from staging to production.

If the same file on both servers was updated since the last sync, your conflict resolution policy determines which data is saved.

NOTE: The first time you run a sync for templates or Workarea files, the sync is bidirectional, regardless of the direction you specify on the Synchronization Direction screen.

If you are using a bidirectional sync, and the same item changed on both servers since the last sync, eSync must decide which version to keep, and which version to overwrite.

NOTE: If you use bidirectional sync and only one version was updated since the last sync, the updated version overwrites the unchanged version.

Use the Synchronization Profile screen's Conflict Resolution Policy field to determine which version ends up on both servers after synchronization. The choices are:

  • Version on Remote Site Wins. the remote version overwrites the local
  • Version on Local Site Wins. the local version overwrites the remote

Managing eSync security certificates

eSync uses security certificates to secure communication between servers. All servers in an eSync relationship must have matching, encrypted security certificates to establish an eSync relationship.

NOTE: If your relationship includes separate database servers, you do not need to install security certificates on them. You only need to install certificates on servers that host Ektron.

See also: Create eSync security certificates for a load-balanced cluster.

Before you can establish an eSync relationship between servers, each server must have its own (local) security certificates and certificates from every other server in the relationship.

As another example, if an eSync relationship consists of 5 servers, each server requires 5 security certificates: one local and 4 remote.

Each server creates 2 certificates: a server and a client. Then, you copy the client certificate to the other servers in the relationship. The local machine’s server certificate must match a client certificate on the remote server, and vice versa.

You typically copy certificates only when establishing an eSync relationship between servers. After that, any eSync activity triggers a background check, and you can only proceed if certificates match.

Each certificate consists of these files.

  • Server certificate
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
  • Client certificate
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer

The security certificates can apply to one site or all sites on a server. You determine this when installing them.

Viewing security certificates

Use Certificate Manager to view security certificates installed on your server. Check marks indicate the certificates. You can also delete all certificates for a server.

NOTE: You can only remove certificates from remote servers. You cannot remove them from the server to which you are logged in.

To view (and delete) certificates:

  1. Click the Windows Start button > All programs > Ektron > CMS400vxx > Utilities > Security Configurator > right click Run as Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  2. Click Manage Certs. Your server's security certificates appear.

  3. To remove a remote server's certificates, select that row and click Remove.

Installing security certificates

Prerequisite

Permission to copy and paste files between local and remote servers

To create and place eSync security certificates in the correct locations:

Step 1: Create security certificates on your local server

  1. Log on using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.

  2. During the Ektron installation, you are asked if you want to install eSync security certificates. The eSync checkbox (second from the top) is only accessible if your license key contains an eSync modifier.

  3. If you check eSync, near the end of installation, the following screen prompts you to create the certificates.

    NOTE: You can access this screen at any time screen by clicking the Windows Start button > All programs > Ektron > CMS400 vxx > Utilities > Security Configurator > right click and choose Run as Administrator.
    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  4. Use the following information to understand this screen.
    • Generate Certificates. Use this screen area to create security certificates that must be copied to a remote server with which you want to sync.
    • Site Name. If more than one site is installed on this server, use the pull-down list to select the website for which you are installing security certificates. Or, click All to apply certificates to all sites on the server.
    • Apply Remote Server Certificates. Use this screen area to apply security certificates that were copied from a remote server to your local server. See also: Step 3: Copy local client certificate to remote server.
  5. Click Generate.
  6. Local security certificates are created and configured.

    NOTE: Only click Generate once. The status field at the bottom of the screen updates as it progresses. If you click OK more than once, you delay the certificates’ creation.

Step 2: Create security certificates on the remote server

  1. Sign on to the remote server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. Generate security certificates for the remote server, following instructions in Step 1: Create security certificates on your local server.

Step 3: Copy local client certificate to remote server

  1. On the local server, open 2 Windows Explorer windows: one showing the local server’s file system, and the other showing the remote server’s file system.
  2. On the remote server window, create a folder underneath the root folder. The folder name is not important.

    IMPORTANT: Do not create the folder under the Web root folder, for example C:\inetpub\wwwroot.

  3. In the local server window, open the following folder: C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.
  4. Copy the following files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer

    NOTE: These files were created when you completed the eSync Security Configurator Screen in Step 1.

  5. Paste the files to the remote server folder that you created in Step 2. Make sure there are no other security files in the folder.

    After you copy the local server’s security certificates to the remote server, they need to be registered and moved to the correct folders. The Security Configurator screen does this.

  6. Log into the remote server, using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  7. Open the security configurator screen using this path: Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator > right click and choose Run as Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  8. The security configurator screen appears.

  9. Click Apply Remote Server Certificates (circled above).
  10. Click the browse button next to that field.
  11. Browse to the folder to which you pasted the security certificates in Step 5.
  12. Click Apply.
  13. The utility copies the security certificates you pasted in Step 5 to the correct folder, and configures them for the remote server.

Step 4: Copy remote client certificate to local server

  1. Sign on to the remote server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. Follow the steps described in Step 3: Copy local client certificate to remote server, except substitute remote for local.

Step 5: Test the security certificates

  1. From the local server, sign on to Ektron using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. In the Workarea, go to Settings > Configuration > Synchronization > Profiles.
  3. Click Create Synchronization Server Configuration.
  4. Enter the name of the Remote Server.
  5. Select the security certificate you are testing.
  6. Click Connect. If the next screen appears, the security certificates are working properly.

Regenerating security certificates

Follow these steps to regenerate security certificates. You would do this if they stop working, or you are concerned about a security breach.

  1. Log into the Ektron server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's App Pool.
  2. Access the eSync Security Configurator screen via Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator > right click and choose Run as Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  3. Use the Web Site Description field to select a site on your server, or choose All sites.
  4. Check the Discard Existing Keys box.

  5. Click Generate. Security certificates are removed from your local server.
  6. Reopen the Security Configurator screen.
  7. Choose the correct website, verify the other settings, and click Generate. See also: Step 1: Create security certificates on your local server. This action creates new security certificates on your server.
  8. Copy the new certificates to all other servers in the eSync relationship. This is explained in Step 3: Copy local client certificate to remote server.

Troubleshooting security certificates

Could not connect error

When trying to connect to a remote server, after selecting a security certificate, you may see the following message.

To resolve the problem:

  • Check the Windows Event Viewer > EktronL2 log for the error. If the service is hosted but already exists, stop then start the service (do not restart).
  • The certificates may be corrupted. To resolve this, see Regenerating security certificates.

No endpoint error

The following endpointPart of a DXH connection, it is the combination of an endpoint (a URL or API path) and authentication credentials that allows communication between 2 software instances. You define DXH endpoints in your site’s web.config file. error indicates that

  • the remote site may not be on the same Ektron version as the local site, or
  • the Ektron Windows Service is not started

Specifying eSync settings

The eSync Settings screen lets you define many eSync settings.

Workarea > Configuration > Synchronization > Settings.

Running eSync

IMPORTANT: The names of the site and all folders must match on both servers. This is because paths to images, xslt files, and so on, refer to a site and its folders. If the servers’ site and folder names do not match, the links break.

NOTE: Syncs can be queued so they run 1 after the other. See also: Managing the eSync queue.

Optional steps before running a sync

You may want to adjust the web.config and db.config settings before running a Sync. The following topics explain eSync features that you control via the .config files.

Replacing the file sync

Some Ektron customers prefer a tool other than eSync to sync assetAn external file, such as a Microsoft Word document or image, stored in one of these Ektron siteroot folders: assets, privateassets, uploadedfiles and uploadedimages. An asset can be managed like native Ektron content.s; for example RoboCopy. To disable eSync's asset sync:

  1. On your Ektron server, open C:\Program Files (x86)\Ektron\EktronWindowsService40\Ektron.ASM.Services40.exe.config.
  2. Set the <add key="disableFileSyncProvider"> element to true.
  3. Save Ektron.ASM.Services40.exe.config.
  4. Restart the Ektron Windows service.

From now on, eSync does not copy assets. Set up your replacement tool to do that.

Adjusting relationship settings

You can modify settings in the Ektron Windows service (EWS) config file (C:\ProgramFiles (x86)\Ektron\EktronWindowsService40\Ektron.ASM.EktronServices40.exe.config) to accommodate your preferences. The settings are:

  • DebugEnabled. By default, this is set to zero (0). If PDB files are present in the EWS folder or it is a DEBUG build, this value is set to 1. Setting this value to 2 works as in version 8.5.
  • DependencyImageSyncExtensSprtForThumbnls. All valid image file extensions. This list determines if a content item being synchronized is an image. If true, a thumbnail is also synchronized. If this value is BLANK, no thumbnails are synchronized while synchronizing dependent images (including the file sync retry and content dependency sync).
  • DependencySyncRecursionDepth. The depth of recursion for the content dependency sync. Zero (0) indicates that all dependencies are evaluated, regardless of the number of recursions necessary. If you enter a number more than zero, EWS only evaluates as far as the specified depth.
  • DownloadFileStreamsInParallel. If this is set to true on a server with more than 1 processor,, then it will download file streams from the remote server in parallel, using as many threads as specified in MaxNumberOfParallelThreads. Ensure that BOTH the local and remote server has enough resources to handle normal load if the number of MaxNNumberOfParallelThreads processors run at 100% CPU.
  • EnableMetadataEvalInDependencySync. If set to True, metadata evaluation occurs during the content dependency sync. If set to False, files specified in metadata are not synchronized during a content sync. Default value is True.
  • EnableRecursiveDependencySync. If set to True, recursive dependency sync is enabled for content sync. This means that if a content's metadata or HTML references other content blocks, their dependencies are also evaluated and synchronized. Default value is True. See also: Resource Selector , Creating and deploying a related content definition.
  • EnableSiteFileHashIndexingAtStartup. If set to true AND if UseFileHashForFolderSyncChangeDetection OR UseFileHashForFilteredFolderSyncChangeDetection are also true, then the EWS will start indexing all the files in the site which are synchronized using file sync, without using high CPU. This process starts 5 minutes after the service starts.
  • FileSyncFailureMaxRetries. The maximum number of times the EWS tries to sync a file that was not synchronized in the initial try. Default value is 5.
  • FileSyncFailureSleepBetweenRetriesInSeconds. The time (in seconds) the EWS "sleeps" before it attempts to retry a failed file sync. Default value is 5.
  • LoadFileStreamsInParallel. If this is set to true on a server with more than 4 processors, eSync loads file streams locally, in parallel, using as many threads as specified in MaxNumberOfParallelThreads. Ensure that the server has enough resources to handle a normal load if the number of MaxNumberOfParallelThreads> processors run at 100% CPU.
  • MaxNumberOfParallelThreads. Specifies the maximum number of threads created. You should increase this value if you have an adequate CPU resources to significantly improve performance.
  • UploadFileStreamsInParallel. If this is set to true on a server with more than 1 processor, eSync uploads file streams to the remote server in parallel, using as many threads as specified in MaxNumberOfParallelThreads. Ensure that both the local and remote servers have enough resources to handle normal load if the number of MaxNumberOfParallelThreads processors run at 100% CPU.
  • UseFileHashForFilteredFolderSyncChangeDetection. Similar to UseFileHashForFolderSyncChangeDetection, but used for file syncs where folder sync is filtered by file name.
  • UseFileHashForFolderSyncChangeDetection. Runs file sync in CompareFileStreams mode as described here: FileSyncOptions Enumeration. This is set to false by default because file hash mode can fail when the file is locked for reads.

Prerequisites for Running a Sync

Beginning a sync

You can run eSync on a schedule, or on demand. To sync a profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. immediately:

  1. Go to the Settings > Configuration > Synchronization > Profiles screen.
  2. If a profile is ready to sync, a sync button () appears in the right column.

  3. Click Sync ().

    NOTE: If another sync is running, and you have enabled the eSync Queue, this sync is queued and will be synched after all other syncs in the queue are run. See also: Managing the eSync queue.

  4. A screen monitors progress and indicates when the sync is complete.

NOTE: You can close the status window and reopen it at any time by clicking Sync (). If you do, the sync’s current status appears.

IMPORTANT: If you performed a database sync and the site being synchronized uses URL aliasing, you must go to its URL Aliasing Settings screen and click Refresh () to update its aliasing information.

Forcing the initial sync

Use the Force Initial Sync button to reinitialize a server that was previously initialized.

Here is an example of when to use Force Initial Sync.

  1. You initialized a test server from your current Ektron server.
  2. You experimented on the test server by adding content, deleting content, and so on.
  3. You no longer want the test server’s database. Instead, you want to reinitialize the test server from your current Ektron server.

    To accomplish step 3, use the Force Initial Sync button. The button only appears when all of these conditions are present.

    Prerequisite: Forcing Initial Sync Conditions

    The Force Initial Sync feature requires these conditions.

    • The server’s web.config file’s ek_ForceReInit property is set to true.
    • The site is not part of a multi-site relationship.
    • The server has only one sync server relationship.
    • The server is the destination (that is, on the download side) of the sync server relationship.

    The following image illustrates the last 2 conditions.

NOTE: The Force Initial Sync procedure ignores these checks that are normally made prior to synchronization:
* the destination database is smaller than the source database
* the site was not previously staged

Backing up the destination server during an eSync

You can create a backup of the destination server’s database. If you do and problems occur during the sync, the database is restored to its pre-backup state. You can specify the backup to occur on the initial sync only, or every time you sync.

NOTE: No backup is made when you sync a package, folder, content. See also: Synchronizing content and folders, Synchronizing a package.

To set up database backup:

  1. Go to Workarea > Settings > Synchronization > Settings.
  2. At the Backup action field, select an option.
    • Before initial sync. Run backup before the initial sync only.
    • Before each sync. Run backup before each sync.
  3. At the Backup location field, enter a local or network path to the folder to which the backup file will be saved. The user account that runs the Ektron Windows Service must have read and write permission to the folder.
  4. Click Save.

The backup file format is [dbname][yyyy][mm][dd][hh][mm][ss][mmm].[product].bak. For example: cms400min20120216075946765.esync.bak.

Synchronizing content and folders

This section explains how to sync content and folders using context menu options.

Prerequisites for content/folder sync

See also: Prerequisites for Using eSync.

Rules governing folder and content sync

Content sync

Folder sync

Synchronizing a content item

Content sync copies selected content to another server. The sync also copies all entities on which the content is dependent, such as

NOTE: When you sync one content item, all physical files (DMSDocument Management System; Ektron's way of managing assets (Microsoft Office files and other types of files) assets and library files) in the content’s folder are also synchronized.

See also: Synchronizing content and folders.

To sync a content item:

  1. In the Workarea, go to the content.
  2. Click the arrow to its right to see its drop-down menu.

  3. Click Synchronize.

    NOTE: Alternatively, use the Synchronize button on the View Content screen.

  4. All profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.s whose direction is Upload or Bidirectional appear. Select the appropriate one.

  5. Click Sync Now. The content is synchronized with the selected database.

    NOTE: If another sync is running, and you have enabled the eSync Queue, this sync is queued and will be synched after all other syncs in the queue are run. See also: Managing the eSync queue.

Synchronizing a folder

The folder sync updates folder properties and all content in the folder with the same folder in another server. It does not affect content in folders underneath the selected folder. See also: Synchronizing content and folders.

To sync a folder:

  1. Go to the folder.
  2. Choose Action > Synchronize Folder. A screen asks you to select a sync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule..

  3. Click Start Sync. All content in the folder is synchronized with the selected database.

    NOTE: If another sync is running, and you have enabled the eSync Queue, this sync is queued and will be synched after all other syncs in the queue are run. See also: Managing the eSync queue.

Synchronizing custom SQL database tables

You can use eSync to synchronize custom SQL database tables. To do this, you must create the custom table on all servers. eSync does not create the tables, but will follow rules for populating records in them.

IMPORTANT: Table names, which are case sensitive, must be identical on all servers.

Adding an empty custom table to your database on the source and destination servers

Run the following SQL Query on the database. The table must have a primary key and cannot use identity columns.

Here is an example of a valid table.

Create table foo3(Id int not null primary key clustered, 
  Id2 int not null, company nvarchar(50) null)

Here are examples of invalid tables, which incorrectly use identity columns.

create table foo1(Id int not null identity(1,1) primary key clustered,
  company nvarchar(50) null)
create table foo2(Id int not null primary key clustered,
  Id2 bigint not null identity(1,1),
  company nvarchar(50) null

Adding a custom table to an eSync configuration

NOTE: The Manage Custom Table Configuration button () appears only if your database has custom tables.

To add custom tables to an eSync Configuration, follow these steps on the source server.

  1. Go to Workarea > Settings > Configuration > Synchronization > Profiles.

  2. Click Manage Custom Table Configuration (). The Manage Custom Table Configurations screen appears.

  3. Click Edit Custom Table Configuration.
  4. Click a custom table from the Available column to select it.
  5. Click the right arrow button to move it to the Selected column.
  6. Click Save Custom Table Configuration.

After you add a custom table, your eSync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule. displays a new Database/Resource scope, Custom Tables. Select it to sync custom tables.

Synchronizing a package

You can group Ektron objects (content, folders, taxonomies, and so on) into a package, which can be synchronized at any time without having to run a complete sync. Advantages of a sync package include:

For example, you are developing a new marketing campaign which consists of content in 2 folders, all library files in those folders, and 2 menus. After assembling the items into a sync package, you can sync it from development to production at any time without affecting other site files.

For a video tutorial on eSync packages, see eSync Packages (Ektron 8.6.1).

A package may include these objects.

Package sync limitations

301 redirects are not synchronized automatically with a package.

Creating a package

Prerequisites

  • You are a member of the Administrators group or assigned to the Synchronization Admin role.
  1. Workarea > Settings > Configuration > Synchronization > Packages.
  2. Click Create Package.
  3. Enter a unique Name and optional Description.
  4. Click the tab of objects you want to add to the package.

  5. Check items to include in the package.
  • An item is added to the package as soon as you check it. There is no submit button. Click Save Package to save all items in a package.
  • To view a package's contents at any time, click the Package Contents tab.
  • When you view a tab, items in the package are checked.
  • File System tab lets you select files within the siteroot folder and its children.
    • Exception. You cannot add these file types to a package: thumbs.db, .cer, .pfx, .pvk, .refresh, .ekt, .config, .dll, .exe, .metadata, .sln, .svn, .tekt, ._svn, .log, metaconfig.doc. They do not appear in the selection grid.
  • Taxonomy tab lets you select top-level taxonomies only. You cannot select categories within them. By selecting a taxonomy, you also add the following to the package
    • all categories below it
    • all content, users and groups assigned to the taxonomy and its categories

    As a taxonomy's content changes, the package automatically includes the current files.

    NOTE: By adding a taxonomy to a package, you automatically select all language versions of that taxonomy.

  • Menus tab lets you select top-level menus only. You cannot select submenus. By selecting a top-level menu, you also add to the package
    • all of its submenus
    • all items assigned to the menu and its submenus: content, library assets, hyperlinks, and additional submenus

    As a menu's content changes, the package automatically includes the current files.

    Folders assigned to menus are not synchronized with them. See also: Assigning a folder or template to a menu.

    NOTE: By adding a menu to a package, you automatically select all language versions of that menu.

  • Local Packages tab lets you include other package definitions in the package. This lets you re-use the packages on other servers in your eSync relationship. Other package definitions do not include objects assigned to them (content, folders, and so on).
  • Orphan Items tab lists records referenced in a package which, for some reason, are not in the database.

Synchronizing a package

To sync a package, add it to a sync profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule., then sync the profile.

IMPORTANT: The package sync requires but does not validate identical folder structure on both servers. You must verify matching folder structures on both servers before beginning a package sync.

Prerequisites

  • One or more eSync packages. See also: Creating a package.
  • You are a member of the Administrators group or assigned to the Synchronization Admin role.
  1. From the View All Synchronization Configurations screen, click Add Sync Profile. The Add Synchronization Profile screen appears.
  2. In the Profile Type field, check Local Package.
  3. Use the Select Package drop-down to choose the package.
  4. Complete the remaining fields, which are documented in Setting up a profile to Sync a database.
  5. Click Save Synchronization Profile.
  6. From the View All Synchronization Configurations screen, click the profile.
  7. Click Sync Now ().

    NOTE: If another sync is running, and you have enabled the eSync Queue, this sync is queued and will be synched after all other syncs in the queue are run. See also: Managing the eSync queue.

Deleting a package

Prerequisite

  • You are a member of the Administrators group or assigned to the Synchronization Admin role.
  1. Workarea > Settings > Configuration > Synchronization> Packages.
  2. Click Delete in the right column of the package that you want to delete.

Managing the eSync queue

The eSync queue holds profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.s waiting to be synched. A profile is added to the queue in FIFO order (first in—first out) if a sync process is running when you try to sync a profile. To view the eSync queue, go to Workarea > Settings > Configuration > Synchronization > Queue. The queue screen lets you

You can only view the eSync queue for the site to which you are logged in.

If you enable queuing for several sites on the same server, the eSync queue consumes a significant amount of server resources. So, you should carefully consider hardware resources when using the eSync queue in a hosted environment.

Enabling the eSync queue

To enable the eSync queue, open the following 2 files and change value of EnableSyncQueue to true.

  • siteroot\web.config
  • C:\Program Files (x86)\Ektron\EktronWindowsService40\ Ektron.ASM.EktronServices40.exe.config

eSync queue tasks

Within the eSync queue, you can remove a profile or move it up or down (unless its state is "In Process"). If you want to sync a removed profile at a later time, return to the View All Synchronization Configurations screen and click Sync () again.

Viewing eSync activity

eSync provides the following logs of sync activity.

Viewing synchronization configurations

The View All Synchronization Configurations screen lets you perform the following eSync-related activities.

Viewing a profile’s most recent sync

To view a log of a profile’s most recent sync:

  1. Go to Workarea > Settings > Configuration > Synchronization > View All Synchronization Configurations screen.
  2. Click Get Status () next to the profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule..

This button also appears on the View Profile screen.

Get Status () appears only for previously-synchronized profiles.

The sync log appears upon completing a sync (see following image).

Viewing a log of a sync server relationship’s most recent sync

You can view a log of a Sync Server Relationship’s most recent sync by clicking Get Status () in the header section of the screen.

Viewing a log of all syncs for a sync server relationship

The View All Synchronization Relationships screen provides a Synchronization Logs button () that displays a chronological log of all syncs on your server, with the most recent at the top.

Click the icon in the Status column to view any sync's details. If the column contains a check mark, the sync was successful.

If the column contains a warning (), the sync failed for some items. If you click the icon, a screen lists causes for the failure. Ektron support can use this log to troubleshoot the problem.

Reviewing collisions

To verify the accuracy of data being synchronized, eSync may check for and resolve collisions between the following matching items.

For example, on the staging server, a user creates a folder under the root folder called Marketing, and a user on the production server does the same.

NOTE: * Folders only match if they have the same name and folder path.
* Ektron and membership users are included.

A collision only occurs if both items were created since the last synchronization.

Although matching items have different ID numbers, their names are the same, so users may be unable to distinguish them. To avoid confusion, eSync appends a number to the more recently-created item. For example, the Marketing folder becomes Marketing11329. This is an example of a resolved collision.

To track resolved collisions, the View All Synchronization Configurations screen has a button () that appears only after a collision is resolved. If the eSync direction is download, the collision resolution information appears on the local server; if upload, it appears on the remote server; if bi-directional, it appears on both servers.

When you click the button, you are prompted to review resolved collisions. If you click Resolve, the following button appears on the toolbar.

Click that button to see the Review Synchronization Collisions screen, showing the original and changed items.

Reviewing resolved collisions

The Review Synchronization Collisions screen shows resolved collisions. Upon viewing it, you should notify appropriate content authors, who may want rename the items.

After noting these changes, you can check the box in the left column, then click Mark Reviewed to remove it.

The Users tab has an additional button, Mark Reviewed and Email. Use it to remove the user from the screen and send an email to the user (using the address from the Add/Edit User screen’s E-Mail Address field). 

lbl sync collision email subject = Your username has been changed
lbl sync collision email body = For security purposes, your username has been 
  changed. 
Your new username is {0}.  You will need to use this new username the next time
  you login.  Thank you.

NOTE: You can change the email text in the resource file. To learn about editing it, see Translating the Workarea.

Determining which collisions are resolved

On the eSync Settings screen, use the Types of data field to identify items for which you want to resolve collisions. Unchecked items are ignored.

Ektron recommends disabling the Resolve Collisions during Synchronization boxes for everyday use, because resources required to search for collisions may negatively impact your website's performance. When activity that might cause collisions occurs, you may temporarily enable checkboxes. Then, disable them again once the activity is complete.

Using performance counters to monitor the Ektron Windows Service

You can use the Windows Performance Counter to view the progress of a file sync without affecting the EWSEktron Windows Service's performance. You can also use the Performance Counter to debug and monitor the EWS.

You can set up the Performance Counter to write to a file, so that you may monitor its activity over a few days or weeks.

The Performance Counter helps you monitor a sync's progress, especially if it has been running for a long time. If the counter's values stop changing, nothing is happening. This information can help you determine that it is safe to stop the service.

Performance counter notes

  • Most counters increment over time—they do not rise and fall.
  • Restarting the service resets the counters.

Performance counter display options

These performance counters are available.

NOTE: Definitions:
Initiating Server. The server from which file sync is initiated (via the website).
Peer Server. The other server(s) in a sync relationship.

Ektron Windows Service data

  • EWS Approximate Total Number of Threads Alive Currently. if eSync is running, at least one thread is alive
  • EWS Approximate Total Number of Timers Alive Currently. increases as the number of scheduled syncs increases
  • EWS Database Write Operations Total. increases when the EWS inserts/ updates or deletes rows in a site’s database.
  • EWS Database Read Operations Total. increases when the EWS reads rows from a site’s database.
  • EWS Exceptions Total. if eSync or load balancing exceptions occur while the service is running, they increment the performance counter and appear on the graph. A continual increase indicates a problem.

eSync data

  • eSync. Total Number of Remote WCF Calls Made from Service. increases when the EWS makes network calls to other EWS instances on the network.

File Sync data

  • File Sync. Applying Changes (Total) on Initiating and Peer Servers. incremented when a file change is about to be attempted
  • File Sync. Changes Applied (Total) on Initiating and Peer Servers. counter is incremented when a file change is applied
  • File Sync. Changes Detected (Total) on Initiating and Peer Servers. counter is incremented when a change detection pass is completed
  • File Sync. Changes Skipped (Total) from Initiating and Peer Servers. eSync was supposed to do something but the action was skipped. This may occur if, for example, a file is locked.
  • File Sync. Completed Work on Initiating Server. amount of work completed out of total work to be done
  • File Sync. Conflicts Detected (Total) from Initiating and Peer Servers. indicates conflicts between servers in a sync relationship. This number always increases, never decreases unless someone restarts the EWSEktron Windows Service.
  • File Sync. Copying File (Total) on Initiating and Peer Servers. incremented periodically to show progress while a file is being copied
  • File Sync. Detecting Changes (Total) on Initiating and Peer Servers. incremented for every directory , including the root directory, during a change detection pass. This is incremented before change detection begins for that folder.
  • File Sync. File Download Requests (Total) on Peer Server. total number of download requests
  • File Sync. Files Skipped Change Detection (Total) from Initiating and Peer Servers. eSync was supposed to do something but the action was skipped. This may occur if, for example, a file is locked
  • File Sync. File Upload Calls (Total) from Initiating Server. indicates the total number of upload calls from the initiating server to the remote EWS server
  • File Sync. File Upload Requests (Total) on Peer Server. total number of upload requests received on the peer server
  • File Sync. File Upload Preview Calls (Total) from Initiating Server. total number of upload preview calls made from the initiating server
  • File Sync. Temporary Files Deleted Total. total number of temporary files deleted by EWSEktron Windows Service so far. This number should never be zero (0) on the destination server while a sync is running.
  • File Sync. Total Work on Initiating Server. total work to be done by file sync

Setting up the performance counter display

To set up the display of the Ektron Windows Service performance counter:

  1. Click the Windows Start button > Administrative Tools > Performance Monitor.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter perfmon.msc. Right click and choose Run as Administrator.

  2. Click Add ().
  3. In the upper left corner, click Ektron Windows Service - Performance Counter, then Add and OK.

Sync status email notification

Provides email notifications when the following important sync events occur.

  • A sync goes longer than a specified duration.
  • A sync fails.
  • A sync completes.

In the screen settings, you determine which events trigger an email notification.

To use this feature:

  1. Go to Settings > Configuration > Synchronization > Settings page.
  2. Set the values:

    Sync status

    • Sync(s) running longer than (minutes). Specify the number of minutes before sending an email notification .
    • FE Sync failure(s). Enable if you want an email notification to be sent if an FE sync failure occurs.
    • All completed sync(s). Enable if you want an email notification to be sent when a sync completes.
    • Recipient email addresses. Specify the email addresses of notification recipients.

      NOTE: Separate email addresses with a comma (,).

  3. Open Ektron.ASM.EktronServices40.exe.config file.
  4. Find following entry keys. Here, set the SMTP information for sending email.
    <add key="CEIPSmtpServer" value="ektexch01" />
<add key="CEIPKey" value="" />
<add key="CEIPSmtpUserName" value="your-ID" />
<add key="CEIPSmtpPassword" value="************" />
<add key="CEIPSmtpEnableSSL" value="false" />
<add key="CEIPSmtpPortNo" value="25" />

Using eSync with other Ektron features

eSync in a load-balanced environment

Ektron supports a load-balanced environment, in which several servers share your website’s processing load. See Balancing the load on your servers.

If your site uses load balancing, you can set up eSync so that, after one server in a load balance cluster is synchronized, the other servers are automatically synchronized. Note that if a separate database server is outside the load balance cluster, eSync only synchronizes documents and files used by the search among the clustered servers. It does not touch the database.

Beginning with Ektron version 8.5, the load-balance chain of servers is updated automatically, and servers that are not available are removed. The following illustration shows a typical load balanced cluster.

IMPORTANT: In a load balanced environment, only update templates on the staging server. Do not update them on the production server and assume they will be synchronized with the staging server.

IMPORTANT: Assume your load balanced cluster consists of 2 staging servers (S1 and S2) and 2 production servers (P1 and P2).
If you add/modify/delete a file on S1, to get the file to S2, you must run either a download sync on S2, or an upload sync on S1, or a bidirectional sync from either server. If you run a download sync on S2, you also need to run an upload sync to push the file to P2, which will then Load Balance with P1.
The best way to make sure that the added/modified/deleted file is changed on all servers is to initiate the sync from the server on which the file was changed. In this example, since you changed the file on S1, if you initiate a sync from S1, it will be automatically updated on S2, P1, and P2.

Prerequisites

  • The connection string on all servers in the cluster matches
  • You must initiate eSync relationships and the sync from a staging server
  • If your staging servers are clustered, you must remove one from the cluster before you can sync

Follow these steps to set up this capability.

Install a min site on every server in the cluster

  1. Upgrade each server to the same version of Ektron. If Ektron is already installed on one server, install a minimum site on the others. To do this, run the Ektron base installation file (cms400Base9x.exe). See also: Installing the Ektron base.
  2. If the site with which you will sync is precompiled, precompile all min sites.

Update Assetmanagement.config

  1. Sign on to the first server in your load balanced cluster.
  2. In the site root folder, open assetmanagement.config.
  3. Change the value of LoadBalanced to 1 and save.
  4. Do this on every server in the cluster.

Update the Ektron Windows Service config file

  1. Sign on to the first server in your load balanced cluster.
  2. Open C:\ProgramFiles(x86)\Ektron\EktronWindowsService40\Ektron.ASM.EktronServices40.exe.Config.
  3. Change the value of LoadBalanced to 1.
  4. Change the value of AssetsLoadBalanced to 1.
  5. Change the value of LibraryLoadBalancedto 1.
  6. Save the file.
  7. Do this on every server in the cluster.
  8. Stop and then Start the Ektron Windows Service on every server in the cluster.

Create eSync security certificates for a load-balanced cluster

You should be familiar with eSync security certificates before beginning this procedure. See also: Managing eSync security certificates.

Assume the load balance cluster has 3 servers: mach1, mach2, and mach3.

Part one: Generate security certificates

In this part, create the security certificates.

  1. Sign on to mach1 using an account with administrative privileges and generate security certificates. To do this, click the Windows Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator > right click and choose Run as Administrator.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

  2. The security configurator screen appears. See Managing eSync security certificates. Select the Generate Certificates radio button. Click the Generate button then click OK when the Ektron Windows Service’s warning dialog appears.
    This action creates security certificates for your server and applies them to all the sites on the server. Optionally, you can select a single site from the Web Site Description drop-down to install certificates to a selected site.
  3. Create a new folder (for example, mach1_certitificates) on the desktop.

  4. Open the following folder: C:\ProgramFiles\Ektron\CMS400vxx\Utilities\SecurityConfig\SecurityConfigurator.

  5. Copy the following files from the SecurityConfigurator folder into the folder you created in Step 3.
    • mach1_SyncClient.pfx
    • mach1_SyncClient.pvk
    • mach1_SyncClient.cer
    • mach1_SyncServer.pfx
    • mach1_SyncServer.pvk
    • mach1_SyncServer.cer

  6. Repeat steps 1 to 5 for every server in your load balance cluster.

Part Two: Apply security certificates

In this part, copy then apply the certificates to all other servers in the cluster.

  1. Copy each server's certificates folder to the other servers in the cluster.

  2. Run the Security Configurator (Start button > All programs > Ektron > CMS400 v9x > Utilities > Security Configurator) and apply the certificates from every other server in the cluster.

    If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Security Configurator. Right click and choose Run as Administrator.

    For example, apply certificates from mach2 and mach3 on mach1; and apply certificates from mach1 and mach3 on mach2.

    To apply certificates, follow these steps.

    1. Select the Apply Remote Server Certificates radio button.

    2. Click the browse button next to that field.
    3. Browse to the remote server’s certificates folder (which you copied in Step 1).
    4. Click the Apply button. Then, click OK when the Ektron Windows Service warning dialog appears.
    5. Repeat the above steps for all remote server certificate folders.
    6. Repeat steps on every server in the load balance cluster.

Set up and run eSync

Once load balanced servers are configured to sync assets, configure eSync as normal between your staging server and one production server. When you sync with the production sever, the Load Balance feature pushes those files to the other servers in the LB configuration.

Using eSync in a multi-site environment

If you want to use eSync in a multi-site environment, you must do so before the initial synchronization of a relationship. That is, you cannot set up a eSync relationship in a single-site environment and then later change to multi-site. You can set up a new relationship at any time. See also: Supporting multi-site configurations.

  • In a multi-site environment, you cannot create a staging site from a production site (as described in Initializing a new site). You must first create all sites on the staging server, then set up production sites with which they sync.
  • You should log into the main site then synchronizing it and all multi-sites from there.

Setting up eSync in a multi-site environment

WARNING! Back up your database before beginning this procedure!

  1. Set up all sites on the staging server, following the instructions in Supporting multi-site configurations.
  2. Install an Ektron min site on each production server that will host a site. To do this, run the Ektron base installation file.
  3. Install security certificates between the staging server and all production servers. This procedure is described in Managing eSync security certificates.
  4. Sign on to the staging server.
  5. In the Workarea, go to Settings > Configuration > Synchronization > Profiles.
  6. The View All Synchronization Configurations screen appears. Click Create Synchronization Server Configuration. The screen appears.

    NOTE: If you see the following error, The system cannot find the file specified, you must set up security certificates. See also: Managing eSync security certificates.

  7. Use the following information to complete the screen.

    WARNING! The first time you sync an Ektron website, all of its data is overwritten. Make sure that no important information resides on the production server before beginning the first sync.

  8. Remote Server. Select a production server by choosing the path to the site’s physical location on the remote server.
  9. Choose Certificate. If you selected a single server above, its name appears here. Proceed to the next step.

    If you selected a domain or IP address above, click the drop-down arrow to view all servers whose client security certificates reside on this server. Then, select the server with which you want to set up an eSync relationship.

  10. Click Connect. After you connect to the production server, all eligible databases on it appear. The top one has a green check mark, indicating it is selected by default.

  11. Click the database with which you want to sync. When you do, a green check mark appears on it, and its background color changes.
  12. Click Next.
  13. A new screen appears, showing both servers and allowing you to change the direction of the initial database copy. Make sure you are copying from staging to production. Because the staging server is multi-site, the staging server area has a Site Path pulldown field, which lets you select a site.

  14. When you are satisfied, click Create. This sets up the server relationship but does not launch the initial sync.
  15. The View All Synchronization Configurations screen appears with the new relationship. If you are ready to overwrite the production database with the staging one, click Start Initial Sync ().
  16. A screen monitors the sync’s progress.
  17. The initial sync creates a default profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule., which appears on the View All Synchronization Configurations screen.
  18. Set up and launch sync profiles to sync Workarea files and templates on the staging server with those on the production server. (This is described in Setting up eSync profiles and Running eSync.) For synchronization direction, choose Running eSync.

Setting up staging multi-sites

By default, if you sign on to a staging server then insert library items (images, quicklinks, and so on) into content, the path to those items includes the production server. For example, your server setup includes 2 multi-sites: sales.ektron.com and support.ektron.com.

NOTE: Multi-site names are defined in the site’s folder properties screen’s Production Domain field, as described in Supporting multi-site configurations.

So, library links in the sales.ektron.com site’s content look like this: http://sales.ektron.com/template?id=id number. However, you may wish to change library links so they refer to the staging server. This would help you verify that the linked items exist on it.

To change library links to refer to your staging server:

  1. Go to Settings > Configuration > Setup.
  2. Click Edit.
  3. Check the Staging Server checkbox.
  4. Click Update.
  5. Go to Content > the staging site folder.
  6. Choose View > Properties.
  7. Click Edit Properties.
  8. Scroll down to the section labeled Multi-Site Domain Configuration:
  9. In the Staging Domain field, enter the URL of your staging server.
  10. Click Update.

From now on, when a user signs on to the staging server and works with library links, the links include the staging server instead of the production server.

Using eSync with Web Alerts

The Web Alert feature enables Ektron to generate email for a list of registered users whenever content is created or updated. See also: Sending Web Alert emails to subscribers.

In an eSync environment, you need to determine which servers send Web Alerts. For example, Web Alerts should probably not be generated when content is published on a staging server, but you would want them when content is published on a production server.

To determine if a server generates Web alerts, use the following property of each website’s web.config file.

<add key="ek_DisableWebAlerts" ..... />

Set the property’s value to true to suppress Web Alerts on a server.

Set the property’s value to false to generate Web Alerts to on a server.

Also, the server clock on the download side of the eSync relationship must be exactly the same time as or slightly ahead of the clock on the sending server.

Using eSync with eCommerce

IMPORTANT: Ektron has discontinued new development on its eCommerce module. If you have a license to eCommerce, you will continue to receive support, but if you need to upgrade, contact your account manager for options.

When using eSync with an eCommerce site, you need to prevent orders from being processed on your staging server to prevent orders from being processed twice.

For example, a customer on your production site purchases a product. If the staging server and production server are synchronized before the credit card is processed, it might be charged twice: once from the production server and again from the staging server.

To prevent orders from being processed on your staging server, edit your staging site’s web.config file and set the following property to true:

<add key="ek_ecom_OrderProcessingDisabled" value="true" />

When the property is set to true, you cannot process or edit orders from the Workarea’s View Order screen on the staging server. Also, if you try to create an order from the staging server’s website, you receive the following message.

“We're sorry, an error occurred while processing your request. Please try again later...”

It is important to note that all other eSync functions still work properly. For example, when you create catalog entries on a staging server and perform a sync, the entries are moved to the production server. The ek_ecom_OrderProcessingDisabled key only affects order processing.

Using eSync with notifications

When using eSync with notifications, new agents are not synchronized. This means that you must manually add new agents to each server in your relationship.

When an agent exists on all servers in your relationship, eSync keeps them updated. For example, assume a membership user logs into the production server and updates the profileA collection of eSync information to be reused, such as: files to be synched, direction, source and destination databases, and schedule.’s Activities tab by changing the activities a custom agent will perform. eSync will sync those changes with the staging server.

See also: Adding a custom agent; Sending notifications to a community.

Running Ektron 8.5 and Ektron 9.10 SP3 eSync

If you install an Ektron 9.10 SP3 site to a server that is also running an Ektron 8.5 version, the Ektron 9.10 SP3 Windows Service (EWSEktron Windows Service) replaces the 8.5 version. Also, the dbSync.config file was removed for Ektron 9.10 SP3. To manage settings you previously configured in dbsync.config file, run the following script.

IF(NOT EXISTS(SELECT NAME FROM SYS.OBJECTS WHERE (NAME='sync_settings') AND (type='u')))
begin
create table [dbo].[sync_settings]
(
    profile_id bigint not null,
    memory_data_cache_size int not null default (32768),
    remote_sql_connection tinyint not null default(2), 
    application_tran_size bigint not null default (0),
    script_encryption bit not null default (0),
    collision_action bigint not null default(0),
    backup_action tinyint not null default(0),
    backup_device nvarchar(max) null,
    log_retain_count int not null default(50),
    CONSTRAINT [PK_sync_settings] PRIMARY KEY CLUSTERED (profile_id)
)
end
go
if(not(exists(select 1 from sync_settings where profile_id=0)))
begin
insert into sync_settings(profile_id)values(0)
end
go

The following list describes some lines in the script.

Troubleshooting eSync

You created a custom table and try to sync it to the destination server, but eSync does not synchronize the source and destination servers.

Solution: As stated in Synchronizing custom SQL database tables, you must create the custom table on all servers. eSync does not create the tables, but will follow rules for populating records in them.

There was no endpointPart of a DXH connection, it is the combination of an endpoint (a URL or API path) and authentication credentials that allows communication between 2 software instances. You define DXH endpoints in your site’s web.config file. listening at http://alphatest:8732/Ektron.Sync.Communication/SyncCommunicationScheduleService.svc that could accept the message. This is often caused by an incorrect address or SOAP action. See InnerException, if present, for more details.

One server in the relationship cannot resolve the address of the other server. This may be due to security restrictions or because the Ektron Windows Service (EWSEktron Windows Service) is off.

Solutions:

  • Modify the hostname of the other server so that it can be found.
  • Restart EWS
  • Reconfigure security

Local site cannot communicate with service.

Solution:

  1. Load the security Configuration utility:

    C:\Program Files(x86)\Ektron\CMS400vxx\utilities\SecurityConfig\SecurityConfigurator\securityconfigurator.exe.

  2. Select the website that is failing.
  3. Click OK. This recopies client certificates to the site and updates web.config to use them.

No Ektron site exists on the remote server.

Possible Solution: Install an Ektron min site on the remote server.

Using eSync strategies

eSync Strategies are described in CMS Strategies. These strategies let you plug into the EWSEktron Windows Service , so developers can implement functionality like sync notifications, data modifications, and cache invalidation.

Design goals

The strategies' design goals explain the intent and functionality available through the API.

  • The API is as similar as possible to the framework API.
  • Events are synchronous.
  • The API classes are decoupled from the internal implementation.
  • Events may be canceled.
  • Sample strategies are provided with the EWS.
  • Documentation is embedded within the code.
  • Strategies have minimal impact on eSync stability, scalability, and performance.
  • The data transform strategy, which has some performance penalty, is activated only when it is implemented (to prevent undue performance impact).
  • You cannot break eSync by modifying parameters which do not make sense to be modified via an API. Not all properties are writable.
  • Errors in the strategies do not crash the EWS.
  • The website progress always shows strategy execution details.

Limitations

  • The API does not isolate events when multiple sites exist on the same server in a co-located scenario.
  • Parameter changes cannot be propagated back to eSync from peer events.
  • Peer events are not available for load balancer strategies.
  • Whenever new strategies are registered, restart the EWSEktron Windows Service .
  • Data transform strategy notes.
    • Data transform strategy cannot modify deleted rows. See also: ESyncDataTransformStrategy.
    • Changes to detached or unchanged (DataRow state) rows do not propagate back in the data transform strategy.
    • eSync parameter changes in the data transform strategy do not affect or modify eSync.
    • Not all eSync parameters are available to the data transform strategy.

Tips for working with eSync strategies

  • Enable the sample strategy in the out-of-the-box ObjectFactory.config file (C\Program Files (x86)\Ektron\CMS400vversionnumber\Utilities\EWSUpdates\EktronWindowsService40\ObjectFactory.config).

    After you do, each event is logged to the event viewer. Review the event viewer to learn the order in which events fire.

  • eSync strategies run in the context of the EWSEktron Windows Service, as opposed to a site. So, by default, strategies run for every eSync on a server, whether the sync is incoming or outgoing. To restrict a strategy to certain syncs and sites, use validation. For an example, see Notification strategy example.
  • Tips for creating .dll files.
    1. With the project open in Visual Studio:
      1. Open Solution Explorer.
      2. Right-click your project.
      3. Choose Properties.
      4. Set the Target Framework to .NET Framework 4.5.

      IMPORTANT: The following .dlls require .NET 4.5.

    2. Add references to Ektron Windows Services/Ektron.Cms.Contracts.dll and Ektron.Cms.ObjectFactory.dll.
    3. Add these namespaces:

      using Ektron.Cms.Extensibility;

      using Ektron.Cms.CoreService;

  • After you create .dll files, place them in the C\Program Files (x86)\Ektron\CMS400vreleasenumber\Utilities\EWSUpdates\EktronWindowsService40 folder. Then, when adding project references, reference .dlls in that folder, not .dlls in the site folder.
  • Stop the EWS before building the project. Otherwise, Ektron locks the .dll. So the process is:
    1. Stop EWS.
    2. Build the project.
    3. Move .dlls into the EWS folder.
    4. Start EWS.

    It may take 30-60 seconds to start the EWS with the new .dll. To know when EWS has started, open the Event Viewer\Applications and Services Logs folder and monitor the EktronL4 log. There are 2 messages:

    • Service initialized successfully. you've told EWS to start.
    • Service started successfully. only begin a new sync to test the latest build after you see this message.

Events

The basic events are

  • APIStrategy: ESyncNotificationStrategy See also: ESyncNotificationStrategy
    • Local Database Sync Run Start. API Event Name: OnAfterDatabaseSyncRunStartFromLocal
    • Local Database Sync Run Completed. API Event Name: OnAfterDatabaseSyncRunCompleteFromLocal
    • Local Database Sync Run Error. API Event Name: OnAfterDatabaseSyncRunErrorFromLocal
    • Local Folder Sync Run Start. API Event Name: OnAfterFolderSyncRunStartFromLocal
    • Local Folder Sync Run Completed. API Event Name: OnAfterFolderSyncRunCompleteFromLocal
    • Local Folder Sync Run Error. API Event Name: OnAfterFolderSyncRunErrorFromLocal
    • Local Esync Run Start. API Event Name: OnAfterESyncRunStartFromLocal
    • Local Esync Run Completed. API Event Name: OnAfterESyncRunCompleteFromLocal
    • Local Esync Run Error. API Event Name: OnAfterESyncRunErrorFromLocal
    • Peer Esync Run Start. API Event Name: OnAfterESyncRunStartFromPeer
    • Peer Esync Run Completed. API Event Name: OnAfterESyncRunCompleteFromPeer
    • Peer Esync Run Error. API Event Name: OnAfterESyncRunErrorFromPeer
    • Peer Database Sync Run Start. API Event Name: OnAfterDatabaseSyncRunStartFromPeer
    • Peer Database Sync Run Completed. API Event Name: OnAfterDatabaseSyncRunCompleteFromPeer
    • Peer Database Sync Run Error. API Event Name: OnAfterDatabaseSyncRunErrorFromPeer
    • Peer Folder Sync Run Start. API Event Name: OnAfterFolderSyncRunStartFromPeer
    • Peer Folder Sync Run Completed. API Event Name: OnAfterFolderSyncRunCompleteFromPeer
    • Peer Folder Sync Run Error. API Event Name: OnAfterFolderSyncRunErrorFromPeer
    • Local Database Sync Progress. API Event Name: OnLocalDatabaseSyncProgress
    • Local File Sync Progress. API Event Name: OnLocalFileSyncProgress
    • Peer Database Sync Progress. API Event Name: OnPeerDatabaseSyncProgress
    • Peer File Sync Progress. API Event Name: OnPeerFileSyncProgress
  • APIStrategy: LoadBalancerStrategy See also: LoadBalancerNotificationStrategy
    • Load Balance Run Start. OnAfterRunStart
    • Load Balance Run Completed. OnAfterRunComplete
    • Load Balance Run Error. OnAfterRunError

  • APIStrategy: ESyncDataTransformStrategy See also: ESyncDataTransformStrategy

    • Row synchronized during eSync. OnAfterDataRowSelected

ESyncNotificationStrategy

This is an abstract class, since it has no default functionality.

The eSync Notification strategy lets me detect events, such as when a database sync is completed.

There are two sets of methods: “FromLocal” and “FromPeer”.

  • FromLocal is called by the EWSEktron Windows Service, which manages eSync; it refers to the service on the same server as the site from which the eSync call was made.
  • FromPeer methods are raised on the peer server, which may receive or send data. These methods are called when EWSEktron Windows Service makes a WCF call to the peer EWS which, in turn, raises this event. Note that, unless otherwise mentioned, the “FromPeer” method is analogous to the “FromLocal” method raised on the peer server.

Notification strategy example

Comments on this sample notification strategy follow the example.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Diagnostics;
using Ektron.Cms.Extensibility;
using Ektron.Cms.CoreService;
namespace ProcessTaxonomy
     {
       public class WriteToXml : ESyncNotificationStrategy
        {
          public override void OnAfterDatabaseSyncRunCompleteFromPeer(PeerServerDetails peerDetails, SyncProfile syncProfileData)
             {
                if (syncProfileData.RemoteSiteConfig.SitePath.ToLower().StartsWith(@"c:\inetpub\syncreceiver") && (syncProfileData.SyncConfig.Direction == SyncDirection.Upload || syncProfileData.SyncConfig.Direction == SyncDirection.BiDirectional))
                 {
                    WriteTaxonomyToXml();
                 }
              }
       public void WriteTaxonomyToXml()
        {
           string path = @"C:\inetpub\ConsoleApps\CreateTaxonomyXML\CreateTaxonomyXML\bin\Debug\CreateTaxonomyXML.exe";
           Process proc = new Process();
           proc.StartInfo = new ProcessStartInfo(path, "");
           if (!IsProcessOpen("CreateTaxonomyXML"))
              {
                try
                 {
                   proc.Start();
                   EventLog.WriteEntry("CreateTaxonomyXml - Start", proc.StartTime.ToString(), EventLogEntryType.Information);
                   proc.WaitForExit();
                   EventLog.WriteEntry("CreateTaxonomyXml - End", proc.ExitTime.ToString(), EventLogEntryType.Information);
                 }
                 catch (Exception ex)
                 {
                    EventLog.WriteEntry("CreateTaxonomyXml - Error", ex.Message, EventLogEntryType.Error);
                 }
             }
             else
             {
                EventLog.WriteEntry("CreateTaxonomyXml - Info", "Process already running.", EventLogEntryType.Information);
             }
           }
           public bool IsProcessOpen(string name)
             {
               try
                {
                  var procs = Process.GetProcessesByName("CreateTaxonomyXML");
                  if (procs.Any())
                        return true;
                }
                catch (Exception ex)
                {
                   EventLog.WriteEntry("CreateTaxonomyXml - Warning", "Error finding process.", EventLogEntryType.Warning);
                        return false;
                }
                return false;
             }
        }
   }
  1. The following code overrides a method that is triggered after a database sync completes. This example runs immediately upon completing the DB sync, even if the sync has other tasks to complete, such as a file sync.
    public override void
  OnAfterDatabaseSyncRunCompleteFromPeer(PeerServerDetails
  peerDetails, SyncProfile syncProfileData)
  2. The following conditional validates that the sync runs only for the desired site and direction. This example runs only if a certain site receives data, either through an upload or bidirectional sync. The sitepath distinguishes this site from others on the server. Alternatively, you can check for a DB name in the connection string, as shown in the following example.
    (syncProfileData.RemoteSiteConfig.SitePath.ToLower()
  .StartsWith(@"c:\inetpub\syncreceiver") 
  && (syncProfileData.SyncConfig.Direction
  == SyncDirection.Upload
  || syncProfileData.SyncConfig.Direction
  == SyncDirection.BiDirectional))
{
  WriteTaxonomyToXml();
}
  3. The following strategy executes a companion console application whenever a database sync is completed. Here is the local path to the console application.
    string path = @"C:\inetpub\ConsoleApps\CreateTaxonomyXML\CreateTaxonomyXML\bin\Debug\CreateTaxonomyXML.exe";
  4. The following standard .NET code executes a console application. Remember that your EWS user (often Local System) must have execute permission for the application.
    proc = new Process();
  5. Specify that you want to start the process at the following path. No arguments are used.
    proc.StartInfo = new ProcessStartInfo(path, "");
  6. Check if the process is already running.
    (!IsProcessOpen("CreateTaxonomyXML"))
{
 try
{
proc.Start();
  7. The following code gets the process name above. It must be run after the process starts.
    EventLog.WriteEntry("Process Name", proc.ProcessName,
  EventLogEntryType.Information);

    NOTE: EventLog.WriteEntry methods write to the Event Viewer's Application log, not the EWS log.

  8. Log the process' start time.
    EventLog.WriteEntry("CreateTaxonomyXml - Start",
  proc.StartTime.ToString(),
  EventLogEntryType.Information);
  9. Wait for the process to end, to determine how long it takes to run the process.
    proc.WaitForExit();
  10. Log the process' end time.
    EventLog.WriteEntry("CreateTaxonomyXml - End",
  proc.ExitTime.ToString(),
  EventLogEntryType.Information);

SyncProfile class

SyncProfile is the basic parameter class for eSync strategies. Its properties are neatly categorized and have self-documenting names.

SyncSpecificDetails class

The SyncSpecificDetails class contains all sync details for a sync type (such as template, folder, content, or package sync).

All properties of regular, profiled syncs are in the SyncProfile class. The SyncSpecificDetails class is for extra properties that are only present in a specific sync type.

SyncProfile class

SyncProfile is the basic parameter class for eSync strategies. Its properties are neatly categorized and have self-documenting names.

SyncSpecificDetails class

The SyncSpecificDetails class contains all sync details for a sync type (such as template, folder, content, or package sync).

All properties of regular, profiled syncs are in the SyncProfile class. The SyncSpecificDetails class is for extra properties that are only present in a specific sync type.

ESyncDataTransformStrategy

This strategy lets you plug into database sync and modify columns within the records being synchronized. Addition or deletion of records is not supported.

Only one method is called per record for each table that will be synchronized.

The SyncDataRowContext class provides context about the row being sent in the event. The class is used in the sample strategy to make it easier to perform data row actions.

LoadBalancerNotificationStrategy

This strategy provides a mechanism to get notified about local load balancer events. It provides comprehensive information about them.

Implementing strategies within the Ektron Windows Service

The EWSEktron Windows Service includes a sample strategy that writes to the event log on the sending and receiving servers.

Internal classes used by the EWSEktron Windows Service are not exposed via the API. All API classes are present along with the rest of the CMS API classes in the Ektron.Cms.Contracts assembly.

Internal EWS classes are, however, converted into API classes. By decoupling the API from the EWS classes, the API cannot be changed inadvertently as Ektron changes the EWS. The decoupling also ensures that the API is more developer-friendly, usable, and self-documenting.

Strategies are raised only when they are configured to be raised in the objectFactory.config file, within the EWSEktron Windows Service root folder. The following image files are modified for strategy implementation.

  • app.config
  • ektron.cms.framework.unity.config
  • objectFactory.config

Define a strategy within the objectFactory.config file, as shown in the following image.

The ESyncStrategyLocalHandler class executes local strategies one by one, logging any errors. The class also makes a WCF call to the remote EWSEktron Windows Service to execute strategy there.

The peer server strategy contains a PeerServerDetails parameter that lets you determine which server sent the request. On the remote server, the strategy execution is straightforward, as shown in the following example.

The sample strategy shows records in the system event log, as shown in the following example. These records clarify the order in which events fire on the local server.

The remote server shows peer events.

Database events raised on the peer server also appear.

Progress events for database and file sync

Progress events provided for database and file sync let you track a sync operation's progress. These events have both local and peer methods, because all types of Ektron Sync have two sync orchestrators: one runs on the initiating server, and the other runs on the peer server. Since progress is reported by both orchestrators, both are exposed by the API.

The quality of information provided by the local/peer event is determined by the sync direction and the initiating server. So, some properties may not be available in one method or the other.

Load-balancer events

Load-Balancer events are exposed via a separate LoadBalancerNotificationStrategy, which provides information through the API about what is being synchronized to which server. This strategy provides extensive information about the load balancer, and is useful to end users.

Open topic with navigation