BATCH document structure in designPropEZ


IMPORTANT

The designPropEZ database is no longer supported as of version 16. As of version 16.5.1, designPropEZ batch processes are executed through databaseEZ.

This documentation will be kept for both archival purposes and for users of older versions of designPropEZ.


Batch documents


If you do decide to create your own Batch documents, it is imperative to include the following fields so designPropEZ will understand what to do.


Structure of the document

Field Name

Values

Type

Comment

Form

Batch

Text

Constant value.

Server_Name

https://www2.ytria.com/icons/ecblank.gif

Text

Server where the database to process is located. If local leave empty

Database_Path

DemoInit.nsf
*.ntf
????????.ntf

Text List

Absolute path of the database to process (if processing one given database on the server)
or
Databases to include in process (if performing a full server scan)

Database_Path_Exclude

DemoInit.nsf
*.ntf
????????.ntf

Text List

(Optional) Only used when performing a full server scan

Database_Title

The Library

Text

(Optional) Title of the database to process
This field is not used by designPropEZ.

Database_Template

https://www2.ytria.com/icons/ecblank.gif

Text

(Optional) Name of the database template
This field is not used by designPropEZ.

Class

outline;form;folder

Text List

Category of design elements to work on
(See 

Possible values for the Class field

 for more information)

Regex_Filter

https://www2.ytria.com/icons/ecblank.gif

Text

(Optional) This field allows you to place a regular expression filter on the design names of the notes to be processed in your Batch document.

NoteID

https://www2.ytria.com/icons/ecblank.gif

Text

Specific NoteID of design elements to work on
(See note below this table)

All

0

Number

Flag: 1 - All design elements will be processed, 0 - Only elements specified by the Class and NoteID fields will be processed.
(See note below this table)

Search_Change_Inherit

0

Number

Flag: 1- Search for elements with the Inherited template matching the string in Search_Inherit field, 0- Property is ignored

Update_Change_Inherit

0

Number

Flag: 1- Inherited template will be changed to the one specified in Update_Inherit field, 0- Property is ignored and will not be changed

Search_Inherit

https://www2.ytria.com/icons/ecblank.gif

Text

Inherited template search string

Update_Inherit

https://www2.ytria.com/icons/ecblank.gif

Text

Name of the inherited template you want to change to

Search_Prohibit

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Prohibit Refresh
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Prohibit

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Prohibit Refresh
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Propagate

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Propagate Prohibit
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Propagate

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Propagate Prohibit
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Show46

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Show in Menu
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Show46

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Show in Menu
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Hide46

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Notes
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Hide46

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Notes
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Hide_Web

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Web
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Hide_Web

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Web
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Mobile

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Mobile
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Mobile

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Hide in Mobile
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements

Search_Change_Language

0

Number

Flag: 1- Search for elements with the language matching the string in Search_Language field, 0- The property is ignored
Change Lang.

Update_Change_Language

0

Number

Flag: 1- Language will be changed to the one specified in Update_Language field, 0- The property is ignored and will not be changed

Search_Language

https://www2.ytria.com/icons/ecblank.gif

Text

Language string to search.

This field will not be validated. See 

Language Codes

 for a list of possible values.

Update_Language

https://www2.ytria.com/icons/ecblank.gif

Text

The language you wish to use for the element.

This field will not be validated. See 

Language Codes

 for a list of possible values.

Search_Run_Agent

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Run Agent
Flag: None- Ignore this property, 0- Search for elements with this property disabled, 1- Search for elements with this property enabled

Update_Run_Agent

https://www2.ytria.com/icons/ecblank.gif

Text

Property: Run Agent
Flag: None- Ignore this property, 0- Disable this property for all selected elements, 1- Enable this property for all selected elements


NOTE

When the All flag is 1, all design elements are selected. Otherwise, designPropEZ will use the Class and NoteID fields.

Fields created by the batch process

Field Name

Values

Type

Comment

Number_OK

https://www2.ytria.com/icons/ecblank.gif

Number

Number of elements that were processed OK.

Result

https://www2.ytria.com/icons/ecblank.gif

Rich Text

Result log of last execute

Status

https://www2.ytria.com/icons/ecblank.gif

Text

Final status of last execute

Possible values for the Class field

outline, frameset, page, form, view, folder, agent, privateview, privatefolder, privateagent, navigator, image, applet, subform, sharedfield, lotusscriptlibrary, javalibrary, javascriptlibrary, dataconnection, stylesheet, file, aboutdocument, usingdocument, databaseicon, databasescript, other, xpage, customcontrol, theme, servers