Simplified AEM Automation with cURL and RUBY | TO THE NEW Blog

Simplified AEM Automation with cURL and RUBY | TO THE NEW Weblog

Directors usually must automate or simplify frequent duties inside any system. In Adobe Expertise Supervisor (AEM), managing customers, putting in packages, and managing OSGi bundles are a number of the duties the place automation is usually required.
Due to the RESTful nature of the Sling framework upon which AEM is constructed, a lot of the duties will be decreased to a URL name. cURL can be utilized to execute such URL calls and will be proved as a great tool for automation inside an AEM setting.

cURL stands for Shopper for URL and is an open-source command-line device used to carry out URL manipulations. It helps a variety of web protocols together with HTTP, HTTPS, FTP, FTPS, SCP, SFTP, TFTP, LDAP, DAP, DICT, TELNET, FILE, IMAP, POP3, SMTP, and RTSP.
Initially launched in 1997, cURL is a well-established and widely-used device for offering or receiving knowledge utilizing the URL syntax.

cURL comes by default in a lot of the programs, nevertheless, it may be downloaded and put in from the hyperlink right here.
Home windows customers want to make sure that they’ve appended the setting variable ‘path’ with the trail of the bin the place cURL is put in. The stepwise course of is talked about beneath.

  1. Open the Begin Search, kind in “env”, and select “Edit the system setting variables”.
  2. Click on the “Atmosphere Variable” button.
  3. Below the “System Variables” part (the decrease half), discover the row with “Path” within the first column, and click on edit.
  4. The “Edit setting variable” UI will seem. Click on on “New” and sort within the new path you wish to add.


Since AEM follows REST structure, cURL can execute most duties utilizing a URL name.
cURL will be helpful with regards to content material manipulation duties reminiscent of activating pages, beginning workflows and operational duties reminiscent of bundle administration and managing customers. As well as you possibly can create your individual cURL instructions for a lot of the duties in AEM.
The official hyperlink for some frequent AEM cURL instructions is right here.
A cheat sheet can also be out there for reference.

cURL instructions will be constructed for many operations in AEM reminiscent of triggering workflows, checking OSGi configurations, triggering JMX instructions, creating replication brokers, and many others.
To seek out the precise command wanted for a selected operation, use the developer instruments in your browser to seize the POST name to the server while you carry out the AEM operation manually.
Now, let’s see the best way to create the cURL command for giving path particular learn/modify entry to a consumer.

  1. Put together the motion you want to invoke inside AEM. In our case, we’ve got proceeded to the /useradmin web page to handle customers.
  2. Go to the developer console or Proper click on and choose examine after which go to the community tab.
  3. Choose the permissions that you simply wish to give to the consumer for the required path after which click on save. Right here, we are going to proceed with learn/modify permissions for /and many others path (observe the POST name).
  4. Copy the URL from the POST name within the header part.
    Request payload from request part. This would be the knowledge parameter for our cURL command.
  5. Execute the cURL command by way of command line and examine the response.

Though cURL is the go-to device for administration API testing in AEM and has quite a lot of documentation established round it, it has its flaws when it comes to automation and dependency to shell. These flaws can create obstacles whereas writing server- unbiased and sophisticated scripts.

  • Inconsistent response payload sorts
    cURL response sorts fluctuate when it comes to utilization. This creates a scarcity of uniformity when writing scripts that make the most of response payloads. As seen within the final instance above, the response for updating permission was in HTML.
    Nonetheless, the response for activating an OSGi bundle, for instance, is in JSON.
    And the response for itemizing packages in crx is in XML.
  • Unreliable standing codes
    Among the standing codes which might be returned as a response are sometimes unreliable. Listed here are some examples:
    • http 200 with empty response physique
 when authentication is invalid
    • http 200 with error message in html response physique
 when previous password is wrong
  • Serverless
    cURL relies on entry to shell and lacks integration with Serverless frameworks.

Swagger AEM is an OpenAPI specification for Adobe Expertise Supervisor, which can be utilized to generate API purchasers in 30 programming languages.
These API purchasers, in flip, are helpful for integrating AEM with plenty of expertise stacks. From setting OSGI configuration utilizing provisioning instruments reminiscent of Puppet, to deploying AEM packages utilizing voice by way of Google Assistant. The probabilities are infinite. Ruby_aem is one choice that may resolve the cURL AEM challenges.

  1. Useful resource Oriented Design
  2. Additional abstraction away from endpoints
  3. Error and response objects
  4. Further customized APIs

The steps are illustrated beneath.

Ruby_aem permits for significantly better end result dealing with as a result of its uniform response payloads that are parsed beforehand. Additionally, it’s endpoint free.

Higher error and edge case dealing with permits us to write down extra strong scripts. Moreover, in contrast to cURL, ruby is a firstclass programming language which provides us far more flexibility and freedom.

Ruby_aem is just a part of the out there shopper library help for Swagger_aem. Swagger_aem additionally homes help for java, python and javascript for AEM. This permits us to maneuver ahead from the dependency on shell.

  • Wait till login web page is prepared
  • Wait till AEM well being examine is handed
  • Bundle begin, cease
  • Configuration property create
  • Replication, reverse replication, and flush brokers create, replace, delete
  • Consumer and group create and delete
  • Add consumer and group to a bunch
  • Node create and delete
  • Package deal create, replace, delete, add, set up, uninstall, replicate, record, variations
  • Path activate
  • Repository block, unblock


All in all, cURL and Ruby_aem each have their makes use of in AEM. Though cURL is a a lot simpler device to select up on the go and use for testing out APIs or hitting URLs, it’s nonetheless missing in some areas. For complicated automation, Ruby_aem supplies a extra complete pool of utilities.


Source link

Leave a Comment

Your email address will not be published. Required fields are marked *