Managing the web.config File

Ektron’s web.config file lets you control many key functions of your content management system. When you install Ektron, web.config is placed into webroot/siteroot.

If your server is currently running another .NET application, you must merge that web.config file with this one. To distinguish Ektron’s tags, they begin with ek_ and reside within the <appSettings> tags of the web.config file.

The following sections show the settings in the web.config file.

Analytics
Connection Strings

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.

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

appsettings

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 eWebEditPro and 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_appeWebPath—The folder that stores eWebEditPro, Ektron’s editor. You would only change this value if you need to move the editor to another location. Note that this value is prefixed by the value set in the ek_appeWebPath variable. By default, ek_appeWebPath is set to webroot/cms400Min/workarea/. So, by default, this folder is set to webroot/cms400Min/workarea/ewebeditpro.
  • ek_appeXSLTPath—The folder that stores XSLTs. 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 LDAP 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 Sending a Private Message from the Social Bar.

  • ek_RedirectorInstalled—Turns the redirector on or off. Turning the redirector on enables the option of aliasing the URL of your Web site. 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.

      WARNING! 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, Saturday May 21, 2005
    • short—for example, 5/21/2005
  • 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: Using the Map Server Control
  • VirtualEarthMap—Enter connection information for using Bing Maps for Enterprise with the Mapping feature in Ektron. See Also: Using the Map Server Control
Images

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
SMPT server configuration

SMTP server configuration

See Configuring SMTP Settings

  • 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

Mail Format

  • ek_MailFormat—The format of the email created in Ektron. A value of HTML generates email in HTML format, while a value of Text generates plain text email.
SSL support

SSL Support

See Configuring SSL

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

Active Directory Server Configuration

See Active Directory

  • 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

Menu Settings

See Working with Menus

  • ek_MenuDisplayType—Determines the appearance of the 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 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: Changing the Appearance of the Web Site Content Menu

Multilingual settings

Multilingual Settings

  • ek_DefaultContentLanguage—Sets the 4 digit, decimal representation of the default content language. For example, American English is 1033. If you have a version of Ektron that precedes than 4.7, all content blocks are set to this value during the upgrade. See Also: Working with Multi-Language Content
  • ek_EnableMultilingual—Enable or disable support for multilingual content
    • 1—enable
    • 0—disable

    See Also: Working with Multi-Language Content

  • ek_ServerURL—Mainly used in Web services to determine the location of a remote server. 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

Miscellaneous Settings

  • ek_assetPath—The folder that stores Assets. 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 amount of files that can be uploaded at the same 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—Choose whether to enable caching for Ektron server controls. See Also: Caching with Server Controls
    • 0—Disable
    • 1—Enable
  • ek_EditControlMac—Defines the editor that is used Macintosh operating system user. This must be ContentDesigner. See Also: Using the Ektron Editor
  • ek_EditControlWin—Select which editor will be used by Microsoft Windows operating system users. 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. See Also: Using the Ektron Editor
  • ek_EnableDeveloperSamples—Enable the API developer samples on the Developer demo site shipped with Ektron.
    • True—enable developer samples
    • False—disable developer samples
  • 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. When a user posts to another user’s message board, the board's owner is notified. When a user posts a message to a community group’s message board, all members of the group are notified. This setting does not affect content messages. See Also: Notifications
  • 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 setting when you download help files and install them on local servers. For more information, see 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_loginAttemptsEktron has a login security feature that, by default, locks out a user after 5 unsuccessful attempts to log in. That feature is controlled by this element. See Also: Restricting Login Attempts
  • ek_LoginScreenWidth—The width of the login screen in pixels. You may need to widen the screen if you are using Active Directory and the 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 text appears near the bottom of the items 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_passwordCaseSensitive—By default, passwords are case insensitive (the setting is False). So for example, if the password is TOKEN and the user enters token, the sign-on is successful. To make passwords case sensitive, change this value to True. If you do, and the password is TOKEN and the user enters token, the sign-on is unsuccessful. See Also: Making Passwords Case Sensitive
  • 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 XLIFF version to use when exporting files. See Also: What is XLIFF?
  • WSPath—Determines the location of the Web services page used by the server controls at design time.
system.diagnostics

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

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: Packages
mediaSettings

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

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 http://www.onlineconversion.com/computer.htm.
  • session state—mode—determines the storage option for session data. Ektron supports all session-state modes listed in this article: http://msdn.microsoft.com/en-us/library/ms178586.aspx.