Web Components

The Web Components screen enables you to install the following Web Components:

  • Business Administrator — Installs the Business Administrator component. You can log on to Business Administrator using any computer over the network if the computer has Microsoft Internet Explorer 11.0 or later installed on it. You can create aliases, users, and teams, specify their roles, create rules, and use other administration features of CampusNexus CRM.

  • Media — Installs the files required for chat or any media integrated with CampusNexus. It creates a virtual root on the selected server for the Chat module.

  • Scripting — Installs a presentation tool that you can use to create a sequence of Frequently Asked Questions (FAQs) and their answers that help agents provide solutions to customers in a call center. It ensures standardization of responses and enables call centers to draw on the experience of their best agents.

  • WebTrak — Installs files required for the WebTrak feature and creates a virtual root for WebTrak on the selected server. It provides a Web page on the server that contains the WebTrak code snippet. It also tracks visitors to your corporate site and helps you start a chat session with visitors.

  • Calendar — Installs the services that are used to create and publish a calendar feed for the user, so that users can view their published calendar events on their own third party calendar.

  • Transmit Tracker — Installs a web Application Programming Interface (API) component that enables you to do the following:

    • Track the number of times a campaign URL was accessed by targets.
    • Determine the date and time when a recipient last accessed an email.
    • Include the Unsubscribe option in campaign mailer templates that provides mailer recipients with the option to unsubscribe from a campaign mailer.

    If a URL tracking enabled template is used on a campaign mailer, all hyperlinks on the generated emails sent to targets are tracked when clicked. The data collected by Transmit Tracker is written to a database.

  • Staff Authentication Service — Installs the security web service that is used to authorize and authenticate Staff and Admin users to log in to CampusNexus CRM.

  • Forms Builder Contact STS — Installs the security web service that is used by Contact/Lead users to log in to Forms Builder Renderer.

  • CoBrowse — Installs the service that enables the CampusNexus CRM user or the visitor to initiate a co-browsing session. The Node.js installer is a prerequisite for the Cobrowse feature. It is available in Prerequisites.rar.

All Web Components can be installed by running a single setup program.

Web Components can be configured to work in multiple languages simultaneously. For a list of supported languages, and details on language options, see the “Managing Language Options” in CampusNexus CRM Business Administrator Help.

Prerequisites

Identify and install the prerequisite software. See Software Requirements by Component — Web Components.

