Tag: AddCustomColumn
The AddCustomColumn
action, along with the applicable SetParam child actions, lets you automate the process of adding custom columns in the 'Values' dialog, launched by the 'Add Column' button in the UI.
<AddCustomColumn/>
Tag Attributes
Attributes | Attribute Value | Value Description | Comment |
Name | User definable | | Mandatory |
SetParam Options
Field Name | Compatible Field Values | Value Description | Comment |
TitleOptionType | Default
Field
System
Formula
Column | Title options as found in My Selection dialog | Mandatory |
FieldAttribute | Index
Is Encrypted
Is Protected
Is Signed
Is Summary
Modification Date
Name
Number of Values
Sequence Number
Size (bytes)
Type
Value | Name of item property (normally displayed in the main panel of scanEZ) | See detailed description |
TitleOptionFieldName | Name of field to be used | Name as shown in the second list in the Field info/value Displayed Title | See detailed description |
TitleOptionFormula | User defined | | See detailed description |
TitleOptionColumnName | Column header name as shown in UI | | See detailed description |
TitleOptionSystem | Accessed (In this file)
Added (In this file)
Created (Initially)
Created By
Flags
Modified (Initially)
Modified By
Modified in this file
Note Class
NoteID (Decimal)
NoteID (Hexadecimal)
Number of items in Document
Sequence Number
Size
UNID | | See detailed description |
Detailed Description
Field and Value SetParam actions:
Field="TitleOptionFieldName"
: Use this attribute with Field="TitleOptionType" Value="Field"
Field="FieldAttribute"
: Use this attribute with Field="TitleOptionType" Value="Field"
Field="TitleOptionFormula"
: Use this attribute with Field="TitleOptionType" Value="Formula"
Field="TitleOptionColumnName"
: Use this attribute with Field="TitleOptionType" Value="Column"
Field="TitleOptionSystem"
: Use this attribute with Field="TitleOptionType" Value="System"
Note | The added column will not populate unless the sub-action Evaluate is used at the end of the Values script block. |
Example Script
<YtriaAutomation Version="1.0" Application="scanEZ" ApplicationVersion="16.5" Console="False">
<load server="ACME01/ACME" database="Mailtest.nsf"/>
<focus target="tree" category="Documents" type="Memo"/>
<Values KeepAlive="false">
<SetParam Target="SelectDocumentItems" Field="AddItem" value="Form"/>
<SetParam Target="SelectDocumentItems" Field="AddItem" value="From"/>
<SetParam Target="SelectDocumentItems" Field="AddItem" value="DeliveredDate"/>
<ShowTypeColumns value="false"/>
<AddCustomColumn Name="Created By">
<SetParam Field="TitleOptionType" Value="System"/>
<SetParam Field="TitleOptionSystem" Value="Created By"/>
</AddCustomColumn>
<Evaluate/>
<Export>
<SetParam field="FilePath" value="D:scanEZ-Values.html"/>
<SetParam field="ExportType" value="HTML"/>
<SetParam field="SelectedRowsOnly" value="False"/>
</Export>
</Values>
</YtriaAutomation>
In the script above, the database "Mailtest.nsf" will be loaded into scanEZ and the selection tree focus will be placed on the document category "Memo". The 'Values' operation will be launched on these documents and the Values grid columns will be set to the Items "Form", "From", and "Delivered Date". The AddCustomColumn
block will then add a column using information found in the Note Info value "Created By" for its entries. The custom column will then populate with the individual values of this Note information. All rows within this grid will then be exported to an HTML file, and the Values dialog will close.