CM2WebShare Admin Guide 6.1.x

Prev Next

ACCESSING THE ADMIN CONSOLE

  1. On the Home Page, click the Admin Tab
    image.png

  2. The Admin page will load
    image.png

Restricted Access

The Administration Console can only be accessed by Content Manager Administrators, Records Managers, or any Admin Whitelisted Users.

GENERAL

General settings for the application will be displayed here.
image.png

IMPORTING AND EXPORTING SETTINGS

image.png

Click the Export Settings button to download a zip file of the current CM2WebShare JSON settings files.

Click the Import Settings button to import CM2WebShare JSON settings files to the application.

DOWNLOAD LOGS

image.png

Click on the Download Logs button to download a zip file containing the CM2WebShare log files.

BASIC WHITELIST

image.png

Input the name of the user to be whitelisted to allow basic rights for accessing CM2WebShare. Click on the Save button to save changes.

ADMIN WHITELIST

image.png

Input the name of the user to be whitelisted to allow administrator rights for accessing CM2WebShare. Click on the Save button to save changes.

Access Rights

Anyone that is labelled in the admin whitelist will have full administrators’ rights within CM2WebShare. This will allow the user access to creating and editing tables and themes and accessing the admin page.

STATISTIC WHITELIST

image.png

Input the name of the user to be whitelisted to allow rights for accessing the statistics page of CM2WebShare. Click on the Save button to save changes.

UPDATING THE CONNECTION DETAILS

image.png

Name Description
Dataset ID The 2-character Content Manager dataset identifier
Workgroup Server Name The name of the Content Manager Workgroup Server used for the dataset connection. Connection to the dataset can be created using either the workgroup server name or URL
Workgroup Server URL The name of the Content Manager Workgroup URL used for the dataset connection. Connection to the dataset can be created using either the workgroup server name or URL
Temp Path Path where temporary files and logs are stored

APPEARANCE

image.png

PRIMARY BACKGROUND COLOUR

Click Pick Colour to select the background colour for the header and footer.
image.png

PRIMARY FONT COLOUR

Click Pick Colour to select the font colour for the header and footer.
image.png

LOGO

To change the Logo, drag and drop the image to the Upload New Logo drop zone.
image.png

Click on the Save button to save the changes.

Image Formatting and File Size

We recommend that the image dimensions and file size are optimised to ensure there are no long load times introduced for excessively large images. Optimal naming conventions for images excludes the use of punctuation and special characters including underscores or dashes.

EMAIL NOTIFICATIONS

image.png

Settings are configured for the generation and sending of emails from CM2WebShare to the nominated users.

Name Description
Mail Host Email server address.
Mail Port The Email server port.
Send From The nominated sender e-mail address
License Expiry A comma separated list of email address who will receive the license expiry e-mail notification.
Statistics A comma separated list of email address who will receive the monthly statistics report showing the monthly usage of CM2WebShare.

LICENSE EXPIRY EMAILS

A license expiry notification will be sent 60, 30, 10, 5, 4, 3, 2 and 1 day(s) before the license expires. The email will be sent to the provided License Expiry Contacts. Multiple contacts can be added by adding ';' after each contact.
image.png

STATISTICS EMAILS

An email will be sent monthly showing the monthly usage of CM2WebShare to the Statistics contacts provided. Multiple contacts can be added by adding ';' after each contact.
image.png

Click the Send Email button to send the statistics email.
image.png

LICENSE

image.png

Displays information about the currently configured license and when it will expire. For detailed instructions on updating a license please see the LICENSE UPDATE GUIDE.

TABLES

The Tables settings maintain general CM2WebShare settings.
image.png

DISPLAY TABLES PER PAGE

image.png

Controls the amount of CM2WebShare tables displayed per page on the home page.

RESTRICTION FIELD

Sets the restriction field used for limiting the search results on the CM2WebShare table based on a Boolean additional field. The field can be enabled for each individual table.

CACHE TABLE DATA

Enables the choice to cache individual CM2WebShare table data to allow for quicker loading of the table. Each table config will have the Cache Table Data option available.

AUTHENTICATION

The Authentication tab allows you to specify the authentication method for CM2WebShare.
image.png

WINDOWS

To enable Windows Authentication:

  1. Set the Type field to None.

  2. Click Save

  3. Navigate to the CM2WebShare application in IIS

  4. Ensure Windows Authentication is the only authentication method enabled for CM2WebShare
    image.png

  5. Perform an app pool restart for CM2WebShare

MICROSOFT OPEN ID AUTHENTICATION

To enable Microsoft Open ID Authentication:

  1. Set the Type field to Microsoft.

  2. Enter the values for all the provided fields. The values can be found in the CM2WebShare OpenID Microsoft Guide

  3. Click Save

  4. Navigate to the CM2WebShare application in IIS

  5. Ensure Anonymous Authentication is the only authentication method enabled for CM2WebShare
    image.png

  6. Perform an app pool restart for CM2WebShare

OKTA OPEN ID AUTHENTICATION

To enable Okta Open ID Authentication:

  1. Set the Type field to Microsoft.

  2. Enter the values for all the provided fields. The values can be found in the CM2WebShare OpenID Okta Guide

  3. Click Save

  4. Navigate to the CM2WebShare application in IIS

  5. Ensure Anonymous Authentication is the only authentication method enabled for CM2WebShare
    image.png

  6. Perform an app pool restart for CM2WebShare