Saturday, December 15, 2018

Different approaches to dynamically include custom scripts into websites - Adobe Experience Manager(AEM)

The standard way to include a client-side library (that is, a JS or CSS file) in the HTML of a page is simply to include a <script> or <link> tag for that page, containing the path to the JS or CSS files. For example

<script type="text/javascript" src="/etc.clientlibs/clientlibs/test.js"></script>

Even the inline scripts can be added to the page

document.getElementById("demo").innerHTML = "Hello JavaScript!";

While these approaches work in AEM by adding the client-side library as a link or inline to the page components, AEM provides Client-side Library Folders, which allow you to store your client-side code — JavaScript and CSS in the repository, organize it into categories, and define when and how each category of code is to be served to the client. The client-side library system then takes care of producing the correct links in your final webpage to load the correct code.

<sly data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html"
data-sly-call="${clientlib.all @ categories=['myCategory1', 'myCategory2']}"/>

The generated HTML page contains the reference to the final script URL

<script type="text/javascript" src="/etc.clientlibs/clientlibs/test.js"></script>

Sometimes we may need to include scripts dynamically into the websites without changing the code, this tutorial will explain the different approaches to include the scripts dynamically in the websites without performing the code changes.

Tag Manager:

Tag management software simplifies and unifies the management and maintenance of tags — A tag is a short snippet of code across, all digital properties. Inject the custom scripts remotely by enabling container on the pages, this will provide better management of tags without changing the code.

You can use any one of the tag managers in the market to include the custom scripts into the page. GTM and Adobe Launch are the two popular tag management system in the market.

GTM(Google Tag Manager) — Refer to the below URL for more details on injecting the custom script through GTM.

Adobe Launch- Refer to the below URL for more details on injecting the custom script through Adobe Launch.

AEM Custom Component:

In this approach define a custom component and include that wherever required in the page to inject the custom scripts and HTML dynamically.

Let us now enable a custom component e.g OpenHTML that will include the scripts to the page.

The component should be enabled with the required dialog to configure the custom scripts and HTML

Add the following content into openhtml.html

<sly data-sly-test.editor="${wcmmode.edit}">
</sly><!-- Open HTML component -->
${properties.openhtml @ context='unsafe'}
<!-- end of Open HTML component -->

Drag and drop the component to the parsys on the required website and configure the script — make sure the script/HTML is valid and all the tags are closed.

In Edit mode the place holder string “Open Html” is displayed

Now author the required scripts and HTML— ensure the script/HTML is valid otherwise the page may break

Now the HTML content and the script is included into the website page

AEM Cloud configuration:

This approach uses the custom AEM Cloud Configuration to include the dynamic scripts — header and footer to the website

Define a custom Cloud configuration to enable the header and footer scripts, attach the cloud configuration to the required websites to inject the custom dynamic scripts. Even you should be able to manage the scripts through page properties or through an external configuration page.

Refer to the following URL for the sample cloud service that enables the configuration option for header and footer scripts.

Add the below line to the header file(e.g /apps/wknd/components/structure/page/customheaderlibs.html) of your page rendering component — this will display the header script configured in the generic-script cloud configuration to head section

<sly data-sly-include="/apps/utilities/cloudserviceconfigs/components/servicelibs/serviceheaderlibs.jsp" />

Add the below line to the footer file(/apps/wknd/components/structure/page/customfooterlibs.html) of your page rendering component — this will display the footer script configured in the generic-script cloud configuration to the end of the body section

<sly data-sly-include="/apps/utilities/cloudserviceconfigs/components/servicelibs/servicefooterlibs.jsp" />

Create a service user with the name “script-service” and enable the read access for “/apps/utilities” and “/etc/cloudservices/generic-script”

Add an entry in “Apache Sling Service User Mapper Service Amendment” for “script-service” — “customcloudservice.core:script-service=script-service”

Create a configuration page of type “generic-script” e.g sample-script through http://localhost:4503/libs/cq/core/content/tools/cloudservices.html and configure the required head and footer scripts.

Configure the cloud configuration in parent page properties

