|
scanEZ Automation Select
<Select Target="Tree" Category="Designs" Type="Agents" Name="My Agent"/>
<Select Target="Tree" Category="ByNoteID" Value="2294:2314:2326:2494:2354"/>
| Action : | Select |  |
| Attributes : | Target | Tree |
| Category | The display name of the first level node |
| Type | Specifics values |
| Name | The display name of the document in the tree |
| Value | Decimal or hexadecimal values |
| Description | The Select action is only used to automate control of the Selection Tree.
It will set the focus on a Tree node and select the check box next to the node.
Category works with :
My Selection names - Type and Name are optional
Access Control List
Designs – Type and Name are optional
Documents – Type and Name are optional
Profile Documents – Type and Name are optional
Deletion Stubs – Type and Name are optional
Conflicts – Type and Name are optional
ByNoteID – Requires Value only. Only the following Tree nodes will be searched : Designs, Documents, Profile Documents.
Type is not used with the Category ByNoteID.
For Category other than Designs, Type value is the display name in the Tree.
For the Designs Category, Type values are :
Outlines
Framesets
Pages
Forms
Views
Folders
Navigators
Agents
Images
Applets
Web Services Providers
Web Services Consumers
Java
Jars
Subforms
Shared Fields
Script Libraries
Others
Agent Data
Data Connections
DB2 Access Views
Style Sheets
Shared Columns
Shared Actions
Files
Wiring Properties
Composite Applications
Components
iNotes
XPages
Custom Controls
Themes
Server JavaScript Libraries
Eclipse Files
Name is not used with the Category ByNoteID
Value is only used with the Category ByNoteID. |
|---|
Focus
<Focus Target="Tree" Category="Designs" Type="Agents" Name="My Agent"/>
| Action : | Focus | |
| Attributes : | Target | Tree |
| Category | The display name of the first level node |
| Type | Specifics values |
| Name | The display name of the document in the tree |
| Value | Decimal or hexadecimal values |
| Description | The Focus action is used to automate control of the Selection Tree.
Unlike Select, it will set the focus on a tree node.
This can happen at the Category level, the Type level or the Name level.
For more information about Attributes click on Select. |
|---|
Expand
<Expand Target="Tree" Category="Designs" Type="Agents"/>
| Action : | Expand | |
| Attributes : | Target | Tree |
| Category | The display name of the first level node |
| Type | Specifics values |
| Name | The display name of the document in the tree |
| Value | Decimal or hexadecimal values |
| Description | The Expand action is used to automate control of the Selection Tree.
It will expand the Category and/or the Type tree node.
For more information about Attributes click on Select. |
|---|
MySelection
<MySelection>
<Setparam Field="MySelectionName" Value="Test"/>
<Setparam Field="TitleOptionType" Value="Column"/>
<Setparam Field="TitleOptionColumnName" Value="All Documents|($All):2"/>
</MySelection>
| Action : | MySelection | | | |
| Attributes : | | | | |
| Parameters : | SetParam | Field | Value | KeepAlive |
| | MySelectionName | Name of MySelection | True/False |
| | TitleOptionType | Default | |
| | | Field | |
| | | Formula | |
| | | Column | |
| | TitleOptionFieldName | User specified document field name | |
| | TitleOptionFormula | User specified formula | |
| | TitleOptionColumnName | User specified view name coupled with the column number | |
| Description | This action is used to automate the 'My Selection' panel.
Field="TitleOptionFieldName" : Use this attribute with TitleOptionType="Field"
Field="TitleOptionFormula": Use this attribute with TitleOptionType="Formula"
Field="TitleOptionColumnName": Use this attribute with TitleOptionType="Column"
If you wish to keep a dialog open, use the KeepAlive attribute in a SetParam action. |
|---|
SearchBy
<SearchBy Type="UNID">
<Setparam Field="EnterID" Value="201C6D2F900212A385257A1E0053826F;76B9CD8F3012A32285257A1E00538270"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Test"/>
<Setparam Field="TitleOptionType" Value="Column"/>
<Setparam Field="TitleOptionColumnName" Value="($All):5"/>
</SearchBy>
| Action : | SearchBy | | | | |
| Attributes : | Type | UNID | | | |
| | NoteID | | | |
| | NoteIDRange | | | |
| | DesignTitle | | | |
| | Formula | | | |
| | QuickRetrieve | | | |
| | FullText | | | |
| | NotesClass | | | |
| Parameters : | SetParam | Target | Field | Value | KeepAlive |
| | MessageBox | EnterID | List of UNIDs or NoteIDs to search in the currently opened database. Separate consecutive ID with a semi-colon ";" | True/False |
| | | PutSearchInSelType | Create, Append or Replace.
Textual value of the row to search for in the first column. | |
| | | PutSearchInSelCreateName | User specified name for the My Selection to be created. If none is specified, the default is used. This name is language specific. In English it is My Selection followed by number. For example My Selection 1 | |
| | | PutSearchInSelAppendName | User specified name for the My Selection to appended the found UNIDs. | |
| | | PutSearchInSelReplaceName | User specified name for the My Selection in which to replace the currently inserted UNIDs with the new ones found. | |
| | | TitleOptionType | Default, Field, Formula or Column. | |
| | | TitleOptionFieldName | User specified document field name. Use this attribute with TitleOptionType="Field". | |
| | | TitleOptionFormula | User specified formula. Use this attribute with TitleOptionType="Formula. | |
| | | TitleOptionColumnName | User specified view name coupled with the column number. Use this attribute with TitleOptionType="Column". Separate the view name and column number with a colon ":" | |
| | | EnterFirstID | The first NoteID in the range to search. | |
| | | EnterSecondID | The last NoteID in the range to search. | |
| | | ShowEveryID | True/False. Checkbox state for "Show Every NoteID for a Given Document" | |
| | | DesignElemType | The string to select in the combo OR Index= The index of the combo item. | |
| | | DesignElemTitle | The title of the Design element. | |
| | | PublicNotes | True/False | |
| | | PrivateNotes | True/False | |
| | | SetFormula | The formula to use in the search | |
| | | SearchDocuments | True/False. True to search all documents. False otherwise. | |
| | | SearchDesigns | True/False. True to search all design elements. False otherwise. | |
| | | Show | Radio button value that will determine what to show in the list. | |
| | | ViewFolderList | True/False. True to search all documents. False otherwise. | |
| | | SearchFor | The text to search for. | |
| | | WordVariant | True/False | |
| | | Fuzzy | True/False | |
| | | NonDeleteNotes | True/False | |
| | | Documents | True/False | |
| | | Designs | True/False | |
| | | Form | True/False | |
| | | View | True/False | |
| | | Filter | True/False | |
| | | Field | True/False | |
| | | ReplicationFormula | True/False | |
| | | PrivateDesign | True/False | |
| | | DeletionStubs | True/False | |
| | | ModifiedAfter | True/False | |
| | | ModifiedAfterDate | The modified date after which to look. Note that the format MUST be yyy/mm/dd. | |
| Description | The SearchBy action is used to search a database.
Search by UNID :
<SearchBy Type="UNID">
<Setparam Field="EnterID" Value="201C6D2F900212A385257A1E0053826F;76B9CD8F3012A32285257A1E00538270"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Test"/>
<Setparam Field="TitleOptionType" Value="Column"/>
<Setparam Field="TitleOptionColumnName" Value="($All):5"/>
</SearchBy>
Search by NoteID :
<SearchBy Type="NoteID">
<Setparam Field="EnterID" Value="2560; hA1A"/>
<Setparam Field="PutSearchInSelType" Value="Append"/>
<Setparam Field="PutSearchInSelCreateName" Value="Foo"/>
<Setparam Field="TitleOptionType" Value="Formula"/>
<Setparam Field="TitleOptionColumnName" Value="@NoteID"/>
</SearchBy>
Search by NoteID Range :
<SearchBy Type="NoteIDRange">
<Setparam Field="EnterFirstID" Value="2560"/>
<Setparam Field="EnterSecondID" Value="2622"/>
<Setparam Field="ShowEveryID" Value="True"/>
</SearchBy>
Search Design element by Title :
<SearchBy Type="DesignTitle">
<Setparam Field="DesignElemType" Index="0"/>
<Setparam Field="DesignElemTitle" Value="($All)"/>
<Setparam Field="PublicNotes" Value="True"/>
<Setparam Field="PrivateNotes" Value="True"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Foo"/>
</SearchBy>
Search by Formula :
<SearchBy Type="Formula">
<Setparam Field="SetFormula" Value="SELECT @All"/>
<Setparam Field="SearchDocuments" Value="True"/>
<Setparam Field="SearchDesigns" Value="False"/>
</SearchBy>
Quick Retrieve Contents of View or Folder :
<SearchBy Type="QuickRetrieve">
<Setparam Field="Show" Value="Name"/>
<Setparam Field="ViewFolderList" Value="($All)"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Tata"/>
</SearchBy>
Full Text Search :
<SearchBy Type="FullText">
<Setparam Field="SearchFor" Value="Yes"/>
<Setparam Field="Fuzzy" Value="True"/>
<Setparam Field=" WordVariant" Value="True"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Tata"/>
<Setparam Field="TitleOptionType" Value="Column"/>
<Setparam Field="TitleOptionColumnName" Value="($All):5"/>
</SearchBy>
Extensive Search by Note Class :
<SearchBy Type="NotesClass">
<Setparam Field="NonDeleteNotes" Value="False"/>
<Setparam Field="Documents" Value="True"/>
<Setparam Field="Designs" Value="False"/>
<Setparam Field="Form" Value="False"/>
<Setparam Field="View" Value="False"/>
<Setparam Field="Filter" Value="False"/>
<Setparam Field="Field" Value="False"/>
<Setparam Field="ReplicationFormula" Value="False"/>
<Setparam Field="PrivateDesign" Value="False"/>
<Setparam Field="DeletionStubs" Value="False"/>
<Setparam Field="ModifiedAfter" Value="True"/>
<Setparam Field="ModifiedAfterDate" Value="2011/09/19"/>
<Setparam Field="PutSearchInSelType" Value="Create"/>
<Setparam Field="PutSearchInSelCreateName" Value="Tata"/>
</SearchBy>
By default, if a dialog shows a confirmation, the automation will suppress it.
You can use the following XML code to pop a confirmation:
<Setparam Target="MessageBox" KeepAlive=True"/> |
|---|
Replication Auditor
<ReplicationAudit>
<Setparam Field="SelectRepServer" Value="192.168.0.2"/>
<SetParam Field="ModifiedAfter" Value="17-10-2012 10:00:00 PM"/>
</ReplicationAudit>
| Action : | ReplicationAudit | | | |
| Attributes : | | | | |
| Parameters : | SetParam | Field | Value | KeepAlive |
| | SelectRepServer | Can be any string including and IP address. | True/False |
| | ModifiedAfter | A date. Can be date only or date and time. Format: 17-10-2012 10:00:00 PM | |
| Description | The Replication Auditor action is used to automate the Replication Auditor.
If you wish to keep a dialog open, use the KeepAlive attribute in a SetParam action. |
|---|
Post Replication Auditor
<PostReplicationAudit>
<SetParam Field="ModifiedAfter" Value="17-10-2012 10:00:00 PM"/>
</PostReplicationAudit>
| Action : | PostReplicationAudit | | | |
| Attributes : | | | | |
| Parameters : | SetParam | Field | Value | KeepAlive |
| | ModifiedAfter | A date. Can be date only or date and time. Format: 17-10-2012 10:00:00 PM | True/False |
| Description | The Post Replication Auditor action is used to automate the Post Replication Auditor.
If you wish to keep a dialog open, use the KeepAlive attribute in a SetParam action. |
|---|
Notes Ini Editor
<NotesIni KeepAlive="True">
<Export FilePath="D:\dev\Temp_XML\MyNotesIni.ini"/>
<New Name="zer99" Value="mugre66"/>
<Edit Name="zer23" Value="edit 2323"/>
<Delete Name="zer99"/>
<Export FilePath="C:\dev\Temp_XML\MyNotesIni.ini"/>
</NotesIni>
| Action : | NotesIni | | | |
| Attributes : | KeepAlive | True/False | | |
| Sub Actions : | New | Name | Entry to create | |
| | Value | Value to set for entry | |
| Edit | Name | Entry to edit | |
| | Value | Value to set for entry | |
| Delete | Name | Entry to delete | |
| Export | FilePath | Filepath to export | |
| Parameters : | SetParam | Target | Field | Value |
| | "NotesIni" | "Source" | "Local" or "Server" |
| Description | The Notes Ini Editor action is used to automate the Notes Ini Editor.
All grid actions (Sort, Filter, etc.) can be used to automate the NotresIni grid by embedding them in the NotesIni action :
<NotesIni keepAlive="True">
<Sort Column="Name" Ascending="False"/>
</NotesIni> |
|---|
|