Enhancing AARI Forms

Enhancing AARI Forms within the Control Room

FAQs

How do I control which AARI requests my mods runs on?

AARI uses a URL routing approach called “hash” routing. The AARI path/request appears after the # in the URL.

Therefore, to control which mods/AARI pages the mod runs on use a Sites rule with an Advanced: Match Rules > URL Patterns rule

The Sites for your mod could contain the root AARI URL:

https://[[Control Room URL]]/aari/*

Example:

In the URL Patterns, fill the hash with the URL pattern. In AARI, the request reference follows the pattern processId-runId.

Therefore to match all runs of a given process, provide a regular expression pattern for the reference:

How do I control which AARI task my mod runs on?

AARI does not encode the active task in the URL. Therefore, to restrict an mod to a particular task, you have to check the page content.

This approach must be combined with a trigger to detect task initialization, because PixieBrix may perform the check before the task list elements have been rendered on the page.

This approach must be combined with a trigger to detect task initialization, because PixieBrix may perform the check before the task list elements have been rendered on the page.

To restrict an mod to when a particular task is selected, use the Advanced: Match Rules > Selectors configuration

For example, to restrict by task name, where Task Name is the name of the task

.task-list--selected .task-list__details-title:contains("Task Name")