Change Displayed Document Title
Tag: ChangeDocumentTitle
ChangeDocumentTitle, along with the applicable SetParam child actions, lets you automate 'Change Displayed Title'.
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="TitleOptionSysten": Use this attribute with Field="TitleOptionType" Value="System"
Tag Attributes
Field Name | Compatible Field Values | Value Description |
---|---|---|
TitleOptiontype | Default Field System Formula Column | Title options as found in My Selection dialog - Required |
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 | N/A (See detailed description) |
TitleOptionColumnName | Column header name as shown in UI | N/A (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) |
Example Scripts
<ChangeDocumentTitle>
<Setparam Field="TitleOptionType" Value="System"/>
<Setparam Field="TitleOptionSystem" Value="UNID "/>
</ChangeDocumentTitle>
<YtriaAutomation>
<Load Server="ACME01/ACME" Database="Mailtest.nsf"/>
<focus target="tree" category="Documents" type="Memo"/>
<ChangeDocumentTitle>
<Setparam Field="TitleOptionType" Value="System"/>
<Setparam Field="TitleOptionSystem" Value="UNID"/>
</ChangeDocumentTitle>
</YtriaAutomation>
In the script above, the database "Mailtest.nsf" will be loaded into scanEZ and the focus will be placed on the document category "Memo". The ChangeDocumentTitle action will be launched, and the displayed titles for all documents within the category will be set to display their UNIDs.