Set Up Web Components

  1. In the Installation menu, click Web Components. The Web Component Settings screen is displayed.  Closed

    Web Components Settings

    Note: Ensure that the Database settings and Application Server settings are appropriate. Installation Manager allows multiple machine names listed in the Machine Name column.

  2. Click Add to add a line to the Settings screen.

  3. Select an appropriate Action. The following Action values are available:

    • None – Performs no action.

    • Install – Performs a fresh installation or upgrade of a component. You can install or upgrade multiple components at same time.

    • Uninstall – Removes all subcomponents on that machine and uninstalls the component from Programs and Features.

    • Reinstall – Retries to install a subcomponent.

    • Add – Installs an additional component on the computer where one or more components already exist. You can add only one component at a time.

    • Remove – Uninstalls a single component. You can remove only one component at a time.

      Note: The Add and Remove options are not applicable to Calendar and TransmitTracker.

    Optional: Click Select All to set the Action field to Install for all components listed on this screen. Click Unselect All to set the Action field to None.

  4. Enter the Machine Name for the component to be installed.

  5. Select the Web Component to associate with the machine in the Machine Name field. More than one machine can be associated with the same Web Component. The following Web Components are available:

    • BusinessAdministrator
    • Media
    • Scripting
    • WebTrak
    • Calendar
    • TransmitTracker
    • StaffAuthenticationService
    • FormsBuilderContactSTS
    • CoBrowse

  6. Click copy icon to copy a line. Edit the copied line as needed.

    Copy as many lines as needed to create the Web Components required for the installation.

  7. Click Options (ellipsis) icon to view and edit the Options form for each Web Component. Depending on the selected Web Component, the Options form contains the fields listed below or a subset of those fields.

      Business Administrator Options  Media Options Form  Scripting Options Form  WebTrak Options  Calendar Options  Transmit Tracker Options  Staff STS Options  Forms Builder Contact STS Options  CoBrowse Option

    Options Fields for Web Components
    Field Description
    Business Administrator Options
    IIS Virtual Root Name of the Virtual Root for the Web Component.
    Host Name Specify the Host Name for the Web Component.
    Application Server Select an Application Server set up in the App Servers screen.
    Main Database Select a Main Database set up in the Databases Screen.
    Scripting Options, WebTrak Options, and Calendar Options
    IIS Virtual Root Name of the Virtual Root for the Web Component.
    Application Server Select an Application Server set up in the App Servers screen.
    Main Database Select a Main Database set up in the Databases Screen.
    Media Options
    Media Virtual Root Name of the Virtual Root for the Media Web Component (default: Media).
    Media Upload Virtual Root Upload name for content going to the Virtual Root for the Web Component (default: MediaUpload).
    Application Server Select an Application Server set up in the APP Servers screen.
    Main Database Select a Main Database set up in the Databases Screen.
    Media Directory Directory where the Media Components are stored (default: Program Files\Common Files\Media).
    Media Upload Directory Path where this Web Component is uploaded (default: Program Files\Common Files\MediaUpload).
    Transmit Tracker Options
    Port Port number used by Transmit Tracker.
    Transmit Service Server Select a Transmit Service Serve set up in the Services screen.
    Main Database Select a Main Database set up in the Databases Screen.
    Staff Authentication Service Options
    Hostname This is an optional field. When selected, the web.config file of the Web Components for CampusNexus CRM will be updated with the custom host URL.

    If this field is left blank, the URL in the config files will be
    http(s)://machinename.domain.com:port

    Enter a hostname if you want to assign a hostname (DNS name) in IIS. If you specify a hostname, clients must use the hostname instead of the machine name or IP address to access the web site. This feature is often used when a TCP Port must be shared.
    Port Port number used by the Staff Authentication Service.
    Use HTTPS Select this check box if you want the Staff Authentication Service to be accessed through HTTPS. When this option is selected, the Certificate Thumbprint field is enabled.
    Certificate Thumbprint Certificate thumbprint from IIS.

    The same certificate thumbprint that is used on the Staff STS must be used here. Copy and paste the thumbprint from the Staff STS into this field, or click Browse to navigate to the IIS Server Certificates to select the thumbprint. The thumbprint is added to the Designer web.config file. Closed

    1. Open Internet Information Services (IIS) Manager and choose the certificate to be used from Server Certificates.

      IIS Manager

    2. Double-click to open the certificate properties.

      Server Certificates

    3. Select Root level and in the Details tab, click the Copy to File… button.

    4. Click Next. Select No, do not export the private key and click Next.

    5. Select DER encoded binary X.509 (.CER) and click Next.

    6. Specify a file path and name (root) to export to and click Next.

    7. Click Finish
    Main Database Select a Main Database set up in the Databases Screen.
    Forms Builder Contact STS Options
    Main Database Select a Main Database set up in the Databases Screen.
    Certificate Thumbprint Certificate thumbprint from IIS.

    The same certificate thumbprint that is used on the Staff STS must be used here. Copy and paste the thumbprint from the Staff STS into this field, or click Browse to navigate to the IIS Server Certificates to select the thumbprint. The thumbprint is added to the Designer web.config file. Closed

    1. Open Internet Information Services (IIS) Manager and choose the certificate to be used from Server Certificates.

      IIS Manager

    2. Double-click to open the certificate properties.

      Server Certificates

    3. Select Root level and in the Details tab, click the Copy to File… button.

    4. Click Next. Select No, do not export the private key and click Next.

    5. Select DER encoded binary X.509 (.CER) and click Next.

    6. Specify a file path and name (root) to export to and click Next.

    7. Click Finish
    CoBrowse Options
    Protocol Select HTTP or HTTPS protocol. The Port, Service Name, and Install Directory must be specified for HTTP. All fields are mandatory for HTTPS.

    Note: If CoBrowse was installed with HTTP protocol and you want to install CoBrowse with HTTPS on the same machine, uninstall CoBrowse and install CoBrowse with HTTPS option.
    Port Specify the port for the CoBrowse service. The recommended port is 8086.
    Service Name Specify the Service Name or accept the default: CoBrowseService
    Install Directory Specify the install directory or accept the default: C:\CoBrowse
    Certificate Path Provide the full .pfx file path. The file format must be .pfx.
    Click Browse to navigate to the certificate.
    Password Specify the password for the certificate pfx file.
    Click Test to verify access to the certificate.

  8. Click OK to save changes on the Options form. The form is closed.

  9. Click Test to ensure the setup for the corresponding line is correct. If a test on a particular line fails, check all associated fields and click Test again.

  10. Click Delete icon to delete a selected line.

  11. If all tests pass, click right arrows.

     

