How to retrieve parent component object from a localized component using Tom.Net API?

Question

I have a localized Component in one of the child Publications. I would like to know the parent Component from which the current Component has been localized.

This code will be executed in an event handler. Any guidance in the TOM.Net API or a code snippet on how to achieve this scenario would be very much helpful.

Answer 1

Please use the below method to get the parent Component from which the current Component been localized. This method been already validated. Blueprint chain filter just denotes the parent component if the current component is not localized; also it list down only the items in Down direction of blueprinting hierarchy. So please use the below method which uses the UsedItemsFilter concept. Hope this fulfills your requirement.

 private Component GetParentComponent(Component component)
    {
        UsedItemsFilter usedItemFilter = new UsedItemsFilter(component.Session)
        {
            IncludeBlueprintParentItem = true,
            ItemTypes = new Tridion.ContentManager.ItemType[] { ItemType.Component },
            BaseColumns = ListBaseColumns.Id
        };
        IEnumerable<IdentifiableObject> usedItems = component.GetUsedItems(usedItemFilter);
        if (usedItems == null) return null;
        usedItems = usedItems.Where(usedItem => usedItem.Id.ItemId.Equals(component.Id.ItemId));
        if (usedItems == null) return null;
        return usedItems.FirstOrDefault() as Component;
    }

Answer 2

It would definitely help if you just read the API documentation, but here is some sample code that should give you an idea:

[TcmExtension("ExampleEventHandlerExtension")]
public class EventHandler : TcmExtension {
  public EventHandler() {
    EventSystem.Subscribe<Component, SaveEventArgs>(ComponentSaveAction, EventPhases.Processed);
  }

  public static void ComponentSaveAction(Component subject, SaveEventArgs args, EventPhases phases) {
    // the TCMURI of the Publication from this item
    TcmUri contextRepository = subject.ContextRepository.Id;

    // the TCMURI of the Publication where this item was localized
    TcmUri owningRepository = subject.OwningRepository.Id;

    if (subject.IsLocalized) {
      BluePrintChainFilter filter = new BluePrintChainFilter(subject.Session) {
          Direction = BluePrintChainDirection.Up
        };

      // the TCMURI of the Publication where this item was created
      owningRepository = new TcmUri(subject.GetBluePrintChain(filter).Last().Id.ContextRepositoryId, ItemType.Publication);
    }

    // build TcmUri of parent Component
    // (note using ItemId of owningRepositiory as a PublicationId, 
    //  since that is a Publication TcmUri)
    TcmUri uri = new TcmUri(subject.Id.ItemId, subject.Id.ItemType, owningRepository.ItemId);

    // load parent Component
    Component parent = new Component(uri, subject.Session);
  }
}

Note I didn't test any of this, it is just an example to give you an idea of what you can use, please read the API documentation for every method shown here to see if it indeed is what you require.

If you need the same info via the Core Service see my answer to How to get the owning publication of a component via the Core Service?

update

@Josh was right, it needs to be direction Up and Last(), so updated my code accordingly.

Answer 3

From CoreService you can retrieve the information.

var component = client.Read("tcm:5-25", defaultReadOptions);
var componentInOriginalContext = client.Read(component.BluePrintInfo.PrimaryBluePrintParentItem.IdRef, defaultReadOptions);

This will return the most root item from anywhere in blueprint regardless the source is shared/localized.

Answer 4

I recently ran into the same problem you are experiencing so I wrote the following helper method. Hopefully this helps you out. Essnetially, I use '.getBluePrintChain' to scan up the blueprint, and then calculate the lowest publication ID which we will use to construct the 'root' component.

// Scan up the blueprint to find the root component. This method will find the
// first instance in the blueprint of a component, which we will call the root.
public Component FindRootComponent(Component component)
{
    BluePrintChainFilter filter = new BluePrintChainFilter(component.Session);
    filter.Direction = BluePrintChainDirection.Up;
    var blueprintScanUp = component.GetBluePrintChain(filter);

    // Calculate the lowest pub ID in the tree, which will be our root.
    List<int> publicationIDs = new List<int>();
    foreach (RepositoryLocalObject blueprintNode in blueprintScanUp)
    {
        publicationIDs.Add(blueprintNode.Id.PublicationId);
    }
    int rootPubID = System.Linq.Enumerable.Min(publicationIDs);

    // Construct the component to be returned.
    TcmUri returnedId = new TcmUri(component.Id.ItemId, ItemType.Component, rootPubID);
    if (!component.Session.IsExistingObject(returnedId)) return null;
    Component returnedComponent = component.Session.GetObject(returnedId) as Component;
    if (returnedComponent == null) return null;
    else return returnedComponent;
}

Answer 5

besically, you need find parent publication. because ItemId is always same in all publications("tcm:publicationID-ItemID"). Appending parent publication to ComponentId(ItemID) will solve the issue.

Below Code could help:

Component tcmComponent = (Component)engine.GetObject("tcm:x-y-z");
tcmComponent.OwningRepository

Answer 6

Component.GetBluePrintChain method with filter parameter may help.