Virtual Staging

Use Ektron’s approval process and scheduled publishing of content to manage when content goes live.

• Best choice when changes to templates and library files are infrequent
• No special implementation guidelines; just an installation on one server
• When upgrading this type of site, make a temporary copy of the site (both display layer and database) on a separate server to test the upgrade

Same Server, Same Database

• Production and development/staging sites use separate copies of Ektron but reside on same server and point to same database
• Ektron’s settings, managed content, and library files are identical between sites

To set up this configuration:

• To maintain file paths between sites:
  • Create separate websites in IIS.
  • Assign different ports to the production and development/staging sites. For example, the production site is http://www.example.com, and the development/staging site is http://www.example.com:8080.
• Both sites must use the same pathing relative to the Web root. For example, www.example.com\Workarea\applicationAPI.asp and dev.example.com\Workarea\applicationAPI.asp.
• Because both sites use the same database, editing and publishing content on one site affects the other site. As a result, the development/staging server always has the freshest content.
• Make the Ektronuploadedimages/ and uploadedfiles/ folders IIS virtual directories that point to the same physical directory.
• Template changes must be copied between sites. The best way to copy site templates and other assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content.s is eSync. This is described in Synchronizing Servers Using eSync.
  • If eSync was not implemented and changes to these items are infrequent, you can manually copy them.

To test and QA an upgrade, make a temporary copy of the site’s display layer on a separate server connected to the development/staging database.

If the development/staging database is the master, back it up before upgrading.

Same Server, Different Databases

• Production and development/staging sites use separate copies of Ektron’s display layer, reside on same server, but point to different databases
• Changes to content, configuration, or library files made in one site must be copied to other site

To set up this configuration:

• To maintain file paths between sites:
  • Create separate websites in IIS.
  • Assign different ports to the production and development/staging sites. For example, the production site is http://www.example.com, and the development/staging site is http://www.example.com:8080.
  • Separate the databases for isolation.
  • One database is the master, and the other is a copy
  • Only edit content in the site connected to the master database
  • Remove the Ektron login page from the site connected to the copy database
• To copy the Ektron database, your best choice is Ektron’s eSync feature. This is described in Synchronizing Servers Using eSync.
• If you have not implemented eSync, copy site content using a replication tool for the database.
  • SQL Server 2008 SDK Replication: See SQL Server Replication
• Library files—Make sure the Ektron uploadedimages/ and uploadedfiles/ folders IIS virtual directories point to the same physical directory.
• Templates and other file system assets—The best way to move these is eSync. If that was not implemented and changes to these items are infrequent, you can manually copy them. For automated replication, use a product such as Microsoft Application Center.
• Upgrading Ektron—To test an upgrade, make a temporary copy of the site’s display layer on a separate server connected to the development/staging database. If the development/staging database is the master, back it up before upgrading.

Separate Servers, Same Database

• Production and development/staging sites reside on separate servers, which point to the same database.
• Ektron settings, content, and library files are identical between sites.
• Changes to templates must be copied between servers.

To set up this configuration:

• Configure Ektron’s Load Balancing feature to copy uploaded images and files between the servers.
• The best way to move site templates and other assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content.s is eSync. This is described in Synchronizing Servers Using eSync.
  • If that was not implemented and changes to these items are infrequent, you can manually copy them. For automated replication, use a product like Microsoft Application Center.
• When upgrading Ektron:
  1. Back up the file system of the development/staging server.
  2. Make a temporary copy of the production server database.
  3. Switch the development/staging site to use the copy.
  4. Test and QA the upgrade on the development/staging server.

Separate Servers, Separate Databases

• Production and development/staging sites are installed to separate servers and point to different databases
• Changes to content, configuration, or files must be copied between sites.

To set up this configuration:

• Both sites must have the same pathing relative to the Web root, for example, www.example.com\Workarea\applicationAPI.asp and dev.example.com\Workarea\applicationAPI.asp.
• Separate the databases for isolation.
  • One database is the master, and the other is a copy
  • Only edit content in the site connected to the master database
  • Remove the Ektron login page from the site connected to the copied database
• The best way to copy site templates and library files is eSync. This is described in Synchronizing Servers Using eSync.
  • If that was not implemented and changes to these items are infrequent, you can manually copy them. For automated replication, use a product like Microsoft Application Center.
• To copy the Ektron database (containing HTML and XML content), your best choice is Ektron’s eSync feature.
  • If you have not implemented eSync, copy site content using a replication tool for the database, such as SQL Server 2008 SDK Replication. See SQL Server Replication
• Make sure the Ektronuploadedimages/ and uploadedfiles/ folders IIS virtual directories point to the same physical directory.
• When upgrading Ektron:
  1. Back up the file system of the development/staging server
  2. Make a temporary copy of the production server database
  3. Switch the development/staging site to use the copy
  4. Test and QA the upgrade on the development/staging server

Analytics

• See Google Web Analytics and Templates.

Connection Strings

For SQL Server—Use this connection string to define an SQL server.

• name—ektron.DbConnection
• providerName—System.Data.SqlClient
• connectionString—this part of the connection string contains the following element.
• server—the name of the database server to which Ektron is installed. If installed locally, the value is localhost. This value is set during installation, at the Host screen.
• database—use the name of the database.
• Integrated Security—use True or False. True—use integrated security.
• user—If required, specify the username used to connect to the DSN. This user account must have at least read and write permissions to the database.

  NOTE: This value can be blank if you are using Windows authentication.

• pwd—If required, specify the password for the username given. It should match your database name.

  NOTE: This value can be blank if you are using Windows authentication.

  IMPORTANT: After changing any database settings, you must stop and restart the Ektron Windows Service. See Also: Ektron Windows Service

appSettings

• ek_appName—The name of the application, CMS400. You typically would not change this value.
• ek_appPath—This element is prefixed by the ek_sitePath value and describes the location of the workarea folder. This file stores external applications (such as eWebDiff), templates, and the images folder.
• ek_appImagePath—The folder that stores the images within Ektron, such as toolbar icons. Only change this value if you need to move the images folder to another location. This value is prefixed by the value set in the ek_appPath variable. By default, ek_appPath is set to webroot/cms400Min/workarea/. So, by default, this folder is set to webroot/cms400Min/workarea/images/application/.
• ek_appXSLTPath—The folder that stores XSLTExtensible Stylesheet Language Transformationss. Only change this value if you need to move the XSLT folder to another location. This value is prefixed by the value set in the ek_appPath variable. By default, ek_appPath is set to webroot/cms400Min/workarea/. So, by default, this folder is set to webroot/cms400Min/workarea/Xslt.
• ek_buildNumber—This value is set by the installation program. You typically would not change it.
• ek_cmsversion—This value is set by the installation program. You typically would not change it.
• ek_LDAPMembershipUser—Integrate membership users with LDAPLightweight Directory Access Protocol; permits access to distributed information. or Active Directory. Set the value to True for Membership Users to be authenticated using LDAP/AD.
• ek_RedirectFromLoginKeyName—Provides a mechanism to return from the login page to the previous page, specify the query string key-name. By default the value is RedirectUrl. Currently, the redirect works in 2 instances.
  1. When a user tries to use a forum but is not logged in, it sends them to a login page and returns them. The value in this key used in conjunction with the ek_RedirectToLoginURL key sends the user from a forum page to a login page and back to the previous page.

     For example, a user tries to reply to a forum post, but the user is not logged in. The user is sent to the login page and then returned to the original page.

  2. When a user sends a private message to another user or group administrator from the SocialBar server control, the user is returned to the page where the user clicked private message once the message is sent.

     For example, you visit a community group’s page and click Private Message Admin. You are directed to the private message screen. When you click post, you are returned to the community group’s page. For additional information, see Server Control Reference.

• ek_RedirectorInstalled—Turns the redirector on or off. Turning the redirector on enables the option of aliasing the URL of your website. The default is False.
  • True—Aliasing turned on
  • False—Aliasing turned off

  See Also: Creating User-Friendly URLs with Aliasing

• ek_RedirectorManualExt—Set a comma-delimited list of Web page extensions for which you will create aliased pages. For example, .aspx,.htm,.html. By default, the list contains.aspx. See Also: Creating User-Friendly URLs with Aliasing

  NOTE: You can enter one or more extensions. Each extension must begin with a period, and the last extension must be followed by a comma (,).

