Web Client

The Web Client component supports browser-based access allowing agents to access critical CampusNexus CRM functions through the Internet from anywhere in the world.

Prerequisites

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

  • Before installing the Web Client for CampusNexus CRM, uninstall previous versions of Web Client.

  • The Web Client for CampusNexus CRM version 11.0 or later requires the Staff STS component to be installed. Go to the Start screen and select Package Manager. Download the Staff STS package and install it. For more details, see Staff STS.

    As a result of the installation, the following appSettings are added to the web.config of the web service.

    <appSettings>
<add key="ServerConfig" value="<server>/<MainDB>" />
<add key="UserName" value="<UserName>" />
<add key="CoreLogging" value="1" />
</appSettings>

    The Staff STS uses this new web service to authorize and authenticate CampusNexus CRM Web Client Staff logins.

    <SecurityServiceCollection>
<add name="<name>" address="<URL>" enabled="false" />
<add name="CRM" address="http://StaffSTSServiceServer/<VirtualDirectoryName>/ Security/SecurityService.svc" />
</SecurityServiceCollection>

 

Set Up Web Clients

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

    Web Client Settings

    Note:

    • When upgrading or installing CampusNexus CRM, verify all settings and then click OK in the Options dialog.

    • When upgrading with Anthology Student, verify the Student Web Client and Web Client details and then click OK in the Options dialog.

  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 the same time.

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

    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 a Database from the Database list.

  6. Accept the default Destination Directory or select a directory where the information for this component is stored. Changing this directory will apply across all machines in the Machine Name column.

  7. The Attachment Path field is optional if the Web Client Setting screen includes the details for only one web server.

    The field is mandatory if the Web Client Setting screen includes the details for more than one web server. A validation error message will be displayed if the field is mandatory and is left blank.  Closed

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

  9. Click Options (ellipsis) icon to view and edit the Options form.

    CampusNexus CRM Settings Tab

    Used this tab to specify settings for the CRM Web Client, Staff Authentication Service, and Notification Server.    Closed

    If multiple instances of Web Client are installed, they must all be associated with a common instance of Notification Server.

    Web Client Options - CRM Settings tab

    CampusNexus CRM Settings Tab Fields
    Field Description
    Web Client Settings
    URL The Web Client URL is populated with <machine name.domain.com> by default. You can override the default URL with another URL. The specified URL will be updated in the web.config file of the Web Client for CampusNexus CRM and in the CampusNexus CRM database.

    alert If you change the Web Client URL during an upgrade in an environment where Forms Builder is used, the Web Client URL must be manually updated in the web.config files of Forms Builder Designer and Renderer.
    Hostname This is an optional field. When selected, the web.config file of the Web Client 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 website. This feature is often used when a TCP Port must be shared.
    Port Specify the port number of the Web Client for CampusNexus CRM or accept the default (8090).
    Test Click Test to ensure that the Staff STS setup is correct.
    Use HTTPS Select this check box if you want the CRM Web Client to be accessed through HTTPS. When this option is selected, the Certificate Thumbprint field is enabled.
    Certificate Thumbprint Certificate thumbprint from IIS.

    This certificate is required only when HTTPS is selected. It is not added to the web.config file. This certificate is used only for the CRM Web Client.

    Click Browse to navigate to the IIS Server Certificates to select the thumbprint. 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
    Other Services
    Staff Authentication Service Click drop-down icon to view the complete URL.
    Notification Server Click drop-down icon to view the complete URL.
    Staff STS Tab

    Use this tab to specify the Staff STS server, port, hostname (if applicable), and certificate. Staff STS must be installed prior to installing the Web Client for CampusNexus CRM.   Closed

    Web Client Options - Staff STS tab

    Staff STS Tab Fields
    Field Description
    refresh Click the Refresh button to attempt an automatic settings update.
    Staff STS Server Specify the name of the Staff STS Server. The Staff STS Server must have been previously installed. See Staff STS.
    Port Specify the port number of the installed Staff STS server or accept the default (91).
    Staff STS Hostname If you have configured Staff STS to use a custom hostname, fill out the hostname. Example: Staffsts.campusmgmt.com
    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

    Note: Only RSA-based certificates are supported.

    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
    Verify STS Click Verify STS to
    • Verify that the Staff STS is installed.
    • Validate that the certificate is installed in the personal store.
    Azure Settings Tab

    Use this tab to specify the Azure settings for the Web Client.   Closed

    Web Client Options - Azure Settings tab

    Azure Settings Tab Fields
    Field Description
    Configure AAD Select this check box if Azure Active Directory is used for the CampusNexus CRM web client.
    Tenant ID Specify the Azure tenant identifier.
    Client ID Specify the Azure client identifier.
    Client Secret Specify the Azure client secret.

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

  11. Click Delete icon to delete a selected line.

  12. Accept the default Destination Directory or select a directory where the information for this component is stored. Changing this directory will apply across all machines in the Machine Name column.

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

  14. If all tests pass, click right arrows.

 

