Folder object

Table 1. Attributes for the folder object
Attributes Description DataType Required Default value Possible values Updateable
name Name of the folder nameString Yes  
  • Folder name
  • "_ALL"
 Yes
description A description of the folder descString No ""   Yes
searchType The note search type searchTypeString No "Retrieve"
  • "Retrieve"
  • "Hit List"
  • "Note"
 Yes
displayDocHold Whether the client displays the hold status for each document yesnoString No "No"
  • "Yes"
  • "No"
 Yes
displayDocLocation Whether the client should show the storage location of each document in the document list yesnoString No "No"
  • "Yes"
  • "No"
 Yes
queryUnmappedFields Whether this user or group should be allowed to add CFS-CMOD documents to this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
applQueryName Name of the application that has all the folders you want to export. When you specify applQueryName during export, the value for the name attribute is ignored. If you specify applQueryName, you cannot specify agQueryName. string No ""   No
agQueryName Name of the application group that has all the folders you want to export. When you specify agQueryName during export, the value for the identifier attributes is ignored. If you specify agQueryName, you cannot specify applQueryName. string No ""   No
Table 2. Child objects under the folder object
Name Minimum number Maximum number Deleteable Updateable
permission 0 Unbounded Yes Yes
applicationGroup 1 Unbounded Yes No
field 1 128 No Yes
nls 0 26 Yes Yes
folderNls 0 26 Yes Yes
Table 3. Attributes for the permission object under the folder object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
user Provide permission to the folder of this user nameString Yes ""
  • User name
 No
group Provide permission to the folder of this group nameString Yes ""
  • Group name
  • "*PUBLIC"
 No
adminAuthority Whether the user or group should have administrator authority yesnoString No "No"
  • "Yes"
  • "No"
 Yes
accessAuthority Whether the user or group should have access authority yesnoString No "No"
  • "Yes"
  • "No"
 Yes
fieldsAuthority Whether the user or group should have authority to change fields yesnoString No "No"
  • "Yes"
  • "No"
 Yes
publicNQAuthority Whether the user or group should have public named query authority yesnoString No "No"
  • "Yes"
  • "No"
 Yes
privateNQAuthority Whether the user or group should have private named query authority yesnoString No "No"
  • "Yes"
  • "No"
 Yes
viewNQAuthority Whether the user or group should have named query view authority yesnoString No "No"
  • "Yes"
  • "No"
 Yes
maxHits The maximum number of hits allowed maxHitsType No "No Limit"
  • "No Limit"
  • "None"
  • A positive integer value
 Yes
secondaryFolder Whether this is a secondary folder yesnoString No "No"
  • "Yes"
  • "No"
 Yes
userGroupFields Whether user/group fields should be created for this user/group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
fullReportBrowse Whether full report browse should be allowed for this user/group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
serverBasedSorting Whether sorting should be done on the server yesnoString No "No"
  • "Yes"
  • "No"
 Yes
Important: You must specify either a user or a group object, however, you cannot specify both.
Table 4. Attributes for the applicationGroup object under the folder object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
 N/A
name Name of this object nameString Yes   Application group name No
Table 5. Child objects under the applicationGroup object under the folder object
Name Minimum number Maximum number Deleteable Updateable
application 0 Unbounded Yes No
Table 6. Attributes for the application object under the applicationGroup object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
 N/A
name Name of this object nameString Yes   Application name No
Table 7. Attributes for the field object under the folder object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
name Name of the folder field nameString Yes     Yes
description A description of the folder field descString No ""   Yes
fieldType Field type of the folder object fieldString No "String"
  • "Ann Color Search"
  • "Ann Text Search"
  • "Application Group"
  • "Big Int"
  • "Date"
  • "Date (native)"
  • "Date/Time"
  • "Date/Time (native)"
  • "Date/Time (TZ)"
  • "Date/Time (TZ) (native)"
  • "DecFloat (16)"
  • "DecFloat (34)"
  • Decimal
  • "Document Type"
  • FTI Highlight
  • FTI Score
  • FTI Search
  • FTI Summary
  • "Hold"
  • "Integer"
  • "Segment"
  • "Small Int"
  • "String"
  • "Text Search"
  • "Time"
 No
mappingType Mapping type of the folder field mappingString No "Single"
  • "Single"
  • "Range"
  • "Operator Or"
 No
applicationGroup The Application Group to use for a segment field nameString No "" "" Yes
Table 8. Child objects under the field object under the folder object
Name Minimum number Maximum number Deleteable Updateable
mapping 0 Unbounded Yes No
fieldInfo 1 Unbounded Yes Yes
Table 9. Attributes for the mapping object under the field object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
 N/A
dbName The database field name nameString Yes     No
appGroup The application group name nameString Yes     No
Table 10. Attributes for the fieldInfo object under the field object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
user The user that is associated with this field definition nameString Yes   User name Yes
group The group that is associated with this field definition nameString Yes  
  • Group name
  • "*PUBLIC"
 Yes
