DocumentAnalyzer: Run Document Analyzer
Tag: DocumentAnalyzer
The DocumentAnalyzer action, along with the applicable SetParam child actions, lets you automate the Document Analyzer tool.
Detailed Description
Setting the TreeOptions field values that correspond to the higher-level nodes in the Document Analyzer tree is the equivalent of setting all tree options within that category.
<SetParam field="TreeOptions" value="CategoryFields"/>
is equal to
<SetParam field="TreeOptions" value="CategoryFieldsAuthor"/>
<SetParam field="TreeOptions" value="CategoryFieldsReader"/>
<SetParam field="TreeOptions" value="CategoryFieldsMultiple"/>
SetParam Options
| Field Name | Compatible Field Values | Value Description |
|---|---|---|
| TreeOptions | CategoryFields | 'Fields' category options found within the Document Analyzer tree - One value per line |
| CategoryFieldsAuthor CategoryFieldsReader CategoryFieldsMultiple | 'Fields' category options found within the Document Analyzer tree - One value per line | |
| CategorySignature | 'Documents Signature' category options found within the Document Analyzer tree - One value per line | |
| CategorySignatureNotSigned CategorySignatureSigned | 'Documents Signature' category options found within the Document Analyzer tree - One value per line | |
| CategoryEncryption | 'Documents Encryption' category options found within the Document Analyzer tree - One value per line | |
| CategoryEncryptionNotEncrypted CategoryEncryptionSecret CategoryEncryptionPublicListed CategoryEncryptionPublicUnlisted CategoryEncryptionNotEncryptedPublic CategoryEncryptionNotEncryptedSecret | 'Documents Encryption' category options found within the Document Analyzer tree - One value per line | |
| CategoryResponses | 'Parent/Responses' category options found within the Document Analyzer tree - One value per line | |
| CategoryResponsesMissingResponse CategoryResponsesMissingParent CategoryResponsesIsOwnParent CategoryResponsesResponseWithPhantomParent CategoryResponsesIsPhantomParent CategoryResponsesIgnorantparent | 'Parent/Responses' category options found within the Document Analyzer tree - One value per line | |
| CategoryConflicts | 'Conflicts' category options found within the Document Analyzer tree - One value per line | |
| CategoryConflictNoValidParent CategoryConflictIsOwnConflict | 'Conflicts' category options found within the Document Analyzer tree - One value per line | |
| CategorySummarized | 'Sum of Summarized Item Data' category options found within the Document Analyzer tree - One value per line | |
CategorySummarized30k CategorySummarized32k CategorySummarized60k CategorySummarized64k | 'Sum of Summarized Item Data' category options found within the Document Analyzer tree - One value per line | |
| Documents | True / False | Sets the checkbox option's state - Not Required |
| DesignElements | True / False | Sets the checkbox option's state - Not Required |
Only one TreeOptions value can be set per script line.
Example Scripts
<DocumentAnalyzer KeepAlive="true">
<SetParam field="TreeOptions" value="CategoryFields"/>
<SetParam field="TreeOptions" value="CategorySummarized"/>
<SetParam field="Documents" value="true"/>
<SetParam field="DesignElements" value="true"/>
</DocumentAnalyzer><ytriaAutomation>
<Load Server="ACME01/ACME" Database="testdatabase.nsf" />
<DocumentAnalyzer KeepAlive="false">
<SetParam field="TreeOptions" value="CategoryFields"/>
<SetParam field="TreeOptions" value="CategorySummarized"/>
<SetParam field="Documents" value="true"/>
<SetParam field="DesignElements" value="true"/>
<Select Lines="All"/>
</DocumentAnalyzer>
</ytriaAutomation>In the script above, the database "testdatabase.nsf" will be loaded. The Document Analyzer process will be launched using all tree options within the "Fields" and "Sum of Summarized Item Data" categories. The Analysis Target options of 'Design Elements' and 'Documents' will be selected. All rows (all documents and designs found) within the resulting grid will be selected and placed into a new My Selection folder.