CM2WebShare User Manual 5.1.22

GETTING STARTED

1. Open a web browser and browse to CM2Webshare
2. This will load the CM2Webshare home page
   

COMPATIBLE BROWSER

Please ensure you are using a compatible browser

• Microsoft Edge
• Google Chrome
• Mozilla Firefox

HOME PAGE NAVIGATION

Within the homepage, each table that is created has a range of features that can be applied. The following features are (in order of appearance):

NAME

A unique name to find a CM2WebShare Table.

DESCRIPTION

An optional detailed description about the CM2Webshare Table.

UPDATED BY

The person who last updated the table.

DATE LAST UPDATED

The date and time which the table was last updated.

ADDITIONAL FEATURES

• Lock Show a table is locked for editing. An unlocked symbol will appear for Administrators and users who are editing the selected table.
• Edit a CM2WebShare Table
• Delete a CM2WebShare Table
• View a CM2WebShare Table
• Copy a CM2WebShare Table URL
• Copy a CM2WebShare Table iFrame Link
• Copy a CM2WebShare Table ePathway Link
• Copy a CM2WebShare Table Index (CSV formatting) Table Index
• Download a CM2WebShare Table CSV file Download

EPATHWAY LINKS

There are three options to select from for CM2WebShare to generate an ePathway link. All links will output the same CM2WebShare table. Formatting on each link is slightly different depending on the requirements needed for ePathway.

SHORT LINKS

Short links will display the Content Manager string query within the URL. These links are great for shorter, simple Content Manager queries.

Short links can also be utilised as templates to create one off rendered CM2WebShare tables, this can be completed by changing out the query in the url. You will be able to keep the same functionality from the table saved (i.e theme, table fields, and table options) but the query can be updated to assist with rendering more tables live without creating a new table in the CM2WebShare config.

LONG LINKS

Long links are similar to short links, but they are best utilized if you want to explicitly change the table's design per link. Long links are most suitable for iframe or intranet site generation due to their long character limit.

DYNAMIC LINKS

Dynamic links are best utilized if you find the short link exceeds the character limit OR you wish to hide the query from the url of the table. Dynamic tables require for a CM2WebShare table configuration to be saved that contains placeholders within the configured Content Manager search string that will be identified by CM2WebShare and populated by the placeholders in the Dynamic Link url.

Placeholders need to be in the format %PLACE_HOLDER% to be identified by CM2WebShare. Placeholders can only be utilized by the Content Manager Search within a CM2WebShare table.

Upon saving this table and generating a dynamic link, the link will contain the placeholders within the URL that can now be substituted with the vales required.

Any links not generated by CM2WebShare will not be supported.

SEARCHING FOR TABLES

Use the Search By dropdown to determine the criteria to search on.

Enter the search into the search bar and press enter. Alternatively clicking the magnify glass will also start the searching process.

Any tables found will be displayed on the home page.

CREATING A NEW TABLE

1. On the Home Page, click on the Create New Table button
   

2. The New Table configuration page will load
   

3. Searching for Records can be completed in three separate ways:
   a. Searching by Container
   b. Searching by Saved Search
   c. Searching by custom Content Manager String Search

SEARCHING BY CONTAINER

To activate container searching enable the container search checkbox and a search field will display for locating the correct Folder.

The Search Folder (Container) dropdown list will display all favourited folders upon your first click. To search for a particular folder, start typing the folder's title to begin a search.

SEARCHING BY SAVED SEARCH

To activate saved search searching click the Saved Search checkbox. An input will display upon click.

The saved search dropdown list will display all favourited saved searches available for display and is searchable by Save Search name. To see all saved searches available, in the input bar type "all".

SEARCHING BY CONTENT MANAGER STRING SEARCH

To activate Content Manager string searching click the Content Manager Search checkbox.
You can input a Content Manager search string directly into this field.

TABLE SETTINGS

1. Table Columns (Metadata Properties)
   Table columns are created by selecting Metadata Properties from the list provided as illustrated below
   

Metadata properties are populated by the predefined properties within Content Manager and any additional fields created. The search bar allows you to search through the list to find the property to intend to use.

To add a column to the table, select the field desired using the checkbox. The sorting arrows allow for the table rows to be moved up and down to position the fields into the most ideal configuration for the display.

If you wish to remove a Field from the table, you can press the delete button on the corresponding row, or alternatively, uncheck the check box of the corresponding field within the list.

Table columns can be sorted by clicking on a row and dragging the row to the desired spot

2. Extra Table Settings
   Add extra features to your table by using the optional table settings below
   

3. Table Themes
   To add a theme to a table, select a pre-existing theme from the drop-down table.
   If a theme is not selected, a default theme will be placed onto the table which may be changed within the editing stage.
   

4. Previewing the Table
   Pressing save will allow you to see a quick preview of what your configured table will look like on display

EDITING A TABLE

1. On the Home Page, click on the Edit Button (Pencil Icon)
   
