Tag: CopyMoveDocsToDbs

The CopyMoveDocsToDbs action, along with the applicable SetParam child actions, lets you automate the Copy/Move Documents to Multiple Databases process.

<CopyMoveDocsToDbs checkbox="true" KeepAlive="true" FilePath="D:\Activities\09 Dec 2015\AutomationListDbs.xml">
XML

Tag Attributes

AttributesAttribute ValueValue DescriptionComment
CheckboxTrue/FalseToggles between using CheckBox Selection or Focus mechanicsMandatory
FilePathUser definableFilepath to the XML file containing the list of target databasesMandatory

SetParam Options

AttributesAttribute ValueValue DescriptionComment
ModeStandard

ForceCreate

ForcePush

IncrementSeqNum

IncrementSeqNumIfExist

This will set the Copy mode for the processMandatory when selecting Copy
CheckFoldersTrue/False

N/A

Mandatory
FolderSourceSetFolders

GetFolders

N/A

Mandatory
EditSetFoldersUser definableThe folders to copy or move the documents to. Separate folder names with a semicolon.Mandatory with <SetParam field="FoldersSource" value="SetFolders"/>
EditTemplateFolderUser definableThe name of the folder to use as a template for the new folders to be createdNot Mandatory
CopyBlank valueWill trigger a Copy operationMandatory – one of either Field
MoveBlank valueWill trigger a Move operationMandatory – one of either Field

Detailed Description

All options available within the 'Copy/Move Documents to Multiple Databases' dialog are available to set via SetParam options and their values. See table for notes about compatibility between different options.

NoteThe FilePath value MUST be set in order for this process to be carried out.
This file is easy to create by simply selecting the target databases from within the 'Copy/Move Documents to Multiple Databases' dialog by adding your databases the the current list, and then clicking 'Save'. The resulting XML file's path can be plugged in as the FilePath value.

Example Script

<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="scanEZ" ApplicationVersion="16.5.0" Version="1.0">
	<Load Server="ACME01/ACME">
		<Load Database="dbtest\maildbtest.nsf" Select="True"/>
	</Load>
	<Select target="tree" category="ByNoteID" value="2350:2354"/>
	<CopyMoveDocsToDbs checkbox="true" KeepAlive="true" FilePath="D:\Activities\09 Dec 2015\Input_Database_list.xml">
		<SetParam field="CheckFolders" value="true"/>
		<SetParam field="FoldersSource" value="SetFolders"/>
		<SetParam field="EditSetFolders" value="TestFolder1;TestFolder2;TestFolder3"/>
		<SetParam field="EditTemplateFolder" value="TemplateTestFolderAutomation"/>
		<SetParam field="SetCopyMove" value="Move"/>
	</CopyMoveDocsToDbs>
</YtriaAutomation>
XML

In the script above, the database "dbtest\maildbtest.nsf" will be loaded and the two documents whose NoteIDs are indicated will be selected. The action CopyMoveDocsToDbs will trigger 'Copy/Move Documents to Multiple Databases' operation to be carried out , moving these two documents to three different target folders named TestFolder1, TestFolder2, and TestFolder3 newly created, within the databases that are defined in the 'Input_Database_list.xml' file, using the template 'TemplateTestFolderAutomation' as the template for the folders. These documents will not remain in the original database.