Postinstallation Tasks

Perform the following postinstallation steps for Web Client:

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

When the Web Client is installed on a Windows 64-bit computer, set the value of the Enable 32-Bit Applications option to False in the Internet Information Service Manager (IIS). To do so:

  1. On the computer where Web Client is installed, open Internet Information Service Manager.

  2. Click Application Pools.

  3. Right-click the Application Pool on which Web Client is running, and select Advanced Settings.

  4. Set the value of the Enable 32-Bit Applications option to False.

  5. Click OK.

If the regional settings of the Web Client computer are not set to a 24-hour format, perform the following steps:

  1. Launch IIS Manager on the Web Client computer.

  2. Navigate to Sites\Default Web Site\cmc.crm.workspaces.

  3. In the right pane, double-click .NET Globalization.

  4. In the Culture list, select a language that supports a 24-hour format (E.g.: English (United Kingdom) (en-GB) or English (United States) (en-US)).

  5. Reset IIS.

If SQL Server is running on the same computer as the Web Client web server and regardless of whether Workflow Composer is configured to work with CampusNexus CRM (From CampusNexus CRM 13.2 and later, Workflow Composer is integrated with CampusNexus CRM by default.):

  1. Add the application pool account to the Main database:

    IIS APPPOOL\appPoolName

    For example:

    IIS APPPOOL\cmc.crm.workspaces

    Postinstall - Workspaces

  2. Make sure to give db_datareader and public access to the Main database.

    db_datareader permissions

 

Configuration Settings

You can set the value of the maxAttachmentSize and RestrictedFileFormat tags in the web.config file. To do so, perform the following steps:

  1. Navigate to <CampusNexus CRM installation folder>\cmc.crm.workspaces.

  2. Open the web.config file.

  3. Add the maxAttachmentSize and RestrictedFileFormat tags and values.

    "maxAttachmentSize" and "RestrictedFileFormat" Tags and Values
    Tag Description
    maxAttachmentSize Enables you to set the maximum limit of the files that can be attached in Web Client.

    For example, if the value of this parameter is set to 2048 kilobytes, a Web Client User can attach single or multiple files totaling to a size of 2 MB.

    By default, the value of this tag is 25 MB.

    Important:

    By default, the maximum allowed IIS (Internet Information Services) limit for file upload on any Website is 28.6 MB.

    If you want to increase the maximum upload limit to a value that is greater than 25 MB, you must first configure your IIS file upload limit to the required value.

    To do this, ensure you specify the appropriate value (in bytes) in the maxAllowedContentLength attribute. A sample code extract is shown here:

    code sample

    After configuring the file upload limit value in IIS, you must configure the maxAttachmentSize
    RestrictedFileFormat      Enables you to specify the file formats that cannot be attached in Web Client. To add a list of file formats that are not supported, add the extension of the file format in this tag. To add multiple file formats, separate the file extensions by the comma delimiter.

    For example: .txt,.jpeg,.gif

    The default value is .exe, .bat, which indicates that files with the .exe and .bat format cannot be attached in Web Client.

  4. Save the web.config file.

  5. You can configure the execution time-out period for the Web Client server in the web.config file of Web Client. The execution time-out period is the elapsed time after which an execution request from the Web Client server is timed out. By default, the execution time-out period is set to 120 seconds.

    To specify a custom value for the execution time-out period, add the following line of code in the web.config file:

    <httpRuntime executionTimeout="<<Time-Out Period>>"/>, where <<Time-Out Period>> is the elapsed time after which an execution request from the Web Client server must be timed out.

    For example, specify: <httpRuntime executionTimeout="360"/>

  6. Save and close the web.config file.