Skip to main content
Skip table of contents

Modify Items

Tag: ModifyItem

The ModifyItem action, along with the applicable SetParam child actions, lets you automate the 'Modify Items' process launched by clicking on the 'Modify' button found in the Diff/Values panel in scanEZ.

Detailed Description

By default, omitting the attribute OnMissing will have the same effect as <ModifyItem OnMissing="Create"> which is the equivalent of the 'Create' button on the Warning dialog displayed when trying to modify an item that does not exist in the target documents.

The checkbox option 'Apply to all documents' always acts as if engaged when using the ModifyItem action.

The minimum block of SetParam child actions will consist of:

      1. TypeList and value
      2. FieldName and value
      3. FieldValue (for a fixed value) or FieldFormula (for a calculated value)
      4. 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 'Modify Item' dialog.

      Tag Attributes

      AttributesAttribute ValueValue Description
      OnMissingSkip, Create, CancelDefines the action to take if the item already exists within the document - Not Required (See detailed description)

      SetParam Options

      Field NameCompatible Field ValuesValue Description

      Text List


      Number List


      Date List





      Dropdown 'Type' list options - Required
      FieldNameUser definableValid field name of your choice (Date and Date List type items must be in the proper format) - Required
      FieldValueUser definableValid field value of your choice - One must be selected
      FieldFormulaUser definableValid formula - One must be selected
      IsSummaryTrue / FalseFlag checkbox state - Not Required (See detailed description)
      IsEncryptpedTrue / FalseFlag checkbox state - Not Required (See detailed description)
      IsSignedTrue / FalseFlag checkbox state - Not Required (See detailed description)
      IsProtectedTrue / FalseFlag checkbox state - Not Required (See detailed description)
      FieldSeparatorNew Line





      Dropdown 'Separator' list options Required for TypeList values 'Text List', 'Number List', and 'Date List'.

      Example Scripts

      <ModifyItem OnMissing="skip">
      	<SetParam field="TypeList" value="number"/>
      	<SetParam field="FieldName" value="autoCreateNUM"/>
      	<SetParam field="FieldValue" value="29"/>
      	<SetParam field="IsProtected" value="true"/>
      	<Load Server="ACME01/ACME" database="Testcopy.nsf"/>
      	<focus target="tree" category="Documents" type="Document"/>
      	<ModifyItem OnMissing="skip">
      		<SetParam field="TypeList" value="Number"/>
      		<SetParam field="FieldName" value="AutoCreateNum"/>
      		<SetParam field="FieldValue" value="29"/>
      		<SetParam field="IsProtected" value="true"/>

      In the script above, the database "Testcopy.nsf" will be opened and the focus placed on the document type "Document". The ModifyItem action will be launched on all documents within the focused selection tree node, setting all items named "AutoCreateNum" found to Number-type items with a value of "29" and a flag set for 'Protected'.

      JavaScript errors detected

      Please note, these errors can depend on your browser setup.

      If this problem persists, please contact our support.