Versions Compared

Key

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

Platform URL

https://[enterprise].cvtr.io/v2/system/categories

API Endpoints

To retrieve all content languages in the ‘Add Categories’ and ‘Add subcategories’ modal

GET /api/v4/content-languages

To save new category

POST /api/v4/categories

Editing categories

PUT /api/v4/categories

Listing categories

GET /api/v4/categories

To save new sub category

POST /api/v4/subcategories

List all subcategories

GET /api/v4/subcategories

Editing subcategories

PUT /api/v4/subcategories

PUT /api/v4/subcategory-localiseds

Deleting subcategories: retrieving associated campaigns

GET /api/v4/campaigns

DELETE /api/v4/subcategories

Deleting categories

GET /api/v4/subcategories

DELETE /api/v4/categories

Epic

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

Document status

Status
colourGreen
titleDRAFTREVIEWED

Document owner

Danny Hannah Adam Carter

Technical writers

Anu Kalangi

🏠 Feature Overview

...

Categories are important for campaigns with whitepapers, to allow categorisation of assets on distributor websites. At the time of campaign creation/update, it is possible to select the category/sub category that most closely fits the requirements.

On the platform, Categories and sub categories can be created only by admin users, by navigating to System > System Categories.

...

This page lists Categories and Sub-Categories tables. User can add/edit/delete category and sub-category on this page.

...

On this page, the user can ‘Add’ categories using the ‘Add’ button available just above the ‘Data Categories’ table. The table has the columns: Category, Last Updated and Actions.

The ‘Category’ column shows the names of the categories available and has a search option and sort option for users to search the table by a category name and to sort the names in asc/desc order.

The ‘Last Updated’ column shows the last updated timestamp information of each category and also provides an option to sort the values in asc/desc order.

The ‘Actions’ column provides options for the user to Edit/Delete the category.

Data Categories

Add Category

Clicking on Add button opens a an ‘Add Category’ modal as shown below.

...

Enter all the required fields The user must enter the name of the category in different content languages configured for the enterprise, and click Save. New category will be added to categories the ‘Data Categories’ table.

Edit Category

Clicking on Edit button from Actions column opens the ‘Edit Category’ modal. User The user can edit the details of the category and click Save to update the category.

...

Delete Category

Clicking on delete button from Actions column opens delete confirmation dialog.A category may only be deleted if there are no sub categories associated with it. If the user tries to delete a category that has a sub category associated, the below dialog will be shown. Deletion will be permitted only if the sub category is deleted or edited.

...

If there are no sub categories associated with the category, the below ‘Delete’ confirmation dialog will be shown when the user tries to delete the category. Once the action is confirmed, the category will be deleted and removed from the ‘Data Categories’ table.

...

Data Sub-Categories

Multiple sub categories may be associated with a System category. The sub categories may in turn be associated with campaigns. The ‘Data Sub-Categories’ table has the following columns: Parent Category, Subcategory, Data Type, Last Updated and Actions.

'Parent Category' is the name of the category that the sub category is a child of.

‘Subcategory’ is the name of the subcategory. The column has a search option and sort option for users to search the table by a subcategory name and to sort the names in asc/desc order.

‘Data Type’ has a search option and sort option for users to search the table by a category name and to sort the names in asc/desc order.

‘Last Updated’ column shows the last updated timestamp information of each subcategory, and also provides an option to sort the values in asc/desc order.

The ‘Actions’ column provides options for the user to Edit/Delete the subcategory.

...

Adding a Sub Category

Clicking on ‘Add’ button will open Add Sub Category modal. Select The user must select the parent category and enter all the required fields the name of the sub category in different content languages configured for the enterprise, and click Save. New Sub Category sub category will be added to the ‘Data Sub Categories -Categories’ table.

...

Edit Sub Category

Clicking on Edit button from Actions column opens ‘Edit Sub Category’ modal. The user can edit the details of the sub category and click Save to update the sub category.

...

Delete Sub Category

Clicking on delete button from Actions column opens delete confirmation dialog.

User can only delete a Sub Category A sub category may only be deleted if there are no campaigns associated to the parent category. In order with it. If the user tries to delete a sub category that is associated with a campaign, user has to remove and reassign the campaign from the category.

...

Delete modal when the parent category is associated with campaigns.

...

the below dialog will be shown. Clicking on ‘View’ button against a campaign will take the user to the corresponding campaign’s overview page. Deletion will be permitted only if the associated campaigns are reassigned to different sub categories.

...

If there are no campaigns associated with the sub category, the below ‘Delete’ confirmation dialog will be shown when the user tries to delete the sub category. Once the action is confirmed, the sub category will be deleted and removed from the ‘Data Sub-Categories’ table.

...

Adding a category/subcategory to a campaign

Category/Subcategory is Sub category can be assigned to a campaign when a new in the ‘Metrics’ tab:

  • when the campaign is created

...

  • from Advertiser

...

  • > Create Campaign or

  • when the campaign is updated updated from Campaign > Admin > Setup

...

 User PermissionsUser Permissions

Only admin users have access to System Categories menu.

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