defaultValue The default value string No     Yes
defaultValue2 The second default value string No     Yes
displayOrder The order of this field within the hit list Integer No 1 0 — Number of fields Yes
queryOrder The order of this field during a query Integer No 1 0 — Number of fields Yes
sortOrder The sort position of this field, if any Integer No 0 0 — Number of fields Yes
sortType Whether the documents should be sorted in an ascending or descending order sortTypeString No "Ascending"
  • "Ascending"
  • "Descending"
 Yes
equal Whether the equal operator should be available compString No "Default"
  • "Yes"
  • "No"
  • "Default"
 Yes
notEqual Whether the not equal operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
lessThan Whether the less than operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
ItOrEqual Whether the less than or equal operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
greaterThan Whether the greater than operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
gtOrEqual Whether the greater than or equal operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
in Whether the in operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
notIn Whether the not in operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
between Whether the between operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
notBetween Whether the not between operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
like Whether the like operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
notLike Whether the not like operator should be available compString No "No"
  • "Yes"
  • "No"
  • "Default"
 Yes
default Determines whether the field contains a default value when the user opens the folder yesnoString No "No"
  • "Yes"
  • "No"
 Yes
fixed Determines whether the value that you type in the default fields can be changed by the user compString No "No"
  • "Yes"
  • "No"
 Yes
required Determines whether the user must specify a search value for the field in order to type a query yesnoString No "No"
  • "Yes"
  • "No"
 Yes
viewTitle Determines whether OnDemand client programs display the field name on the title bar of the viewing window when the user selects a document for viewing yesnoString No "No"
  • "Yes"
  • "No"
 Yes
internal Determines whether OnDemand lists the displayed values or the database values for the folder search field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
wildCard Determines whether OnDemand uses wildcards with field search values wildString No "Append"
  • "Prepend"
  • "Append"
  • "Both"
  • "None"
 Yes
min For integer, DecFloat(16), DecFloat(34), decimal, date, and time fields, determines the minimum value that the user can type in the search field Integer No Based on datatype   Yes
max For integer, DecFloat(16), DecFloat(34), decimal, date, and time fields, determines the maximum value that the user can type in the search field Integer No Based on datatype   Yes
decimalPrecision Specifies the decimal precision for decimal values Integer No 2 Nonnegative integer Yes
dateDisplayFormat Determines the format that is used to display dates and times string No "" Date or time format Yes
dateDefaultFormat Determines the format that OnDemand uses to validate date and time values string No "" Date or time format Yes
dateInterval For date and time fields, determines whether the interval refers to the next or last interval intervalString No "Last"
  • "Last"
  • "Next"
 Yes
dateIntLength For date and time fields, determines the number of units that OnDemand uses to compute a default search range integer No 0 Nonnegative integer Yes
dateIntType Units of measure for dateIntLength intTypeString No "Months"
  • "Days"
  • "Months"
  • "Years"
  • "Hours"
  • "Minutes"
  • "Seconds"
 Yes
Table 11. Attributes for the nls object under the folder object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object. taskString No "add"
  • "add"
  • "update"
 No
language The language employed by this object. langString Yes  
  • "English"
  • "French"
  • "German"
  • "Italian"
  • "Japanese"
  • "Norwegian"
  • "Portuguese (Brazil)"
  • "Spanish"
  • "Chinese (Simplified)"
  • "Chinese (Traditional)"
  • "Danish"
  • "Finnish"
  • "Swedish"
  • "Korean"
  • "Dutch"
  • "Arabic"
  • "Czech"
  • "Greek"
  • "Hebrew"
  • "Croatian"
  • "Hungarian"
  • "Polish"
  • "Russian"
  • "Slovakian"
  • "Slovenian"
  • "Turkish"
 No
Table 12. Child objects under the nls object under the folder object
Name Minimum number Maximum number Deleteable Updateable
field 0 128 No Yes
Table 13. Attributes for the field object under the nls object
Attributes Description DataType Required Default value Possible values Updateable
name Name of the folder field. stringLeng1-60 Yes     No
langName Name of the folder field written in the NLS language. stringLeng1-60 Yes     Yes
langDescription Description of the folder field written in the NLS language. stringLeng1-120 No     Yes
Table 14. Attributes for the folderNls object under the folder object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object. taskString No add
  • add
  • delete
  • update
 N/A
language The language employed by this object. langString Yes  
  • "English"
  • "French"
  • "German"
  • "Italian"
  • "Japanese"
  • "Norwegian"
  • "Portuguese (Brazil)"
  • "Spanish"
  • "Chinese (Simplified)"
  • "Chinese (Traditional)"
  • "Danish"
  • "Finnish"
  • "Swedish"
  • "Korean"
  • "Dutch"
  • "Arabic"
  • "Czech"
  • "Greek"
  • "Hebrew"
  • "Croatian"
  • "Hungarian"
  • "Polish"
  • "Russian"
  • "Slovakian"
  • "Slovenian"
  • "Turkish"
 No
langName Name of the folder written in the NLS language. stringLeng1-60 Yes     Yes
langDescription Description of the folder written in the NLS language. stringLeng1-120 No     Yes
Note:
  1. You must specify either a user or a group, however, you cannot specify both.
  2. The default values for displayOrder and queryOrder are based on their position within the file.
Remember: The "_ALL" value can only be used in an ARSXML export operation.