Postinstallation Tasks

In the right pane of IIS Manager, double-click ISAPI and CGI Restrictions and ensure that the Allowed option is enabled for all the Web Service Extensions.

The following are the postinstallation steps for Web Components installed on a Windows Server computer:

Note: Ensure that the Business Administrator URL is configured with the prefix https, and the value https is set in the Type field in the Edit Site Binding dialog.

  1. Configure the following settings for the DefaultAppPool Application Pool. To do so:

    1. Open the Internet Information Services (IIS) Manager in one of the following ways:

      Go to Start, Run. Type inetmgr.

      — OR —

      Type inetmgr in the Search box of the Start menu.

    2. Click ENTER.

    3. Navigate to the <Server Name>, Application Pool node. The Application Pools screen is displayed.

    4. In the Application Pools screen, right-click the DefaultAppPool Application Pool, and select Basic Settings.

      The Edit Application Pool dialog box is displayed.

    5. Set the value of the fields in the Edit Application Pool dialog box as follows:

      • Set the value of the .Net Framework Version field to .Net Framework v4.0.30319.

      • Set the value of the Managed Pipeline Mode field to Classic.

    6. In the Application Pools screen, right-click the DefaultAppPool Application Pool, and select Advanced Settings. The Advanced Settings dialog box is displayed.

    7. In the Process Model section, set the value of the Identity field as Local System.

  2. In IIS ensure that the Business Administration Virtual Directory is running under domain user account. To do so:

    1. Open Internet Information Services (IIS) Manager in one of the following ways:

      Go to Start, Run, and type inetmgr.

      — OR —

      Type inetmgr in the Search box of the Start menu.

    2. Go to <computer name>/Sites/Default Web Site/BusinessAdministrator virtual directory. The areas and corresponding applications are displayed in the right pane.

    3. Click Basic Settings in Actions pane (right pane). The Edit Application screen is displayed.

    4. Click Test Settings.

    5. If Test Setting Authorization fails, provide domain user credentials by clicking Connect as in the Edit Application dialog box.

    If the Website does not display the page, perform the following steps:

    1. Open Internet Information Services (IIS) Manager in one of the following ways:

      Go to Start, Run, and type inetmgr.

      — OR —

      Type inetmgr in the Search box of the Start menu.

    2. Go to <computer name>/Sites/Default Web Site/BusinessAdministrator virtual directory. The areas and corresponding applications are displayed in the right pane.

    3. In the IIS area, right-click the ASP icon and select Open Feature. The Features View of ASP is displayed.

    4. In the Behavior section, set the Enable Parent Paths options to True.

  3. When Application Server and Business Administrator are installed on different computers, you must perform the following steps on IIS.

    • Perform the following steps for the Classic .NET AppPool option on the Web Components computer:

      1. Open the Internet Information Services Manager.

      2. In the Connections pane, expand the server node and click Application Pools. The Application Pools page is displayed.

      3. Select Classic .NET AppPool, and click Advanced Settings.

      4. For the Identity property, click ellipsis button. The Application Pool Identity dialog box is displayed.

      5. In the Built-in Account option, ensure that LocalSystem is selected.

      6. Click through OK twice.

    • Perform the following steps for the DefaultAppPool option on the Web Components computer:

      1. Open the Internet Information Services Manager.

      2. In the Connections pane, expand the Server node, and click Application Pools. The Application Pools page is displayed.

      3. For the Identity Property, click ellipsis button. The Application Pool Identity dialog box is displayed.

      4. Select the Custom account option and click Set. The Set Credentials dialog box is displayed.

      5. Specify User name and Password details of a CampusNexus CRM user who has domain administration permissions on the computer.

      6. Click through OK three times.

         

  1. Ensure that the user name and password of an administrator user is specified for the TLChatWinService.exe.config service. To do so:

    1. Open the Services screen by typing services.msc in the Run dialog box and locate the TLChatWinService.exe.config service.

    2. Right-click and select Properties from the shortcut menu.

    3. Select the Log On tab and select the This account option.

    4. Provide the user name and password of an administrator user.

    5. Click OK.

  2. Update the TLChatWinService.exe.config file. To do so:

    1. On the computer where the Chat windows service is installed, navigate to the following path: <Drive name>:\ChatService.

    2. Open the TLChatWinService.exe.config file in an edit mode.

    3. Update the <bindings> tag.

      Three binding types, HTTP, HTTPS and TCP are supported. Ensure that the tag related to the binding type used by Chat is uncommented. For example, if the binding type used by Chat is:

      • HTTP, then uncomment the <basichttpbinding> tag.
      • HTTPS, then uncomment the <basichttpsbinding> tag
      • TCP, then uncomment the <Nnettcpbinding> tag

      Comment or remove the binding type which is not applicable.

    4. Update the <endpoint address> tag.

      The hostname and the port number of the computer where Web Components are installed is updated automatically in the <endpoint address> tag. The default port number is 80. If you are using a different port number, change the value accordingly. Comment or remove the <endpoint address> tag which is not applicable.

    5. Update the <baseAddresses> tag.

      The hostname and the port number of the computer where Web Components is installed is updated automatically in the <add baseAddress> tag. The default port number is 80. If you are using a different port number, change the value accordingly. Comment or remove the <add baseAddress> tag which is not applicable.

    6. Set the Identity credentials and then restart Application Server.

    7. In the Run dialog box, type EventVwr and press ENTER.

    8. In the Windows Logs, Application node, ensure that only one event with the entry “Service started successfully." is available for TLChatWinService. If other errors are found, resolve the issue and restart service.

      Note: Ensure that the port that is used for Chat connections is free and not used by any other process.

  3. If you are using the TreatCode.js file, perform the following steps:

    1. Open the TreatCode.js file in edit mode.

      Note:

      A sample TreatCode.js file is available in the following path:

      For desktop and laptop devices: \Samples\Web\WebTrak\Desktop

      For mobile devices: \Samples\Web\WebTrak\Mobile

    2. Locate the following lines:

      var sChatURL = "http://<Chat Server>/Media";
      var sTrackURL = "http://<Chat Server>/Webtrak";

    3. Replace the variable <Chat Server> with the hostname or IP address of the computer where Web Components are installed.

    4. Save the TreatCode.js file.

      Note: If the WebTrak server and Chat server are installed on different computers, the value of the sTrackURL must include the hostname or IP address of the computer where WebTrak is installed.

  4. On the computer where Web Components are installed, specify the domain names of the web pages from where Chat is initiated in the Web.Config file that is available in the <Drive name>:\Program Files\Talisma Web Components\Media path. To do so:

    1. Open the Web.Config file in edit mode.

    2. Locate the following tag: <add key="HostDomains" value=""/>

    3. Specify the domain names of the web pages from where Chat is initiated.

      For example, if www.talisma.in/chat.htm and www.talisma.com/initiatechat.htm are the web pages that are configured for initiating Chat, in the Web.Config file of the Media Web Component, specify the value as follows:

      <add key="HostDomains" value="www.talisma.in, www.talisma.com"/>

  5. If Media and WebTrak applications are installed on different computers belonging to the same domain, you must specify the common domain name in the Web.Config file that is available in the <Drive name>:\Program Files\Talisma Web Components\WebTrak path on the computer where Web Components are installed. To do so:

    1. Open the Web.Config file in edit mode.

    2. Locate the following tag: <add key="HostDomains" value=""/>

    3. Specify the common domain name suffix of the computers where WebTrak applications are installed and domain name of the web pages from where Chat is initiated.

      For example, if the Media application is installed on media.talisma.com, and the WebTrak application is installed on webtrak.talisma.com, in the Web.Config file of the WebTrak Web Component specify the value as follows:

      <add key="HostDomains" value="talisma.com"/>

  6. Specify the required Team Routing Rules and User Assignment Rules. This step is optional. If Team Routing Rules and User Assignment Rules are not configured, the Chat requests will be routed to the Home Team.

  7. To ensure that Chat traces are captured for all processes, perform the following steps:

    • Configure the following settings for the DefaultAppPool Application Pool. As a best practice, a separate application pool must be created instead of using the default application pool.

      1. Open the Internet Information Services (IIS) Manager in one of the following ways:

        Go to Start, Run. Type inetmgr.

        — OR —

        Type inetmgr in the Search box of the Start menu. The Internet Information Services (IIS) Manager screen is displayed.

      2. Navigate to the <Server Name>, Application Pool node. The Application Pools pane is displayed.

      3. In the Application Pools pane, right-click the DefaultAppPool Application Pool, and select Advanced Settings. The Advanced Settings dialog box is displayed.

      4. In the Process Model section, set the value in the Identity field.

      5. Navigate to the Process Model area and click the ellipsis in the Identity field. The Application Pool Identity dialog box is displayed.

      6. Select the Custom account option and click Set.

      7. In the Set Credentials dialog box, specify the domain user account details.

      8. Click OK twice.

    • Configure the following settings for the Media Site:

      1. In the Internet Information Services (IIS) Manager screen, navigate to the <Server Name>, Sites, Default Web Site, Media node.

      2. In the right pane, select Basic settings from the Actions area. The Edit Application dialog box is displayed.

      3. Click Connect as. The Connect as dialog box is displayed.

      4. Select the Specific user option and click Set. The Set Credential dialog box is displayed.

      5. Specify user name, and password details of the user that is specified in step (g).

      6. Click OK three times.

    • Enable trace for Chat. To do so:

      1. Log on to Trace Client.

      2. Select Chat server from the Process list.

  8. Before initiating a chat request ensure the following:

    1. Log on to SQL Server Management Studio.

    2. Ensure that the database replication is working fine. Else, drop the replication and reconfigure it.

    3. In the Object Explorer, right-click the Server name and select Facets.

    4. In the View Facets screen, select Surface Area Configuration from the Facets field.

    5. Ensure that the value for the following options is set to True:

      • OleAutomationEnabled
      • XpCmdShellEnabled

    6. The correct URL is provided in Business Administration.

    7. The TLChatWinService.exe.config service is running.

 

Ensure that the Port number you specify for the Transmit Tracker (web service) is not used by any other service.

If required, you can change the Port value in the web.config file. An extract of the file is illustrated here:

<client>
<endpoint binding="basicHttpBinding" bindingConfiguration="BasicHttpBinding_ITrackableService" contract="TrackableService.ITrackableService" name="BasicHttpBinding_ITrackableService" address="http://CLTTRCK:8082/Cmc.NexusCrm.Common.Services/TrackableService/"/>
</client>

 

Perform the following steps If Transmit Tracker and Chat are using <basichttps> binding:

  1. At the command prompt, navigate to the path c:\windows\system32.

  2. Run the following command:

    netsh http add sslcert ipport=0.0.0.0:<port number> certhash=<thumb print of the certificate> appid=<unique GUID> clientcertnegotiation=enable

    Replace the following values:

    • <port number> - the unique port number that you specified when you updated the endpoint address tag.

    • <thumb print of the certificate>

    • <unique GUID> - To generate this value:

      1. In the Start menu, type Windows Powershell.

      2. Type the following command:

        [guid]::newguid()

        Ensure that you copy the generated value including the curly braces.

 

For information about configuring the CoBrowse feature, see CampusNexus CRM Web Client Help.