Now the website displays the header and footer scripts

This covers some of the feasible options to dynamically include the scripts into the pages without modifying the code, even some of the other options e.g configure through separate site-specific configuration pages, enable through page properties dialog, etc can be used based on the requirement.

How to include a dynamic custom script to websites through Adobe Launch - Adobe Experience Manager(AEM)

Launch, by Adobe is a next-generation tag management system that unifies the client-side marketing ecosystem by empowering developers to build integrations on a robust, extensible platform that partners, clients, and the broader industry can build on and contribute to.

Adobe Launch is the upgraded version of Adobe’s Dynamic Tag Manager (DTM), Adobe’s Dynamic Tag Manager (DTM) will be replaced by Adobe Launch (It doesn’t mean the platform will be shut down anytime soon).

This post explains the approach to use Adobe Launch to include the dynamic scripts as part of Adobe Experience Manager (AEM) websites, the same steps can be followed to include the scripts into the websites hosted on a different platform.

Define Property:

A property, or web property, is a collection of rules, data elements, configured extensions, environments, and libraries.

Log in to Adobe Launch and create new property- LAUNCH_CUSTOM_SCRIPT, specify the domain as localhost.local for localhost testing and Save the Property(add the other website domains where this script need to be enabled).

Define New Rule:

The launch is a rule-based system. It looks for user interaction and associated data. When the criteria outlined in your rules are met, the rule triggers the extension, script, or HTML you identified.

Create a new rule and configure the Event Type as “DOM Ready”, the event is what you want the rule to look for, this is defined by choosing an event, any applicable conditions, and any exceptions

Configure the Action — When the criteria outlined in your rules are met and conditions are satisfied, the actions you define are executed in order.

Select the Action Type as “Custom Code”, Select Language as “JavaScript”

Define the required script in the “Script Editor”, I am just enabling some sample script to display an alert on page load but you can insert the required custom script.

var s = document.createElement("script");
s.innerHTML = "alert('Custom Script from GTM');"; // add the custom script content
//s.src="test.js";// specify the script file instead of script content

Adding multi-line script — example

s.innerHTML = "document.onreadystatechange = function(){ "+
"if(document.readyState=='loaded' || document.readyState=='complete') "+

Approval Workflow:

New properties are created with three environments: one Development, one Staging, and one Production. This is enough to run the publishing workflow. If desired, you may add additional Development environments. This is most common on larger teams with multiple developers working on different projects at the same time.

The approval flow is going to be like below for the properties

Different Launch artifacts can exist in each Environment. This allows you to test different Libraries in different environments as you push them through your Workflow.

Extensions, rules, and data elements are building blocks. When you want to make your application do something, these building blocks are added to a Library. This Library is then built to produce the actual artifacts that are used by your application.

When you create a Library, you must assign it to an Environment. Each Environment corresponds to a different state in the Publishing workflow.

Publish the change to the Development environment:

“Add New Library” to apply the changes to Development Environment

Select the Environment value as Development

Add Specific Resource or All changed Resources to Library for Deployment to Development environment (to deploy the latest change to the Development environment, remove the current version from Library and add the latest version)

Select the Resource (CUSTOM_SCRIPT rule) Version (Latest) and Create New Revision and finally Save the Library.

Click on Apply Updates and Continue (this is required only for the first time)

Build the library for Development

Now the changes are deployed to Development Environment

To apply the new changes (latest pending changes) to the Development environment, remove the current version from the Library (My case Revision 2)

Add the latest resource version and Click on Select&Create New Revision

Click on Save & Build for Development

Now the latest rule change is deployed to Development Environment

For testing the Property in a Development environment, install the Development script to the AEM(Adobe Experience Manager) website header.

(Multiple Development Environment can be added for testing)

Copy the script to clipboard

Add the script to the head section of the website pages (The script can be added through Adobe IO integration for AEM, I am directly enabling the script through CRXDE for demo)

Now the script is inserted into the website pages, the alert box is displayed on every page load

Publish the changes to Stage and Prod environments:

Click on Submit for Approval on Library

Click on Submit

Click on Build for Stage

