Form Utilities DSC

 Browse Space
Added by Kendy Yus, last edited by Lachlan Aldred on Apr 01, 2009  (view change)

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Please check out these following articles for scenarios where Form Utilities DSC will be used: 

Inserting XML data into a form variable 

Component: com.avoka.livecycle.formutil 8.0

FormUtil Service

Form Utilities: The service allows to insert repeating XML data into a form. It also allows to merge repeating data from forms and save the merged data into an XML variable.

Operation Title: Insert XML Data   (insertXmlData)

Insert XML Data: This operation retrieves repeating data from an XML document and inserts the data into a form.

Input Parameter Type Description Editor
Input Repeat Element XPath java.lang.String An XPath expression that evaluates to the repeating element in the input XML variable  
Starting Row Index java.lang.String A numerical value to specify the starting row index to read from the input XML data, 0 used by default to read starting form the first row of data  
Number of rows to read java.lang.String A numerical value to specify the number of rows to read from the input XML data, -1 used by default to read all rows of data  
Output Repeat Element XPath java.lang.String An XPath expression that evaluates to the repeating element in the output XML variable  
Copy Everything java.lang.Boolean If the check box is selected, all data from the input XML will be copied to the output form data and only repeating element names will be changed.  
Source destination mapping java.util.List The mapping is used to read only source data and save it into destination data for each repeating XML element. This setting is used only when "Copy Everything" is not selected.  
Append or Overwrite java.lang.String If 'Append' is selected, the data will be appended to the output form data, otherwise it will be overwritten.  

Operation Title: Merge Form Data   (mergeFormData)

Merge Form Data: This operation retrieves data from forms, merges the data and saves the merged data into an XML variable.

Input Parameter Type Description Editor
Input Repeat Element XPath java.lang.String An XPath expression that evaluates to the repeating element in the input XML variable  
Starting Row Index java.lang.String A numerical value to specify the starting row index to read from the input XML data, 0 used by default to read starting form the first row of data  
Number of rows to read java.lang.String A numerical value to specify the number of rows to read from the input XML data, -1 used by default to read all rows of data  
Output Repeat Element XPath java.lang.String An XPath expression that evaluates to the repeating element in the output XML variable  
Copy Everything java.lang.Boolean If the check box is selected, all data from the input XML will be copied to the output form data and only repeating element names will be changed.  
Source destination mapping java.util.List The mapping is used to read only source data and save it into destination data for each repeating XML element. This setting is used only when "Copy Everything" is not selected.  
Append or Overwrite java.lang.String If 'Append' is selected, the data will be appended to the output form data, otherwise it will be overwritten.  

For how to configure license information for this component service - Form Utilities, please click on the following link:
Avoka LiveCycle ES Component License Configuration

Please send us any questions or comments on this documentation regarding Form Utilities by clicking on the following link:
Feedback

Licence Configuration:

Parameter Type Description
License Key java.lang.String The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time.
License Organisation java.lang.String The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time.