System Categories
- Arunima Kurup Prasad
- Anu Kalangi
Platform URL | |
|---|---|
API Endpoints | To retrieve all content languages in the ‘Add Categories’ and ‘Add subcategories’ modal GET To save new category POST Editing categories PUT Listing categories GET To save new sub category POST List all subcategories GET Editing subcategories PUT PUT Deleting subcategories: retrieving associated campaigns GET DELETE Deleting categories GET DELETE |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad @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.
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.
There is also an option for pagination below the table.
Data Categories
Add Category
Clicking on Add button opens an ‘Add Category’ modal as shown below.
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 the ‘Data Categories’ table.
Edit Category
Clicking on Edit button from Actions column opens the ‘Edit Category’ modal. The user can edit the details of the category and click Save to update the category.
Delete Category
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.
There is also an option for pagination below the table.
Adding a Sub Category
Clicking on ‘Add’ button will open Add Sub Category modal. The user must select the parent category and enter the name of the sub category in different content languages configured for the enterprise, and click Save. New sub category will be added to the ‘Data Sub-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
A sub category may only be deleted if there are no campaigns associated with it. If the user tries to delete a sub category that is associated with a campaign, 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/Sub category can be assigned to a campaign 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 Permissions
Only admin users have access to System Categories menu.