2. The Edit Table configuration page will load
3. You can now edit any of the existing settings needed

DELETING TABLES

1. On the Home Page, click on the Delete Button (Rubbish Bin Icon)
   

2. A confirmation will appear to confirm the deletion process

3. Click on the Delete button

VIEWING A TABLE

1. On the Home Page, click on the View Button (Eye Icon)
   
2. The table will open in a new tab for viewing

ADD TABLE TO A WEBPAGE

FYB CM2Webshare provides you with multiple ways to share your newly created tables.

1. Tables can be shared using a URL link to send via email, mobile, or hyperlinked within a web page
2. Tables can be embedded in web pages using an iFrame link

USING THE URL LINK

1. On the Home Page, click on the URL button (Clipboard Icon)
   

2. The URL link to the selected table will be copied to the clipboard

3. Paste the link to the web browser to see the table

USING THE IFRAME LINK

1. On the Home Page, click on the iFrame button ("< / >" Icon)
   
2. A popup will prompt for the height and width for the iFrame (in pixels)
   
3. The iFrame link to that table has been copied to your clipboard and now can be shared

The link will be in the following format :
< iframe src="http://[MYSERVER]/Grid?id=[GRID-ID]" width="XXpx" height="XXpx" frameborder="0">< /iframe>

CM2WEBSHARE TABLE MINIMUM SIZING

For CM2WebShare to seamlessly work within an iFrame, the minimum width for a CM2WebShare table with 3 columns, is 600px. For each additional column add 150px per column.

Please note these measurements are a guidance based off the default theme setting, and may require slight adjustment to suit your tables needs.

Adjusting the width to less than the recommended minimum width may see issues with the use of CM2WebShare tables.

EPATHWAY TABLE LINK

1. On the Home Page, click on the EPathway button (Path Icon)
   

2. The EPathway link to the selected table will be copied to the clipboard

TABLE INDEX (Comma Delimited Format)

1. On the Home Page, click on the Table Index button (A Icon)
   

2. The Table Index of the selected table will be copied to the clipboard in CSV format.

DOWNLOAD CSV

1. On the Home Page, click the Download button (Download Icon)
   

2. A copy of the table's content will be downloaded to CSV format

THEMES

1. On the Home Page, click on the Themes button from the dropdown menu
   

2. The Theme page will load if you are an administrator in Content Manager
   

Within the theme page you can complete the following:

• Upload a customised theme using CSS
• Create a new theme using the CM2WebShare interface
• Delete an existing theme

UPLOADING A CUSTOM CSS THEME

1. Within the theme page, click on the Upload Custom Theme button

2. When the upload theme page load, supply a theme name

3. Select your CSS File within your computer by clicking on the choose file button
   

4. Click on the Save button to upload your theme

When creating a custom CSS file, please ensure that you have read the CM2WebShare CSS Styling Guide and Template, and followed the directions correctly to ensure that the CSS file created will work with the CM2WebShare table.

CREATING A NEW THEME

1. In the Create New Themes page, fill out the details to create a new theme.
   The colour pickers allow you to search for your desired colour
   

A theme name is needed to save a theme and you cannot name a theme the same name as a pre-existing theme.

2. Click on the Save button to save the theme

Themes can now be used on all CM2WebShare tables

DELETING A THEME

On the theme listing screen, to remove a theme please follow the steps below

1. Find the theme you wish to delete
2. Click the trash icon to remove the theme
   
3. When the prompt appears click om the Delete button
   
4. The theme will be removed from the theme list

CUSTOM TABLES USING QUERY STRINGS

The CM2WebShare Custom Link Template allows for CM2WebShare tables to be created using Content Manager search strings.

CREATING A CUSTOM TABLE

1. Start with your base URL: www.servername/CM2WebShare/Grid?query=

2. Go to Content Manager and create a search string that will return the records you need.

3 Add the Content Manager search string after the '?query='.

URL : www.servername/CM2WebShare/Grid/Grid?Title:example%20and%20type:2030

If you wish to exclude options from your table, skip this step.

4 Add options to the URL, add '?options=' to the end of the Content Manager search string

All Table options have a set name. To enable an option, just add the option name after '?options='

To add multiple options, add %20 between each option.

The following table options can be configured within the URL.
URL : www.servername/CM2WebShare/Grid/Grid?Title:example%20and%20type:2030?options=VIEW%20EDIT%20PAGES=10

5. To add a theme to the table, after options add &theme= followed by the name of the theme.

6. To add fields to the table, add &fields= followed by the field name, replacing any whitespace with ' - '. To add multiple fields, use %20 between each field.

7. To add a name to the table add name= followed by the name of the table, replacing any whitespace with ' - '.

8. To add a description to the table add *description= followed by the description of the table, replacing any whitespace with ' - '.

9. Paste the created URL into the browser. If the URL is configured correctly, a CM2WebShare table will be created and will display the records from the Content Manager query created.