Skip to main content

DynamicContent REL Tag Addition to OData Query Extension

Image
By
The current post is a follow-up of the previous OData Query Extension I had developed for Tridion 2011 and 2013:
The code for this version is available in my GitHub project, distributable JAR (odata-query-extension-1.3.jar).

DynamicContent REL Tag

This tag queries for dynamic Component Presentations using the CD API Query and Criterias. It accepts the following attributes:

<tridion:dynamiContent var="name" filter="expr" orderby="expr" top="int" skip="int"
    componentTemplate="tcmuri" />

, where:
  • var - name of the TransformContext variable that would hold the result. If var is specified, the resulting array of ComponentPresentation objects is stored into the TransformContext; otherwise, the DCPs are output one after the oter;
  • filter - expression specifying the Criterias to query by. The format of this attribute is the same as the $filter query parameter presented in URL Syntax for OData Query Extension;
  • orderby - expression specifying the order to sort results by. The format of this attribute is the same as the $orderby query parameter presented in URL Syntax for OData Query Extension;
  • top - if specified, only returns the first top results;
  • skip - if specified, skip the first skip results;
  • componentTemplate - if specified, only return Component Presentations based on this Component Template;
Example:
<tridion:dynamicContent filter="ItemModificationDate gt '2013-05-01 13:24:56.999'"
    orderby="ItemTitle ItemModification asc" />

Configuration

  • Copy the JAR (odata-query-extension-1.3.jar) to your WEB-INF/lib folder (or /bin/lib for .NET installations);
  • Edit your cd_dynamic_conf.xml and add the following line just below the <TCDLEngine>:
    <TagBundle Resource="odata-query-extension.xml" />

Save the Good Part Last - The Code

DynamicContentTagRenderer Class

@Override
public int doStartTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target)
        throws TCDLTransformerException {
    DynamicContent dynamicContent = new DynamicContent(parametersMap);
    dcps = dynamicContent.queryComponentPresentations();

    return dcps.length > 0 ? Tag.CONTINUE_TAG_EVALUATION : Tag.SKIP_TAG;
}

@Override
public String doEndTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target)
        throws TCDLTransformerException {
    if (var == null) {
        int publicationId = dcps[0].getPublicationId();
        ComponentPresentationAssembler assembler = new ComponentPresentationAssembler(publicationId);
        for (ComponentPresentation dcp : dcps) {
            tagBody.append(assembler.getContent(dcp.getComponentId(), dcp.getComponentTemplateId()));
        }
    } else {
        context.set(var, dcps);
    }

    return tagBody.toString();
}

DynamicContent Class


public DynamicContent(Map<String, String> attributes) {
    setComponentTemplate(attributes.get(COMPONENT_TEMPLATE));
    QueryBuilder builder = new QueryBuilder(attributes);
    query = builder.getQuery();
}

public ComponentPresentation[] queryComponentPresentations() {
    List<ComponentPresentation> result = new ArrayList<ComponentPresentation>();

    try {
        String componentTcmUris[] = query.executeQuery();
        log.debug("Query found " + componentTcmUris.length + " Components");
        if (componentTcmUris.length == 0) {
            return new ComponentPresentation[0];
        }

        TCMURI tcmUri = new TCMURI(componentTcmUris[0]);
        int publicationId = tcmUri.getPublicationId();
        String templateTcmUri = getTemplateTcmUri(publicationId);

        ComponentPresentationFactory factory = new ComponentPresentationFactory(publicationId);
        ComponentPresentation componentPresentation;

        for (String componentTcmUri : componentTcmUris) {
            if (templateTcmUri == null) {
                componentPresentation = factory.getComponentPresentationWithHighestPriority(componentTcmUri);
            } else {
                componentPresentation = factory.getComponentPresentation(componentTcmUri, templateTcmUri);
            }
            if (componentPresentation != null) {
                result.add(componentPresentation);
            }
        }
    } catch (StorageException se) {
        log.error("StorageException occurred", se);
    } catch (ParseException pe) {
        log.error("ParseException occurred", pe);
    }

    return result.toArray(new ComponentPresentation[0]);
}


Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as...
2 comments
Read more

Toolkit - Performance

By
This post if part of a series about the File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents performance data that was captured for each major functionality with and without caching Linking, CP Assembler, Component Presentation Factory, Dynamic Content Queries, Model Factory. The data was captured on a 2014 Macbook Pro 15", 16 GB RAM, 2.6 GHz Intel Core i7 running OS X El Capitan. Test methodology: each test was run for 3 minutes and the total number of successful Toolkit API calls was measured. Then the number of calls per second was computed 'with cache' and 'without cache' test runs. Then a cache boost factor was calculated by diving (the number of API calls with cache) / (number of API calls without cache). Each cache test was executed 3 times, with different cache time-to-live values of 1 second, 5 seconds and 0 seconds (eternal cache, no expiration). The rationale is to see what impact different cache expiration/evi...
Post a Comment
Read more

Debugging a Tridion 2011 Event System

By
OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven...
7 comments
Read more