Word Manipulation DSC

Please check out these following article for a scenario where the Create Meeting DSC will be used:
[Merging Process Data into Word Documents]



h3. Component: com.avoka.livecycle.MSWordManipulations 1.0



h2. Word Manipulation Service

Word Manipulation: Support various operations all related to modifying MS Word files, including adding, removing, and merging data.




h3. Operation: mergeDataWithDoc
Merge Data with MS Word Document.: Mail Merge data with MS Word Document.
|| Input Parameter || Type || Description ||
| Input filename path | String | The input param to this Component is the document's filename path (MS word document) to merge the data with.
|
| Output filename path | String | The output param is the (location) filename path of the resulting document after merging the data.
|
| Table Fields and Values | String | The Field param is the document's fields that gets populated from the input file.
The Value param is the data to be merged with the corresponding field.|
| Input filename path (literal value) | String | The literal value of the document's filename path to populate the field column in the table with mailmerge field.
|
| Delete paragraphs of empty mergefields. | Boolean | Whether or not to delete paragraphs of empty mergefields after merging has been completed.|




h3. Operation: mergeDataWithRegions
Merge Data with MS Word Regions.: Merge repeating workflow data into regions of an MS Word Document.
|| Input Parameter || Type || Description ||
| Input filename path | String | The input param to this Component is the document's filename path (MS word document) to merge the data with.
|
| Output filename path | String | The output param is the (location) filename path of the resulting document after merging the data.
|
| Table Fields and Values | String | The Field param is the document's fields that gets populated from the input file.
The Value param is the data to be merged with the corresponding field.|
| Input filename path (literal value) | String | The literal value of the document's filename path to populate the field column in the table with mailmerge field.
|
| The Region selected for merging | String | The region of the document selected for repeated data insertion (e.g. a table row).|
| Delete paragraphs of empty mergefields. | Boolean | Whether or not to delete paragraphs of empty mergefields after merging has been completed.|




h3. Operation: removeByBookmark
Remove Sections of MS Word Document.: Remove Sections of MS Word Document by identifying which bookmarks are to be removed. Only the bookmarks that have an XPath expression that evaluates to 'true()' during runtime will be removed from the output document.
|| Input Parameter || Type || Description ||
| Input filename path | String | An input to this Component is the full filepath of the template document (MS word document). This is used to source a copy of a document to start removing sections from.|
| Output filename path | String | An output to this Component is the full filepath of the resulting document (MS word document) removing sections (by bookmark).
|
| Table of 'Bookmarks' and 'XPath' | Map | The 'Bookmark' column contains the document's bookmarks, and gets populated from the input file.
The 'XPath' column refers to process data and is used to determine whether or not to remove the corresponding section of the input document.
|
| Input filename path (literal value) | String | The literal value of the document's filename path. Used to populate the table at design-time.
|





h5.
{panel:borderStyle=solid}
For how to configure license information for this component service - Word Manipulation, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]

Please send us any questions or comments on this documentation regarding Word Manipulation by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: Word Manipulation]
{panel}




h3. Licence Configuration:

|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key provided to you when you purchased a production license for this Solution Component. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The organization name you provided to Avoka for which you are licensing this Solution Component. |