Now the changes are deployed to Stage

Click on Approve for Publishing to publish the changes to Production Environment

Click on Approve

Build & Publish to Production

Click on Publish

Now the changes are published to the Production environment.

Configure the Stage and Production environment scripts to corresponding Website(AEM) environments(Stage and Prod)

Add New Library and follow the process explained above to send the additional changes to Development to Production Environments

How to include dynamic custom script to websites through GTM(Google Tag Manager) - Adobe Experience Manager(AEM)

How to include dynamic custom script to websites through GTM(Google Tag Manager) - Adobe Experience Manager(AEM)

Google Tag Manager is a tag management system that allows you to quickly and easily update tracking codes and related code fragments collectively known as "tags" on your website or mobile app. Once a small segment of Tag Manager code has been added to your project, you can easily configure and deploy your tag configurations from a web-based user interface without the need to deploy additional code in most cases. This reduces errors and frees you from having to involve a developer every time you need to make changes.

This post explains the approach to use Google Tag Manager(GTM) to include the dynamic scripts as part of Adobe Experience Manager(AEM) websites.

Create a free google tag manager account if one is not available


Install the GTM header and body scripts to the AEM website



Copy the head script to the header file and body script to body footer(start of body section)




Thursday, December 6, 2018

How to use Attribute Loader in Adobe Search and Promote

How to use Attribute Loader in Adobe Search and Promote

This tutorial explains the details on how to use Attribute Loader in Adobe Search and Promote.

Attribute loader help us to provide additional meta data to the URL’s crawled from website.

For example, the PDF’s document crawled from the website will not have any additional metadata specified but the additional metadata can be loaded through Attribute Loader.

e.g while crawling the pdf document from website it will be possible to provide only pdf URL and file name but will not be able to provide the additional details like title, description etc, these additional metadatas can be provided via Attribute Loader.

The values will be merged during indexing through primary key value.

PDF URL Crawled from website —

Additional Meta Data-

url- key)
Tittle — test PDF
Description — test PDF

The Attribute Loader is executed before actual indexing and the metadata data values are merged based on the primary key during indexing.


Attribute Loader option is available under Settings → Metadata →Attribute Loader


Add new Attribute Loader definition


Sample Feed XML with additional meta data , the data should be available through any one of the following channel — HTTP(S),FTP, sFTP and File

The meta data for each PDF document is represented by Item tag in the XML data

<attributes xmlns:xs=”" version=”2.0">


<title>Attribute Loader Feed</title>


<title>test PDF1</title>

<desc>test PDF1</desc>




<title>test PDF2</title>

<desc>test PDF2</desc>





Enter the Feed details to the Attribute Loader


Map the Feed data fields to the Adobe S&P meta data definitions, specify a primary key to map the attribute loader data with the data crawled from other channels e.g website. Here the PDF URL is considered as a primary key, the URL is available through both website and Attribute Loader feed.

The Attribute Loader data is merged to the document based on the primary key during the indexing.


The Attribute Loader data can be previewed after configuration, to preview the Attribute Loader Data — Click on Load Attribute Loader Data then Start Load


Click on Start Load, this will show the preview of the data loaded from the feed


Make sure the Content-Types for the required document types(e.g application/pdf) are selected to enable the crawler to crawl those document types from website — the documents for those the Content Types enabled will be crawled from the website

The Content Types can be enabled from Settings → Crawling →Content Types


Configure the URL entrypoint — website URL from where the documents should be crawled and the URL mask — the matching URL that should be considered for crawling.

Settings →Crawling →URL Entrypoints


The URL mask can be enabled from Settings →Crawling →URL Masks


Sample URL



<a href=”">test1 pdf

<a href=”">test2 pdf



Run the live index by configuring the website URL entrypoint that has the reference to PDF documents, now the search result displays the metadata provided by Attribute Loader for PDF documents

The Attribute Loader is not enabled by default, this should be enabled in S&P account by your Adobe account representative or by Adobe Support.

The attribute loaders add the capability to provide additional meta data to the documents crawled through a channel that is enabled with limited data.