Metadata
- Anu Kalangi
- Arunima Kurup Prasad
Platform URL | |
|---|---|
Epic | |
API Endpoints | Load Metadata fields
Add Metadata field
Edit/Mark as Required
|
Document status | FOR REVIEW |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad |
Related Content |
Feature Overview
Within the Enterprise menu, there is a sub menu item called ‘Metadata’ that allows to create custom fields at an enterprise level, to store campaign metadata. The fields are reportable via Report Builder/Lead Export, so that customers can track their own metadata. Convertr allows adding up to a maximum of 5 metadata fields at the enterprise level.
The ‘Metadata’ page consists of an ‘Add’ button and a table with the below fields:
Field Name | Description |
|---|---|
Id | Unique Id generated by the system to identify the metadata |
Name | Name of the metadata field |
Required | If this toggle is enabled, the metadata field will be a mandatory field at the campaign level. This toggle is disabled by default. |
Actions | Consists of an ‘Edit’ button that allows to edit the ‘Name’ field only |
Adding Metadata
A new metadata field can be added by clicking on the ‘Add’ button that opens the ‘Add Metadata’ modal where the user can enter the name of the metadata field.
Once saved, the new metadata field will be available in the listing table. The user can add up to a maximum of 5 metadata fields only.
The ‘Required’ field may be toggled on/off to make the field mandatory/not mandatory at the campaign level.
Editing Metadata
The name of the metadata field can be updated by clicking on the ‘Edit’ button available in the Actions column for the metadata field. This will open an ‘Edit Metadata’ modal where the user can make changes to the name of the field and click Save. Saving will update the name of the metadata field in the listing table.
Deletion
It is not possible to delete any metadata. User can only edit existing metadata fields.
Metadata at Campaign level
The metadata fields configured in the Enterprise section is available for all campaigns. This information is available in the ‘Metadata’ tab in Campaign > Admin > Setup.
The metadata fields marked as ‘Required’ in Enterprise, are marked with a red asterisk and is a mandatory field.
The Save button will remain disabled until a value is provided for the mandatory metadata fields. If the mandatory values are entered or if none of the metadata fields are marked as mandatory, the Save button will be enabled.
Reporting
User can report on metadata fields using the Campaign Report Builder and Lead Export.
Lead Export
Within field selection in Lead Export, there is a section called ‘Campaign Metadata’ that shows all the metadata values configured at the Enterprise level, and can be used for selecting the metadata fields to be reported against.
Report Builder
Within fields selection in Campaign Report builder, there is a section called ‘Campaign Metadata’ that shows all the metadata values configured at the Enterprise level, and can be used for selecting the metadata fields to be reported against.
User Permissions
Only Admin users have access to the Enterprise section of the platform.