Content Comparison

Page Properties

Platform URL

https://[enterprise].cvtr.io/v2/system/whitepapers/website

API Endpoints

Retrieves the collection of Website resources/Creates a Website resource:

Code Block
GET/POST https://{enterprise}.cvtr.io/api/v4/websites

Retrieves/Removes/Replaces a Website resource:

Code Block
GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/websites/{id}

Epic

Jira Legacy

server	System JIRA
serverId	47839f05-61cf-355f-8da7-a069f30ee70e
key	CON-4296

Document status

Status

title	DRAFTREVIEWED

Document owner

Adam Carter

Technical writers

Adam Carter

🏠 Feature Overview

The white papers website section allows users to embed our solution onto an external website by implementing various tags that can be added to their website.

This section of the platform can be accessed by navigating to System > Whitepapers > Websites and is accessible only to admin users.

The following functionalities are available in this section:

Website listing page
Add website
Edit website
Delete website
Copy tags

Listing Page

...

Add Website

...

	Name	Description
1	Name	Name of the website
2	Domain	The domain you are embedding the tag onto
3	Category URL	The category URL you are embedding the tag onto
4	Landing Page URL	The landing page URL you are embedding the tag onto
5	Rotation	Deafault: Would display white papers based on when the campaign is ending Newest: shows the most recent white papers uploaded
6	Advertisers	You can filter the white papers on this domain by the white papers associated to a certain advertiser
7	Domain (restrict to Domain)	You can restict the website tag to a specify domain.

Goal

...

Metric

Requirements

...

Requirement

...

User Story

...

Importance

...

Jira Issue

...

Notes

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

...

Status

colour	Red
title	HIGH

User interaction and design

Open Questions

...

Question

...

Answer

...

Date Answered

...

The below tag will render all live white paper assets (max 5) assigned to a content block.

Code Block
<script src="https://demo.cvtr.io/whitepapers/v2/block.js?w=5&locale=1"></script>

To reference a single block the tag can be amended by passing the BLOCK ID. If you wish to reference multiple blocks the tag can be amended by passing the block id with a comma in between eg BLOCK ID, BLOCK ID.

The BLOCK ID can be found within the 'Content Blocks' tab.

Code Block
<script src="https://demo.cvtr.io/whitepapers/v2/block.js?w=5&b=BLOCK_ID&locale=1"></script>

To display the content block as a carousel, the parameter 'carousel=true' has to passed within the tag, along with this script (see below).

Code Block

<script src="https://demo.cvtr.io/whitepapers/v2/block.js?w=5&b=1&locale=1&"></script>

<script src="https://code.jquery.com/jquery-1.7.2.min.js" integrity="sha256-R7aNzoy2gFrVs+pNJ6+SokH04ppcEqJ0yFLkNGoFALQ=" crossorigin="anonymous"></script>

<link rel="stylesheet" href="https://demo.cvtr.io/bundles/convertrdashboard/css/wpCarousel.css" />

<script type="text/javascript" src="https://demo.cvtr.io/bundles/convertrdashboard/libs/carousel/carousel.min.js"></script>

The below parameters can be applied to the tag to change autoplay, autoplay speed, click speed and adaptive height:

This controls the carousel to be on a continuous loop. default is 1 (true), 0 (false)

Code Block
<script src="https://demo.cvtr.io/whitepapers/block.js?w=5&b=1&locale=1&carousel=true&carouselParams[autoplay]=1"></script>

This controls the speed of the carousel while on auto play, the default is 3000 (which equates to 3 seconds)

Code Block
<script src="https://demo.cvtr.io/whitepapers/block.js?w=5&b=1&locale=1&carousel=true&carouselParams[autoplaySpeed]=3000"></script>

This controls the speed of carousel when you click the next button, default is 300

Code Block
<script src="https://demo.cvtr.io/whitepapers/block.js?w=5&b=1&locale=1&carousel=true&carouselParams[speed]=300"></script>

This controls the adaptive height, default is 1 (true), 0 (false)

Code Block
<script src="https://demo.cvtr.io/whitepapers/block.js?w=5&b=1&locale=1&carousel=true&carouselParams[adaptiveHeight]=1"></script>

To control the number of white papers assets that can be viewed within the content block, the parameter limit=NUMBER_OF_ASSETS can be passed.