• ek_RedirectToLoginURL—The URL of the login page to automatically redirect to when a site visitor is not logged in as a user or membership user.
• ek_sitePath—The location of Ektron relative to the Web root. This value is set during installation at the Site Path Directory screen. If you move Ektron to another folder, you must update this value.
• ek_TreeModel—Choose whether or not to use Ajax for the folder tree in the Workarea.
  • 0—use the legacy folder tree in the Workarea.
  • 1—use Ajax for the folder tree in the Workarea.

    NOTE: This key has been removed from the web.config file. However, you can still use this key by adding it between the <appSettings> tags. For example, <add key=”ek_TreeModel” value=”0”> changes the folder tree in the Workarea back to legacy.

• ek_workareaDateFormat—Choose how you want to display dates in some areas of the Workarea.
  • long—for example, Tuesday May 21, 2013
  • short—for example, 5/21/2013
• ek_xmlPath—The location of the xmlfiles directory. The ek_sitePath path is prefixed to this location. You would only change this value if you want to move the location of the xml files relative to the Web root.
• GoogleMap—Enter connection information for using Google Maps with the Mapping feature in Ektron. See Also: Server Control Reference
• VirtualEarthMap—Enter connection information for using Bing Maps for Enterprise with the Mapping feature in Ektron. See Also: Server Control Reference

Images

These images appear before the user signs in, so cannot be stored in the database. Update as needed. Their location is set in the ek_appImagePath variable. See Also: ek_appImagePath.

• ek_Image_1—close button
• ek_Image_2—small login button
• ek_Image_3—big login button

SMTP server configuration

See Installing Ektron

• ek_SMTPPass—The password set up to send and receive email
• ek_SMTPPort—The port your system uses to retrieve email
• ek_SMTPServer—The server that processes email
• ek_SMTPUser—The username set up to send and receive email

Mail Format

• ek_MailFormat—The format of the email created in Ektron.HTML generates email in HTML format, while Text generates plain text email.

SSL Support

See Setting Up Ektron

• ek_SSL_Port—SSL port used by Web server.
• ek_UseSSL—Determines if server will use SSL for security

Active Directory Server Configuration

See Using Active Directory with Ektron

• ek_ADAdvancedConfig—Enable Active Directory advanced configuration.
• ek_ADEnabled—Whether Ektron uses Active Directory support.
• ek_ADPassword—Password for the Active Directory server.
• ek_ADUsername—User name for the Active Directory server.
• ek_AUTH_Protocol—The directory access protocol used with the Active Directory feature. The default value is LDAP. Other protocols are GC (global catalog) and WINNT.

Menu Settings

• ek_MenuDisplayType—Determines the appearance of the content menu that appears within every content block after the user signs in.

  NOTE: This setting only works if ek_UserMenuType is set to zero (0).

  • 0—Horizontal—menu icons are arranged horizontally
  • 1—Vertical—menu icons are arranged vertically and include the tooltip text
• ek_UserMenuType—Determines the appearance of the content menu that appears within every content block after the user signs in.
  • 0—New dynamic menu—only appears when user moves cursor over content block
  • 1—Old classic menu—always appears
  • 2—Menu without borders—a silver pin head appears above content that has a menu available. Hovering over this pin produces a menu.

  See Also: Working with Ektron Content

Multilingual Settings

• ek_DefaultContentLanguage—Sets the 4 digit, decimal representation of the default content language. For example, American English is 1033. See Also: Setting the Default Language
• ek_EnableMultilingual—Enable or disable multilingual content support.
  • 1—enable
  • 0—disable

  See Also: Enabling/Disabling Support for Multiple Language Content

• ek_ServerURL—Mainly used in Web services to determine a remote server location. For example, in a Web farm environment, the content server can reside in a remote location. In this case, the developer’s content is replaced with this value, so all <img src=””…/> and <href…. references point to server named here instead of the local one.

Miscellaneous Settings

• ek_assetPath—The folder that stores assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content.s. Only change this value if you need to move the Assets folder to another location. Note that this value is prefixed by the ek_appPath value. By default, ek_appPath is set to webroot/CMS400Min. So, by default, this folder is set to webroot/CMS400Min/assets.
• ek_BatchSize—The number of files that can be uploaded at one time. The default is 4, but it can be any non-negative number.

  NOTE: Users can upload any amount of files. The system handles them 4 at a time.

• ek_CacheControls—Enable or disable caching for Ektronserver controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified.s. See Also: Caching with Server Controls
  • 0—Disable
  • 1—Enable
• ek_EditControlMac—Defines the editor used by a Macintosh operating system user.
• ek_EditControlWin—Defines the editor used by a Microsoft Windows operating system user. Choice are:
  • ContentDesigner—Use the eWebEdit400 editor. This editor does not require an ActiveX installation on the user’s computer.
  • eWebEditPro—Use the eWebEditPro editor. This editor requires an ActiveX install on the user’s computer.
  • Aloha—Use the Aloha third-party editor. See Also: Using a Third-Party Editor.
• ek_EnableMessageBoardEmail—Set to True to enable e-mail notification when a user posts a message to a user or community group’s message board. If true and a user posts to another user’s message board, the board's owner is notified. If true and a user posts a message to a community group’s message board, all group members are notified. This setting does not affect content messages. See Also: Sending Notifications to a Community
• ek_helpDomainPrefix—The path to the help files. By default, help files are located on an external server and the path is

  http://documentation.ektron.com/cms400/v[ek_cmsversion]/webhelp

  Change this path if you install help files on local servers. See Also: Installing Help Files on a Local Server.

• ek_InvitationFromEmail—The “From” email address used when a user sends an Invitation. Invitations are emails that are sent to non-system users asking them to join your site. See Also: Invite server control.
• ek_LinkManagement—This setting determines if Ektron uses linkit.aspx when inserting a quicklink. By default, it is set to false. If set to true, when a user inserts a quicklink, Ektron inserts a special link instead of a quicklink. A special link determines the correct quicklink to use when a site visitor clicks it. For example, a user adds a content block to folder A. A quicklink to that content is a.aspx?id=10. Later, if an administrator changes the folder’s template but doesn’t update the quicklink within the content block, the quicklink is broken. To avoid this problem, enable link management.
• ek_LogFileName—Path to the log file name for the message queue
• ek_loginAttempts—Ektron has a login security feature that, by default, locks out a user after 5 unsuccessful attempts to log in. See Also: Getting Started with Ektron
• ek_LoginScreenWidth—The width of the login screen in pixels. You may need to widen the screen if you are using Active Directory and database names are long.
• ek_PageSize—This setting determines the maximum number of items that can appear on a page before it “breaks.” When a page breaks, additional entries appear on another screen, and the following appears near the bottom of the list:

  Page 1 of 2

  [First Page] [Previous Page] [Next Page] [Last Page]

  NOTE: The above text changes depending on the page you are viewing.

• ek_QueueName—Path to the message queue.
• ek_ShowWorkareaRetErrorReferrer—Choose whether to enable referrer debug information on the RetError.aspx page.
  • True—enable
  • False—disable
• ek_ToolBarFormatTag— This setting only applies after a user signs in to your site. Change this setting if the colored border that surrounds content looks wrong. (The border color indicates the content’s status.) By default, <table> tags create the border. If the border looks wrong or inappropriate, change setting to div. If you do, <div> tags are used to draw the border instead of <table> tags. This change typically solves the problem.
• ek_WorkareaLibSearchResultMode—Sets the Workarea Library search-results mode.
  • text—returns a text only version of the library search results.
  • mixed—returns text and images associated with library search results.
  • graphical—returns a images associated with library search results.
• ek_XliffVersion—Define the XLIFFXML Localization Interchange File Format; for exchanging localization data. version to use when exporting files. See Also: Exporting Content to XLIFF
• WSPath—Determines the location of the Web services page used by the server controls at design time.

system.diagnostics

• LogLevel—Enter a numeric value that determines the level of message logging. By default, diagnostic messages are logged in the Event Log. Choices are:

  1—Error: log errors.

  2—Warning: log errors and warnings.

  3—Information: log errors, warnings and informationals.

  4—Verbose: Everything is logged.

ektronCommerce

See Conducting eCommerce

• ek_ecom_ComplianceMode—When set to true, your site is Security Compliant. This means the Workarea is encrypted in an SSL session and Logging is started.
• ek_ecom_DefaultCurrencyId—Select the default currency and enter its Numeric ISO code. This should be done before creating your product catalog.

  WARNING! Do not change the default currency or measurement system after your eCommerce site is live.

  See Also: The Default Currency

• ek_ecom_TestMode—When set to true, payments are sent to a test gateway instead of the actual one.
• ek_MeasurementSystem—Select whether to use English or Metric measurements for your packages. See Also: Configuring Packages

mediaSettings

