Using rule sets to transform URLs
- Topics:
- Rulesets
CREATED FOR:
- Admin
- User
- Developer
You can deploy rule sets in Dynamic Media to transform URLs. Rule sets are sets of instructions written in a scripting language (such as JavaScript) that evaluate XML data and take certain actions if that data meets certain conditions. Each rule consists of at least one condition and at least one action. A rule evaluates the XML data against the conditions, and if a condition is met, then it takes the appropriate action. Examples of rule sets include the following:
-
Adding a MIME type suffix. Many services and websites require image suffixes, such as adding
.jpg
to a URL. -
Creating a folder path to the URL for SEO (Search Engine Optimization) purposes.
-
Adding metadata to the URL for SEO (Search Engine Optimization) purposes.
-
Setting the content disposition to trigger a download.
-
Simplify Image Serving templating URLs for personalization. For example, turn
rgb{XX,YY,ZZ}
into the RTF-ready\redXX\greenYY\blueZZ
-
Request certain characters to be encoded such as
$
,{
, and}
, and certain characters to be decoded toward ImageServer. For example, Facebook does not work well with URLs containing special characters.
In the context of Dynamic Media, websites that use an XML-based system to manage asset information can upload XML files to Dynamic Media. You can designate one of these files as the pre-processing rule set file for serving Dynamic Media asset. This file restructures the standard URL protocol format to meet the business logic of systems being integrated with Dynamic Media. You specify an XML file to serve as the rule set definitions file path.
There are sample rulesets available that can help you create your own ruleset.
See Rule set reference.
As with all rule set creation, ensure that your XML file is valid before you upload it by using an XML validator program such as xmlvalid.
See also Troubleshooting rule sets.
Also, make sure you first test your rule set in a staging environment that does not impact your live production environment.
Production environments and staging environments typically require different logins.
See the Adobe Dynamic Media Classic desktop application for sign in information.
See also Using ‘asset’ instead of ‘is’ image in a rule set.
To deploy XML rule sets:
-
Sign in to your Dynamic Media Classic desktop application.
Your credentials and sign in were provided by Adobe at the time of provisioning. If you do not have this information, contact Technical Support.
-
Upload your rule set file by doing the following:
- On the Global Navigation bar, click Upload.
- On the Upload page, near the upper-left corner, click Browse.
- In the Open dialog box, browse to your rule set file (XML).
- Select the file, then click Open.
- On the right side of the Upload page, select a destination folder for the rule set file.
- Near the bottom of the page, ensure Publish After Uploading is checked.
- In the bottom right corner of the page, click Submit Upload.
- On the Global Navigation bar, click Jobs to check the status of the upload job. When the Status column on the Job page says Upload Done, continue to the next steps.
-
On the navigation bar near the top of the page, click Setup > Application Setup > Publish Setup > Image Server.
-
On the Image Server Publish page, under the Catalog Management group, locate Rule Set Definition File Path, then click Select.
-
On the Select Rule Set Definition File (XML) page, browse to your rule set file, then in the lower-right corner of the page, click Select.
-
In the lower-right corner of the Setup page, click Close.
-
Run an Image Server Publish job.
The rule set conditions are applied on the requests to the live Dynamic Media Image Servers.
If you make changes to the rule set file, the changes are immediately applied when you re-upload and re-publish the updated rule set file.
Experience Manager
- Assets user guide
- AEM 6.4 Assets release notes
- About DAM
- User experience improvements
- Best practices for assets
- Use AEM Assets
- Dynamic Media
- Dynamic Media newsletter archive by Experience League
- Setting up Dynamic Media
- Working with Dynamic Media
- Configuring Dynamic Media - Scene7 mode
- Configuring Dynamic Media - Hybrid mode
- Troubleshooting Dynamic Media - Scene7 mode
- Managing Dynamic Media assets
- Best practices for optimizing the quality of your images
- Managing Dynamic Media Viewer Presets
- Applying Dynamic Media Viewer Presets
- Managing Dynamic Media Image Presets
- Applying Dynamic Media Image Presets
- Dynamic Media Video Profiles
- Dynamic Media Image Profiles
- Smart Imaging
- Smart Imaging with client-side Device Pixel Ratio
- Video
- HTTP2 delivery of content
- Delivering Dynamic Media assets
- Activating hotlink protection in Dynamic Media
- Dynamic Media limitations
- Image Sets
- Mixed Media Sets
- Spin Sets
- Panoramic Images
- Video
- Interactive Images
- Interactive Videos
- Carousel Banners
- Using Quickviews to create custom pop-ups
- Delivering optimized images for a responsive site
- Previewing Dynamic Media assets
- Adding Dynamic Media assets to pages
- Adding Dynamic Media Classic components to pages
- Embedding the Dynamic Video or Image viewer on a web page
- Linking URLs to your web application
- Using Rulesets to transform URLs
- Publishing Dynamic Media assets
- Invalidating your CDN cached content
- Installing Feature Pack 18912 for bulk asset migration
- Working with Selectors
- Extend Assets
- Administer Assets
- Assets supported formats
- Search facets
- Managing Metadata for assets
- XMP writeback to renditions
- Asset link sharing
- Asset reports
- Enhanced Smart Tags
- Profiles for processing metadata, images, and videos
- Cascading metadata
- Create and configure Asset Editor pages
- Assets sizing guide
- Metadata Schemata Reference
- Best practices for translating assets efficiently
- Assets performance tuning guide
- How to edit or add metadata
- Assets migration guide
- XMP metadata
- Assets network considerations
- AEM Assets vs. AEM MediaLibrary
- Using PDF rasterizer
- Configuring asset upload restrictions
- AEM and Creative Cloud integration best practices
- Configure Adobe Asset Link
- Integrating AEM Assets with InDesign server
- Metadata profiles
- Digital Rights Management in Assets
- Using demo package for Assets Insights
- Assets Offloading Best Practices
- Assets file format best practices
- Assets Monitoring Best Practices
- Camera Raw Support
- Detecting MIME Type of Assets Using Apache Tika
- Imaging Transcoding Library
- Support for IPTC Metadata
- Metadata Schemas
- Multi-tenancy for Collections, Snippets, and Snippet Templates
- Watermarking
- Bulk Metadata Import and Export
- Asset Templates
- AEM to Creative Cloud Folder Sharing Best Practices
- Folder Metadata Schema
- Managing Smart Tags
- Brand Portal
- Content Fragments
- Working with Content Fragments
- Managing Content Fragments
- Content Fragment Models
- Variations - Authoring Fragment Content
- Content Fragment Associated Content
- Metadata - Fragment Properties
- Content Fragments - Delete Considerations
- Content Fragments - Markdown
- Creating translation projects for Content Fragments
- Manage Assets
- Managing Assets with the Touch-Optimized UI
- Managing multiple assets and collections
- Asset selector
- Managing Collections
- Check in and check out files in Assets
- Configure asset tagging using the Smart Content Service
- Enabling duplicate detection
- Enhanced sorting of assets in AEM
- Organize digital assets
- Managing video assets
- Creating Translation Projects
- Preparing Assets for Translation
- Download assets from AEM
- Asynchronous Operations
- Lightbox
- Enabling Assets Insights through DTM
- Configuring Assets Insights
- Applying translation cloud services to folders
- Using Page Tracker and Embed code in web pages
- Managing Compound Assets
- Related Assets
- Assets Insights
- Searching Video Assets
- Private folder sharing
- Smart Content Service Training Guidelines
- Video renditions
- Integration with other solutions
The Perfect Blend: A New Era of Collaboration with AEM and Workfront
Adobe Customer Success Webinars
Wednesday, Apr 2, 5:00 PM UTC
Explore how Adobe Experience Manager and Workfront integrate to help teams move from ideation to delivery without the usual bottlenecks, ensuring content is organized, on-brand, and ready to go live faster.
RegisterAdobe Experience Manager Assets at Summit
Register for these sessions:
- The Future of Digital Asset Management (attend online)
- Adobe’s Top 10 Generative AI Capabilities to Accelerate Your Content Supply Chain (attend online)
- Elevate and Empower Teams with Agentic AI for Exceptional Experiences (attend online)
- Rapid Feature Releases with AEM Cloud: Telegraph Media Group’s RDE Strategy (attend online)
- The True Cost of a Failed Implementation (attend online)
Connect with Experience League at Summit!
Get front-row access to top sessions, hands-on activities, and networking—wherever you are!
Learn more