Tag: CreateFolder

The action CreateFolder, along with a set of SetParam options will emulate the process of creating a new folder in scanEZ.


<CreateFolder>
	<Setparam Field="Name" Value="NewFolder2"/>
	<Setparam Field="Type" Value="Private"/>
	<SetParam Field="CopyFrom" Value="Folder1"/>
</CreateFolder>
XML

Tag Attributes

Attribute NameAttribute ValueValue DescriptionComment
NameUser definableAny valid folder name stringNot Mandatory—If not used, created folder will be untitled.
TypeShared
Private
Defines if created folder is shared or privateNot Mandatory—If not used, created folder will default to "Shared".
CopyFromUser definableName of view or folder to inherit fromNot Mandatory—If not used, created folder will not inherit from any other view or folder.

SetParam Options

Field NameCompatible Field ValuesValue DescriptionComment
NameUser definableAny valid folder name stringNot Mandatory—If not used, created folder will be untitled.
TypeShared
Private

N/A

Not Mandatory—If not used, created folder will default to "Shared".
CopyFromUser definableAny valid folder name string of view or folder to inherit fromNot Mandatory—If not used, created folder will not inherit from any other view or folder.

Detailed Description

All options available in the Create Folder dialog can be specified either by the tag attributes or in SetParam child actions.
Either method will produce the same results.

Sub-Action Tag: CopyFrom

The sub-action tag CopyFrom lets you automate the selection of options in the View or Folder Selection dialog when using the 'Copy From…' option when creating a new folder.


<CopyFrom>
	<SetParam Field="Show" Value="NameAlias"/>
	<SetParam Field="ShowPrivate" Value="False"/>
	<SetParam Field="ViewFolderList" Value="Meat"/>
</CopyFrom>
XML

Tag Attributes

Attribute NameAttribute ValueValue DescriptionComment
ShowName
Alias
NameAlias
Radio button options for view/folder list displayNot Mandatory—If not used, operation will default to "NameAlias".
ViewFolderListUser definableName and/or alias as would be shown in view/folder list according to the value used for the "Show" attribute.Mandatory
ShowPrivateTrue/FalseName of view or folder to inherit fromNot Mandatory—If not used, created folder will not inherit from any other view or folder.

SetParam Options

Field NameCompatible Field ValuesValue DescriptionComment
ShowName
Alias
NameAlias
Radio button options for view/folder list displayNot Mandatory—If not used, operation will default to "NameAlias".
ViewFolderListUser definableName and/or alias as would be shown in view/folder list according to the value used for the "Show" attribute.Mandatory
ShowPrivateTrue/FalseName of view or folder to inherit fromNot Mandatory—If not used, created folder will not inherit from any other view or folder.

Detailed Description

All options available in the View or Folder Selection dialog can be specified either by the tag attributes or in SetParam child actions.
Either method will produce the same results.

Example Script

<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="scanEZ" ApplicationVersion="16.5">
	<Load Server="ACME01/ACME" database="maildbtest1.nsf"/>
	<CreateFolder Name="NewFolder2" Type="Private" CopyFrom="NewFolder1"/>
</ytriaAutomation>
XML

In the script above, the database "maildbtest1.nsf" will be loaded in scanEZ. The action CreateFolder will then trigger the a create folder operation. The tag attributes are defined to produce the same results as the example syntax shown in the beginning of this page. The name of the new folder will be "NewFolder2". It will be private and the inheritance will be copied from the folder "NewFolder1". This folder name is selected in the default manner (name & alias) that is, the folder only has a name "NewFolder1" with no aliases defined.