Application group object

Table 1. Attributes for the applicationGroup object
Name Description DataType Required Default value Possible Values Updateable
autoFTI All data loaded into the Content Manager OnDemand server is processed by the full text indexer. yesnoString No
  • "Yes"
  • "No"
 Yes
name Name of the application group nameString Yes  
  • Application group name
  • "_ALL"
 Yes
database Name of the database nameString No ""   Yes
description Description of the application group descString No ""   Yes
cacheData Whether to store data in cache yesnoString No Yes
  • "Yes"
  • "No"
 Yes
docDataLen How many days to cache the data for docDataLenValue No 90
  • No Cache
  • Search Cache
  • A positive integer
 Yes
storageSet Name of the storage set to use for this application group nameString No ""   Yes
CFSOD Use CFSOD yesnoString No "No"
  • "Yes"
  • "No"
 Yes
declareCFSOD Use to declare CFSOD yesnoString No "No"
  • "Yes"
  • "No"
 Yes
expirationType Determines how data is deleted from the application group expTypeString No "Load"
  • "Load"
  • "Segment"
  • "Document"
  • z/OS® only option: "Storage Manager"
 No
expirationDate The number of days that Content Manager OnDemand keeps documents, resources, and index data in the application group expDateValue No 90
  • "Never Expire"
  • A positive integer 1-99999
 Yes
federateCFSOD Federate CFSOD yesnoString No "No"
  • "Yes"
  • "No"
 Yes
FTI Whether to enable Full Text Indexing for the application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
encryption Whether to enable encryption for the application group yesnoString No "No"
  • "Yes"
  • "No"
 No
enableLoadDate Whether to enable document load activity tracking for the application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
enableQueryDate Whether to enable document query activity tracking for the application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
enableRetrieveDate Whether to enable document retrieve activity tracking for the application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
lastLoadDate The date and time of the last load String No ""   No
lastQueryDate The date and time of the last query String No ""   No
lastRetrieveDate The date and time of the last retrieve String No ""   No
logRetrieval Whether document retrieval messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logBulkRetrieval Whether document bulk retrieval messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logDBQueriesAfter Whether database queries (after the query) should be logged yesnoString No "No"
  • "Yes"
  • "No"
 Yes
logDBQueriesBefore Whether document database queries should be logged yesnoString No "No"
  • "Yes"
  • "No"
 Yes
logServerPrinting Whether document server printing messages should be documented yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logIndexAdd Whether document index add messages should be documented yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logIndexUpdate Whether document index update messages should be documented yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logIndexDelete Whether document index delete messages should be documented yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logObjectStore Whether object store messages should be documented yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logObjectRetrieve Whether object retrieve messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logAnnotAdd Whether annotation add messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logAnnotUpdate Whether annotation update messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
logAnnotDelete Whether annotation delete messages should be logged yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
maxDBRows The maximum number of database rows for this application group Integer No 10000000
  • Positive integer
  • "Single table for all loads"
 Yes
loadsPerTable The amount of loads per table loadsString No "Multiple"
  • "Multiple"
 No
dbTablespaceType The type of database table space to use for this application group dbtString No "SMS"
  • "None"
  • "SMS"
  • "Automatic Storage"
  • "Use Tablespace"
 Yes
dbCompress For databases that support compression, Content Manager OnDemand compresses the tables or table spaces. If the database does not support compression, Content Manager OnDemand ignores this setting. yesnoString No "No"
  • "Yes"
  • "No"
 No
annot Annotation flags in the document database tables yesnoString No "No"
  • "Yes"
  • "No"
 No
enhancedRetManagement Use enhanced retention management yesnoString No "No"
  • "Yes"
  • "No"
 Yes
impliedHold Use implied hold yesnoString No "No"
  • "Yes"
  • "No"
 Yes
objectSize The object size in kilobytes Integer No 10,000 Positive integer Yes
migrateCache When to migrate data from cache migrateString No "Load"
  • "Load"
  • "Never"
  • "Migration"
  • A positive integer
 Yes
migrateIndex When to migrate indexes from cache migrateIndString No "Never"
  • "Never"
  • A positive integer
 Yes
