{"id":7224,"date":"2019-08-05T19:22:22","date_gmt":"2019-08-05T13:52:22","guid":{"rendered":"https:\/\/www.argildx.us\/?p=7224"},"modified":"2020-07-02T17:55:33","modified_gmt":"2020-07-02T12:25:33","slug":"on-deploy-scripts-an-acs-aem-commons-utility","status":"publish","type":"post","link":"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/","title":{"rendered":"On-Deploy Scripts \u2013 an ACS AEM Commons Utility"},"content":{"rendered":"<p>Developers need to perform certain tasks during deployment to AEM server. Component reauthoring is one of the major tasks for a developer making changes to existing components. In this article, we&#8217;ll talk about using <strong>on-deploy scripts<\/strong> to simplify reauthoring tasks in AEM.<\/p>\n<p><strong><u>Problem Statement:<\/u><\/strong><\/p>\n<p>If the component is to be configured on one or two pages, then reauthoring is simple. However, if the component needs to be configured on many pages, then it&#8217;s tedious for an author to reauthor the same component on every page.<\/p>\n<p>This is one of the scenarios in which we can use on-deploy script. Here is a list of problems we will try to solve.<\/p>\n<p><strong><u>What Problems are We Trying to Solve?<\/u><\/strong><\/p>\n<ul>\n<li>Running ad-hoc script manually<\/li>\n<li>Update the content without reauthoring<\/li>\n<li>Admin update that needs to do on all server<\/li>\n<li>Mass content updates<\/li>\n<li>One-time content creation<\/li>\n<li>Removing obsolete content<\/li>\n<li>Deleting all nodes of a particular resource type<\/li>\n<\/ul>\n<p><strong><u>Available Methodology to Solve the Above Problems<\/u><\/strong><\/p>\n<ol>\n<li>Using Servlet<\/li>\n<li>Using Ad-hoc scripts<\/li>\n<\/ol>\n<p><strong><u>Issues with Servlet or Ad-hoc Scripts<\/u><\/strong><\/p>\n<ul>\n<li>Security Risk<\/li>\n<li>Password Expose<\/li>\n<li>Anyone can execute<\/li>\n<li>Server remains in broken state till we run Ad-hoc script or if it fails<\/li>\n<li>Making sure you run scripts on deployment else existing functionality breaks<\/li>\n<li>Keeping track of scripts that have been run becomes difficult<\/li>\n<\/ul>\n<p>ACS AEM Commons provides a useful utility called \u201cOn-Deploy Scripts,\u201d which help developers create one-time scripts that execute upon deployment to an AEM server. This feature is available for <strong>v3.15.0 <\/strong>and higher versions of ACS-AEM Commons.<\/p>\n<p>So, to overcome this problem we can use On-Deploy Scripts.<\/p>\n<p><strong><u>Advantages of On-Deploy Scripts:<\/u><\/strong><\/p>\n<p>On-Deploy Scripts allows developers to create one-time scripts that execute upon deployment to an AEM server. Some advantages of this <strong>one-time script creation<\/strong> feature are given below.<\/p>\n<ul>\n<li>Fully automated<\/li>\n<li>Continuous integration gives you automatic testing on Pre-prod<\/li>\n<li>Scripts execute along with deployment &#8211; more broken state<\/li>\n<li>Automation removes chances for error<\/li>\n<li>Script status is preserved to be validated later<\/li>\n<li>Available with version v3.15.0<\/li>\n<\/ul>\n<p><strong><u>How To use:<\/u><\/strong><\/p>\n<ol>\n<li><strong>Install v3.15.0 or higher version ACS-AEM Commons<\/strong><\/li>\n<li><strong>Enable on-deploy script feature<\/strong>\n<ul>\n<li>Create OSGi configuration<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p>\u201ccom.adobe.acs.commons.ondeploy.impl.OnDeployExecutorImpl.xml\u201d<\/p>\n<pre>&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\r\n &lt;jcr:root xmlns:sling=\"http:\/\/sling.apache.org\/jcr\/sling\/1.0\"\r\n xmlns:jcr=\"http:\/\/www.jcp.org\/jcr\/1.0\"  jcr:primaryType=\"sling:OsgiConfig\"\/&gt;<\/pre>\n<ol start=\"3\">\n<li><strong>Implement Script Provider Service<\/strong>\n<ul>\n<li>Override the getScripts () method.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<pre style=\"padding-left: 80px;\">@Component(immediate = true, service= OnDeployScriptProvider.class, property = { \"name =service.description\", \"value =Developer service that identifies code scripts to execute upon deployment\"})\r\npublic class OnDeployScriptProviderImpl implements OnDeployScriptProvider {\r\n\u00a0\u00a0\u00a0 @Override\r\n\u00a0\u00a0\u00a0 public List&lt;OnDeployScript&gt; getScripts() {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return Arrays.asList(\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Add Script instances here e.g. new Script1(), new Script2(), new Script3()\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 );\r\n\u00a0\u00a0\u00a0 }\r\n}<\/pre>\n<ol start=\"4\">\n<li><strong>Create Script and Add Script Provider<\/strong>\n<ul>\n<li>Override execute () method<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<pre>public class ScriptUpdateProperty extends OnDeployScriptBase implements OnDeployScript {\r\n\u00a0\u00a0\u00a0 @Override\r\n\u00a0\u00a0\u00a0 protected void execute() throws Exception {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Node nodeUpdate = getOrCreateNode(\"content\/we-retail\/us\/en\/onDeployePage\/jcr:content\",\"cq:Page','cq:PageContent\");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 nodeUpdate.setProperty(\"sling:resourceType\",\"weretail\/components\/structure\/page\");\r\n\u00a0\u00a0\u00a0 }}<\/pre>\n<ol start=\"5\">\n<li>Make sure acs-commons-on-deploy-scripts-service user has all necessary permissions<\/li>\n<li>Just install the package<\/li>\n<li>Check status at \/var\/acs-commons\/on-deploy-script-status on crxde.<\/li>\n<\/ol>\n<p><strong><u>Demo:<\/u><\/strong><\/p>\n<p>A working demo present on bitbucket <a href=\"https:\/\/bitbucket.org\/argildx\/aemdev-meetup-s1\/overview\">https:\/\/bitbucket.org\/argildx\/aemdev-meetup-s1\/overview<\/a><\/p>\n<p><strong><em>Read our article about another <a href=\"https:\/\/www.argildx.us\/technology\/ensure-service-user-an-acs-aem-commons-utility\">ACS AEM Commons Utility, Ensure Service User<\/a><\/em><\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Developers need to perform certain tasks during deployment to AEM server. Component reauthoring is one of the major tasks for a developer making changes to existing components. In this article, we&#8217;ll talk about using on-deploy scripts to simplify reauthoring tasks in AEM. Problem Statement: If the component is to be configured on one or two &#8230; <a title=\"On-Deploy Scripts \u2013 an ACS AEM Commons Utility\" class=\"read-more\" href=\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/\">Read more<\/a><\/p>\n","protected":false},"author":29,"featured_media":7226,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","content-type":"","footnotes":""},"categories":[66],"tags":[1619,1620,1621],"yst_prominent_words":[1011,366,1008,1009,1012,1003,1010,1013,1001,996,1002,998,1005,1007,1000,1014,999,1006,1004,997],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v14.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>On-Deploy Scripts \u2013 an ACS AEM Commons Utility - Argil DX<\/title>\n<meta name=\"description\" content=\"Use on-deploy scripts in place of ad-hoc scripts to reauthor bulk components. You can create one-time scripts that automatically execute upon deployment.\" \/>\n<meta name=\"robots\" content=\"index, follow\" \/>\n<meta name=\"googlebot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta name=\"bingbot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"On-Deploy Scripts \u2013 an ACS AEM Commons Utility - Argil DX\" \/>\n<meta property=\"og:description\" content=\"Use on-deploy scripts in place of ad-hoc scripts to reauthor bulk components. You can create one-time scripts that automatically execute upon deployment.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/\" \/>\n<meta property=\"og:site_name\" content=\"Argil DX\" \/>\n<meta property=\"article:published_time\" content=\"2019-08-05T13:52:22+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-07-02T12:25:33+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.argildx.us\/wp-content\/uploads\/2019\/08\/card.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"431\" \/>\n\t<meta property=\"og:image:height\" content=\"227\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.argildx.us\/#website\",\"url\":\"https:\/\/www.argildx.us\/\",\"name\":\"Argil DX\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/www.argildx.us\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/#primaryimage\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/www.argildx.us\/wp-content\/uploads\/2019\/08\/card.jpg\",\"width\":431,\"height\":227,\"caption\":\"a perpendicular cylinder breaking up into puzzle pieces\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/#webpage\",\"url\":\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/\",\"name\":\"On-Deploy Scripts \\u2013 an ACS AEM Commons Utility - Argil DX\",\"isPartOf\":{\"@id\":\"https:\/\/www.argildx.us\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/#primaryimage\"},\"datePublished\":\"2019-08-05T13:52:22+00:00\",\"dateModified\":\"2020-07-02T12:25:33+00:00\",\"author\":{\"@id\":\"https:\/\/www.argildx.us\/#\/schema\/person\/1c5b6f3f2f7218d9acb851588b98551f\"},\"description\":\"Use on-deploy scripts in place of ad-hoc scripts to reauthor bulk components. You can create one-time scripts that automatically execute upon deployment.\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.argildx.us\/technology\/on-deploy-scripts-an-acs-aem-commons-utility\/\"]}]},{\"@type\":[\"Person\"],\"@id\":\"https:\/\/www.argildx.us\/#\/schema\/person\/1c5b6f3f2f7218d9acb851588b98551f\",\"name\":\"Argil DX Media\",\"image\":{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/www.argildx.us\/#personlogo\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/0ccbc04705942d1269cdf9f789e58484?s=96&d=mm&r=g\",\"caption\":\"Argil DX Media\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","_links":{"self":[{"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/posts\/7224"}],"collection":[{"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/users\/29"}],"replies":[{"embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/comments?post=7224"}],"version-history":[{"count":0,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/posts\/7224\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/media\/7226"}],"wp:attachment":[{"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/media?parent=7224"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/categories?post=7224"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/tags?post=7224"},{"taxonomy":"yst_prominent_words","embeddable":true,"href":"https:\/\/www.argildx.us\/wp-json\/wp\/v2\/yst_prominent_words?post=7224"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}