WriteZonesFPX

Member of namespace

FPXML

Syntax

bool WriteZonesFPX (StrParam)

Parameters

Three comma separated parameters:

• Fingerprint host name: This is the fingerprint class name and can be seen in the Zones tab of Datacap Studio. It is used to group or classify fingerprints. If this value is not provided, then a blank class name will be used.
• Fingerprint host id: This is an internal numeric value that is associated with the fingerprint class name. If a value is not provided, a blank value is used.
• Fingerprint page type: This is the page type that corresponds to the fingerprint for the page. If this value is not provided, it uses the page type of the current page.

Smart parameters are supported. All parameters are optional. If you provide only the second or third parameter, you must supply an empty value for the previous parameters.

Returns

False, if there is a problem saving to fingerprint XML file or if not called at the page level, if the page does not have a fingerprint assigned, or a fingerprint directory has not been set. Otherwise True.

Level

Page level only.

Details

This action writes out all of the field positions for the current page to the fingerprint XML file. Typically this action is used for applications that are using fingerprint XML files and new pages are dynamically zoned at runtime. After the zoning of the page has been completed, then this action is used to write out the zone information to the FPXML file, allowing subsequent pages of this type to be processed using the saved zone information.

If the fingerprint directory that had been previously specified using SetDirectoryFPX does not exist, it is created, providing that the parent directory already exists.

Fields with empty positions are not written to the fingerprint XML file.

Example:

SetDirectoryFPX("@APPPATH(*/fingerprint)")
WriteZonesFPX("MyFPClass,,MyPageType")

This example writes out the zones for the current page and sets the fingerprint class to "MyFPClass" and the page type to "MyPageType".

SetDirectoryFPX("@APPPATH(*/fingerprint)")
WriteZonesFPX("MyFPClass,,@P.MyType")     

This example writes out the zones for the current page and sets the fingerprint class to "MyFPClass" and the page type to the value contained by the page variable "MyType".