See Also: Managing Multimedia Assets

• application/x-shockwave-flash—Define the relationship between the Shockwave Flash mime type and the Flash player.
• audio/mpeg—Define the relationship between the MPEG audio mime type and the Windows Media Player.
• audio/x-ms-wma—Define the relationship between the MS-WMA mime type and the Windows Media Player.
• audio/x-realaudio—Define the relationship between the realaudio mime type and the Real player.
• audio/x-wav—Define the relationship between the WAV mime type and the Windows Media, Quicktime and Real players.
• audio/x-wav-default—Define the relationship between the WAV default mime type and the Windows Media Player.
• Flash-CLSID—The class ID for the Flash player.
• Flash-Codebase—Location of the code base plug-in for Flash player.
• Quicktime-CLSID—The class ID for the Quicktime player.
• Quicktime-Codebase—Location of the code base plug-in for Quicktime player.
• Realplayer-CLSID—The class ID for the Real player.
• Realplayer-Codebase—Location of the code base plug-in for Real player.
• video/mpeg—Define the relationship between the MPEG video mime type and the Windows Media Player.
• video/quicktime—Define the relationship between the Quicktime mime type and the Quicktime player.
• video/x-avi—Define the relationship between the AVI mime type and the Windows Media, Quicktime and Real players.
• video/x-avi-default—Define the relationship between the AVI default mime type and the Quicktime player.
• video/x-msvideo—Define the relationship between the msvideo mime type and the Windows Media, Quicktime players.
• video/x-msvideo-default—Define the relationship between the msvideo default mime type and the Windows Media Player.
• video/x-ms-wmv—Define the relationship between the MS-WMV mime type and the Windows Media Player.
• video/x-realvideo—Define the relationship between the realvideo mime type and the Real player.
• WindowsMedia-Codebase—Location of the code base plug-in for Windows Media Player.
• WindowsMedia-CLSID—The class ID for the Windows Media Player.

Miscellaneous

• HttpHandlers—This section sets how the URL Aliasing feature handles URLs with certain extensions. If you have any extension you do not want aliased, add it below the following line using the same syntax.
  add verb="*" path="*.png" type="URLRewrite.StaticFileHandler,
Ektron.Cms.URLRewriter" />
• maxRequestLength—This setting determines the maximum size of files that can be uploaded to your server. The default setting is 204,800 kilobytes, or 200 MB. Enter the desired value in kilobytes. To convert megabytes to kilobytes, go to OnlineConversion.com.
• session state—mode—determines the storage option for session data. Ektron supports all session-state modes listed in this article: Session-State Modes.

Prerequisites

• All sites reside on the same server
• Each site requires a multi-site license key. To purchase additional licenses, contact Ektron sales.

Advantages of multi-site configurations:

• The URL can indicate the nature of the site to visitors
  • www.example.com
  • support.example.com
  • forums.example.com
• All sites can share a single database
  • common content, but appear within their own site and templates
  • the library of images and files. These files can be stored once; authors can insert them into content from any site.

Automatic Multi-Site Setup

IMPORTANT: Before creating a multi-site configuration, you must have installed an Ektron website. All installed folders must remain in that site. The original site cannot have virtual folders.

1. Create each new site in IIS. Convert each site folder to an application. See http://www.iis.net/learn/manage/creating-websites.
2. Run the Multi-Site Setup Wizard.
   1. Double click C:\Program Files (x86)\Ektron\CMS400vxx\Utilities\MultiSiteInstall\Multisite.exe.
   2. Use the pulldown to select the site you created in Step 1.
   3. Select your host.
      

      

   4. Enter a path to the new site.
      

      

   5. Identify your main website; that is, the site to which this multi-site is being added.
      

      

   6. When prompted to add a multi-site key, click Yes.
   7. Enter a license key for the new site. This step copies the new site's license keys to the database.
   8. Enter information about the new site's database.
   9. Follow the remaining screens in the wizard.
3. Assign multi-site capabilities in Ektron.
   1. Log in the Workarea.
   2. Click Content.
   3. Click the site root folder.

      NOTE: Site folders must reside within the site root folder.

   4. On the View Contents of Folder screen, create a new top-level site folder for each site by choosing New > Site.
   5. Assign site folder properties as you did for the root folder. The Multi-site Configuration fields appear on the lower section of the screen.
      

      

   6. In the Staging Domain field, insert your staging domain.

      IMPORTANT: Production and staging URLs must be unique across multi-sites. In other words, in a multi-site configuration, one site's production or staging URL cannot be the same as another site‘s production or staging URL.

   7. In the Production Domain field, insert your production domain.
   8. Click Add Folder. Within Ektron, new sites are indicated by a globe icon.
      

      

Manual Multi-Site Setup

Ektron provides a utility (Multisite.exe) that automatically completes Steps 1 and 2 for you. If you run this utility, you only need to complete Step 3. The utility is located C:\Program Files\Ektron\CMS400vxx\Utilities\MultiSiteInstall.

1. Create New Folders in the File System.

   IMPORTANT: Before creating a multi-site configuration, you must have installed an Ektron website. All installed folders must remain in that site. The original site cannot have virtual folders.

   1. Using Windows Explorer, navigate to the C:\Inetpub\wwwroot folder.
   2. Create a new folder for each site.
      

      

   3. Copy the following Ektron files and folders from the original site to the new, multi-site folder.
      • all individual files (not subdirectories)
      • all .config files in all directories under the site root
      • these subdirectories:
        • bin
        • WorkArea
        • widgets
        • App_Code
        • AssetManagement
        • App_GlobalResources
   4. Within each new site folder, open the web.config file and update the ek_sitePath and WSPath elements with your Ektron site path.

      For example, if your Ektron site is in the website root, enter slash (/). If it is in a subdirectory of the website, enter the subdirectory name. For example, if the website root is C:\inetpub\wwwroot and you have a subdirectory called CMS400Min, enter CMS400Min as the site path.

2. Create new sites in IIS. Convert each site folder to an application. See http://www.iis.net/learn/manage/creating-websites.
3. Create Virtual Folders in IIS.

   In IIS, for each new website, create one new virtual folder for the following shared folders:

   • assets
   • privateassets
   • uploadedfiles
   • uploadedimages

   These folders are created when you install Ektron. If you did a normal installation, they reside under the site directory. For example, C:\Inetpub\wwwroot\siteroot\uploadedimages.

   To create virtual versions of these folders, see the following section.

   Creating virtual folders in IIS 7

   Creating Virtual Folders in IIS 7

   1. In IIS, select the new site folder you created.
   2. Right click the mouse and choose Add Virtual Directory.
      

      

   3. Identify the corresponding subfolder in the root folder.
      

      

   4. Follow this procedure for all folders: assets, privateassets, uploadedfiles, uploadedimages.
4. Set file system permissions on new folders.
   1. Using Windows Explorer, navigate to the new folder(s) you created in Setting Up Development and Staging Environments .
   2. Right click the folder and click Properties.
   3. Click the Security tab.
   4. Click Advanced.
   5. Check Include Inheritable Permissions from this object's parent.
      

      

5. Install the aspnet_isapi.dll file.
   Installing the aspnet_isapi.dll file in IIS 7

   Installing the aspnet_isapi.dll File in IIS 7

   1. In the Connections window, select your application.
      

      

   2. Make sure that the Features view is selected.
   3. Double-click Handler Mappings.
      

      

   4. Click Add Wildcard Script Map.
      

      

   5. The Add Wildcard Script Map dialog appears.
      

      

   6. In the Executable field, browse to C:\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_isapi.dll.
   7. Enter a name.
   8. Click OK.
6. Assign multi-site capabilities in Ektron.
   1. In the Workarea, click Content.
   2. Click the site root folder.

      NOTE: Site folders must reside within the site root folder.

   3. Create a new top-level site folder for each site by choosing New > Site.
   4. Assign site folder properties as you did for the root folder. The Multi-site Configuration fields appear on the lower section of the screen.
   5. In the Staging Domain field, insert your staging domain.

      IMPORTANT: Production and staging URLs must be unique across multi-sites. In other words, in a multi-site configuration, one site's production or staging URL cannot be the same as another site‘s production or staging URL.

   6. In the Production Domain field, insert your production domain.
   7. Save the screen. In Ektron, new domains are indicated by a globe icon.
      

      

Before Adding a Website

Adding a website to a server requires careful preparation before running the Website Creation Wizard. Consider these recommendations.