migrateIndexKeep How long to keep imported migrated indexes Integer No 0 Nonnegative Yes
parameterMarkers Whether to use parameter markers yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
serverFTI IP address of the full text indexer server String No   Yes
useFilegroups Specifies whether this application group uses file groups yesnoString No "No"
  • "Yes"
  • "No"
 Yes
updateExistingTables Specifies whether tables should be updated if an index changes yesnoString No "No"
  • "Yes"
  • "No"
 Yes
applQueryName Name of the application that has all the application groups 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 folderQueryName. string No ""   No
folderQueryName Name of folder that has the application groups you want to export. When you specify folderQueryName during export, the values for the name attribute is ignored. If you specify folderQueryName, you cannot specify applQueryName. string No ""   No
Important:
  1. The storageSet value can be updated only if it is currently set to "".
  2. The default and possible dbTablespaceType values depend on the database that is used.
Remember: The "_ALL" value can only be used in an ARSXML export operation.
Table 2. Child objects for the applicationGroup object
Name Minimum number Maximum number Deleteable Updateable
permission 0 Unbounded Yes Yes
field 1 128 No Yes
index 0 Unbounded Yes No
Table 3. Attributes for the index object under the applicationGroup object
Attributes Description DataType Required Default value Possible values Updateable
task Task to perform taskString No "add"
  • "add"
  • "delete"
 N/A
name Name of the index indexName Yes   A positive integer No
cluster Only for Db2. Whether it is a cluster index yesnoString No "No"
  • "Yes"
  • "No"
 No
Table 4. Child objects under the index object
Name Minimum number Maximum number Deleteable Updateable
field 2 16 Yes No
Table 5. Attributes for the field object under the index object
Attributes Description DataType Required Default Possible values Updateable
name Name of the field string Yes     No
order The field order orderString No "Ascending"
  • "Ascending
  • "Descending"
 No
Table 6. Attributes for the permission object under the applicationGroup object
Attributes Description DataType Required Default Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
user Provide permissions to the application group to this user nameString Yes ""
  • User name
  • "*PUBLIC"
 No
group Provide permissions to the application group to this group nameString Yes ""
  • Group name
  • "*PUBLIC"
 No
docAddPerm Whether this user or group should be allowed to add documents to this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docDeletePerm Whether this user or group should be allowed to remove documents from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docUpdatePerm Whether this user or group should be allowed to update documents in this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docPrintPerm Whether this user or group should be allowed to print documents from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docCopyPerm Whether this user or group should be allowed to copy documents from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docCFSODPerm Whether this user or group should be allowed to add CFS-CMOD documents to this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docFTIPerm Whether this user or group should be allowed to add full text indexer documents to this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
docHoldPerm Whether this user or group should be allowed to add holds to documents for this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotViewPerm Whether this user or group be allowed to view annotation in this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotAddPerm Whether this user or group be allowed to add annotation to this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotDeletePerm Whether this user or group be allowed to delete annotation from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotUpdatePerm Whether this user or group be allowed to update annotation in this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotPrintPerm Whether this user or group be allowed to print annotation from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
annotCopyPerm Whether this user or group be allowed to copy annotation from this application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
authority Specifies the authority given authagString No "Access"
  • "Access"
  • "Administrator"
  • "Logical Views"
 Yes
queryRes A query restriction for the user or group queryString No ""   Yes
Important: Either a user or a group must be specified, but not both.
Table 7. Attributes for the field object under the applicationGroup object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on the object taskString No Same as the task attribute of the parent
  • "add"
  • "update"
 N/A
name Database field name nameString Yes     No
type Index type fieldTypeString No
  • "Filter"
  • Index
  • "Filter"
  • "Index"
  • "Not in Database"
 Yes, but only from "Filter" to "Index" or from "Index" to "Filter"
CFSOD Whether this field is a CFSOD field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
dataType The data type of the field dataTypeString No "String"
  • "Big Int"
  • "Date"
  • "Date (native)"
  • "Date/Time"
  • "Date/Time (native)"
  • "Date/Time (TZ)"
  • "Date/Time (TZ) (native)"
  • "Decimal"
  • "Integer"
  • "Small Int"
  • "String"
 No
