Rename Items | Ytria Documentation

Tag: RenameItems

The RenameItems action, along with the applicable SetParam child actions, lets you automate the Rename Items process launched by clicking on the 'Rename' button found in the Diff/Values panel in scanEZ.

Detailed Description

Document Items can be renamed in a single automated operation.

A category of documents must first be selected via the Focus action.

SetParam Options

Field Name	Compatible Field Values	Value Description
Source	User definable	Source item names. Separate multiple field names with a semicolon - Required: The order of Source item names will be matched with Target item names.
Target	User definable	The names for the target items. Separate multiple field names with a semicolon - Required: The order of Target item names will be matched with Source item names.
NoTrim	True / False	The state of the Advanced option checkbox - Not Required

Example Scripts

XML

<RenameItems>
	<SetParam field="Source" value="Form1;Form2;Form3"/>
	<SetParam field="Target" value="FormA;FormB;FormC"/>
	<SetParam field="NoTrim" value="True"/>
</RenameItems>

XML

<ytriaAutomation>
	<Load Server="ACME01/ACME">
		<Load Database="dbtest\maildbtest.nsf" Select="True"/>
	</Load>
	<focus target="tree" category="Documents" type="Reponse"/>
	<RenameItems>
		<SetParam field="Source" value="Form1;Form2;Form3"/>
		<SetParam field="Target" value="FormA;FormB;FormC"/>
		<SetParam field="NoTrim" value="True"/>
	</RenameItems>
</ytriaAutomation>

In the script above, the database "dbtest\maildbtest.nsf" will be loaded and the selection tree focus placed on the "Response" document category in the selection tree. The RenameItems action will be launched, renaming the fields "Form1", "Form2", and "Form3" to "FormA", "FormB", and "Form3" respectively with the option to not automatically trim the entered field names enabled.