Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Status
colourRed
titleHIGH

User interaction and design

Open Questions

...

Question

...

Answer

...

Date Answered

...

Page Properties

Platform URL

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

API Endpoints

Epic

Document status

Status
titleDRAFT

Document owner

Adam Carter

Technical writers

Objective

Success metrics

...

Goal

...

Metric

Requirements

...

Requirement

...

User Story

...

Importance

...

Jira Issue

...

Notes

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

...

Status
colourRed
titleHIGH

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

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

Retrieves/Removes/Replaces a Asset resource:

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

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

Code Block
GET/POST https://{enterprise}.cvtr.io/api/v4/asset-tags

Retrieves/Removes/Replaces a AssetTag resource:

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

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

Code Block
GET/POST https://{enterprise}.cvtr.io/api/v4/asset-localiseds

Retrieves/Removes/Replaces a AssetLocalised resource:

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

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyCON-4969

Document status

Status
titleDRAFT

Document owner

Adam Carter

Technical writers

Muge Budak

🏠 Feature Overview

The whitepaper assets feature allows users to upload downloaded content to the platform (PDF, MP3 and MP4) the main purpose of this is to act as a content library for our customers.

The typical user flow is that a user will engage with a Convertr landing page where they will then fill in the Convertr form and submit from there this is where they get the value exchanged for the content.

Within assets, it relates to multiple areas of the platform:

Feature

Impact

1

Content Blocks

You can associate an asset to a content block.

2

Whitepaper Landing pages

Depending on the landing page template selected this will impact what is displayed on the landing page form the assets:

Headline, Description, Published Date, Logo, Thumbnail

When creating a whitepaper landing page this links to tracking links which then links to an asset.

3

Tracking Links

You need an asset to to create a tracking link with a whitepaper template to so we pass the WP ID within the tracking link. eg

https://[enterprise name].cvtr.io/lp/[landing page name]?wp=[campaign whitepaper id]&locale=[ entperise content languages id]

4

System Categories

When displaying assets on an external website you can group the assets by the system category and sub category.

5

Advertisers

When displaying assets on an external website you can group the assets by Advertiser.

you can also filter WP on a website based off the advertiser the assets is associated too.

6

Enterprise > Content Languages

When adding an asset you can create a separate listing per language added to the platform.

7

Whitepaper Tags Tag

When displaying assets on an external website you can group the assets by a key word tag

8

Search Tag

When displaying assets on an external website you can search for the asset using the synopsis or description of the asset along with searching by the advertiser name

\uD83D\uDDD2 Summary

Functionality

User Story

1

Table Filtering

Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label

2

Custom Tables

A user can add, remove and reset columns for custom table

3

Add Asset > Setup

Mandatory: Associate to an advertiser, content block, system category and add a publisher date

Optional: Add tags to the asset

4

Add Asset > Content

Mandatory: Add Headline, Synopsis and Description (this has a WYSIWYG editor).

5

Add Asset > Whitepaper logo

Unchecked will use the logo the user uploads if the user does not upload a logo this will then use the enterprise logo.

Checked Use advertiser logo will use the logo associated to the advertiser selected.

6

Add Asset > Whitepaper Thumbnail

Mandatory: This has to be an image file JPEG,PNG or GIF

7

Add Asset > Whitepaper Download

Mandatory: This has to be an PDF, MP3 or a MP4

\uD83D\uDDD2 User Permissions

Only admin users have access to System > Whitepapers > Assets

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