segment If the expiration type is segment, value of this field is used by Content Manager OnDemand to determine when to delete data from the application group yesnoString No "No"
  • "Yes"
  • "No"
 No
expireDate Whether this field is used for the expiration date yesnoString No "No"
  • "Yes"
  • "No"
 No
lockdown Whether this is a lockdown field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
log Whether to use the system log yesnoString No "No"
  • "Yes"
  • "No"
 Yes
userExit Whether to send data to the user exit yesnoString No "No"
  • "Yes"
  • "No"
 Yes
partition Used to partition the index data across the multiple nodes yesnoString No "No"
  • "Yes"
  • "No"
 Yes
cluster Only for Db2. Determines the clustering index for the application group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
reference Only for z/OS. Controls which reports are distributed from Content Manager OnDemand Distribution Facility. yesnoString No "No"
  • "Yes"
  • "No"
 Yes
stringCase The case to use if the data type is string caseString No "Upper"
  • "Upper"
  • "Lower"
  • "Mixed"
 No
stringType The type of string stringType No "Fixed"
  • "Fixed"
  • "Variable"
 No
stringLength The length of the string Integer No 0
  • For fixed strings: 1–254
  • For variable length strings: 1–2000
 No
stringEmbedded The embedded characters to remove from the string string No ""   Yes
stringLeading The leading characters to remove from the string string No ""   Yes
stringTrailing The trailing characters to remove from the string string No ""   Yes
appIDField Whether this field is the application ID field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
pageCount Specifies whether this is a page count field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
documentSize Specifies whether this is a document size field yesnoString No "No"
  • "Yes"
  • "No"
 Yes
updateable Whether this field can be updated yesnoString No "Yes"
  • "Yes"
  • "No"
 Yes
FTI Whether to index this field with the Full Text Indexer yesnoString No "No"
  • "Yes"
  • "No"
 Yes
uniqueID Whether this is a unique ID field yesnoString No "No"
  • "Yes"
  • "No"
 No
hashSHA256 Whether this is a Hash SHA-256 field yesnoString No "No"
  • "Yes"
  • "No"
 No
encryption Whether this is an encryption field (used internally by the encryption process) yesnoString No "No"
  • "Yes"
  • "No"
 No
The following restrictions apply to the Not in Database value:
  • Do not use a field whose type attribute has a definition of Not in Database to hold information such as a report ID that applies to all documents that are returned in the hit list.
  • The Not in Database value allows you to create a segment field that is based off the start/end dates that are found in the segment table without capturing another date in the application group data table.
  • You can query on a value by using a folder field that is mapped to the application group field whose type attribute has a definition of "Not In Database". The system performs a check to determine whether the value matches the segment range. However, the value cannot be displayed because it is not stored anywhere.
  • Use the "Not In Database" value for a database field that has been defined as segment field.
  • You can use the "Not In Database" value to segment a report that is based on a value that you do not want to capture in the database as an index or filter. In other words, you only needed the field when you were indexing the report.
Table 8. Child objects under the field object
Name Minimum number Maximum number Deleteable Updateable
mapping 0 Unbounded Yes Yes
nls 0 26 Yes Yes
Table 9. Attributes for the mapping object under field
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "update"
  • "delete"
 N/A
dbValue The database value dbString2 Yes     No
displayedValue The displayed value dvString Yes     Yes
Table 10. Attributes for the nls object under field
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "update"
  • "delete"
 N/A
language The natural language string Yes
  • English
  • French
  • German
  • Italian
  • Japanese
  • Norwegian
  • Portuguese (Brazil)
  • Spanish
  • Chinese (Simplified)
  • Chinese (Traditional)
  • Danish
  • Finnish
  • Swedish
  • Korean
  • Dutch
  • Arabic
  • Czech
  • Greek
  • Hebrew
  • Croatian
  • English
  • Hungarian
  • Polish
  • Russian
  • Slovakian
 Yes
Table 11. Child objects under the nls object
Name Minimum number Maximum number Deleteable Updateable
mapping 0 Unbounded Yes Yes
Table 12. Attributes for the mapping object under nls
Attributes Description DataType Required Default value Possible values Updateable
dbValue The database value string Yes     No
displayedValue The displayed value string Yes     Yes