Customizing Cloud Service configuration in AEM

-
There are many cloud services provided out of the box to connect aem with the adobe marketing cloud & third party services.
You can access cloud services by Cloud Services





Some of the mostly used cloud service configurations are:-
  • DTM
  • Adobe Target
  • Adobe Analytics
  • Adobe Campaign
  • Livefyre
  • Facebook Connect
  • Twitter Connect
  • Youtube 
  • reCaptcha
Most useful and strong feature of Cloud Service is that it allows inheritance from parent pages to child pages with the ability to break the inheritance at any level.So You can provide configuration at site top level/root page and all the child pages can use the same configuration by default.
If you want to change the configuration at any level you can create a separate configuration for that page or simple uncheck the inheritance at child lev
You can configure cloud service like this and can use at page level.

1:-Click on Configure now to create a new configuration.Give Name and title and click on create.

























2:- Fill the required details and your new configuration is ready to use on any page.

3: Open page properties of site root page or page where you want to use these properties and go to Cloud Services Tab.


Creating Custom Cloud Service:-

We can also create a custom cloud service for our project use case where we want to connect our website with some third party product which is not the part of listed third party cloud services in http://localhost:4502/libs/cq/core/content/tools/cloudservices.html

Steps to create a new cloud Service:-
To create a new custom cloud service follow below steps.

 1:- Go to http://localhost:4502/crx/de/index.jsp
2:- In your project hierarchy  Select Create --> Create Component... 


3:-Provide following in the Create component dialog.
  • Label: testcloudpage
  • Title: Test Cloud Service Page
  • Super Type: cq/cloudserviceconfigs/components/configpage
  • Group: .hidden

4:-Suppose our test cloud service will have three field named field1,field2 & field3 as configurable.
So create a new file content.jsp under component created.
add following content.



5:- Create a dialog which will have three text boxes to take values for Field1,Field2 & Field3.



6:-Now copy /libs/cq/cloudserviceconfigs/components/configpage/body.jsp to  your created component parallel to content.jsp & remove testcloudpage.jsp.

7:- Create a new template under /apps/test-project/templates which will use this page component just created for cloud service.


  • Resource Type = path of your created component:test-project/components/pages/testcloudpage
  • Label = testcloudservice
  • Title = Test Cloud Service Template
  • allowedPath = /etc/cloudservices/testcloudservice(/.*)?
  • allowedChildren = /apps/yourproject/templates/testcloudservice
  • sling:resourceSuperType = cq/cloudserviceconfigs/templates/configpage (on template node, not the jcr:content node)


8:- Go to http://localhost:4502/miscadmin#/etc/cloudservices and create a new page:



    • Title: Test Cloud Service
    • Name: testcloudservice
  • 9:- Navigate to the newly created Service page direct by http://localhost:4502/etc/cloudservices/testcloudservice.html) and click the + to create a new config:
    • Parent Configuration: /etc/cloudservices/testcloudservice
    • Title: Test Cloud Service Configuration
    • Name:TestCloudServiceConfiguration
     click Create.
  • 10:- Provide required values in the respective Fields and click OK.Your new configuration is ready to use on page.

  • 11:-You can also check your newly created cloud service inside http://localhost:4502/etc/cloudservices.html under Third Party Services.

  • 12:-Navigate to a page and add the newly created configuration in the page properties, under the Cloud Services tab.

































    • How to use cloud service configuration values:-
    You can use code below to retrive configuration values and can use accordingly.

    final String[] services = getInheritedPageProperties().get("cq:cloudserviceconfigs", String[].class);
    final ConfigurationManager cfgMgr = getResourceResolver().adaptTo(ConfigurationManager.class);
    if (cfgMgr != null) {
    final Configuration testCloudConfig = cfgMgr.getConfiguration("testcloudservice", services);
    if (testCloudConfig != null) {
    final String field1 = testCloudConfig.get("field1", StringUtils.EMPTY);
    final String field2 = testCloudConfig.get("field2", StringUtils.EMPTY);
    final String field3 = testCloudConfig.get("field3", StringUtils.EMPTY);
    }
    }


    Hope this helps!




    Comments

    1. Anonymous9 October 2019 at 11:59

      Hi,

      How can I handle the event on the "Ok" button from the pop-up in which you introduce the configuration? I need to add some extra logic besides the saving process that is behind that button.

      ReplyDelete

    Post a Comment

    Popular posts from this blog

    AEM Scheduler

    -
    Image
    AEM Scheduler is a service which is used to schedule jobs in AEM Application. We can write a scheduler service in AEM by two different ways. 1:- Using Scheduler API 2:- Using Whiteboard Pattern We can create our scheduler class using SCR Annotaions or using New OSGi R6 Annotaions. From AEM 6.2 SCR Annotations are deprecated now.So we will only use OSGi Annotaions to create our scheduler. Writing scheduler class using Whiteboard Pattern:- In this case we will use the normal Java thread API to schedule a job. In example below we are scheduling a job for every 2 seconds. We have given cron expression as */2 * * * * ?. We can take help of  http://www.cronmaker.com/  to create your cron expression easily. package com.adobe.aem.saurabhaem.core.schedulers; import org.osgi.service.component.annotations.Activate; import org.osgi.service.component.annotations.Component; import org.osgi.service.metatype.annotations.AttributeDefinition; ...
    Read more

    Event Handling in AEM

    -
    There are multiple ways of handling events in AEM. All the methods have their own pros &cons. 1:- JCR Level Event Handling Using Event Listener 2:- Sling Level using Event Handlers 3:  Workflows & Launchers 4:- Using Scheduler Service Handling  JCR Level Event u sing Event Listener:- This is the lowest level event handling which listens to below JCR level events When a node was added When a node was moved When a node was deleted When a property was added to a node When a property was changed When a property was deleted We can write a custom  handler to handle these  events by implementing  javax.jcr.observation. EventListener   interface & registering an event using ObservationManager object. ObservationManager allows for the registration and deregistration of event listeners.It has methods like :- 1:- addEventListener(EventListener listener, int eventTypes, java.lang.String absPath, boolean isDeep, java.lang.String[] ...
    Read more

    AEM Sling Servlet

    -
    Image
    We can register our servlet as an OSGI service in AEM. There are two types of Servlet supported in AEM. 1:- Sling Safe Methods Servlet (GET, HEAD):-    Servlet implementation that responds to “Safe” HTTP Requests. It is a Read only Implementation & only supports GET &Head method. java.lang.Object javax.servlet.GenericServlet org.apache.sling.api.servlets.SlingSafeMethodsServlet public class DemoServlet extends SlingSafeMethodsServlet 2:- Sling All Methods Servlet (GET, HEAD, POST, PUT, DELETE):-  Servlet implementation that responds to all HTTP methods. Primarily used for POST Requests. java.lang.Object javax.servlet.GenericServlet org.apache.sling.api.servlets.SlingSafeMethodsServlet org.apache.sling.api.servlets.SlingAllMethodsServlet public class DemoServlet extends SlingAllMethodsServlet How to declare Sling Servlet in AEM:- There are couple of ways to declare sling servlet in AEM. 1:- Old way of...
    Read more