Code Block
<script src="https://demo.cvtr.io/whitepapers/block.js?w=5&b=1&locale=1&limit=25"></script>

*The locale parameter is used to pass different languages via the tag (optional), the ID for this can be found in the Enterprise > Content Languages section.

Search

This allows you to search for a white paper by keyword or advertiser.

...

The below tag will render the search functionality on your webpage.

Code Block

<script id="cvtrSearchScript" src="https://demo.cvtr.io/whitepapers/v2/serveSearch.js?w=5&locale=1&text={0} No white papers found based on the search '__keyword__'|{1} Found one white paper based on the search '__keyword__'|]1,Inf[ Found __count__ white papers based on the search '__keyword__'"></script>
<div id="cvtrSearchContent"></div>

To implement the form place the HTML below. Within the form action attribute input your 'Search Results page as this is where your search results will display.

Code Block

<form action=”[SEARCH-RESULTS-PAGE-URL-HERE]" method="get">
    <input type="text" name="wpSearch" />
    <select name="searcht">
      <option value="">Everything</option>
      <option value="a">Advertiser Name</option>
    </select>
    <button type="submit">Search</button>
  </form>

WP Landing

This allows the landing page to be embedded to your website

...

WP Landin

Code Block

breakoutMode	wide

<script>window.addEventListener("message", function(event) 
{if(event.data == "cvtrRedirect") {window.location.href = "http://wpdemo.test:666/category.html?w=5&locale=1"; } });
</script>
<script src="https://demo.cvtr.io/whitepapers/serve.js?w=5&locale=1">
</script>

Advertiser

This allows you to group the white papers by advertisers

...

Code Block

breakoutMode	wide

<script id="cvtrAdvScript" src="https://demo.cvtr.io/whitepapers/v2/serveAdvertiserV2.js?w=5&locale=1">
</script>
<div id="cvtrContent">
</div>

WP by Tag

This allows you to group the white papers by key word tags

...

The below tag will render the 'WP Tag' tag. This allows the output of the specific white papers that have a tag associated with the asset.

Code Block
<script id="cvtrTagScript" src="https://demo.cvtr.io/whitepapers/v2/serveTag.js?w=5&tag=TAG_NAME&group={subcat, cat or leave empty}"></script> <div id="cvtrTagContent"></div>

To populate the page with specific white papers, without a category or subcategory this can be done by passing the below

Code Block
<script id="cvtrTagScript" src="https://demo.cvtr.io/whitepapers/v2/serveTag.js?w=5&tag=TAG_NAME&group="></script> <div id="cvtrTagContent"></div>

To populate the page with specific white papers, with a category this can be done by passing the below

Code Block
<script id="cvtrTagScript" src="https://demo.cvtr.io/whitepapers/v2/serveTag.js?w=5&tag=TAG_NAME&group=cat"></script> <div id="cvtrTagContent"></div>

To populate the page with specific white papers, with a category or subcategory this can be done by passing the below

Code Block
<script id="cvtrTagScript" src="https://demo.cvtr.io/whitepapers/v2/serveTag.js?w=5&tag=TAG_NAME&group=subcat"></script> <div id="cvtrTagContent"></div>

Example

https://cvtr.s3.amazonaws.com/wp-demo/index.html

\uD83D\uDDD2 Summary

	Functionality	User Story
1	Add Website	A user must add a name, Domain,Category URL,Landing Page URL and set a Rotation Advertisers and Domain are optional filter
2	Delete Website	A user can delete a website
3	Edit Website	A user can edit a website
4	Copy Tag	A user can copy all tag using the clipboard funtion
5	Custom Tables	A user can add, remove and reset columns for custom table

\uD83D\uDDD2 User Permissions

Only admin users have access to System > Whitepapers > Websites

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=67588165

Version	Old Version 5	New Version Current
Changes made by	Muge Budak	Adam Carter
Saved on	Feb 21, 2023	Mar 08, 2023

Versions Compared

Key

🏠 Feature Overview

Listing Page

Add Website

Tags

Block

Category

Search

WP Landing

Advertiser

WP by Tag

Success metrics

Requirements

User interaction and design

Open Questions

Category

Search

WP Landing

Advertiser

WP by Tag

\uD83D\uDDD2 Summary

\uD83D\uDDD2 User Permissions