Tag: CreateItem
The CreateItem action, along with the applicable SetParam child actions, lets you automate the 'Create Items' process launched by clicking on the 'Create' button found in the Diff/Values panel in scanEZ.
<CreateItem OnExisting="skip">
<SetParam field="TypeList" value="number"/>
<SetParam field="FieldName" value="autoCreateNUM"/>
<SetParam field="FieldValue" value="29"/>
<SetParam field="IsProtected" value="true"/>
</CreateItem>
Tag Attributes
| Attributes | Attribute Value | Value Description | Comment |
|---|
| OnExisting | Skip
Create
Cancel | Defines the action to take if the item already exists within the document | Not mandatory – see detailed description below |
SetParam Options
| Field Name | Compatible Field Values | Value Description | Comment |
|---|
| TypeList | Text
Text List
Number
Number List
Date
Date List
Authors
Names
Readers
Formula | Dropdown 'Type' list options | Mandatory |
| FieldName | User definable | Valid field name of your choice | Mandatory |
| FieldValue | User definable | Valid field name of your choice | One must be selected |
| FieldFormula | User definable | Valid formula | One must be selected |
| IsSummary | True/False | Flag checkbox state | Not mandatory – see detailed description |
| IsEncrypted | True/False | Flag checkbox state | Not mandatory – see detailed description |
| IsSigned | True/False | Flag checkbox state | Not mandatory – see detailed description |
| IsProtected | True/False | Flag checkbox state | Not mandatory – see detailed description |
| FieldSeparator | [New Line]
[Semicolon]
[Comma]
[Space]
[Tab] | Dropdown 'Separator' list options | Mandatory for TypeList values "Text List", "Number List", and "Date List". |
Detailed Description
By default, omitting the attribute OnExisting will have the same effect as <CreateItem OnExisting="Create"> which is the equivalent of the 'Replace' button on the Warning dialog displayed when creating an item that already exists in the target documents.
| Note | The checkbox option 'Apply to all documents' is always engaged when using the CreateItem action. |
|---|
The minimum block of SetParam child actions will consist of:
- TypeList and value
- FieldName and value
- FieldValue (for a fixed value) or FieldFormula (for a calculated value)
- FieldSeparator and value—for List-type items only
If omitted, the additional SetParam 'Flag' options IsSummary, IsEncrypted, IsSigned, and IsProtected will be their default values set for the New Items dialog.
Example Script
<?xml version="1.0" encoding="UTF-8"?>
<ytriaAutomation Application="scanEZ" ApplicationVersion="16.5" Version="1.0">
<Load Server="ACME01/ACME" database="Testcopy.nsf"/>
<focus target="tree" category="Documents" type="Document"/>
<CreateItem OnExisting="skip">
<SetParam field="TypeList" value="Number"/>
<SetParam field="FieldName" value="AutoCreateNum"/>
<SetParam field="FieldValue" value="29"/>
<SetParam field="IsProtected" value="true"/>
</CreateItem>
</ytriaAutomation>
In the script above, the database "Testcopy.nsf" will be opened and the focus placed on the document type "Document". The CreateItem action will be launched on all Documents within the focused selection tree node, creating a new Number-type item named "AutoCreateNum" with a value of "29", and with a flag set for 'Protected'.