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 profiles. One syncs the database, assetan external file, such as a Microsoft Word document or image, stored in Ektron. It 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 profiles, one for each site.

• 3 database and template profiles
• 3 Workarea profiles

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 (CMS400Base8x.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 AppPool.
2. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > 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 local server.
4. Click Generate.
5. Click Yes. The certificates are created on the local server.

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

6. Close the dialog.
7. 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.
8. 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.

9. In the local server window, open the following folder:
   32-bit:
   C:\ProgramFiles\Ektron\CMS400vxx\Utilities\Software\SecurityConfigurator
64-bit:
C:\ProgramFiles (x86)\Ektron\CMS400vxx\Utilities\Software\SecurityConfigurator
10. From that folder, copy these files.
    • servername_SyncClient.pfx
    • servername_SyncClient.pvk
    • servername_SyncClient.cer
    • servername_SyncServer.pfx
    • servername_SyncServer.pvk
    • servername_SyncServer.cer
11. Paste the files into the remote folder you created in Step 8. Make sure there are no other security files in the folder.
12. 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.

13. Sign on to the remote server using the credentials of the service account used by Ektron Windows Service 4.0 and your site's AppPool.
14. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > Security Configurator. Right click and choose Run As Administrator. The security configurator screen appears.
    

    

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

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

19. Click Yes to continue.
20. The security configurator copies the certificates you pasted in Step 11 to the correct folder, and configures them for the remote server.
21. Click OK when you see All sites are now configured for eSync.
22. 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 Ektron. It 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 profile. The profile remembers sync information, such as source and destination databases, sync direction, and items to synchronize. 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 Ektron. It 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

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

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 profile 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 profile to sync templates in the future.

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 (CMS400Base8x.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, as shown below.

To generate and copy these certificates:

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

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 AppPool.

2. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > 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\Software\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 AppPool.
12. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > 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

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 AppPool.

   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 v8x > Utilities > 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 the folder 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\Software\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 AppPool.
12. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > 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

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 AppPool.

   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 v8x > Utilities > 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\Software\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 AppPool.
13. Click the Windows Start button > All programs > Ektron > CMS400 v8x > Utilities > Security Configurator. Right click and choose Run As Administrator. The following screen appears.
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 Ektron. It 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 profile. The profile remembers information about the sync, such as the source and destination databases, sync direction, and which database and resource files are synched. 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 profile 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 profile. The profile remembers information about the sync, such as the source and destination databases, sync direction, and the fact that it syncs the database and resource files (see example below). 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 profile 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.

Include/Exclude Files Field

Use the Include/Exclude Files field to include files not normally synched, or exclude files or directories that are synched 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 synched, 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

Regardless of how you complete the Include/Exclude Files field, the following siteroot folders are not synched:

• App_GlobalResources
• App_WebReferences
• Workarea
• assetlibrary
• assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content.s, privateassets, uploadedfiles, uploadedimages (individual checkboxes under Files)
• latestchanges
• app_webreferences
• app_globalresources

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.

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 AppPool.

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 v8x > Utilities > 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 AppPool.
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\Software\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 AppPool.
7. Open the security configurator screen using this path: Windows Start Button > All programs > Ektron > CMS400 v8x > Utilities > 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 AppPool.
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 AppPool.
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.

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 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

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 Ektron. It 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 will 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 synched is an image. If true, a thumbnail is also synched. If this value is BLANK, no thumbnails are synched 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 synched 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 synched. 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 synced 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 synched 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, then it will load file streams locally, in parallel, using as many threads as specified in MaxNumberOfParallelThreads. Ensure that the server has enough resources to handle 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, then it will upload file streams to 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 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.

• 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.

• The Package Contents tab lists all objects in the package. Use the Show drop-down to display only objects of a selected type.
  

  

  • Use the delete button () to remove items. You can also remove an item by clicking its tab and unchecking it there.
  • If you choose a taxonomya content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure., menu, or collectionA list of Ektron content links for display on a Web page., only the top-level object appears on the Package Contents tab. However, all child objects (taxonomy categories, submenus, and so on) and all assigned content, users and groups are synched with the package.

• Content and Folders tab lets you select folders or content within them.

  IMPORTANT: You cannot select eCommerce catalog folders.

  

  

  • Unlike content sync, content status does not affect your ability to sync it within a package.
  • If you select a folder, the package includes the folder's content, in all languages, when the package sync is run.
  • Folder selection is not recursive. So, you must select each child folder.
  • If you view a selected folder, its content is checked and grayed out (see example below). This indicates that the content's folder is included in the package.
    

    

• Library tab lets you select libraryA folder that stores images, files, quicklinks, and hyperlinks that can be inserted into HTML content images or files. Do not choose those inserted into selected content, since they are automatically included.
  • All attributes of folders (described in Content and Folders, above) apply to library folders.

• 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 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: If you add 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 synched with them. See Also: Assigning Folders or Templates to a Menu

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

• Collections tab lets you select any collectionA list of Ektron content links for display on a Web page.. By selecting a collection, you also add to the package all content assigned to it. As a collection's content changes, the package automatically includes the current files.

• 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.

Reviewing Resolved Collisions

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

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). The email text is below.

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 text in the resource file. To learn about editing it, see Translating the Workarea.

See Also: Synchronizing Servers Using eSync

Determining which Collisions are Resolved

On the eSync Settings screen, use the Types of data field to identify objects 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.

While activity that might cause collisions occurs, you may temporarily enable checkboxes, then disable them again once the activity is complete.

Performance Counter Display Options

• Line
  

  

• Histogram
  

  

• Report
  

  

You have the following performance counters available to you:

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

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 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 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 counters:

1. Click the Windows Start button > Administrative Tools > Performance Monitor.
2. Click the Add button ().
3. From the list in the upper left corner, click Ektron Windows Service - Performance Counter, then Add and OK.

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 (CMS400Base8x.exe). For more information, see Installing the CMS Base.
2. If the site with which you will sync is precompiled, precompile all min sites.

Update the Assetmanagement.config File

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\Ektron\EktronWindowsService40\Ektron.ASM.EktronServices40.exe.Config.
3. Change the value of LoadBalanced to 1 and save.
4. Do this on every server in the cluster.
5. 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.

Generate security certificates

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 v8x > Utilities > 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 OKwhen 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\Software\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.

Apply security certificates

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 v8x > Utilities > Security Configurator) and apply the certificates from every other server in the cluster. 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

Set up and run eSync in a load balanced environment the same way you run it normally. See these sections for details.

• Initializing a New Site
• Setting up eSync Profiles
• Optional Steps before Running a Sync
• Running eSync

• 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 (). A confirmation message appears.
16. A screen monitors the sync’s progress.
17. The initial sync creates a default profile, 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.