Tag: CreateFolder
The action CreateFolder, along with a set of SetParam options will emulate the process of creating a new folder in scanEZ.
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.
Tag Attributes
|
Attribute Name |
Attribute Value |
Value Description |
|---|---|---|
|
Name |
User definable |
Any valid folder name string - Not Required - If not used, created folder will be untitled. |
|
Type |
Shared
|
Defines if created folder is shared or private - Not Required - If not used, created folder will default to "Shared". |
|
CopyFrom |
User definable |
Name of view or folder to inherit from - Not Required - If not used, created folder will not inherit from any other view or folder. |
SetParam Options
|
Field Name |
Compatible Field Values |
Value Description |
|---|---|---|
|
Name |
User definable |
Any valid folder name string - Not Required - If not used, created folder will be untitled. |
|
Type |
Shared
|
N/A - Not Required - If not used, created folder will default to "Shared". |
|
CopyFrom |
User definable |
Any valid folder name string of view or folder to inherit from - Not Required - If not used, created folder will not inherit from any other view or folder. |
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.
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.
Tag Attributes
|
Attribute Name |
Attribute Value |
Value Description |
|---|---|---|
|
Show |
Name
|
Radio button options for view/folder list display - Not Required - If not used, operation will default to "NameAlias". |
|
ViewFolderList |
User definable |
Name and/or alias as would be shown in view/folder list according to the value used for the "Show" attribute - Required |
|
ShowPrivate |
True/False |
Name of view or folder to inherit from - Not Required - If not used, created folder will not inherit from any other view or folder. |
SetParam Options
|
Field Name |
Compatible Field Values |
Value Description |
|---|---|---|
|
Show |
Name
|
Radio button options for view/folder list display - Not Required - If not used, operation will default to "NameAlias". |
|
ViewFolderList |
User definable |
Name and/or alias as would be shown in view/folder list according to the value used for the "Show" attribute - Required |
|
ShowPrivate |
True/False |
Name of view or folder to inherit from - Not Required - If not used, created folder will not inherit from any other view or folder. |
Example Scripts
<CreateFolder>
<Setparam Field="Name" Value="NewFolder2"/>
<Setparam Field="Type" Value="Private"/>
<SetParam Field="CopyFrom" Value="Folder1"/>
</CreateFolder>
<CopyFrom>
<SetParam Field="Show" Value="NameAlias"/>
<SetParam Field="ShowPrivate" Value="False"/>
<SetParam Field="ViewFolderList" Value="Sales"/>
</CopyFrom>
<ytriaAutomation>
<Load Server="ACME01/ACME" database="maildbtest1.nsf"/>
<CreateFolder Name="NewFolder2" Type="Private" CopyFrom="NewFolder1"/>
</ytriaAutomation>
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.