Input forms - Difference between xpathsToLoad/xpathsToLoadOpt | Community
Skip to main content
Heku_
Level 5
April 2, 2025
Solved

Input forms - Difference between xpathsToLoad/xpathsToLoadOpt

  • April 2, 2025
  • 1 reply
  • 655 views

Hello, I can't find any documentation for this. I would like to know the difference between the attributes xpathsToLoad/xpathsToLoadOpt of the form.

 

Thank you in advance,

Heku

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by SushantTrimukheD

Hi @heku_ ,

In Adobe campaign the xpathsToLoad and xpathsToLoadOpt attributes in input forms are used to define which data fields (XPath references) from the underlying schema are loaded when a form is rendered.

xpathsToLoad : Is the mandatory XPath fields that must be loaded when the form is opened. These are the core fields required for the form to function correctly. This Fields listed in xpathsToLoad are always retrieved from the database, regardless of whether they are immediately displayed or used in the form. This ensures that essential data is available for processing or display.

xpathsToLoadOpt: Is the optional XPath fields that are loaded only when needed or explicitly requested by the form's logic or user interaction. This Fields in xpathsToLoadOpt are not loaded by default when the form opens. They are fetched on-demand, typically when a specific action (e.g., a button click or tab switch) or condition requires them. This helps optimize performance by reducing the initial data load.

Example:

A delivery form (nms:delivery) in Adobe Campaign:

  • xpathsToLoad: You might include @id, @label, and @state because these are essential for identifying and displaying the delivery.
  • xpathsToLoadOpt: You might include @deliveryCode or @trackingUrl because these are only needed when viewing advanced details or performing specific actions.

Thanks

Sushant Trimukhe

1 reply

SushantTrimukheD
SushantTrimukheDAccepted solution
Level 4
April 2, 2025

Hi @heku_ ,

In Adobe campaign the xpathsToLoad and xpathsToLoadOpt attributes in input forms are used to define which data fields (XPath references) from the underlying schema are loaded when a form is rendered.

xpathsToLoad : Is the mandatory XPath fields that must be loaded when the form is opened. These are the core fields required for the form to function correctly. This Fields listed in xpathsToLoad are always retrieved from the database, regardless of whether they are immediately displayed or used in the form. This ensures that essential data is available for processing or display.

xpathsToLoadOpt: Is the optional XPath fields that are loaded only when needed or explicitly requested by the form's logic or user interaction. This Fields in xpathsToLoadOpt are not loaded by default when the form opens. They are fetched on-demand, typically when a specific action (e.g., a button click or tab switch) or condition requires them. This helps optimize performance by reducing the initial data load.

Example:

A delivery form (nms:delivery) in Adobe Campaign:

  • xpathsToLoad: You might include @id, @label, and @state because these are essential for identifying and displaying the delivery.
  • xpathsToLoadOpt: You might include @deliveryCode or @trackingUrl because these are only needed when viewing advanced details or performing specific actions.

Thanks

Sushant Trimukhe

Heku_
Heku_Author
Level 5
April 3, 2025

Hello @sushanttrimukhed, thanks a lot for the fast reply. Did you find this in any documentation?

SushantTrimukheD
Level 4
April 3, 2025

@heku_,

Unfortunately, there is no official documentation for xpathsToLoadOpt. However, you can find several resources and discussions on communities for xpathsToLoad. When we conduct R&D or explore how Adobe's out-of-the-box input forms are built, that's when we'll gain more insight.