User Story Metadata Index

Updated 1 month ago by Copado Solutions


The User Story Metadata Index feature is used to track metadata components that have been added/committed to user stories. This index consists of records of the User Story Metadata object. Each of these records associates a metadata component with a user story. 

The index is updated provided that the Index Metadata checkbox in the user story’s project is checked. The Overlap Awareness feature will check whether the metadata or Git metadata added to user stories have potential conflicts.

When a potential conflict is found with a metadata component, the status of the conflicting user story metadata will be updated to Potential Conflict. You will find the indexed metadata in the User Story Metadata related list in the user story layout:

You can click on any user story metadata in the related list to see a list of user stories that share the same metadata component:

You can also create a pull request between the feature branches of user stories with potential conflicts in order to review if changes are mergeable or have conflicts. If there are conflicts, you can start a discussion with the developer/admin/business user that has ownership of the other user story to discuss and agree on how the conflict should be resolved.

The status of each user story metadata can be updated by clicking on the drop-down menu icon in each record:

The status of all the user story metadata records can be updated at once by selecting a status from the Mark All As drop-down list:

The status picklist values are defined in the Status custom field of the User Story Metadata object, and you can add custom values to it.

Metadata Index Update


The metadata index for each user story is updated automatically whenever a metadata component is added or committed in the user story. 


You can schedule periodic updates of all your metadata index by scheduling an Apex class called 'IndexMetadataJob'. To schedule it go to Setup > Develop > Apex Classes and then click on Schedule Apex. Choose a name (e.g. metadata index), select the class 'IndexMetadataJob' and set the period as needed: 


To execute the index metadata job manually follow these steps:

  1. Open the Developer Console -> Debug -> Open Execute Anonymous Window.
  2. Copy and paste the following line of code:
    1. Id batchJobId = database.executebatch(new copado.IndexMetadataJob(), 50);
  3. Click on Execute.
    1. The execution of the job usually takes between 1 to 5 minutes depending on the amount of user stories you have. 
      • After this time has passed, you can rerun the report to update the values, and you will find the updated User Story Metadata related list within every user story.
      • You can also track the execution of the job by going to Setup -> Monitor -> Jobs -> Apex Jobs.


You can create a report with the User Story and User Story Metadata objects.

The image below is an example of a report that shows the user stories where the same metadata components are included:

You can add custom filters to the report and customize it depending on your needs. For instance, you can exclude user stories with status Completed.

How did we do?