• Review the methods of hosting multiple websites, and determine which one is appropriate for your environment.
• Multiple websites can use the same IP address. But if you decide to use a unique IP address for the new website, obtain a static IP address from your organization or ISP. Then, configure the server’s TCP/IP settings.
• If you use a host header name to identify the new website, select a unique name. On a private network, the host header can be an intranet site name. But on the Internet, the host header must be a publicly available Domain Name System (DNS) name, such as support.microsoft.com. Register a public DNS name with an authorized Internet name authority.
• Update your name resolution system (typically DNS) with a new record that contains the new IP address and site name. For more information, see Domain Name Resolution in IIS help.
• Standard Internet services use TCP port 80 by default. It is not recommended to use any other port for HTTP services.

  If you use a non-standard TCP port number to identify a new website for special situations (such as a private website for development/testing), select a TCP port number above 1023. In this way, the number does not conflict with well-known port numbers assigned by the Internet Assigned Numbers Authority. (For more information about IANA and port assignments, see List of TCP and UDP port numbers.)

• Use Windows Explorer to create a home directory for the content. Create subdirectories to store HTML pages, image files, and other content as needed.

  To organize home directories for multiple websites on one server, create a top-level directory for all home directories, then subdirectories for each site.

  You can create a home directory

  • on the local server
  • as a uniform naming convention (UNC) path on a network share
  • as a URL that redirects clients to a different Web server

  You can also create virtual directories that map to physical directories. For more information, see “Setting Home Directories” and “Using Virtual Directories” in IIS help.

• Determine whether to generate the website’s identification number incrementally or from the website name.
• Create a home page that clearly identifies the new site.

Adding a Website

IIS provides 2 methods for adding a new website.

• The Website Creation Wizard
• The iisweb.vbs command-line script

IMPORTANT: You must be a member of the Administrators group on the local computer to perform the following procedure (or procedures), or you must have been delegated the appropriate authority. As a security best practice, log on to your computer using an account that is not in the Administrators group, and then use the Run as command to run IIS Manager as an administrator. From the command prompt, type runas /user:administrative_accountname "mmc %systemroot%\system32\inetsrv\iis.msc".

IIS 7—Website creation wizard

Using Website Creation Wizard with IIS 7

1. In IIS Manager, expand the local computer, right-click the Sites directory, and click Add Web Site.
   

   

2. Click Next. The following dialog appears.
   

   

   • Site Name—Enter the website name.
   • Application Pool—Click Select if you want to select a different application pool than the one listed in the Application Pool box. If you do, the Select Application Pool dialog box appears. Select an application pool from the list and then click OK.
   • Physical path—Enter the physical path to the website's folder. Or, click the browse button (...) to navigate the file system and find the folder.If the physical path that you enter is to a remote share, click Connect as... to specify credentials that have permission to access the path. If you do not use specific credentials, select the Application user (pass-thru authentication) option in the Connect As dialog.
   • Type—Select the protocol for the website from the Type list.
   • IP Address—The default value in the IP address box is All Unassigned. If you must specify a static IP address for the website, type the IP address in the IP address box. All Unassigned refers to IP addresses assigned to a computer but not a specific site. The default website uses all IP addresses not assigned to other sites. Only one site can be set to use unassigned IP addresses for a given port number. For more information on how sites are identified, see Creating Multiple FTP Sites in IIS help.
   • Port—Enter a port number. The TCP port is assigned to port 80 by default. To use a nonstandard port number to create a unique identity for a private website, enter a new port number above 1023.
   • Host name—Optionally, enter a host header name for the website.If you are adding additional sites to a single IP address by using host headers, you must assign a host header name containing the full name of the site, for example, www.ektron.com.
   • Start website immediately—Check this box if you do not have to make any changes to the site and want it to be immediately available.

IIS 7—command line script

Adding a Website with a Command Line Script in IIS 7

To add a site, use the following syntax:

appcmd add site /name: string /id: uint /physicalPath: 
  string /bindings: string

The variable namestring is the name, and the variable iduint is the unsigned integer that you want to assign to the site. The variables namestring and iduint are the only variables that are required when you add a site in Appcmd.exe.

NOTE: If you add a site without specifying values for the bindings and physicalPath attributes, the site will not be able to start.

The variable physicalPathstring is the path of the site content in the file system.

