How to use the Component Editor (component_editor) tab
The Component Editor (
component_editor) tab allows you to:
- edit or delete components globally
- or for Curated Components of multiple Virtual Report Suites (VRS) at once: You can
- add or remove them from VRS or
- edit their VRS-specific "Curated Name"
The Component Editor tab and its menu functions
First you want to make sure to work with the most recent state in your Adobe Analytics account. For that, quickly reload the components from Adobe Analytics by clicking on "Component Editor" -> "Reload Components from AA":
Refresh the Component Manager by reloading all components from AA
In the background, this actually refreshes the
full_comp_importtab, which is where the "Component Viewer" reads from. In the Viewer (on the blue-green left side), you can view a list of all components, or only the curated components of a specific VRS by selecting a VRS in the drop-down menu on top:
Filter the components you want to see on the left side.
You can configure the VRS's for your Component Manager in the "config" tab in cells A4:B4 and below (column C "Import Sheet Prefix" is no longer needed).
Then simply copy the IDs of the components you want to edit to the "ID" column of the Component Editor (the orange part on the right). Wait a couple of seconds, the Component Editor will automatically populate the other columns with the current values:
How to copy from the Component Viewer to the Component Editor
Of course, you can copy the IDs from any of the other tabs as well. It does not have to be from the "Component Viewer".
The Component Manager supports the following operations:
- 1.change: change name/description globally or VRS-specific curatedName
- 2.add: add to VRS
- 3.remove: remove from VRS
- 4.delete: delete globally (component will be gone)
See the following screenshot for a visual explanation:
Supported Editing and Deletion options
- VRS operations (add/remove/change curated name) are supported for any component type
- change or delete operations are supported for segments, calculated metrics and date ranges
- 1.Copy the Component IDs into the "ID" column (as many IDs as you'd like), as shown in the previous chapter.
- 2.Wait for the other columns to populate all columns with the current values.
- 3.For each component (each row), choose the "method" (or simply copy-paste), i.e. change/remove/add/delete (explanation in previous chapter).
- 4.Edit the "Curated Name", "Name" or "Description" fields for those components where you want to change something (e.g. add the new name in the "name" column if you want to change the name)
- 5.If you have any VRS-specific operations (add/remove/change Curated name), add an "x" to the Virtual Report Suite columns where these operations should apply.
- 6.Run "Component Editor -> Validate Data to Send".
- Leaving a field empty will be interpreted as "no change". As of now, there is no method to entirely "clear" a value. Adding a space " " however does the job.
- You can combine VRS add/remove operations with changes to the (curated) name or description. E.g. If your method is "add" or "remove" and you also submit a change to the global or Curated name or the description in the same row, these changes will be executed as well, so you don't need an extra row for them.
You are now taken to the "update_export" sheet where you can see a preview of all the planned updates. The validation checks if the updates you want to send are "valid". In the example below, the validation failed because no "method" was specified:
Note that this validation is not exhaustive, it covers most of the typical errors.
After successful validation, click Component Editor -> Send Updates to AA and confirm the message. You can now follow the updates in the "Status" of the "component_editor" tab.
Once done, you see: "Component update finished. See update_log tab for effective changes."
The "update_log" tab contains
- a list of all changes sent to Adobe Analytics (does not mean the changes were effective)
- a link to an Excel file with a log of the effective results after the change has been executed: In this log file, you can see whether the changes actually were effective or if any errors occurred
Download the log file by double-clicking on the cell next to "Effective changes (logs)" and open it in Microsoft Excel (or import the file into Google Sheets).
The following example screenshot should help you understand how to interpret the update logs. You can also download this example for more comfortable viewing:
How to interpret the update log
To avoid accidentally sending the same change again, it is recommended to clear the edit area after each update run. Select "Component Editor -> Clear Edit Area" to do so: