Chuyển đến nội dung chính

[CQ Embedded Form] Add an approach for server side validation in Cq5 to use for CQ embedded form

Issue

While working with cq5 forms you would need to do some validations at server side end. These validations can be very generic like character only validation or may be complex business scenarios.

Solution

The approach we would discuss would incorporate all these scenarios:
The first and foremost thing to do is to override the default server validation file in /libs directory (/libs/foundation/components/form/defaults/field/servervalidation.jsp) into your project like /apps/foundation/components/form/defaults/field/servervalidation.jsp
The file above is called for each form field separately when the form is submitted. Within this default server validation field I suggest you to validate only required constraint. This can be achieved with the help of form api’s available OOTB.
Required validation (available OOTB in the constraint tab on the form field) can be done with this code below.
FieldDescription[] descs = FieldHelper.getFieldDescriptions(slingRequest, resource);
for (final FieldDescription desc : descs) {
if (desc.isRequired()) {
String[] values = request.getParameterValues(desc.getName());
// You can check for length of values in the string array/values whatever
//suits you for required validation.  
}
}
Now, if required validation passes you might want to validate other constraints that can be applicable per form field like numbers/characters/business constraint for the form.
This can be done by creating constraints at location /apps/<your-project-name>/components/form/constraints/<constraint-name>/servervalidation.jsp. Similar to the ones created under /libs at the same location.
The sling:resourceType for the <constraint-name> would be foundation/components/form/constraint.
Now, the question arises how would you call server side validation jsp for specific constraints?
First you have to set the specific constraint in the dialog of the form field. Make sure that the constraint you just created above is available in the dialog. This can be achieved by writing a Servlet that produces a json. When the dialog is set for the respective form field you can call itsserversidevalidation.jsp.
The code for this can be: (A short snippet of my project code, sorry can’t revel more)
final Resource includeResource = new ExtendedResourceWrapper(desc.getFieldResource(), resourceType, FormsConstants.RST_FORM_CONSTRAINT);
FormsHelper.includeResource(slingRequest, slingResponse, includeResource, FormsConstants.SCRIPT_SERVER_VALIDATION);

ExtendedResourceWrapper class is nothing but extends theorg.apache.sling.api.resource.ResourceWrapper and has just a constructor that accepts resource, resourceType and resourceSuperType)
By including these scripts below the required validation (in default server validation file) , you would be able to call the validation (servervalidaiton.jsp) file that has been configured over the form element.
Now, you can retrieve the value of the form fields as we did in required validation and do pattern matchings/ can apply complex business validation rules.
If you face problems in implementing the above approach, please leave a comment and I would be happy to help

From cqwemblog

Nhận xét

Đăng nhận xét

Bài đăng phổ biến từ blog này

[PERFORMANCE] Adobe WEM/CQ performance tuning

Adobe WEM/CQ performance tuning Contents Caching-related configurations CRX Bundle cache CRX Search index handler (Lucene) cache Tar PM index cache Scalability Maintenance Optimizing Tar Files (for Tar Persistence Manager) Data Store Garbage Collection Main documentation you should consult first: http://dev.day.com/docs/en/cq/current/deploying/performance.html http://dev.day.com/content/kb/home/cq5/CQ5Troubleshooting/performancetuningtips.html Caching-related configurations CRX Bundle cache CRX caches bundles, consisting of a node with all its properties. This is used by all bundle-based Persistence Managers. The default size of BundleCache is 8 MB. If this is too small it can cause an excessive number of read-accesses to the underlying persistence layer. Set the bundleCacheSize to something larger than the default. See more here: http://dev.day.com/docs/en/cq/current/deploying/performance.html#CRX%20Bundle%20Cache CRX Search index handler (Lucene...
Đăng nhận xét
Đọc thêm

[Query Builder] Advanced Search

Using the Advanced Search When using a list, select from the 'Build list using' options 'Advanced Search.' This will open a new tab in the list window with one text box labeled: 'Querybuilder Predicate Notation.' This is asking for a few lines of code to define search parameters. Example Code - With Explanations of Results Searching for Pages type=cq:Page property=jcr:content/jcr:title property.value=Places 'type' defines what sort of object you'll be searching for (it's usually a page). 'property' defines what property of the object you'll be filtering by; in this case, its by the title. 'property.value' defines your search term. So this search would be searching all PAGES with the TITLE of PLACES. So it would find every page titled Places. *IMPORTANT* Searches by title ARE case-sensitive, so 'Places' is not the same as 'places'. type=cq:Page path=/cq/sandbox property=jcr:cont...
Đăng nhận xét
Đọc thêm

[ENVIRONMENT] Author and Publish environments (codes, bundles) out of sync

ISSUE: I have configured two environments of CQ5.5, Author (at 4502) and Publish (at 4503). Initially, when I just created pages based on default templates, the publishing went on just fine. I even activated using workflows.. However, when I created my own components/templates/jsp's, the pages stop getting fdeployed on Publish Environment. Now, even after activation (green light), the pages on publish environment display just a blank page and nothing else. I checked and found that all my new components/templates/jsp's etc. are not present in the 4503 node. Any way to keep them in sync ? RESOLVED: The issue isn't that your pages aren't being activated. They are likely in fact being activated just fine. You can verify this by examining the content tree on your publish instance. The issue is that the components you created and are using on those pages aren't present on the publish instance - as you noted. It's important to keep in my that CQ won't...
Đăng nhận xét
Đọc thêm