The variable bindingsstring contains information that is used to access the site, and it should be in the form of protocol/IP_address:port:host_header. For example, a website binding is the combination of protocol, IP address, port, and host header. A binding of http/*:85: enables a website to listen for HTTP requests on port 85 for all IP addresses and domain names (also known as host headers or host names). On the other hand, a binding of http/*:85:marketing.contoso.com enables a website to listen for HTTP requests on port 85 for all IP addresses and the domain name marketing.contoso.com.

To add a website named contoso with an ID of 2 that has content in c:\contoso, and that listens for HTTP requests on port 85 for all IP addresses and a domain name of marketing.contoso.com, type the following at the command prompt, and then press Enter.

appcmd add site /name: contoso /id:2 /physicalPath: c:\contoso /bindings:http/*:85: marketing.contoso.com

See Also: Appcmd.exe (IIS 7).

Load Balancing Library Images and Files

Library load balancing is important when your configuration consists of 2 or more websites that share one database. Library files are not saved in the database but in the site root folders uploadedfiles and uploadedimages.

To support load balancing, library files on all servers must be identical. To maintain this state, whenever a user uploads an item to the library, it is replicated on all other servers. After following the setup instructions, whenever an image or file is added to the library of one server, it is copied to the corresponding folder on other servers in the configuration.

1. Open the file C:\Program Files\Ektron\EktronWindowsService40\Ektron.ASM.EktronServices40.exe.config using a word processor such as Notepad.
2. Set the value of the LibraryLoadBalanced property to 1.
3. Set the value of the LoadBalServerCount property to the number of servers in your load balance cluster.
4. Save the config file.
5. Restart the Ektron Windows Service.
   

   

See Also: Ektron Windows Service

Load Balancing Assets

Asset load balancing is important when your configuration consists of 2 or more websites that share one database. Ektron balances requests to work with assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content.s from multiple servers by ensuring that each server has a copy of every asset.

After setting up asset load balancing, any asset added to one server is copied to the corresponding folder on other servers in the configuration. There is no limit to the number of servers that can be load balanced.

The following list shows the load balance settings summary on all servers.

<webroot>\AssetManagement.config

• LoadBalanced=1
• (0 to disable)

c:\Program Files\Ektron\Ektron.ASM.EktronServices40\Ektron.ASM.EktronServices40.exe.config

• LibraryLoadBalanced=1
• LoadBalServerCount=x

Where x is the number of servers in load balanced configuration

To set up load balancing for assets, follow these steps on all servers that are load balanced together.

1. Within the site root folder, open the AssetManagement.config file using a word processor such as Notepad.
2. Change the value of the LoadBalanced element to 1.
3. Save the config file.
4. Open the following file using a word processor such as Notepad:

   C:\Program Files\Ektron\EktronWindowsservice40\
Ektron.ASM.EktronServices40.exe.config

5. Set the value of the LibraryLoadBalanced property to 1.
6. Set the value of the LoadBalServerCount property to the number of servers in your load balance cluster.
7. Save the config file.
8. Update these files for each server in the load balance cluster.
9. Sign on to Ektron. This action sets up the load balance software in the database.

Refreshing Load Balanced Files

Prerequisite

You must be an Administrators group member.

Asset and Library files may become out-of-date or lost due to equipment failures, power outages, or other events. In addition to your Load Balance system, Ektron provides a way to refresh the files contained in the DMS Assets folders and Library Files and Images folders.

NOTE: Open Port 8732 on load balanced servers for load balancing refresh to work properly.

IMPORTANT: Previously, Ektron used Port 6079 for communication between load balancing servers. Starting with version 8.01, this port is no longer used and can be closed in your firewall.

To refresh the load balanced files:

1. In the Workarea, go to Settings > Configuration > Load Balancing. The page looks like this.
   

   

2. Click Start. A status screen appears.
   

   

3. Verify that the status screen shows servers you expect to be refreshed. Server name WS10155 is circled in the example.

   IMPORTANT: If you click Start and the screen quickly returns and files do not refresh, or if a server is missing from the status list, check your Load Balancing settings in Ektron.ASM.EKtronServices40.exe.config.

4. Click Close when finished viewing the status.

Load Balancing Status

To check the Load Balancing Status, click the Scroll button.

The Status screen shows the Load Balancing screen showing either the previous refresh or the current refresh in progress.

SMTP Error Messages

When submitting a form or a content block in an approval process, if you get an error message listed below, it is generated by the SMTPSimple Mail Transport Protocol; an internet standard for electronic mail. server on which you set up the mail system, not by Ektron.

• The Transport failed to connect to the server. [CBR SendMail R1] [CBR R65] [DIO R 36]
• The server rejected one or more recipient addresses. The server response was: 550 5.7.1 Unable to replay for [email protected] [CBR SendMail R1] [CBR R1] [DIO R36]

Automatic email Notification

Ektron's automated system sends email to proper users when an action has been, or needs to be, performed. See Also: Customizing Ektron email with Variables.

Email is generated when any of the following actions takes place.

• Submitted to be published—email sent to next approver
• Submitted to be deleted—email sent to next approver
• Published to website—email sent to author
• Declined to be published or deleted—email sent to author

To be notified of these actions, the following criteria must be met:

• Valid system email address
• Enabled email notification
• User email address
• User email notification enabled

These values are set in the Edit User screen. See Also: Managing Users and User Groups

The Tasks feature also has automatic email notification. See Setting Up Task Types and Categories.

Customizing Ektron email with Variables

Ektron can send email notification to users, informing them that actions have taken place or are requested of them. For example, a content contributor receives an email that the contributor's content was published. These emails are stored in resource files, where each email consists of one string for the subject and one for the body. Each message is called in the presentation layer by its message title. Ektron does not support HTML email, however the message text is fully customizable.

The body of an email can include variables, located between @ symbols. Ektron replaces them with the information for that instance of the email. For example, @appContentTitle@ in the following sentence is replaced with the email’s title.

• Before: The content “@appContentTitle@” has been deleted.
• After: The content “Home Page Content” has been deleted.

You can customize the emails, move the variables, add text, rewrite and reorganize.

• Before: “@appContentTitle@” has been deleted from the XYZ website.
• After: “About Us” has been deleted from the XYZ website.

Carriage Return/Line Feeds are represented by @appCRLF@. These cause the email to move down one line. For example:

• Before: The content was approved.@appCRLF@Thank you!
• After: The content was approved.

  Thank you!

Ektron email variables

Ektron email Variables

Ektron email variables are specialized for the type of email message you need to send.

• Notify CMS users
  • @appApprovalList@—The current approval list that the content block must pass through.
  • @appChangeDateTime@—The date and time changes will be updated on the website.
  • @appComment@—Displays the comments for the content block.
  • @appContentLink@—The link to the content block on the website.

    NOTE: You must be logged in to see the changes.

  • @appContentTitle@—The title of the content block.
  • @appCRLF@—A carriage return.
  • @appDeclinerFirstName@—The first name of the user who declined the content block.
  • @appDeclinerLastName@—The last name of the user who declined the content block.
  • @appDeletionDateTime@—The date and time the content will be deleted from the website.
  • @appEmailFrom@—The address of the email sender.
  • @appEmailTo@—The address of the email recipient.
  • @appFolderPath@—The location of the content block in the Ektron folder tree.
  • @appPassword@—Displays the account password for ResetPassword and RequestResetPassword message types.
  • @appSubmitterDateTime@—The date and time the content block was submitted.
  • @appSubmitterFirstName@—The first name of the user who submitted the content block.
  • @appSubmitterLastName@—The last name of the user who submitted the content block.
• Notify discussion board users—Discussion board email
  • @appForumUrl@—The forum’s URL.
  • @appHostUrl@—The host site’s URL.
  • @appPosterDisplayName@—The display name of the person who posted.
  • @appPosterId@—The integer ID of the person who posted.
  • @appPosterProfileUrl@—The profile URL for the person who posted.
  • @appPostMessage@—The text of the message posted to the discussion board.
  • @appPostUrl@—The URL of the post on the website.
  • @appRecipientDisplayName@—The display name of the email recipient.
  • @appRecipientEmail@—The email address of the email recipient.
  • @appRecipientFirstName@—The first name of the email recipient.
  • @appRecipientId@—The email recipient’s integer ID.
  • @appRecipientLastName@—The last name of the email recipient.
  • @appTopicId@—The integer ID of the topic.
  • @appTopicTitle@—The title of the topic.
• Invite users to participate in a community group—Community group email
  • @appFriendDisplayName@—The recipient's name.
  • @appFromUserDeleted@—Token message is from a user that was deleted.
  • @appFromUserDisplayName@—The name of the user from whom the private message was sent.
  • @appFromUserID@—The ID of the user from whom the private message was sent.
  • @appGroupName@—The group a person is being invited to join.
  • @appInvitedEmail@—The recipient's email address.
  • @appInviteId@—Appends the invite ID to the registration URL. For example:

    Click <a href=http://www.example.com/register.aspx&fInvId=
@appInviteId@>here</a> to accept.

  • @appMessage@—The Message field of the private message (message body text).
  • @appOptionalText@—Text a user types into the Optional Message box on the Invite server control.
  • @appPrivateMessageID@—The CMS ID for the particular private message.
  • @appSenderName@—The sender of the invitation.
  • @appSubject@—The Subject field of the private message.
  • @appToUserDisplayName@—The name of the user receiving the message.
  • @appToUserID@—User ID of the user receiving the message.
  • @appToUserMessageID@—The CMS ID of the recipient's message object.
• Notify a subscription list of users through a Web Alert—Web alert email
  • @appComment@—The comments for the content block.
  • @appContentLink@—The link to the content block on the website.

    NOTE: You must be logged in to see the changes.

  • @appContentTitle@—The title of the content block.
  • @appContentURL@—The URL of the content, from the quicklink and domain.
  • @appCRLF@—A carriage return. Moves text down one line.
  • @appSubmitterFirstName@—The first name of the user who submitted the content block.
  • @appSubmitterLastName@—The last name of the user who submitted the content block.
  • @appSubscriptionNames@—Comma separated list of subscriptions that a user selected.

    You can insert these membership variables into the confirmation message.

    • @appActivateId@—Account ID
    • @appAvatar@—Avatar
    • @appDisplayName@—Display name
    • @appEmail@—email address
    • @appFirstName@—First name
    • @appLastName@—Last name
    • @appSignature@—Signature
    • @appUserName@—UserName

email notification variables

email Notification Variables

The list shows variables you can use to customize email messages. When the email is sent, the corresponding description replaces the variable.

• @appApprovalList@—The current approval list that the content block must pass through.
• @appChangeDateTime@—The date and time changes will be updated on the website.
• @appComment@—Displays the comments for the content block.
• @appContentLink@—The link to the content block on the website.

  NOTE: You must be logged in to see the changes.

• @appContentTitle@—The title of the content block.
• @appCRLF@—A carriage return.
• @appDeclinerFirstName@—The first name of the user who declined the content block.
• @appDeclinerLastName@—The last name of the user who declined the content block.
• @appDeletionDateTime@—The date and time the content will be deleted from the website.
• @appEmailFrom@—The address of the email sender.
• @appEmailTo@—The address of the email recipient.
• @appFolderPath@—The location of the content block in theEktron folder tree.
• @appPassword@—Displays the account password for ResetPassword and RequestResetPassword message types.
• @appSubmitterDateTime@—The date and time the content block was submitted.
• @appSubmitterFirstName@—The first name of the user who submitted the content block.
• @appSubmitterLastName@—The last name of the user who submitted the content block.

Default Ektron email messages

Default Ektron email Messages

• Approved Content Awaiting Go Live Date

  Message Title: email subject: content changes approved.
  Message Text: Content changes have been approved.

• Approved Content Published Immediately

  Message Title: email subject: content has been changed.
  Message Text: Content changes have been made.

• Decline Approval Request

  Message Title: email subject: approval request declined.
  Message Text: Content approval request declined.

• Deletion of Content Approved

  Message Title: email subject: content deletion approved.
  Message Text: Deletion of content has been approved.

• Immediate Deletion of Content

  Message Title: email subject: content has been deleted.
  Message Text: Content has been deleted.

• Send Approval Message

  Message Title: email subject: request for approval.
  Message Text: Request for content approval.

Sending Instant email

In addition to automatic email, Ektron lets you email a user or user group from many screens. An email icon () next to a user or group name or on the toolbar indicates your ability to do this. Screens in the following Ektron features support instant email.

• Tasks
• Approvals
• Reports

When you click one or more user/group names then the toolbar's email icon, the email screen appears.

NOTE: The email software must be configured for your server. See Setting up the SMTP Server.

When the email screen appears, the following information is copied from Ektron into the email.

• To—User you selected to receive email. If the user does not have a valid email address, an error message appears. If you then insert a valid address, the email is sent. If you specify a group to receive the message, as long as one group member has a valid email address, all group members with valid addresses receive the email. You can edit and add recipients.
• From—User signed on to Ektron. You cannot edit this field.
• Subject—If the email message is linked to content, its title appears. You can edit this field.
• Body of message—If the email message is linked to content, a content link appears. You can edit this field.

Logging into an Ektron Website

To sign on to an Ektron site:

1. In your Web browser, navigate to the URL of your Ektron website. Your system administrator provides this.
2. Click the Login button. The Login dialog box appears.
   

   

   

3. Enter your username and password.

   If you are using one of Ektron’s sample sites, you can use any of 3 standard users that demonstrate Ektron’s flexible user-permissions model.

   • Administrator—Username: admin; Password: admin; Permissions: All
   • Standard user—Username: jedit; Password: jedit; Permissions: Basic (for example, add/edit content, manage library files, and so on)
   • Membership user —Username: jmember; Password: jmember; Permissions: Read-only permission to private content
4. Click the Login button. The Web page appears. When you are logged in, the content is either surrounded by a border or has an access point () in the top left corner of the content.
   

   

Logging Out

1. Click Logout from the content menu, or on the Web page. The Logout confirmation box appears.

   

2. Click Logout. You return to the Web page from which you logged out. However, it is in standard view, not Ektron view.

Restricting Login Attempts

Ektron has a login security feature that locks out a user after 5 unsuccessful attempts to log in on one computer. You control login security by changing the ek_loginAttempts element in the web.config file.

• any number between 1 and 254—The number of unsuccessful login attempts after which the user is locked out
• 0—Lock out all users
• -1—Disable feature; unlock all locked users
• -2—Lock out Ektron users only; membership users can log in

You can control the following capabilities.

Changing the number of unsuccessful login attempts

Changing the Number of Unsuccessful Login Attempts

If a user unsuccessfully tries to log in 5 times, this error appears: The account is locked. Please contact your administrator. Afterwards, even if the user enters the correct password, the user is locked out.

NOTE: You can change the error message text in the resource file. See Also: Translating the Workarea.

To change the number of login attempts prior to lockout, edit the ek_loginAttempts element in the siteroot/web.config file. For example, to allow 3 unsuccessful logins before lockout, change the value to 3. You can enter a value of up to 254.

Disabling the login attempts feature

Disabling the Login Attempts Feature

To disable the Login Attempts feature, set the value of the ek_loginAttempts element in the web.config file to -1. If you do, any user can try to log in as many times as the user wants. The error message never appears, and the user is not prevented from entering a password.

NOTE: Setting the ek_loginAttempts element in the web.config file to -1 unlocks all locked accounts.

Unlocking a locked account

Unlocking a Locked Account

When an account is locked out, the Account Locked field is checked on the Edit User screen.

To unlock the account, an administrator user (or a user assigned to the user-admin role) accesses the Edit User screen and unchecks the box. At this point, the user can sign in again.

NOTE: To unlock all users, set the ek_login Attempts element in the siteroot/web.config file to -1. See Also: Disabling the Login Attempts Feature.

Manually locking a user from signing on

Manually Locking a User from Signing On

You can use the Account Locked field to manually lock a user out of Ektron.

1. Go to the Edit User screen.
2. Identify the user.
3. Check the Account Locked field.

That user cannot sign in until either you uncheck the box or change the value of the ek_loginAttempts element in the web.config file to -1.

Preventing Ektron users from signing on

Preventing Ektron Users from Signing On

To lock out all Ektron users, set the ek_loginAttempts element in the web.config file to -2. If you do, only membership users can sign in.

NOTE: The builtin user cannot sign in if ek_loginAttempts is set to -2.

Preventing all users from signing on

Preventing All Users from Signing On

To lock out all users (including membership users), set the ek_loginAttempts element in the web.config file to 0. If you do, no one can sign in to Ektron until you change the value.

NOTE: The builtin user cannot sign in if ek_loginAttempts is set to 0.

Changing images used for logging in and out

Changing Images Used for Logging In and Out

You can change the images used for the login and logout buttons. To do so:

1. Move the new images to the following folder: siteroot\Workarea\images\application.
2. Open the web.config file in your website’s root directory.
3. Change the images in this section of the file:

   <add key="ek_Image_1" value="btn_close.png" />
   <add key="ek_Image_2" value="btn_login.png" />
   <add key="ek_Image_3" value="btn_login_big.png" />

   NOTE: You must update the images and web.config whenever you upgrade Ektron.

Resolving a problem with the login screen

Resolving a Problem with the Login Screen

You may find that in certain browsers, the login screen occupies the entire browser window instead of just a small box. Browsers such as Internet Explorer 8 and Firefox have a feature called tabs. When the login window pops up, it may appear as a new tab. You can change this behavior by turning off tabs within the browser.

Managing Passwords

This section's topics relate to managing passwords.

Editing the builtin username and password

Editing the Builtin Username and Password

The builtin user is an emergency user to use if you cannot log into Ektron as an administrator. The builtin username and password are defined in Ektron's setup screen.

1. From the Workarea, choose Settings > Configuration > Setup. The Application Setup screen appears with the General tab showing.
2. Click Edit to modify the settings.
3. Locate the Built In User fields.
4. Change the username or password or both.
5. Click Update.

The builtin user can log in to Ektron whether or not Active Directory or LDAPLightweight Directory Access Protocol; permits access to distributed information. is enabled. The builtin user's default username/password combination is builtin/builtin. For security reasons, change them during installation.

If you log into the Workarea as the builtin user, you can access only the following screens on the Settings tab.

• Active Directory
• Asset Server Setup
• Setup
• User
• User Group

WARNING! Use the builtin user only to correct a bad or expired license key. It is not designed for regular Ektron operations. If you try to edit content while signed in as a builtin user, you will generate errors.

If the builtin user password was changed and you don’t know it, you cannot sign in. In this case, use the BuiltinAccountReset.exe utility, which resets the username/password to builtin/builtin. This utility is located in C:\Program Files\Ektron\CMS400versionnumber\Utilities.

Enforcing a password change every 90 days

Enforcing a Password Change Every 90 Days

Ektron has a password security feature that forces an administrator or user with the Commerce Admin role to change the password at least every 90 days. This feature is only enabled if the ek_ecom_ComplianceMode key in the site’s web.config file is set to true.

When you go 85 days without changing your password, a dialog box appears upon the next log-in, asking you to change the password. If you do not want to do so at that time, click Skip. You can this for the next 5 days. After 90 days have passed, you must change your password before you can log into Ektron.

Enforcing login after time of inactivity

Enforcing Login After Time of Inactivity

Ektron has a password security feature that automatically logs out an administrator or user with the Commerce Admin role after 15 minutes of inactivity. Activity is based on requests made to the server.

This feature is enabled when the site’s web.config file‘s ek_ecom_ComplianceMode key is set to true. In addition, if you are using IIS7Internet Information Services (IIS) for Windows® Server, version 7, the line in red below needs to appear between the <modules> tags in the web.config file. This line is a part of the default install. You should make sure it has not been removed.

<modules>
  <add name="MyDigestAuthenticationModule"
type="Ektron.ASM.EkHttpDavHandler.Security.DigestAuthenticationModule,
    Ektron.ASM.EkHttpDavHandler" />
  <add name="ScriptModule"
    type="System.Web.Handlers.ScriptModule, System.Web.Extensions,
    Version=1.0.61025.0, Culture=neutral,
    PublicKeyToken=31bf3856ad364e35" preCondition="integratedMode" />
  <add name="EkUrlAliasModule" type="UrlAliasingModule" 
    preCondition="integratedMode" />
</modules>

Enforcing a minimum password

Enforcing a Minimum Password

Ektron has a password security feature that forces an administrator or user with the Commerce Admin role to use at least 7 characters in a password. Further, the password must contain at least one alphabetic and one numeric character.

This feature is enabled only when the ek_ecom_ComplianceMode key in the site’s web.config file is set to true.

Enforcing a no-match password

Enforcing a No-match Password

Ektron has a password security feature that forces an administrator or user with the Commerce Admin role to create a password that does not match the person's previous 4 passwords. This feature is enabled only when site’s web.config file has the ek_ecom_ComplianceMode key is set to true and the ek_ecom_PasswordHistory key is set to at least 4.

You can set ek_ecom_PasswordHistory to a number higher than 4 if you want a higher level of security. If you set this key to less than 4 and the ek_ecom_ComplianceMode key is set to true, Ektron enforces at least 4.

Creating a Custom Password Strategy

The Ektron password validation provider lets developers create custom password validation strategies for Ektron. These providers can enforce custom password rules inside the system, beyond the out-of-box capabilities.

This section explains how to create a custom password validation provider for Ektron.

1. Create a class library project in Visual Studio.
2. Import the namespaces you need. Add references to:
   • Ektron.Cms.Commerce
   • Ektron.Cms.Common
   • Ektron.Cms.ObjectFactory
   • Microsoft.Practices.EnterpriseLibrary.Validation.dll
   • System.Configuration
   • Ektron.CMS.User
   • Ektron.CMS.DataRW
3. Add the following using statements.

   using System;
   using System.Collections;
   using System.Configuration.Provider;
   using Microsoft.Practices.EnterpriseLibrary.Validation;
   using Ektron.Cms;
   using Ektron.Cms.Common;
   using Ektron.Cms.Commerce;
   using Ektron.Cms.Commerce.PasswordValidation.Provider;
   using System.Collections.Generic;
   using System.Text;
   using System.Text.RegularExpressions;

4. Change the namespace to Ektron.Cms.Extensibility.Commerce.Samples, rename your class to CustomPasswordProvider, and inherit from the Ektron.Cms.Commerce.PasswordValidation.Provider.PasswordValidationProvider class and the Ektron.Cms.Commerce.IPasswordValidation interface.

   namespace Ektron.Cms.Extensibility.Commerce.Samples
   { public class CustomPasswordProvider : 
     Ektron.Cms.Commerce.PasswordValidation.Provider.PasswordValidationProvider, 
     Ektron.Cms.Commerce.IPasswordValidation

5. Add the following constructor.

   #region constructor, member variables
   public CustomPasswordProvider() { }
   #endregion

6. Add GetRegexFor methods required by the PasswordValidationProvider base class. These methods return the RegExregular expression; an alias that creates a pattern. For example, blogs.aspx?blogmonth=3&blogyear=2012&blogid=41 can be a RegEx blogs/2012/03/41. From that, a site visitor can infer blogs/2012/03/40 to see the previous post, or enter blogs/2012/03 to see all March 2012 postss that will validate passwords in Ektron for specific user types.
   • GetRegexForMember—Returns one or more regular expressions used for client side validation of membership users, along with corresponding error messages to be used when client-side validation fails.
   • GetRegexForAuthor—Returns one or more regular expressions used for client side validation of Ektron authors, along with corresponding error messages to be used when client-side validation fails.
   • GetRegexForCommerceAdmin—Returns one or more regular expressions used for client-side validation of eCommerce administrators, along with corresponding error messages to be used when client side validation fails.
   • GetRegexForAdmin—Returns one or more regular expressions used for client-side validation of Ektron administrators, along with corresponding error messages to be used when client side validation fails.

   NOTE: This example enforces a minimal requirement for authors/members, and adds a length and diversity requirement for administrators.

   #region public methods
   public override string GetRegexForAdmin()
   { return "[/.{7}/, Password must contain at least seven characters]
       " + ",[/[0-9]+/, 
     Password must contain at least one number]
       " + ",[/[a-zA-Z]+/, 
     Password must contain at least one alphabetical character]
       " + ",[/^[^ \t'\"%#]+$/, 
     Password cannot contain spaces, tabs, single-quotes, 
       double-quotes, percent-signs, or pound-signs]";
   }
   public override string GetRegexForAuthor()
   { return "[/.{1}/, Password too short]" + ",[/^[^ \t'\"%#]+$/, 
     Password cannot contain spaces, tabs, single-quotes, 
       double-quotes, percent-signs, or pound-signs]";
   }
   public override string GetRegexForCommerceAdmin()
   { return "[/.{1}/, Password too short]" + ",[/^[^ \t'\"%#]+$/,
     Password cannot contain spaces, tabs, single-quotes, 
       double-quotes, percent-signs, or pound-signs]";
   }
   public override string GetRegexForMember()
   { return "[/.{1}/, Password too short]" + ",[/^[^ \t'\"%#]+$/,
     Password cannot contain spaces, tabs, single-quotes,
       double-quotes, percent-signs, or pound-signs]";
   }
   #endregion

7. Implement the ValidateFor methods, which use the regexs to validate passwords. We use the generic function Validate to which we pass parameters.

   public override ValidationResults 
     ValidateForAdmin(string password)
     { return Validate(password, GetRegexForAdmin());
     }
   public override ValidationResults 
     ValidateForAuthor(string password)
     { return Validate(password, GetRegexForAuthor());
     }
   public override ValidationResults 
     ValidateForCommerceAdmin(string password)
     { return Validate(password, GetRegexForCommerceAdmin());
     }
   public override ValidationResults 
     ValidateForMember(string password)
     { return Validate(password, GetRegexForMember());
     }
   protected ValidationResults 
     Validate(string password, string regexErrorMessage)
     { ValidationResults results = new ValidationResults(); 
       string regex, errorMessage; 
       string[] parts; 
       string[] raw = regexErrorMessage.TrimStart('[').TrimEnd(']')
         .Split(new string[] { "],[" }, StringSplitOptions.None); 
       foreach (string combined in raw) 
       { parts = combined.Split(new string[] { "/," }, 
           StringSplitOptions.None); 
         regex = parts[0].Trim('/'); 
         errorMessage = parts[1].Trim().TrimStart('"').TrimEnd('"'); 
         if (!Regex.IsMatch(password, regex)) 
         { results.AddResult(new ValidationResult(errorMessage, 
           this, "", "", null)); 
         } 
        } 
     return results;
     }

8. Tell the system whether to enforce password expiration on users. There are 2 requirements.
   • PasswordExpirationEnabled—Enabled password expiration globally, which allows the RequiresPasswordExpiration to be called.
   • RequiresPasswordExpiration—Returns whether password expiration is enforced for a user.

   NOTE: The system handles password expiration dates. Setting PasswordExpirationEnabled and RequiresPasswordExpiration tells Ektron to check and enforce those values.

   NOTE: When compliance mode is on, password validation cannot be disabled.

   public override bool PasswordExpirationEnabled()
   { return RequestInformation.CommerceSettings.ComplianceMode;
   }
   public override bool RequiresPasswordExpiration(long userId)
   { return (userId == 1);
   }

9. Build the project, and copy the assembly to the Ektron site's bin directory.
10. Register the provider, and direct Ektron to use it. The siteroot/web.config file lets you manage password providers within Ektron.
    • Locate the passwordValidationProvider section in the web.config file.
    • Add a reference to the class created earlier in the <providers> key.
    • Change the defaultProvider attribute, as shown below.

    <passwordValidationProvider 
      defaultProvider="CustomPasswordProvider">
    <providers>
      <add name="CustomPasswordProvider" 
        type="Ektron.Cms.Extensibility.Commerce.Samples
          .CustomPasswordProvider, CustomPasswordProvider" />
    </providers>
    </shipmentProvider>

Logging in through Facebook

Facebook Login, an alternative to Ektron's standard login, lets users log in using their Facebook username and password instead of creating an Ektron username and password. Here is an example of Facebook Login control.

This control lets Membership and Ektron users log into an Ektron website. If users have an Ektron user profile, they can be prompted to link the Facebook username and password with that profile.

Facebook Login allows log in only—it provides no other Facebook features, such as viewing profiles or sending messages.

NOTE: The Facebook Login feature does not support Active Directory.

The OnTrek starter site includes a samples of a Facebook Login.

NOTE: The user experience is enabled only after a developer sets up the feature. See Also: Setting Up Facebook Login

If a user clicks a Facebook Login button but is not logged into Facebook, the following screen appears.

When you complete this screen or if you are already logged into Facebook, you are forwarded to a page that prompts you to register with or log into Ektron.

This screen asks if you have a membership account. If so, do you want to connect this Facebook username and password with the Ektron account? If you agree, you will access your membership account via the Facebook Login with Facebook credentials from now on. If you do not have a membership account, complete the lower half of the screen. This is the same screen that new members use to create Ektron accounts. From then on, you can click the Facebook Login button to log into Ektron using a Facebook username and password.

When you log out of Ektron, that action does not log you out of Facebook. Conversely, if a user logs out of Facebook, you are not logged out of Ektron.

NOTE: Facebook often caches information in your browser. If you see JavaScript errors or other odd behavior, clear the browser cache, close all browser windows, and try again.

Setting up Facebook login

Setting Up Facebook Login

To set up the Facebook Login feature:

Step 1: Connect Facebook to Your Ektron Website

Follow these steps to obtain Facebook keys, paste them into the web.config file, and identify your site to Facebook.

1. In you do not have one, create a Facebook account. Go to www.facebook.com and follow the sign up instructions.
2. Sign in to the Facebook Developer site.
3. Click +Create New App.
4. Enter an App Name and APP Namespace for your application. The name cannot include facebook or any variations, such as FB. Click Continue. A new screen appears, showing your App ID and AppSecret.
   

   

5. Open your website's root folder/web.config file.
6. Copy the Facebook keys into these web.config elements.
   • APP ID—ek_FacebookApiKey
   • App Secret—ek_FacebookSecret

   NOTE: Keys shipped in Ektron sample sites are for localhost. Also, make sure the Facebook keys were generated for the host header/URL to which you're applying them. And, if you are testing secure site setup, verify that the web.config element ek_useSSL is true.

7. Save and close web.config.

   NOTE: After you update web.config with Facebook keys, wait a few minutes before logging into the Ektron site via the Facebook Login server control.

8. Return to the Facebook Basic screen.
9. Under Select how your app integrates with Facebook, click Website.
10. In the Site URL field, enter your website's URL.
    • for a public site, enter its URL. For example, http://www.example.com.
    • for a shared server or if you are accessing the site from a remote machine, use the IP address. As examples, http://192.168.14.10, http://192.168.14.10/QA
    • for a local server, use localhost. As examples, http://localhost, http://localhost/EktronTech
11. Save and close the Facebook screen.
12. After setting up your application, you can return to this screen at any time to view the keys, edit the Site URL, etc.

Step 2: Create or Modify a Facebook Login/Signup Page

A Facebook form appears if a user clicks a Facebook Login button and is not currently logged into Facebook.

The form is created by Facebook, not Ektron. You can customize parts of it, such as the title and site image, using Facebook's Application settings.

When the user completes the form, the user is forwarded to an Ektron form that prompts the person to register or log in to Ektron.

You specify which form appears via the Facebook Login server control's SignupTemplate property.

The logic to connect a Facebook user with an Ektron account (circled) is not part of the Facebook Login server control. However, sample code for that functionality is included in the Ektron Tech sample site's register.aspx page.

Alternative to Redirecting to the Signup Form

If you do not want to redirect the user to a signup form after Facebook login, you can hook the Ektron_FacebookNewMemberLoggedIn JavaScript event and do whatever you want with it. For example, you could raise a modal dialog with a short signup form. .

Step 3: Place the Facebook Login Server Control on a Page

1. In Visual Studio, open the template onto which you want to place a Facebook Login server control. See Also: Working with Ektron Server Controls
2. Drag and drop the control.
3. Use the following information to complete its properties.
   Facebook Login server control properties

   The following are Ektron-specific server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. properties. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

   • Authenticated (String)

     Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

   • FacebookButtonText (String)

     Enter the Facebook Login button text. The default is Connect with Facebook.

   • Hide (Boolean)

     Hides or displays the output of the control in design time and run time.

     • True—Hide the control output.
     • False—Display the control output.
   • InstructionDetail (String)

     Enter additional text that appears above the Facebook Login button. The default is Sign in using your Facebook account.

   • InstructionHeader (String)

     Enter text that appears above the Facebook Login button. The default is Sign in using your Facebook account.

   • Language

     Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).

   • SignupTemplate (String)

     Enter the path to the template that appears after a user completes the Connect with Facebook screen.

You can customize the markup for the form using the LoginTemplate and LogoutTemplate server controls.

Using Facebook connect extension with the Targeted Content widget

Using Facebook Connect Extension with the Targeted Content Widget

Facebook Login lets you retrieve the following Facebook profile information, using Facebook Connect Extension.

• Age
• Gender
• Marital Status
• Likes
• Employment

See Also: Using Widgets

General Tab

• Version—This number shows the Ektron version and build numbers. This number is important to know if you place a call to Ektron Support.
• License Key(s)—Enter the license key sent to you from Ektron.
• Module Licenses—Enter the license key for WebImageFX that was sent to you via email.
• Default Application Language—Select a default language for Ektron. This user’s language determines the screens and messages that appear in Ektron. In the user profile, you can set any user’s language to system default. Each user set to system default uses the language assigned here.

  NOTE: Do not confuse the default application language with the ek_ DefaultContentLanguage variable in web.config. For more information on that, see Working with Multi-Language Content.

• System E-mail Address—Enter a valid email address. This address will appear in the From field in the notification emails. See Also: Installing Ektron
• Server Type: Staging Server—Check this box if you want your library links to refer to the staging server domain, as opposed to the production server domain. This would help you verify that the linked items exist on the staging server. See Also: Automatic Multi-Site Setup

  NOTE: Checking this box disables the Web Alerts feature on your server.

• Asynchronous Processor Location—If your site uses the Web Alerts feature, enter or update the location of the asynchronous processor Web Services file. The default location is “[none specified].” See Also: Setting Up Message Queuing and the Asynchronous Processor
• Enable Office documents to be published in other format—Check the box to allow Ektron to render Office documents in PDF format. When a checked, PDF generation is available for individual folders.See Also: Working with Assets in the Document Management System
• Enable CMS to create file system folders for library assets—Check the box if you want to create physical folders on your file system server that match the Ektron library folder tree. See Also: Creating File System Folders with Ektron
• Builtin User—Edit the username and/or password for the built in user. By default, the username and password combination is builtin/builtin.

  WARNING! Ektron strongly urges you to change the default password assigned to the builtin user. Opportunities to do this are presented during installation and in the above field.

Editor Tab

IMPORTANT: Editor tab settings apply only to the eWebEdit400 editor.

• Preserve MS-Word Styles—When Microsoft Word content is pasted into the editor, it removes some Word styles by default. Check this box if you want to prevent the editor from removing them.

  NOTE: Ektron does not recommend enabling this feature.

• Preserve MS-Word Classes—Similar to styles, when Microsoft Word content is pasted into the editor, it removes some Word classes by default. Check this box if you want to prevent the editor from removing them.
• Enable Font Buttons—Checking this option displays the following font-related buttons on the editor toolbar:
  • Font Face
  • Font Size
  • Font Color
  • Font Background Color
• Accessibility/Section 508 Evaluation—If your editor is eWebEdit400:

Workarea Tab

The following fields change the default Web page after sign-in and the default Workarea page. The default values are automatically applied to all new users, and to all existing users when you upgrade. Normally, you can modify these values for any user via the Edit User screen. But, you can force these values on all users, removing the ability to personalize them.

• Landing Page After Login—If you want one page in your website to appear after users sign in, enter the URL to that page. You can click Select Page to browse to the landing page. The last published version of the page appears. If the page has never been published, nothing appears. By default, the page from which the user logged in reappears.

  IMPORTANT: If you are logging in from the OnTrek sample site, this field is ignored. OnTrek has its own landing page after login, regardless of this setting.

• Set Smart Desktop as Start Location in the Workarea—If you want the Smart Desktop to appear as soon as a user enters the Workarea, click this box. By default, the user sees the Smart Desktop after sign in. If you leave this box blank, when a user enters the Workarea, the folder of the content specified in the user profile at the Landing Page after login field is displayed.
• Force Preferences to all users—To force these settings on all Ektron users, check this box. If you do, users can see the values in the user profile screen but not change them. If you leave this box blank, users can personalize these values in their User Profile.
• Enable Verify Email—Check this box if users should be notified whenever they subscribe to an email notification list. See Also: What Happens if Verification email is Used

  IMPORTANT: When using the Checkout Server Control on an eCommerce site, the Enable setting must be unchecked. Otherwise, new users will receive an error message when they sign-up using this control. See Also: Checkout

• Enable PreApproval Group—Use this field to enable Automatic Task Creation. See Also: Setting Up an Automatic Task for Pre-approving Content

System Tab

Use this button to clear Ektron's cache, which recycles the application pool. For example, you updated the web.config file but cannot yet see the changes.

Under certain circumstances, Ektron's support group may instruct you to click this button.

Administrators would use this button if they cannot access the hosting servers yet need to reset their website. The button is an alternative to submitting a request to their IT department or hosting company.

Impact on Ektron

After you click Restart, the first request takes longer than usual since the application needs to recompile. Subsequent requests should be processed normally.

To minimize the impact on site visitors, visit your home page immediately after the restart, so that your request is the first "hit."

See Also: Managing Application Pools in IIS 7

Creating File System Folders with Ektron

If this option is enabled, each time you create a new content or library folder in Ektron, a corresponding physical folder is created on the file system to organize library files on your file server. The following image shows a library folder tree and its corresponding system folder structure.

NOTE: If you are upgrading, the installation does not create sample website folders on the file server. You must add these folders manually. However, all folders that you create are also created on the file server when enabled.