ATG Web Services and Integration Framework Guide

Property Filtering

ATG Platform REST Web Services includes functionality that filters properties from output. You could use this functionality to:

Mark a certain property in a Nucleus component or repository item as hidden or not writable.

Configure the system to override the default functionality of outputting all items and instead output only the items defined in the filtering configuration file.

Add your own custom properties for components or repository items and specify from where to get their values.

An extension of the property filtering feature, called property aliasing, allows you to create virtual components with properties that assemble values from a variety of sources.

The filtering configuration file is located at /atg/rest/filtering/filteringConfiguration.xml in the config path. To customize it you will create that file in your own module and the server’s XML combination functionality will combine all the filteringConfiguration.xml files.

The following sample makes one property hidden and another writable in a Nucleus component and a repository item:

property1 and repProperty1 are both hidden and will not be returned in the output whenever the Nucleus component or that specific property is requested.

property2 and repProperty2 cannot be changed by a REST request. (Note that the writable flag affects only REST requests.)

The next sample extends the previous one by adding a component attribute to the property tag and using that in combination with the target tag. This demonstrates how the value of a property can come from another Nucleus component. (Note that the component attribute can only reference a Nucleus component.) Dot notation can be used in the target attribute when the component attribute is used.