live delivery platform (ldp)€¦ · 2. under “ldp admin host,” click on “download reg...
TRANSCRIPT
Live Delivery Platform (LDP) User Guide
March 3, 2021
Approved for public release
Version 2
LDP March 3, 2021 Version 2
moderncampus.com Page 2 of 33
Confidentiality Note: This document contains confidential information, which is proprietary to Modern Campus.
In consideration of receipt of this document, the recipient agrees to maintain such information in confidence and not
disclose this information to any party outside of the recipient’s organization. This information may not be reproduced
or displayed to any other party without the written consent of Modern Campus.
Modern Campus shall not be held liable for any technical or editorial errors and omission contained herein, nor any
damages directly or indirectly arising from this document.
© 2021 Modern Campus. All rights reserved. Confidential. Destiny One® and Omni CMS® are registered trademarks
of Modern Campus.
LDP March 3, 2021 Version 2
moderncampus.com Page 3 of 33
Version Control
Version Description of Revisions Date Author
1 Original 2020 Erica B.
2 Moved from OmniUpdate template to Modern
Campus template
3/3/21 Paul W.
LDP March 3, 2021 Version 2
moderncampus.com Page 4 of 33
TABLE OF CONTENTS
INTRODUCTION _____________ 5
REGISTERING THE SSM ________ 6
SSM Test Connection Messages _______________ 7
LDP SETTINGS ______________ 8
IMAGE GALLERIES ____________ 9
Creating an Image Gallery _____________________ 9
FORMS __________________ 13
Creating a Form Asset ________________________ 13
Form Elements ________________________________ 17
Common Element Properties ________________ 17
Label and Name _____________________________ 17
Helper Text __________________________________ 18
Items ________________________________________ 18
Required and Required Failure Text ________ 19
Default Text _________________________________ 19
Validation and Additional Validation
Messages ____________________________________ 19
Available Elements ___________________________ 20
Single-Line Text Field _______________________ 21
Multi-Line Text Field ________________________ 21
Radio Buttons _______________________________ 21
Checkboxes _________________________________ 22
Drop-Down __________________________________ 22
Multi-Select _________________________________ 22
Date/Time Picker ____________________________ 22
Instructional Text ____________________________ 23
File Upload __________________________________ 23
Advanced Field________________________________ 23
Fieldset Attribute ____________________________ 24
Columns and Rows Attribute________________ 24
Size Attribute ________________________________ 25
Addclass Attribute ___________________________ 25
Datasets Attribute ___________________________ 26
Form Submissions ____________________________ 27
COMMENTS _______________ 29
Disqus Set-Up _________________________________ 29
Editing the Source Code Asset _______________ 30
Adding Comments to a Page ________________ 32
LDP March 3, 2021 Version 2
moderncampus.com Page 5 of 33
Introduction
Live Delivery Platform, or LDP, provides three features: image galleries, forms, and comments, all
of which are assets that can be placed on pages.
LDP is accessed and managed through the OU Campus interface. After LDP has been
implemented into the university's account, a level 10 administrator can activate LDP for the
account in the Setup > Account menu, and then clicking the check box next to “LDP” under
“Optional Features.” More settings are available at the site level. After LDP has been activated,
users can create form, gallery, and comments assets under Content > Assets. As with all
other assets, access to LDP assets can be controlled by group and user levels.
LDP March 3, 2021 Version 2
moderncampus.com Page 6 of 33
Registering the SSM
To store forms answers in a database, a server-side module (SSM) must be installed and any
sites using LDP registered with it. This adds the site name, UUID, and public key (found in Setup
> Site > Edit Site > Site Information) to the SSM database. One SSM can work with as many
sites as necessary. The values for a site’s UUID and public key are automatically generated when
a site is created. The UUID is used for LDP forms; the public key for authentication purposes. If
the public key is regenerated, the site must be re-registered.
The SSM is installed on the institution’s production server. It can be installed on the same server
or a different server than that of the website. It is written in Python and the installation includes
a MySQL database, which is where the form data are stored. As part of the configuration of the
SSM, a server-side connector script is installed on the same server as the website. The connector
script’s language is determined based on the needs of the institution. The purpose of the
connector script is to act as a bridge between the website where the data is being submitted
and the SSM.
To register the site with SSM:
1. Navigate in OU Campus to Setup > Sites > your site > Edit > LDP Settings.
2. Under “LDP Admin Host,” click on “Download Reg File.”
3. Save the file and upload it to the SSM on the production server.
4. Run a command for each registration file and replace /root/registration-
site.ldp or C:\Program Files (x86)\OmniUpdate\SSM\registration-file-
path.ldp with the path to the registration file on the server.
• On Linux servers, the command is:
# cd /opt/oussm # bin/oussm -c /opt/oussm/ssmconfig.ini register /root/registration-site.ldp
• On Windows servers, the command is as follows:
C:\> cd "\Program Files (x86)\OmniUpdate\SSM" C:\Program Files (x86)\OmniUpdate\SSM> run.exe register "C:\Program Files (x86)\OmiUpdate\SSM\registration-file-path.ldp"
5. The site is now registered. An example of successful registration messaging is:
LDP March 3, 2021 Version 2
moderncampus.com Page 7 of 33
2013-04-01 12:00:25-0700 [-] Log opened. 2013-04-01 12:00:25-0700 [-] Registering admin method: ldp.test.ping 2013-04-01 12:00:25-0700 [-] Database is version 2, application is version 2
After the site is registered, the registration file can be deleted.
The OmniUpdate Support Team can also register additional sites.
SSM Test Connection Messages
After the SSM has been installed, or during troubleshooting of the SSM, the “Test Connection”
button may be used to help troubleshoot.
Stage Test Connection Message Steps to Take Toward
Resolution
Initial Connection Connection Timed Out
Has the SSM been installed?
If not, install it.
Has the firewall on the server
on which the SSM has been
installed been opened to port
7516? If not, open the port. It
must remain open.
Is the SSM running? If not,
restart the server. If the start-
up file has not been included,
it should be.
During Authentication Authentication Failed
Has the site been registered
with the SSM? If not, register
it.
Has the public key been
regenerated? If not,
download the registration file
again and re-register the site.
LDP March 3, 2021 Version 2
moderncampus.com Page 8 of 33
LDP Settings
Once LDP is activated, the settings can be modified by navigating to Setup > Sites > Edit > Site
> LDP Settings.
The following options are available:
• LDP Admin Host: The host on which the SSM resides. This is the hostname or IP address
of the server used by the application to access LDP administrator functionality.
• Download Reg File: When downloaded, the registration file contains the necessary
components, which must then be run on the server with the SSM.
• Test Connection: After registering the file on the SSM, test the connectivity to ensure
that the file has been registered properly.
• Include CAPTCHA: Toggles on and off the option to use a CAPTCHA code in LDP Forms,
if CAPTCHA has been enabled for the site. Without proper CAPTCHA configuration this
option doesn't do anything.
• LDP Forms now offer integration with Google reCAPTCHA services. If you would
like to use this service, please contact support. You will be asked to provide the
Site Key and Secret key from the reCAPTCHA API for your website; please select
either the reCAPTCHA v2 or Invisible reCAPTCHA option. Multiple domains can
be registered under one key. If you use this option, you may need to whitelist
Google.
• If this option is not available under your LDP Settings, your SSM and/or your OU
Campus version needs to be upgraded. Please contact support for an upgrade.
• LDP Gallery Directory: Each site in which image galleries are used requires a folder to
store the images. This is a staging location, so unlike the production server settings, FTP
Root should not be included with the LDP Gallery Directory. Include only preceding slash
/ and the folder name to specify the folder to contain the images. Without a folder
defined in this field, image galleries won't be created, even if LDP is activated.
LDP March 3, 2021 Version 2
moderncampus.com Page 9 of 33
Image Galleries
Image gallery assets create a slideshow of images to be used on your website, with each image
having its own title, caption, description, and link. At any time, images can be deleted, added,
the information about them edited, and can be dragged into a new order. OU
Campus automatically generates thumbnails based on user-defined settings. By default, users
Level 4 and above can create assets, and all user levels have the inherent ability to view
the Assets screen and insert an asset on a page.
How image galleries display on your live website pages depends on how your XSL and site
design have been configured. Image galleries can be included on pages in several different
ways: in addition to inserting them into a main content region like a typical asset, they are often
added to pages via page parameters, or in some cases an editable region can be configured to
only allow for an asset to be inserted.
Creating an Image Gallery
Creating an image gallery asset is a two-step process. First, create the asset, where you fill out
basic information. Then, upload the images into the asset and sort and caption them before
saving and publishing.
1. Navigate to Content > Assets.
2. Click the blue +New button.
3. Select “Image Gallery.”
4. An asset name is required. Description and tags are optional, but tags can make it easier
to find when searching for an asset to place on a page.
LDP March 3, 2021 Version 2
moderncampus.com Page 10 of 33
5. Set access settings for the asset if desired. Configure who can edit the asset (through the
“Access Group” drop-down menu), and who can place the asset on a page (through the
“Available To” drop-down menu). Level 9 and 10 administrators can choose any group
that is configured in the site; lower-level users can only choose from groups to which
they belong.
6. Set the gallery options. These determine how the image gallery thumbnails would
display. While the default image gallery has thumbnails, your galleries might display
differently, depending on your website styling or even which page they are placed on.
• Maximum Thumbnail Size: Customize the max height and width of the thumbnails.
The max value for each is 500 pixels.
• Thumbnail Preview: The gray placeholder box shows the size and aspect ratio you
are setting. Use the dotted-line edge to adjust, if desired.
Thumbnail Aspect Ratio: Most likely, the images added to the gallery won't fit the thumbnail
dimensions. The aspect ratio determines how they are resized to create the thumbnail.
o “Original” keeps the proportions of the image and resizes it so the longest
dimension meets the max thumbnail dimension. For example, if an 800x600
image is uploaded with a maximum thumbnail size of 100x100, the image
appears as 100x75 in the thumbnail.
o “Crop” resizes the image so the shortest dimension meets the max thumbnail
dimension, and then crops from the center of the image. For example, if an
LDP March 3, 2021 Version 2
moderncampus.com Page 11 of 33
800x600 image is uploaded with a maximum thumbnail size of 100x100, the
image is resized to 133x100 and a 100x100 square cropped from the center
of the resized image.
• Advanced: Additional XML can be added here.
7. Click Create to make the asset.
8. The "Images" panel is now available.
9. Click +Add to upload photos to your gallery, or drag them into the window from your
computer. There is no option to use images already in OU Campus; you must have the
images you want to use as files you can upload. These images also cannot be edited
once uploaded, so make sure they are cropped or otherwise modified appropriately
beforehand.
10. For each image, add a title, description, caption, and click-through link. The only required
field is description, for accessibility purposes. Depending on your gallery styling, not all
these fields will be used.
LDP March 3, 2021 Version 2
moderncampus.com Page 12 of 33
11. Images can be removed by clicking the "X" in the top-right of each image box.
12. The order that the images are placed within the gallery determines the order they
display on a page. To change the order of the pictures, drag and drop them into
place.
13. Once finished, click Save.
Your asset is now available for use on pages but must be published before it appears on any live
web pages.
After the gallery has been created and published, you can add, reorder, or remove images from
the gallery in the same manner described above. Metadata for existing images can be edited as
well. If you want to change the image for a slide, then you must create a new slide, upload the
new image, and copy over or write any relevant information, and delete the previous slide. Once
the images have been added, deleted, or edited, you need to save the gallery asset and
republish it for the changes to be reflected on the live site.
LDP March 3, 2021 Version 2
moderncampus.com Page 13 of 33
Forms
Form assets are used to create and manage forms, surveys, and polls, and require a database to
store form submissions. How forms appear on your website depends on your site design and
styling.
Creating a Form Asset
To create a new form asset:
1. Navigate to Content > Assets.
2. Click the +New button.
3. Choose Form.
4. Complete the Asset Info panel. An asset name is required. Description and tags are
optional, but tags can make it easier to find when searching for an asset to place on a
page.
LDP March 3, 2021 Version 2
moderncampus.com Page 14 of 33
5. Set asset access settings if desired. “Access Group” defines the group that can edit the
asset, while “Available To” defines the group that can place the asset on pages.
6. Add form elements from the panel on the left by either clicking or dragging-and-
dropping into place.
• Each element needs a label, i.e. the question to be answered, and a name.
The name is automatically created from the label and used to record any
answers to that question. Element names can only be edited before you save
the form and are limited to thirty-two characters. Elements cannot have
identical names.
• All elements can have helper text, which instructs users how to answer the
question.
• All elements can be marked as required, so that users must fill them out to
submit their form answers.
LDP March 3, 2021 Version 2
moderncampus.com Page 15 of 33
• All elements have an "Advanced" field where attributes can be added if
desired.
See Form Elements for a full list of each element and advanced attributes.
7. Configure one or more optional email messages. When a form is completed, it can email
the submission results to one or more people.
• More than one addressee can be added to an email by separating each address with
a semicolon.
• The "From" and "To" fields must both be properly formatted email addresses, or the
form won't send emails.
• Insert the value of a form submission into any of the fields by using the Name of that
element surrounded by double braces {{ }}. For example, you might want to send an
email to the person who submitted the form with follow-up information. In the form,
you would ask for their email address, and the element Name would be email. Then
in the email message, you would put {{email}} in the "To" field, and the email would
send to whatever address a form submitter put as their email.
• Check "Include all submitted values" for every question answer to be added to the "Body"
text when the email is sent.
8. Configure additional form settings:
• Success Message: The success message can be toggled to either "Text" or "URL
Redirect."
• If set to "Text," write the success message in the mini-WYSIWYG editor.
This message will then display on the form after a successful submission.
• If set to "URL Redirect," either paste in a URL or use the file-chooser to
select a file. The user will then be redirected to that URL after a successful
submission.
LDP March 3, 2021 Version 2
moderncampus.com Page 16 of 33
• Failure Message: Write the message displays when there is an error with form
submission in the mini-WYSIWYG. The message will also automatically include
the errors preventing form submission (such as missing required information).
• Save Results: Check this to save form submissions to the database and OU
Campus.
• Include CAPTCHA: If CAPTCHA was enabled for your site in site settings, the
"Include CAPTCHA" box is available. Check this to place a CAPTCHA item that
form submitters must fill out.
• Submit Button Text: The text of the submission button can be customized here.
• Advanced: Allows for additional formatting of the messages by adding
attributes.
9. When complete, click Create to commit the settings and save the asset.
The Form Summary, Form Elements, and Form XML are now shown in Preview. Note that
Preview only shows what the questions will look like, not a functional form. In order to test
submitting the form, the asset must be placed on a page and pushed to the live website and
tested from the published page.
After the creation of the new form, the settings can be changed and form elements can be
added, deleted, or modified. Keep in mind that once an asset has been inserted on a page,
LDP March 3, 2021 Version 2
moderncampus.com Page 17 of 33
visitors may complete the form. Adding additional elements means that data may be incomplete
until the asset is published.
Form Elements
Add form elements to an asset by either dragging the element onto the Elements panel from
the Elements toolbar, or by clicking the element's name or plus sign. Once the element has been
added to the Elements panel, text details can be added and the element can be reordered by
dragging it to the new location and dropping it into place.
Common Element Properties
Several of the attributes used for the form elements have the same functionality, no matter
which element it is used within.
Label and Name
Available and required for all elements.
By default, the “Name” field is populated by the value defined by the user in the “Label” field
when adding the element to the form. However, the value of the “Name” field can be edited by
the user, but only at the time of creating the element (before saving the form).
The “Name” field is limited to 32 characters and can include alpha-numeric characters, but
cannot contain spaces or other ASCII characters. The value that is entered in the “Label” field is
truncated within the “Name” field if it exceeds the 32 character limit and other disallowed
characters are automatically removed. The “Label” itself can include more than 2,000 characters.
LDP March 3, 2021 Version 2
moderncampus.com Page 18 of 33
The “Name” entry is automatically truncated by the system and the form data will break if any
two elements have an identical name. Note that two elements can have different labels, but the
names may get truncated to have the same value.
Helper Text
Available for all elements. The helper text provides text that appears under the element in the
form, and can be used to provide instructions to users on how to fill out that specific element. In
fact, the image below is an example of both the Helper Text field and what helper text might
look like in a form.
Items
Available for radio buttons, checkboxes, drop-downs, and multi-select elements. Click the +Add
button to add the option items as necessary and the label for each. For each element, one or
more items (as appropriate) can be preselected for the form. When using a predefined data set
in the “Advanced” field, it is not necessary to add each item individually. This is particularly
useful for lengthy lists.
LDP March 3, 2021 Version 2
moderncampus.com Page 19 of 33
Required and Required Failure Text
“Required” is available for all elements, while “Required Failure Text” is available for single-line
and multi-line elements. Select the “Required” checkbox to compel the user to provide input for
the element. The XSL applies a span with the class required and prepends an asterisk to the
label. The styling for a required element can be modified where it is defined (CSS or XSL).
Additionally, when selecting “Required,” the “Failure Message” field becomes available. Use this
field to define the error message for the visitor if the field has not been completed correctly
prior to submission.
Default Text
Available for single-line and multi-line elements. If default text is entered, it automatically fills in
the form element, but can be overwritten. The message should contain a helpful tip or example
of the desired entry format.
Validation and Additional Validation Messages
Available for single-line text fields. Defines a validation method for the element; default is None.
Selecting a specific validation method also enables one or more additional fields for further
refinement of the validation to be used and for providing the failure text. The failure text can be
used in order to give the user a hint about what is required.
The options for the “Validation” field are as follows:
• None: No validation performed, no extra fields.
• Email Address: Validates the text to ensure that the entry is formatted like an email
address, i.e. with an @ sign and a “.-something” domain. When this is chosen, an
LDP March 3, 2021 Version 2
moderncampus.com Page 20 of 33
additional “Failure Text” field can be used to provide a message when the input fails
validation.
• Minimum Length: When this is chosen, use the additional “Minimum Length” field to
specify the minimum number of characters accepted and the “Failure Text” field to
provide a message when the input fails validation. The minimum length can be 2 or
greater.
• Regular Expression: Input a regular expression in the “Validation Regex” field to ensure
that the configuration of the input data is as desired. For example, if the form requires
the entry of the year of birth, it would be within the 1900s or 2000s. A regex that
validates for this is: ^(19\d{2}|20[0-1]\d)$. When this is chosen, the
“Validation/Failure Text” field can be used to provide a message when the input fails
validation.
The following example shows a group of elements with submitted answers that did not meet the
validation requirements.
Available Elements
Eight elements are available to add to an LDP form:
• Single-Line Text Field
• Multi-Line Text Field
• Radio Buttons
• Checkboxes
• Drop-Down
• Multi-Select
• Date/Time Picker
• Instructional Text
• File Upload
LDP March 3, 2021 Version 2
moderncampus.com Page 21 of 33
Single-Line Text Field
Provides users with one line to answer a question. You can set validation for it, such as for a
minimum answer length, or to validate an email address. If you set this element to "Required,"
you also have to set a failure message telling the user why they didn't answer properly.
Multi-Line Text Field
Provides users with a multi-line field to answer a question. You can set validation for it, such as
for a minimum answer length, or to validate an email address. If you set this element to
"Required," you also have to set a failure message telling the user why they didn't answer
properly.
Radio Buttons
Makes a multiple choice question where only one answer can be selected. Click +Add next to
"Items" to make the answer options. The answer items can be reordered and deleted. Click the
circle to the left of the item for it to be pre-selected on the form.
LDP March 3, 2021 Version 2
moderncampus.com Page 22 of 33
Checkboxes
Makes a multiple choice question where none, some, or all of the choices can be selected. Click
+Add next to "Items" to make the answer options. The answer items can be reordered and
deleted. Click the square to the left of the item for it to be pre-selected on the form.
Drop-Down
Provides users a list from which they can select an answer. Click +Add next to "Items" to make
the answer options. The answer items can be reordered and deleted. Click the circle to the left of
the item for it to be pre-selected on the form.
Multi-Select
Provides users a list from which they can select one or more answers using Ctrl+Click. Click
+Add next to "Items" to make the answer options. The answer items can be reordered and
deleted. Click the square to the left of the item for it to be pre-selected on the form.
Date/Time Picker
Creates a pop-up where users can choose a date and/or time (toggle between a date and time
picker, just date, or just time). The “Default Date/Time” field sets a time and/or date to be
displayed when the form loads.
LDP March 3, 2021 Version 2
moderncampus.com Page 23 of 33
Instructional Text
Instead of making a question, the Instructional Text element gives you a mini-WYSIWYG where
you can format text to display in the form.
File Upload
The File Upload form element allows web visitors to upload files to their form submissions. This
feature requires a customer-provided S3-compatible object storage and may require updates to
SSM, XSL, and other scripts. Please contact the OmniUpdate Support team for more details or
assistance.
Advanced Field
Each element has the Advanced field attribute. Depending upon when a site was implemented
in OU Campus, these attributes may or may not be contained within a current XSL. Additionally,
any classes defined in CSS may override the settings for attributes such as cols and rows. Every
declaration in the Advanced field must be terminated with a semicolon,
e.g. legend=true;addclass=form_legend;.
Attributes are always lowercase and in certain cases, more than one attribute can be included in
the field. For datasets, additional dataset options are defined in the datasets.xsl file, which is
also where the names can be found of the current ones and new sets can be added. For
addclass, the class must be already defined in CSS.
LDP March 3, 2021 Version 2
moderncampus.com Page 24 of 33
If a “Required” checkbox is available for a form element, select it via the interface. If a "Required"
checkbox is not available, it can be specified in the “Advanced” field with the
following: required=true;.
Fieldset Attribute
A fieldset groups form elements under a heading or label, often with a design element defined
by your XSL. It typically consists of three items:
• fieldset_start=true – Defines the beginning of the fieldset, used on the first element
in the group.
• fieldset_label="Label for Fieldset" – Defines the label or header of the fieldset,
used on the first element in the group. It can be entered without quotes and with spaces.
• fieldset_end=true – Defines the end of the fieldset, used on the last element in the
group.
In this example, a single-line text field element is used to start a fieldset and to give it the label
of “About.”
Columns and Rows Attribute
• Define the size of a multi-line text field with the cols and row attributes. Columns and
rows can be used together or singularly to define the visible starting size of the text area
for a multi-line text field. Users can input more text than the defined area as by default
scroll bars and field resizers are included. The following example creates a multi-line text
area of 20 characters by 15 lines.
LDP March 3, 2021 Version 2
moderncampus.com Page 25 of 33
Size Attribute
The size attribute specifies the viewable size (in characters) of a single-line text field within a
form. This does not limit the number of allowed input characters.
Addclass Attribute
The addclass attribute adds a class to the label of any element. The class can be anything that
has been defined in CSS. If your institution doesn’t have its own LDP Forms CSS implemented,
by default LDP Forms use an included CSS file, typically located at _resources/css/ouforms-bootstrap.css.
The definition for the “required” class was added to the CSS file as follows:
.required > label:first-child:before { content : "* "; color : red; }
To create a hidden field in a form, define a CSS class of .hidden {display: none}, and then
enter addclass=hidden in the “Advanced” field.
LDP March 3, 2021 Version 2
moderncampus.com Page 26 of 33
Datasets Attribute
Adds a predefined dataset to a radio button, checkbox, single-select, or multi-select element.
This is useful for data that are frequently used, but tedious to type. For example, the “state”
dataset includes all fifty United States so that they may be used in a selector element.
Available predefined datasets include:
• dataset=year;
• dataset=month;
• dataset=country;
• dataset=state; (US states)
• dataset=state_ab; (postal abbreviations of US states)
Adding a New Dataset to the XSL
In addition to the predefined datasets, you can make your own.
A conditional defined in the XSL creates the dataset based on the use of the Advanced field in
the form element and the dataset named within. In the XSL, the name of the dataset to use gets
passed to the XSL with $adv. The XSL does a choose test to return the correct dataset.
Another dataset can be added to the existing XSL as another "when" condition. The "when"
condition is set off with double quotes, so the dataset name is included within single quotes.
Each item in the dataset should be separated by a comma. Spaces can be used within an item,
but character entities should not. For example, instead of an ampersand (&) the HTML entity
should be used: & and instead of a quote mark ('), the " entity should be used.
To add a new dataset:
1. Navigate to /_resources/xsl/_shared/forms.xsl.
2. Open the source code editor.
3. Paste in the following code at line 312:
<xsl:template name="customer-custom-datasets">
<xsl:param name="dataset-name" /> <xsl:choose> <xsl:when test="$dataset-name = 'custom-1'">option1,option2</xsl:when> <xsl:when test="$dataset-name = 'custom-2'">opt1,opt2</xsl:when>
<xsl:otherwise><xsl:value-of select="'************************************************************************************,
LDP March 3, 2021 Version 2
moderncampus.com Page 27 of 33
Dataset used that is not configured. Please Check Configuration before publishing...,
************************************************************************************'" />
</xsl:otherwise>
</xsl:choose> </xsl:template>
4. Replace ‘custom-1’ with the name of your new dataset.
5. Add in the dataset values between the > and < characters, comma separated, with no
spaces between, and in the order you want.
6. For each new dataset, copy the <xsl:when> statement and adjust as needed.
Form Submissions
As long as a form has “Save Results” checked, form submission results are saved in a database
and viewable in OU Campus. Forms can also be set up to email submission results to one or
more email addresses.
The system removes the following five characters from the radio button, checkboxes, drop-
down, and multi-select element entries when saving to the database: [ ] ‘ / \. Other characters
such as the @ sign are allowed. If the disallowed values are inserted into one of the elements,
then it will not appear in the form, in the published form, or in the data that are returned.
All user levels can see form submissions as long as they have edit access to the asset in
question. To view form submissions, either:
• In Content > Assets, hover over a form asset and click on the More Actions button. Click
on Review > Form Submission.
• While viewing a form asset, click Form Submissions in the top toolbar.
LDP March 3, 2021 Version 2
moderncampus.com Page 28 of 33
The submissions list shows columns for submission date, ID number as defined by OU Campus,
and unless disabled, the IP address of the submitter. It also shows a column for each element
and the submitted answer (if any), labeled with the “Name” of each element. Submissions are
ordered the same way the elements appear in the form.
To delete an individual form submission from the list view:
1. While in the Form Submissions screen, select the checkbox to the left of the submission
or submissions you wish to delete.
2. Click Delete in the table header options.
Alternatively, click the red Delete All button in the top-right corner to permanently clear all
submission data from the form.
Click “Export CSV” in the top-right corner to download a CSV form with all form submission data
to your computer.
LDP March 3, 2021 Version 2
moderncampus.com Page 29 of 33
Comments
Unlike other assets, comments assets are not their own asset type. Instead, they are a source
code asset with specially configured code inserted that connects to the third-party platform
Disqus. Using the comments asset adds a Disqus-powered comments section to any page that
the asset is inserted on.
Generally, once comments have been set up, there is no need to create additional assets. The
same asset can be used on multiple pages and each page will have its own unique comments.
However, it is possible to have multiple Disqus accounts, to segment down moderation to
different administrators, in which case there would need to be an asset for each Disqus account.
Disqus Set-Up
Once LDP has been purchased, our implementations team provides you with code for the
comments asset and add the necessary code to your web pages for it to work. As an
administrator, you are required to create an account with Disqus and connect that account to
the premade asset.
1. Go to http://www.disqus.com.
2. Create an account, following their directions.
3. When instructed, select I want to install Disqus on my site and follow their steps.
• Record the shortname for your site, as you will use this to link Disqus to OU
Campus.
4. When asked to choose a platform, use “Universal Code.”
5. Ignore the code they give you, since you will be using our preconfigured code for the
asset.
6. Complete the rest of the steps in Disqus to finish setting up your account.
You now have an administrator account in Disqus. To navigate to the Admin panel any time
after this, click on the Admin link of the Disqus homepage after logging in.
LDP March 3, 2021 Version 2
moderncampus.com Page 30 of 33
For ease of access, consider linking to Disqus in the add-ons menu.
From the Disqus administration panel, you can:
• Moderate comments made on pages
• Change general settings
• Update site information; name and URL
• Define who can post comments
• Change options for comments
• Add additional moderators
• Add restricted words
• Define blacklists and whitelists
All comments added to the same Disqus "site" (e.g., with assets using the same shortname)
appear on the same moderation page, but the page name relating to the location of the
comment is shown with each comment.
Comments can be marked as spam or deleted. If pre-moderation is on, comments have to be
approved before they show on the live webpage. Those comments appear under
the Pending tab in the moderation screen.
There are many more moderation tools available from the Disqus Dashboard. More detailed
information concerning the tools available, and how to use them, can be found in the Disqus
Knowledge Base.
Editing the Source Code Asset
To connect your Disqus account to comments assets.
1. Return to OU Campus and navigate to Content > Assets.
2. Locate the comments asset and edit it.
3. Wherever the code says EXAMPLE, replace it with the site shortname you set in your
Disqus account.
4. Optionally, uncomment and configure one or both of the two configuration
variables, this.page.url and this.page.identifier. Read more about these two variables
on this page from Disqus. These variables are meant to enhance the reporting
capabilities of Disqus, and their values will change on a per-page basis.
5. Save and publish the asset. It is now ready to be placed on pages.
LDP March 3, 2021 Version 2
moderncampus.com Page 31 of 33
You should already have a comments asset as part of your implementation. If the asset is ever
deleted or needs to be re-created, create a new source code asset and paste the following code
into the source code editor:
<div id="disqus_thread"></div>
<script>
/**
* RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
* LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables
*/
/*
var disqus_config = function () {
this.page.url = page_url; // Replace PAGE_URL with your page's canonical URL variable
//this.page.identifier = PAGE_IDENTIFIER; // Replace PAGE_IDENTIFIER with your page's unique identifier variable
};
*/
// REQUIRED CONFIGURATION VARIABLE: EDIT THE SHORTNAME BELOW
var shortname = 'EXAMPLE'; //IMPORTANT: Replace EXAMPLE with your forum shortname!
(function() {
var d = document, s = d.createElement('script');
LDP March 3, 2021 Version 2
moderncampus.com Page 32 of 33
s.src = '//' + shortname + '.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
In addition to the asset, a small script is placed in the <head> of each page on the site, which
allows for the same comments asset to be used on multiple pages. The script indicates on which
page the comment came from, and works in conjunction with the this.page.url variable located
in the asset. Make sure this variable is uncommented in order to use this functionality.
This code is typically placed during the implementation process, and therefore doesn't need to
be added by you, but in the event that it needs to be re-added, it should be placed in
the <head> tag of common.xsl (or similar, like default.xsl) and looks like this:
<script type="text/javascript"> var page_url="<xsl:value-of select="concat(string-join(remove(tokenize(substring($ou:httproot, 1), '/'), count(tokenize(substring($ou:httproot, 1), '/'))), '/'),$ou:path)"/>"; </script>
Adding Comments to a Page
After the asset is configured and the script is added to the <head> of the page, the asset can be
placed on any page where comments are desired by following these steps:
1. Create or edit a page.
2. Click the Insert Asset icon from within the WYSIWYG Editor or the Source Editor.
3. Locate the appropriate asset from the Asset Browser and insert it on the page.
• The comments display at the bottom of the page, regardless of where in the page
content the asset is placed. We recommend placing the asset at the end of the page,
so as not to get in the way of writing content.
4. Save and Publish the page.
Comments will now appear on the page. The comment count refers to the number of comments
on that particular page, even if the same asset is being used on multiple pages.
LDP March 3, 2021 Version 2
moderncampus.com Page 33 of 33